Skip to content

docs/library: Fix ADC/DAC Common & Channel base addresses #1943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs/library: Fix ADC/DAC Common & Channel base addresses #1943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
28e268c
axi_ada4355: Fix regmap offsets table
StancaPop Oct 29, 2025
a10c801
docs/user_guide: Update axi adc regmap info
StancaPop Nov 19, 2025
80f96f9
docs/user_guide: Update axi dac regmap info
StancaPop Nov 25, 2025
4399e12
docs/library: Update regmap table header
StancaPop Nov 25, 2025
e9169e6
docs/library: Add regmap intro and usage ref
StancaPop Nov 25, 2025
7aab171
axi_ad9144: Delete oboselete IP doc
StancaPop Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions docs/library/axi_ad35xxr/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,18 +150,44 @@ the 16 LSBs -- The 4 LSBs of this word are 0's for the 12-bit accuracy.
Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like DAC common, DAC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

For the AXI_AD3XXR control used registers from DAC Common are:

.. hdl-regmap::
:name: AXI_AD35XXR_DAC_COMMON


For the AXI_AD35XXR control used registers from DAC Channel are:

.. hdl-regmap::
:name: AXI_AD35XXR_DAC_CHANNEL

For reference, all the register map templates are:
The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`DAC register access <generic-dac-register-access>`.

.. list-table:: Register Map base addresses for axi_ad35xxr
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- TX COMMON
- See the `DAC Common <#hdl-regmap-DAC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- TX CHANNELS
- See the `DAC Channel <#hdl-regmap-DAC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
Expand Down
7 changes: 4 additions & 3 deletions docs/library/axi_ad408x/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,14 @@ The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address.
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad408x
:header-rows: 1

* - DWORD
- BYTE
* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
Expand Down
8 changes: 5 additions & 3 deletions docs/library/axi_ad485x/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,14 +302,16 @@ The register map of the core contains instances of several generic register maps
like ADC common, ADC channel, :git-hdl:`up_delay_ctrl <library/common/up_delay_ctrl.v>`.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address.
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad485x
:header-rows: 1

* - DWORD
- BYTE
* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
Expand Down
30 changes: 27 additions & 3 deletions docs/library/axi_ad7405/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,33 @@ Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like ADC common, ADC channel or PWM Generator. The following table presents the
base addresses of each instance, after that can be found the detailed
description of each generic register map.
like ADC common, ADC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad7405
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX COMMON
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX CHANNELS
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
Expand Down
30 changes: 27 additions & 3 deletions docs/library/axi_ad7606x/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,33 @@ Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like ADC common, ADC channel or PWM Generator. The following table presents the
base addresses of each instance, after that can be found the detailed
description of each generic register map.
like ADC common, ADC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad7606x
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX COMMON
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX CHANNELS
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
Expand Down
30 changes: 27 additions & 3 deletions docs/library/axi_ad7616/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,33 @@ Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like ADC common, ADC channel or PWM Generator. The following table presents the
base addresses of each instance, after that can be found the detailed
description of each generic register map.
like ADC common, ADC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad7616
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX COMMON
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX CHANNELS
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
Expand Down
30 changes: 30 additions & 0 deletions docs/library/axi_ad7768/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,35 @@ basic monitoring and control of the ADC's channel.
Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like ADC common, ADC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad7768
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX COMMON
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX CHANNELS
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
:no-type-info:
Expand All @@ -131,6 +160,7 @@ Register Map
:name: ADC_CHANNEL
:no-type-info:


Design Guidelines
--------------------------------------------------------------------------------

Expand Down
29 changes: 29 additions & 0 deletions docs/library/axi_ad777x/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,35 @@ basic monitoring and control of the ADC's channel.
Register Map
--------------------------------------------------------------------------------

The register map of the core contains instances of several generic register maps
like ADC common, ADC channel.
The following table presents the base addresses of each instance, after it you
can find the detailed description of each generic register map.

The absolute address of a register should be calculated by adding the instance
base address to the registers relative address. For a more detailed explanation,
see :ref:`ADC register access <generic-adc-register-access>`.

.. list-table:: Register Map base addresses for axi_ad777x
:header-rows: 1

* - HDL reg
- Software reg
- Name
- Description
* - 0x0000
- 0x0000
- BASE
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX COMMON
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
* - 0x0000
- 0x0000
- RX CHANNELS
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.

.. hdl-regmap::
:name: COMMON
:no-type-info:
Expand Down
Loading