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

100 lines
4.5 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:
SPI Engine
================================================================================
.. toctree::
:hidden:
Execution Module<spi_engine_execution>
AXI Module<axi_spi_engine>
Offload Module<spi_engine_offload>
Interconnect Module<spi_engine_interconnect>
Control Interface<control-interface>
Offload Control Interface<offload-control-interface>
SPI Bus Interface<spi-bus-interface>
Instruction Set Specification<instruction-format>
SPI Engine: Add execution delay documentation (#1230) * SPI Engine: Add execution delay documentation Add documentation for the different delays on the command path and data path, including communication between submodules and instruction execution overhead. Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2023-11-28 21:08:51 +00:00
Pipeline Delays<pipeline-delays>
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
Tutorial - PulSAR ADC<tutorial>
SPI Engine: Add execution delay documentation (#1230) * SPI Engine: Add execution delay documentation Add documentation for the different delays on the command path and data path, including communication between submodules and instruction execution overhead. Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2023-11-28 21:08:51 +00:00
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 is a highly flexible and powerful SPI controller framework.
It consist out of multiple sub-modules which communicate over well defined
interfaces.
This allows a high degree of flexibility and re-usability while at the same time
staying highly customizable and easily extensible.
The core component of the SPI Engine framework is a lean but powerful fully
programmable execution module, which implements the SPI bus control logic.
The SPI Engine execution module is controlled by a command stream which is
generated by a separate module. Different command stream master modules are
available and can be used depending on the system requirements.
For example a software controlled memory mapped command stream offers high
flexibility, while a offload core which executes a pre-programmed command stream
when triggered by an external event allows for very low latency response times.
By using a SPI Engine interconnect it is possible to connect multiple command
stream master modules to a SPI Engine execution module.
Sub-modules
--------------------------------------------------------------------------------
* :ref:`spi_engine execution`: Main module which processes a SPI engine command
stream and implements the SPI bus interface logic.
* :ref:`spi_engine axi`: Memory mapped software accessible interface to a
SPI Engine command stream and/or offload cores.
* :ref:`spi_engine offload`: Stores a SPI Engine command stream, execution is
triggered by an external event.
* :ref:`spi_engine interconnect`: Connects multiple SPI Engine command streams
to a SPI Engine execution module.
Interfaces
--------------------------------------------------------------------------------
* :ref:`spi_engine control-interface`: SPI Engine command stream.
* :ref:`spi_engine offload-control-interface`: Program the command stream stored
in a offload module.
* :ref:`spi_engine spi-bus-interface`: Low-level SPI bus interface.
Software
--------------------------------------------------------------------------------
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`Linux Driver <resources/tools-software/linux-drivers/spi/spi_engine>`:
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
Linux driver for the SPI Engine framework.
* :ref:`spi_engine instruction-format`: Overview of the SPI Engine Instruction
format.
Related IP Cores
--------------------------------------------------------------------------------
This list contains cores that are not part of the core SPI engine framework but
SPI Engine: Add execution delay documentation (#1230) * SPI Engine: Add execution delay documentation Add documentation for the different delays on the command path and data path, including communication between submodules and instruction execution overhead. Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2023-11-28 21:08:51 +00:00
make use of its interfaces and are intended to be used together with the SPI engine
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
framework.
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`util-sigma-delta-spi <resources/fpga/peripherals/util_sigma_delta_spi>`:
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
Helper module for interfacing ADCs from the Analog Devices Sigma-Delta family.
Examples
--------------------------------------------------------------------------------
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`CN0363 <resources/eval/user-guides/eval-cn0363-pmdz>`:
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
Colorimeter application using the :adi:`AD7175-2` Sigma-Delta ADC.
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
* :dokuwiki:`resources/eval/user-guides/adaq7980-sdz`:
A 16-bit ADC subsystem with four common signal processing and conditioning blocks.
* :dokuwiki:`resources/tools-software/uc-drivers/ad5766`:
16-channel, 16-/12-bit, voltage output Digital-to-Analog Converters (DAC).
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`CN0363 <resources/eval/user-guides/eval-cn0363-pmdz>`:
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 AD7768-1 is a low power, high performance, Σ-Δ analog-to-digital converter (ADC).
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:`projects/ad40xx_fmc`
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
Evaluation Board for the AD4000 Series 16-/18-/20-Bit Precision SAR ADCs.
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`AD469x <resources/eval/user-guides/ad469x>`:
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
16-Bit, 16-Channel, 500 kSPS/1 MSPS, Easy Drive Multiplexed SAR ADC.
docs: update link roles, .gitignore Update link roles to use the "text <link>" standard sphinx syntax. Add __pycache__ and _build to .gitignore Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-06 18:00:15 +00:00
* :dokuwiki:`AD4630-24 / AD4030-24 / AD4630-16 <resources/eval/user-guides/ad463x/hdl>`:
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
16/24-Bit, 2 MSPS Single or Dual Channel SAR ADC.
Additional Resources
--------------------------------------------------------------------------------
* :download:`Presentation: SPI Engine Design Philosophy <https://wiki.analog.com/_media/resources/fpga/peripherals/spi-engine3.pdf>`.
SPI Engine: Add execution delay documentation (#1230) * SPI Engine: Add execution delay documentation Add documentation for the different delays on the command path and data path, including communication between submodules and instruction execution overhead. Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2023-11-28 21:08:51 +00:00
* :ref:`spi_engine pipeline-delays`
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
* :ref:`spi_engine tutorial`.