Skip to content

Commit 3406357

Browse files
StancaPopStancaPop
committed
docs/library: Add regmap intro and usage ref
Signed-off-by: Stanca Pop <stanca.pop@analog.com>
1 parent 88db321 commit 3406357

File tree

24 files changed

+533
-32
lines changed

24 files changed

+533
-32
lines changed

‎docs/library/axi_ad35xxr/index.rst‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,18 +150,44 @@ the 16 LSBs -- The 4 LSBs of this word are 0's for the 12-bit accuracy.
150150
Register Map
151151
--------------------------------------------------------------------------------
152152

153+
The register map of the core contains instances of several generic register maps
154+
like DAC common, DAC channel.
155+
The following table presents the base addresses of each instance, after it you
156+
can find the detailed description of each generic register map.
157+
153158
For the AXI_AD3XXR control used registers from DAC Common are:
154159

155160
.. hdl-regmap::
156161
:name: AXI_AD35XXR_DAC_COMMON
157162

158-
159163
For the AXI_AD35XXR control used registers from DAC Channel are:
160164

161165
.. hdl-regmap::
162166
:name: AXI_AD35XXR_DAC_CHANNEL
163167

164-
For reference, all the register map templates are:
168+
The absolute address of a register should be calculated by adding the instance
169+
base address to the registers relative address. For a more detailed explanation,
170+
see :ref:`DAC register access <generic-dac-register-access>`.
171+
172+
.. list-table:: Register Map base addresses for axi_ad35xxr
173+
:header-rows: 1
174+
175+
* - HDL reg
176+
- Software reg
177+
- Name
178+
- Description
179+
* - 0x0000
180+
- 0x0000
181+
- BASE
182+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
183+
* - 0x0000
184+
- 0x0000
185+
- TX COMMON
186+
- See the `DAC Common <#hdl-regmap-DAC_COMMON>`__ table for more details.
187+
* - 0x0000
188+
- 0x0000
189+
- TX CHANNELS
190+
- See the `DAC Channel <#hdl-regmap-DAC_CHANNEL>`__ table for more details.
165191

166192
.. hdl-regmap::
167193
:name: COMMON

‎docs/library/axi_ad408x/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ The following table presents the base addresses of each instance, after it you
122122
can find the detailed description of each generic register map.
123123

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

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

‎docs/library/axi_ad485x/index.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,10 @@ The register map of the core contains instances of several generic register maps
302302
like ADC common, ADC channel, :git-hdl:`up_delay_ctrl <library/common/up_delay_ctrl.v>`.
303303
The following table presents the base addresses of each instance, after it you
304304
can find the detailed description of each generic register map.
305+
305306
The absolute address of a register should be calculated by adding the instance
306-
base address to the registers relative address.
307+
base address to the registers relative address. For a more detailed explanation,
308+
see :ref:`ADC register access <generic-adc-register-access>`.
307309

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

‎docs/library/axi_ad7405/index.rst‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,33 @@ Register Map
5757
--------------------------------------------------------------------------------
5858

5959
The register map of the core contains instances of several generic register maps
60-
like ADC common, ADC channel or PWM Generator. The following table presents the
61-
base addresses of each instance, after that can be found the detailed
62-
description of each generic register map.
60+
like ADC common, ADC channel.
61+
The following table presents the base addresses of each instance, after it you
62+
can find the detailed description of each generic register map.
63+
64+
The absolute address of a register should be calculated by adding the instance
65+
base address to the registers relative address. For a more detailed explanation,
66+
see :ref:`ADC register access <generic-adc-register-access>`.
67+
68+
.. list-table:: Register Map base addresses for axi_ad7405
69+
:header-rows: 1
70+
71+
* - HDL reg
72+
- Software reg
73+
- Name
74+
- Description
75+
* - 0x0000
76+
- 0x0000
77+
- BASE
78+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
79+
* - 0x0000
80+
- 0x0000
81+
- RX COMMON
82+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
83+
* - 0x0000
84+
- 0x0000
85+
- RX CHANNELS
86+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
6387

