Skip to content

Commit 871c5a0

Browse files
committed
docs/library/spi_engine: update documentation
* Update documentation to include the changes done for supporting more than one SDO lane. * Update the register map. Signed-off-by: Carlos Souza <carlos.souza@analog.com>
1 parent 15a8d6e commit 871c5a0

File tree

7 files changed

+1286
-287
lines changed

7 files changed

+1286
-287
lines changed

docs/library/spi_engine/axi_spi_engine.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,18 @@ If an application attempts to read data while the FIFO is empty undefined data
116116
is returned and the state of the FIFO remains unmodified.
117117
It is possible to read the first entry in the SDI FIFO without removing it by
118118
reading from the SDI_FIFO_PEEK register.
119+
It is important to point out that each read represents one lane of the SPI. So,
120+
for ``NUM_OF_SDI`` lanes it is necessary to read ``NUM_OF_SDI`` times. Reading
121+
always starts from lane 0.
119122
The number of valid entries in the SDI FIFO register can be queried by reading
120-
the SDI_FIFO_LEVEL register.
123+
the SDI_FIFO_LEVEL register. This value must be a multiple of ``NUM_OF_SDI``.
124+
125+
Data can be inserted into the SDO FIFO by writing to the SDO_FIFO register
126+
**only the valid lanes**. For example, if there are 4 lanes and just 2 of them
127+
are enabled, then the programmer must write 2 values to this register. The
128+
remaining lanes will contain ``SDO_DEFAULT`` value defined in
129+
:ref:`spi_engine execution`. The number of valid lanes are defined in
130+
:ref:`spi_engine configuration-registers`.
121131

122132
If the peripheral is disabled by setting the ENABLE register to 0 any data
123133
stored in the FIFOs is discarded and the state of the FIFO is reset.

0 commit comments

Comments
 (0)