Skip to content

Commit 1e496ee

Browse files
committed
docs: Add util_extract IP core
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
1 parent 71abcaa commit 1e496ee

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

docs/library/util_extract/index.rst

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _util_extract:
2+
3+
Util Extract
4+
===============================================================================
5+
6+
.. hdl-component-diagram::
7+
8+
The :git-hdl:`Util Extract <library/util_extract>` core
9+
allows the extraction of the trigger signal and restoration of the data signal
10+
that was embedded in the data stream by the :ref:`axi_adc_trigger`.
11+
12+
Files
13+
--------------------------------------------------------------------------------
14+
15+
.. list-table::
16+
:header-rows: 1
17+
18+
* - Name
19+
- Description
20+
* - :git-hdl:`library/util_extract/util_extract.v`
21+
- Verilog source for the peripheral.
22+
23+
Configuration Parameters
24+
--------------------------------------------------------------------------------
25+
26+
.. hdl-parameters::
27+
28+
* - NUM_OF_CHANNELS
29+
- Number of channels
30+
* - DATA_WIDTH
31+
- Data width. It assumes the trigger is in bit (n*16)-1, with n being the
32+
channel number
33+
34+
Interface
35+
--------------------------------------------------------------------------------
36+
37+
.. hdl-interfaces::
38+
39+
* - clk
40+
- Clock input. Should be synchronous to the input and the output data
41+
* - data_in
42+
- Input data from the FIFO. Will replace each trigger bit with the sign
43+
extended version of the data. It should be data from the output of the
44+
variable fifo
45+
* - data_in_trigger
46+
- Data from which the trigger is extracted. It should be data from the
47+
input of the variable fifo
48+
* - data_valid
49+
- Valid for the input data
50+
* - data_out
51+
- Data without the embedded trigger
52+
* - valid_out
53+
- Valid for the output data
54+
* - trigger_out
55+
- Trigger output. Is an logic OR of the triggers from all the channels
56+
that are captured simulaneously

0 commit comments

Comments
 (0)