6488
.. hdl-regmap::
6589
:name: COMMON

‎docs/library/axi_ad7606x/index.rst‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,33 @@ Register Map
8989
--------------------------------------------------------------------------------
9090

9191
The register map of the core contains instances of several generic register maps
92-
like ADC common, ADC channel or PWM Generator. The following table presents the
93-
base addresses of each instance, after that can be found the detailed
94-
description of each generic register map.
92+
like ADC common, ADC channel.
93+
The following table presents the base addresses of each instance, after it you
94+
can find the detailed description of each generic register map.
95+
96+
The absolute address of a register should be calculated by adding the instance
97+
base address to the registers relative address. For a more detailed explanation,
98+
see :ref:`ADC register access <generic-adc-register-access>`.
99+
100+
.. list-table:: Register Map base addresses for axi_ad7606x
101+
:header-rows: 1
102+
103+
* - HDL reg
104+
- Software reg
105+
- Name
106+
- Description
107+
* - 0x0000
108+
- 0x0000
109+
- BASE
110+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
111+
* - 0x0000
112+
- 0x0000
113+
- RX COMMON
114+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
115+
* - 0x0000
116+
- 0x0000
117+
- RX CHANNELS
118+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
95119

96120
.. hdl-regmap::
97121
:name: COMMON

‎docs/library/axi_ad7616/index.rst‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,33 @@ Register Map
8383
--------------------------------------------------------------------------------
8484

8585
The register map of the core contains instances of several generic register maps
86-
like ADC common, ADC channel or PWM Generator. The following table presents the
87-
base addresses of each instance, after that can be found the detailed
88-
description of each generic register map.
86+
like ADC common, ADC channel.
87+
The following table presents the base addresses of each instance, after it you
88+
can find the detailed description of each generic register map.
89+
90+
The absolute address of a register should be calculated by adding the instance
91+
base address to the registers relative address. For a more detailed explanation,
92+
see :ref:`ADC register access <generic-adc-register-access>`.
93+
94+
.. list-table:: Register Map base addresses for axi_ad7616
95+
:header-rows: 1
96+
97+
* - HDL reg
98+
- Software reg
99+
- Name
100+
- Description
101+
* - 0x0000
102+
- 0x0000
103+
- BASE
104+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
105+
* - 0x0000
106+
- 0x0000
107+
- RX COMMON
108+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
109+
* - 0x0000
110+
- 0x0000
111+
- RX CHANNELS
112+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
89113

90114
.. hdl-regmap::
91115
:name: COMMON

‎docs/library/axi_ad7768/index.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,35 @@ basic monitoring and control of the ADC's channel.
119119
Register Map
120120
--------------------------------------------------------------------------------
121121

122+
The register map of the core contains instances of several generic register maps
123+
like ADC common, ADC channel.
124+
The following table presents the base addresses of each instance, after it you
125+
can find the detailed description of each generic register map.
126+
127+
The absolute address of a register should be calculated by adding the instance
128+
base address to the registers relative address. For a more detailed explanation,
129+
see :ref:`ADC register access <generic-adc-register-access>`.
130+
131+
.. list-table:: Register Map base addresses for axi_ad7768
132+
:header-rows: 1
133+
134+
* - HDL reg
135+
- Software reg
136+
- Name
137+
- Description
138+
* - 0x0000
139+
- 0x0000
140+
- BASE
141+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
142+
* - 0x0000
143+
- 0x0000
144+
- RX COMMON
145+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
146+
* - 0x0000
147+
- 0x0000
148+
- RX CHANNELS
149+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
150+
122151
.. hdl-regmap::
123152
:name: COMMON
124153
:no-type-info:
@@ -131,6 +160,7 @@ Register Map
131160
:name: ADC_CHANNEL
132161
:no-type-info:
133162

163+
134164
Design Guidelines
135165
--------------------------------------------------------------------------------
136166

