zcy
/
pluto_hdl_adi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
pluto_hdl_adi/docs/library/spi_engine/control-interface.rst

95 lines
2.6 KiB
ReStructuredText
Raw Normal View History

docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
.. _spi_engine control-interface:
SPI Engine Control Interface
================================================================================
The SPI Engine Control Interface is used to exchange data between different
cores within the SPI Engine framework. It is used to exchange the commands and
synchronization points as well as the SPI bus transmit and receive data.
The interface consists of four streams:
docs: Intermediary for IP Cores import, user guide, regmap (#1321) Use interref (doctools cross-repository) to link the docs guidelines Add user guide pages, update IP references Add axi_adc/dac, up_if, "Use ADI IPs", "Creating new IP", Update AXI DMAC, JESD204, I3C Controller, SPI Engines Minor fixes in the frameworks and register maps, the latter following the discussed guidelines. Update AXI terms to manager and subordinate. Signed-off-by: Jorge Marques <jorge.marques@analog.com> Signed-off-by: Laez Barbosa <laez.barbosa@analog.com> Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>
2024-05-13 13:05:12 +00:00
* The CMD stream which carries the SPI Engine commands. (Manager to Subordinate)
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
* The SDO stream which carries the to be transmitted data for the SPI bus.
docs: Intermediary for IP Cores import, user guide, regmap (#1321) Use interref (doctools cross-repository) to link the docs guidelines Add user guide pages, update IP references Add axi_adc/dac, up_if, "Use ADI IPs", "Creating new IP", Update AXI DMAC, JESD204, I3C Controller, SPI Engines Minor fixes in the frameworks and register maps, the latter following the discussed guidelines. Update AXI terms to manager and subordinate. Signed-off-by: Jorge Marques <jorge.marques@analog.com> Signed-off-by: Laez Barbosa <laez.barbosa@analog.com> Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>
2024-05-13 13:05:12 +00:00
(Manager to Subordinate)
* The SDI stream which carries the received data from the SPI bus. (Subordinate to
Manager)
* The SYNC stream which carries the synchronization events. (Subordinate to Manager)
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
Each of the streams has a valid, ready and data signal. They follow the
docs: Intermediary for IP Cores import, user guide, regmap (#1321) Use interref (doctools cross-repository) to link the docs guidelines Add user guide pages, update IP references Add axi_adc/dac, up_if, "Use ADI IPs", "Creating new IP", Update AXI DMAC, JESD204, I3C Controller, SPI Engines Minor fixes in the frameworks and register maps, the latter following the discussed guidelines. Update AXI terms to manager and subordinate. Signed-off-by: Jorge Marques <jorge.marques@analog.com> Signed-off-by: Laez Barbosa <laez.barbosa@analog.com> Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>
2024-05-13 13:05:12 +00:00
handshaking protocol as defined by the AXI standard. Meaning the manager asserts
valid when the data on the data signal is valid and the subordinate asserts ready
when it is able to accept new data. If both valid and ready are asserted at the same
time the data has been transmitted from the manager to the subordinate.
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
Files
--------------------------------------------------------------------------------
.. list-table::
:header-rows: 1
* - Name
- Description
docs: links, drop part, fixups, codeowners Drop part role, use generic adi instead for root adi domain links. For future reference, the snipped used was: find ./docs/projects -type f -exec sed -i 's/:part:/:adi:/g' {} \; Drop Containerfile. Add option to validate links status (e.g. 200, 404), intended mostly for CI use to check if a page has disappeared from the internet. Validate links uses coroutines to launch multiple tasks concurrently, but do it in bundles to avoid being rate limited. Fixup regmap styling. Add imoldovan, jmarques, spop, lbarbosa as docs codeowners. Remove branch field for links to the hdl repo. Change git role to display full path. Fixup ZedBoard link label, remove IP List, add SYSID_ROM dokuwiki link in ad716_sdz project. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-13 15:42:46 +00:00
* - :git-hdl:`library/spi_engine/interfaces/spi_engine_ctrl_rtl.xml`
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
- Interface definition file
Signal Pins
--------------------------------------------------------------------------------
.. list-table::
:widths: 10 10 10 70
:header-rows: 1
* - Width
- Name
docs: Intermediary for IP Cores import, user guide, regmap (#1321) Use interref (doctools cross-repository) to link the docs guidelines Add user guide pages, update IP references Add axi_adc/dac, up_if, "Use ADI IPs", "Creating new IP", Update AXI DMAC, JESD204, I3C Controller, SPI Engines Minor fixes in the frameworks and register maps, the latter following the discussed guidelines. Update AXI terms to manager and subordinate. Signed-off-by: Jorge Marques <jorge.marques@analog.com> Signed-off-by: Laez Barbosa <laez.barbosa@analog.com> Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>
2024-05-13 13:05:12 +00:00
- Direction (Manager)
docs: Include sphinx documentation The parameters directive allows to almost automatically generate the parameters table. It allows to add rich descriptions to the parameters, such as references, while checking if they exist in the *_hw.tcl file a obtaining the types and default values. However, it cannot obtain parameters generated from a foreach loop yet, making it incompatible with the axi_dmac_hw.tcl file for example. This commit also joins the other extensions into a single adi_links extension. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-08-16 12:57:14 +00:00
- Description
* -
- ``cmd_ready``
- Input
- Ready signal of the CMD stream
* -
- ``cmd_valid``
- Output
- Valid signal of the CMD stream
* - [15:0]
- ``cmd_data``
- Output
- Data signal of the CMD stream
* -
- ``sdo_ready``
- Input
- Ready signal of the SDO stream
* -
- ``sdo_valid``
- Output
- Valid signal of the SDO stream
* - [DATA_WIDTH-1:0]
- ``sdo_data``
- Output
- Data signal of the SDO stream
* -
- ``sdi_ready``
- Output
- Ready signal of the SDI stream
* -
- ``sdi_valid``
- Input
- Valid signal of the SDI stream
* - [(NUM_OF_SDI*DATA_WIDTH-1):0]
- ``sdi_data``
- Input
- Data signal of the SDI stream
* -
- ``sync_ready``
- Output
- Ready signal of the SYNC stream
* -
- ``sync_valid``
- Input
- Valid signal of the SYNC stream
* - [7:0]
- ``sync_data``
- Input
- Data signal of the sync stream