Commit Graph

35 Commits (0e0e1e465508ce581497cb14804d5fff40d52916)

Author SHA1 Message Date
StancaPop 0e0e1e4655 docs/projects/ad7616_sdz: Update block diagrams 2023-11-09 14:43:20 +02:00
Stanca Pop a09ee9d481 docs/projects/ad7616_sdz: Add ad7616_sdz project documentation 2023-11-02 14:50:42 +02:00
LBFFilho becc035ba9
SPI Engine: Fixed delay behaviour on Chip-Select and Sleep instructions (#1200)
Fixed wrong behaviour on chip select instruction:
- previously, a sleep time happened before the chip select change
- the intended behaviour was for another sleep time, of equal amount, to happen after the chip select change as well
- additionally, the counter logic implementation was creating an additional factor of 2 on the sleep time

All of the above points were fixed. The changes introduced also fix another issue where the sleep instruction was likewise happening with a duration larger than intended by a factor of 2


Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2023-10-30 09:52:04 -03:00
Iulia Moldovan f548c422b8 docs/projects/ad9783 & images: Add ad9783_ebz project doc
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan c301f4f44e docs/projects/ad9081 & images: Add ad9081_fmca_ebz project doc
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan 8eda123037 docs/projects/template & common: Create project doc template
* Created the template for the HDL project documentation
* Added the More information and Support pages as two separate files
  which will be embedded in the project documentations

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan 3cee92683a docs/user_guide: Add user guide documentation
* Created the first level of pages for the User guide, from Analog Wiki:
   * Architecture
   * Build HDL
   * Customize HDL
   * Docs guidelines (edited)
   * Git repository
   * HDL coding guideline (edited)
   * Introduction
   * IP cores
   * Porting projects (edited)
   * Releases
   * Third party
 * Moved hdl_coding_guideline under user_guide and changed extension to rst
 * Deleted hdl_pr_process.md
 * docs_guideline: Add reference to project doc template
 * porting_project:

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan bf031dff45 docs/library/axi_dmac: Add identifier for page
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Iulia Moldovan e50227e02f docs: Add color roles. Fix :part: link. Remove extension
* Remove sphinxcontrib.mermaid extension
 * Added red and green role
 * Fixed the :part: role link because analog.com doesn't know to
   redirect to proper part webpage if it's under /products

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-10-26 09:13:36 +03:00
Jorge Marques 4d676ca25a
docs: Update README, misspelings, and improvements
Update docs instructions in the README.md to recommend building the libraries before generating the documentation.
Fix misspellings in the SPI Engines.
Use hashlib to gen the reproducible ids, so these elements won't be committed at every build in the gh-pages branch.
Get username from environment variable, to use in the symbolator local installation path, dismissing user interaction for this.
Use modelParameter to extract the type from ip-xact parameters without the format field, and improve formatting.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-10-06 09:23:50 -03:00
PopPaul2021 86836f5a40 library/common: Added DAC custom read/write interface in up_dac_common.
The DAC common regmap was updated with 3 registers(rd/wr/ctrl) and 1 interface status flag for converters with custom control interface.
2023-10-02 11:07:08 +03:00
Cristian Mihai Popa 0baf3a7c4f docs/regmap/adi_regmap_dac.txt : Updated and added some registers
-Updated description of some fields of these registers: REG_CHAN_CNTRL_1,
REG_CHAN_CNTRL_2, REG_CHAN_CNTRL_3, REG_CHAN_CNTRL_4, REG_USR_CNTRL_4,
and REG_USR_CNTRL_5
-Added two new registers, both with their own fields and description:
REG_CHAN_CNTRL_9 and REG_CHAN_CNTRL_10

Signed-off-by: Cristian Mihai Popa <cristianmihai.popa@analog.com>
2023-09-29 10:12:43 +03:00
Jorge Marques 303b3a0eeb docs: add check for signals/bus
Signals/buses declared in the docs that does not exist in the
components.xml files will raise a warning.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques 55d4215f45 README.md: header, docs info; docs: license, fixes
Add documentation info to the README.md
At adi_hdl_parser.py, filter "_signal_clock" and "_signal_reset"
pseudo buses from component.xml files, append them as description
in the ports table, in the format
"{Bus} [...] is synchronous to this {domain}".
Also, adds collapsible directive

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques 58df312e8b docs: move guidelines, porting project main, repos git roles
Moves guidelines to user_guide as docs_guidelines.
Includes Porting HDL project user guide.
Replaces the Excel spreadsheet with raw space divided files.
Includes the 6 pinned at the org.
Contributors shall expand the list as needed.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques 468d02ea50 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-27 14:36:34 -03:00
Jorge Marques 0597373d62 docs: review fixes
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques cf056cf81c docs: add regmap directive
Automate table generation for register maps.
Based on tfcollins' vger python scripts.
There are docs/adi_regmap_*.txt with more than one regmap per file,
so the logic changed to allow that.
Using title tool as the unique identifier now.
It has a global option to set the default state (hidden or visible)
for the collpasible tables.
Also remove CSVs.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques 83d2bf9603 docs: automate parameters and interfaces tables
Uses Vivado generated components.xml files.
If the file is not found/generated, there is a fallback method.
Also, define bibliography per project, not globally.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-09-27 14:36:34 -03:00
Jorge Marques ef9c98f9b9 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-09-27 14:36:34 -03:00
Iulia Moldovan 2f35ce8a51 check_guideline.py: Change copyright format checker
* Added copyright and license header
 * Updated files on which it runs on
 * SystemVerilog not to be supported, since now there are some pkg files
 that do not have the format of a Verilog file, thus making the
 checker to fail all the time -- which is not good
 * Now it can run on files which contain JESD in their paths, because
   now all of them have the copyright on the same line (but the
 copyright inside the JESD license can't be checked yet by the script)

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-07-11 15:12:28 +03:00
Iulia Moldovan c5cbbfe022 docs: Add HDL PR process documentation
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2023-05-30 13:13:15 +03:00
Jem Geronimo d152ad1e9d
add: softspan support in adc_channel regmap (#1081)
docs/regmap/adi_regmap_adc.txt: 
- add softspan to regmap
library/common/up_adc_channel.v
- update copyright year header
- add softspan to regmap
library/common/up_adc_common.v
- update minor version

Signed-off-by: John Erasmus Mari Geronimo <Johnerasmusmari.Geronimo@analog.com>
2023-04-20 19:05:38 +08:00
AndrDragomir e0ab169fed docs/FMC_eval_board_template: Update instructions 2023-04-11 11:53:48 +03:00
PopPaul2021 41f4f1a988 docs/regmap: Updates on regmap text files to match the Wiki page updates. 2023-03-14 10:08:03 +02:00
Ionut Podgoreanu b3f3f7c392 docs/regmap: Added the regmap file for the generic TDD controller 2022-12-13 16:26:02 +02:00
Travis F. Collins a07cec4a84 Remove extra FIELD marker in regmap
Fix minor typo in adc regmap which is breaking an external parser.

Signed-off-by: Travis F. Collins <travis.collins@analog.com>
2022-10-19 21:34:37 +03:00
alin724 0620f8425d regmap/adi_regmap_common.txt: Add missing RD_RAW_DATA field 2022-10-19 09:41:38 +03:00
Filip Gherman 56789abf2b docs/regmap: Added the new ADDRESS_HIGH registers to the DMAC regmap
Signed-off-by: Filip Gherman <Filip.Gherman@analog.com>
2022-10-18 16:59:18 +03:00
alin724 28ace647d1 up_adc_common: Update IPs and adi_regmap_adc definition file to latest up_adc_common module 2022-10-05 14:56:36 +03:00
alin724 775a23ebf2 up_adc_channel: Update IPs and adi_regmap_adc definition file to latest up_adc_channel module 2022-10-05 14:27:51 +03:00
PopPaul2021 542c361e0a
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 15:12:35 +03:00
AndrDragomir b02f437110 docs: Add common template for evaluation board specific fmc files
Instructions to use the template are found on the first page of the template

Signed-off-by: AndrDragomir <andrei.dragomir@analog.com>
2022-09-20 14:11:08 +03:00
Iulia Moldovan 86408ff2b3 docs: Add HDL coding guideline
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2022-05-12 14:43:35 +03:00
Robin Getz 779a5dba22 HDL Logo: Add
Add a small logo for branding and documetation purposes.

Signed-off-by: Robin Getz <robin.getz@analog.com>
2021-09-16 16:49:52 +03:00