‎docs/library/axi_ad777x/index.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,35 @@ basic monitoring and control of the ADC's channel.
114114
Register Map
115115
--------------------------------------------------------------------------------
116116

117+
The register map of the core contains instances of several generic register maps
118+
like ADC common, ADC channel.
119+
The following table presents the base addresses of each instance, after it you
120+
can find the detailed description of each generic register map.
121+
122+
The absolute address of a register should be calculated by adding the instance
123+
base address to the registers relative address. For a more detailed explanation,
124+
see :ref:`ADC register access <generic-adc-register-access>`.
125+
126+
.. list-table:: Register Map base addresses for axi_ad777x
127+
:header-rows: 1
128+
129+
* - HDL reg
130+
- Software reg
131+
- Name
132+
- Description
133+
* - 0x0000
134+
- 0x0000
135+
- BASE
136+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
137+
* - 0x0000
138+
- 0x0000
139+
- RX COMMON
140+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
141+
* - 0x0000
142+
- 0x0000
143+
- RX CHANNELS
144+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
145+
117146
.. hdl-regmap::
118147
:name: COMMON
119148
:no-type-info:

‎docs/library/axi_ad9144/index.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,35 @@ system's AXI bus, facilitating efficient data transfer and control.
122122
Register Map
123123
--------------------------------------------------------------------------------
124124

125+
The register map of the core contains instances of several generic register maps
126+
like DAC common, DAC channel, JESD TPL.
127+
The following table presents the base addresses of each instance, after it you
128+
can find the detailed description of each generic register map.
129+
130+
The absolute address of a register should be calculated by adding the instance
131+
base address to the registers relative address. For a more detailed explanation,
132+
see :ref:`DAC register access <generic-dac-register-access>`.
133+
134+
.. list-table:: Register Map base addresses for ad_ip_jesd204_tpl_dac
135+
:header-rows: 1
136+
137+
* - HDL reg
138+
- Software reg
139+
- Name
140+
- Description
141+
* - 0x0000
142+
- 0x0000
143+
- BASE
144+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
145+
* - 0x0000
146+
- 0x0000
147+
- TX COMMON
148+
- See the `DAC Common <#hdl-regmap-DAC_COMMON>`__ table for more details.
149+
* - 0x0000
150+
- 0x0000
151+
- TX CHANNELS
152+
- See the `DAC Channel <#hdl-regmap-DAC_CHANNEL>`__ table for more details.
153+
125154
.. hdl-regmap::
126155
:name: COMMON
127156
:no-type-info:

‎docs/library/axi_ad9265/index.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,35 @@ monitoring the PRBS sequence.
141141
Register Map
142142
--------------------------------------------------------------------------------
143143

144+
The register map of the core contains instances of several generic register maps
145+
like ADC common, ADC channel.
146+
The following table presents the base addresses of each instance, after it you
147+
can find the detailed description of each generic register map.
148+
149+
The absolute address of a register should be calculated by adding the instance
150+
base address to the registers relative address. For a more detailed explanation,
151+
see :ref:`ADC register access <generic-adc-register-access>`.
152+
153+
.. list-table:: Register Map base addresses for axi_ad9265
154+
:header-rows: 1
155+
156+
* - HDL reg
157+
- Software reg
158+
- Name
159+
- Description
160+
* - 0x0000
161+
- 0x0000
162+
- BASE
163+
- See the `Base <#hdl-regmap-COMMON>`__ table for more details.
164+
* - 0x0000
165+
- 0x0000
166+
- RX COMMON
167+
- See the `ADC Common <#hdl-regmap-ADC_COMMON>`__ table for more details.
168+
* - 0x0000
169+
- 0x0000
170+
- RX CHANNELS
171+
- See the `ADC Channel <#hdl-regmap-ADC_CHANNEL>`__ table for more details.
172+
144173
.. hdl-regmap::
145174
:name: COMMON
146175
:no-type-info:

0 commit comments

Comments
 (0)