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

52 lines
1.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
:orphan:
.. _template_framework:
Framework Template
================================================================================
.. toctree::
:hidden:
Template Module<template_module>
Template Interface<interface>
Instruction Set Template<instruction-set>
{brief introdution}.
Sub-modules
--------------------------------------------------------------------------------
* :ref:`template_framework module`: {brief description}.
Interfaces
--------------------------------------------------------------------------------
* :ref:`template_framework interface`: {brief description}.
Software
--------------------------------------------------------------------------------
* :ref:`template_framework instruction-set`: {brief description}.
Related IP Cores
--------------------------------------------------------------------------------
This list contains cores that are not part of the core {ip name} but
make use of its interfaces and are intend to be used together with the {ip name}.
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
Additional Resources
--------------------------------------------------------------------------------
* :download:`Presentation: SPI Engine Design Philosophy <https://wiki.analog.com/_media/resources/fpga/peripherals/spi-engine3.pdf>`.
* :ref:`spi_engine tutorial`.