Skip to content

Commit 8fd6311

Browse files
committed
docs: axi_ltc235x: edit_tables
Due to the library being an intel part, the standard HDL- command to automate some tables do not work due to lack of component.xml This patch manually adds them. Signed-off-by: Alexis Czezar Torreno <alexisczezar.torreno@analog.com>
1 parent afcadb1 commit 8fd6311

File tree

1 file changed

+172
-6
lines changed

1 file changed

+172
-6
lines changed

docs/library/axi_ltc235x/index.rst

Lines changed: 172 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
AXI LTC235X
44
===============================================================================
55

6-
.. hdl-component-diagram::
7-
:path: library/axi_ltc235x
8-
96
The :git-hdl:`AXI LTC235X <library/axi_ltc235x>` IP core can be used to
107
interface the :adi:`LTC2358-18`, :adi:`LTC2358-16`, and similar devices
118
using an FPGA. The core has a AXI Memory Map interface for configuration,
@@ -70,15 +67,184 @@ LVDS mode
7067
Configuration Parameters
7168
-------------------------------------------------------------------------------
7269

73-
.. hdl-parameters::
74-
:path: library/axi_ltc235x
70+
.. list-table::
71+
:widths: 20 40 10 30
72+
:header-rows: 1
73+
74+
* - Name
75+
- Description
76+
- Default Value
77+
- Choices/Range
78+
* - ID
79+
- Core ID should be unique for each IP in the system
80+
- 0
81+
-
82+
* - XILINX_INTEL_N
83+
- IP Core Compatibility
84+
- 0
85+
- FPGAS: 0 for Intel, 1 for Xilinx
86+
* - LVDS_CMOS_N
87+
- Selects physical interface type
88+
- 0
89+
- Interface: 0 for CMOS, 1 for LVDS
90+
* - LTC235X_FAMILY
91+
- Selects chip family
92+
- 0
93+
- 0 for 2358-18, 1 for 2358-16, 2 for 2357-18, 3 for 2357-16, 4 for 2353-18, 5 for 2353-16
94+
* - LANE_0_ENABLE
95+
- Lane 0 Enable, if set lane signal is connected
96+
- 1
97+
-
98+
* - LANE_1_ENABLE
99+
- Lane 1 Enable, if set lane signal is connected
100+
- 1
101+
-
102+
* - LANE_2_ENABLE
103+
- Lane 2 Enable, if set lane signal is connected
104+
- 1
105+
-
106+
* - LANE_3_ENABLE
107+
- Lane 3 Enable, if set lane signal is connected
108+
- 1
109+
-
110+
* - LANE_4_ENABLE
111+
- Lane 4 Enable, if set lane signal is connected
112+
- 1
113+
-
114+
* - LANE_5_ENABLE
115+
- Lane 5 Enable, if set lane signal is connected
116+
- 1
117+
-
118+
* - LANE_6_ENABLE
119+
- Lane 6 Enable, if set lane signal is connected
120+
- 1
121+
-
122+
* - LANE_7_ENABLE
123+
- Lane 7 Enable, if set lane signal is connected
124+
- 1
125+
-
126+
* - EXTERNAL_CLK
127+
- Enables external_clk input pin
128+
- 0
129+
- If 1, uses an external clock
130+
* - NUM_CHANNELS
131+
- Select number of ADC channels
132+
- 8
133+
- 8 for LTC2358, 4 for LTC2357, 2 for LTC2353
134+
* - DATA_WIDTH
135+
- Select width of data in bits
136+
- 18
137+
- 18 or 16 based on the part
75138

76139
.. _axi_ltc235x interface:
77140

78141
Interface
79142
-------------------------------------------------------------------------------
80143

81-
.. hdl-interfaces::
144+
.. list-table::
145+
:widths: 20 30 10 40
146+
:header-rows: 1
147+
148+
* - Interface
149+
- Pin
150+
- Type
151+
- Description
152+
* - Input data interface
153+
-
154+
-
155+
- ADC data interface signals
156+
* -
157+
- busy
158+
- input
159+
- Indicates that a conversion is in progress. This pin transitions lowto-high at the start of each conversion and stays high until the conversion is complete
160+
* -
161+
- lvds_cmos_n
162+
- output
163+
- I/O mode select
164+
* -
165+
- external_clk
166+
- input
167+
- external clock
168+
* -
169+
-
170+
-
171+
- CMOS signals
172+
* -
173+
- scki
174+
- output
175+
- Serial clock input of device
176+
* -
177+
- scko
178+
- input
179+
- Serial clock output of device
180+
* -
181+
- sdi
182+
- output
183+
- Serial data input of device
184+
* -
185+
- sdo
186+
- input [7:0]
187+
- Serial data output of device
188+
* -
189+
-
190+
-
191+
- LVDS signals
192+
* -
193+
- scki_p
194+
- output
195+
- Positive serial clock input of device
196+
* -
197+
- scki_n
198+
- output
199+
- Negative serial clock input of device
200+
* -
201+
- scko_p
202+
- input
203+
- Positive serial clock output of device
204+
* -
205+
- scko_n
206+
- input
207+
- Negative serial clock output of device
208+
* -
209+
- sdi_p
210+
- output
211+
- Positive serial data input of device
212+
* -
213+
- sdi_n
214+
- output
215+
- Negative serial data input of device
216+
* -
217+
- sdo_p
218+
- input
219+
- Positive serial data output of device
220+
* -
221+
- sdo_n
222+
- input
223+
- Negative serial data output of device
224+
* - s axi_*
225+
-
226+
-
227+
- AXI Slave Memory Map interface
228+
* - adc fifo
229+
-
230+
-
231+
- FIFO interface for connecting to the DMA
232+
* -
233+
- adc_dovf
234+
- input
235+
- Data overflow, must be connected to the DMA.
236+
* -
237+
- adc_enable_*
238+
- output
239+
- If set, the channel is enabled. One for each channel
240+
* -
241+
- adc_valid_*
242+
- output
243+
- Indicates valid data at the current channel. One for each channel
244+
* -
245+
- adc_data_*
246+
- output [31:0]
247+
- Received data output. One for each channel
82248

83249
Detailed Architecture
84250
-------------------------------------------------------------------------------

0 commit comments

Comments
 (0)