diff --git a/.github/styles/config/vocabularies/Base/accept.txt b/.github/styles/config/vocabularies/Base/accept.txt index b9279dab..d932961a 100644 --- a/.github/styles/config/vocabularies/Base/accept.txt +++ b/.github/styles/config/vocabularies/Base/accept.txt @@ -39,6 +39,7 @@ Pmod(s)? [Dd]efconfig [Ss]etpoint [Pp]assthrough +[Bb]aremetal Tx Rx @@ -83,5 +84,6 @@ kbps is rated is kept are highlighted +are prefixed be adjusted in order to diff --git a/docs/index.rst b/docs/index.rst index a48c7edf..2655da7c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,15 +7,22 @@ System Level Documentation `wiki `_ has been imported yet. -This docs provides developers using Analog Devices products with software and -documentation, including HDL interface code, software drivers, and reference -project examples for FPGA connectivity. +The System Level documentation provides developers using Analog Devices +products with software and documentation, including HDL interface code, +software drivers, and reference project examples for FPGA connectivity. It also contains user guides for some Analog Devices evaluation boards to help developers get up and running fast. Contents ------------------------------------------------------------------------------- +.. toctree:: + :caption: Product Categories + :maxdepth: 2 + :glob: + + products/*/index + .. toctree:: :caption: Kuiper & Linux Kernel :maxdepth: 2 @@ -31,7 +38,7 @@ Contents software/*/index .. toctree:: - :caption: Products & Tools + :caption: Devices :maxdepth: 2 :glob: diff --git a/docs/products/adsp/index.rst b/docs/products/adsp/index.rst new file mode 100644 index 00000000..ebeff5b9 --- /dev/null +++ b/docs/products/adsp/index.rst @@ -0,0 +1,38 @@ +.. _adsp: + +Digital Signal Processors (ADSP) +================================ + +ADI has a large portfolio of :adi:`Digital Signal Processors ` +(see :adi:`Selection Table for Digital Signal Processors `). +A subset of those processors include ARM Cortex cores and are prefixed with SC +for "SHARC Connect". They can run baremetal applications, an RTOS or Linux. +Cortex-M33 models are appropriate for a baremetal application or an RTOS, while +Cortex-A5 and Cortex-A55 can also run 32-bit or 64-bit Linux respectively. + +Cortex-M33 +---------- + +- :adi:`ADSP-SC834 ` +- :adi:`ADSP-SC835 ` + +Cortex-A5 +--------- + +- :adi:`ADSP-SC570 ` +- :adi:`ADSP-SC571 ` +- :adi:`ADSP-SC572 ` +- :adi:`ADSP-SC573 ` +- :adi:`ADSP-SC582 ` +- :adi:`ADSP-SC583 ` +- :adi:`ADSP-SC584 ` +- :adi:`ADSP-SC587 ` +- :adi:`ADSP-SC589 ` +- :adi:`ADSP-SC592 ` +- :adi:`ADSP-SC594 ` + +Cortex-A55 +---------- + +- :adi:`ADSP-SC596 ` +- :adi:`ADSP-SC598 `