Commit Graph

84 Commits (38037641af3a52bb2e61cadaf95fc9f2cf9c96ef)

Author SHA1 Message Date
Jorge Marques 38037641af
i3c_controller: Naming convention, corner case fix (#1314)
Rename "idle bus" to "bus available" per specification:
* Tune it to require < 1us.

Rename "IBI auto" to "IBI listen":
* Clarify that the controller is listening for IBI's:
* Explain that this field should be set.
* Fix for known IBI's DA with IBI disabled.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-04-30 12:14:47 -03:00
Ionut Podgoreanu ee54456079 docs: axi_dmac: Update documentation
Signed-off-by: Ionut Podgoreanu <ionut.podgoreanu@analog.com>
2024-04-30 17:41:57 +03:00
AndreiGrozav 7e84c2575c axi_pwm_gen: Fix 100% duty cycle width
Signed-off-by: AndreiGrozav <andrei.grozav@analog.com>
2024-04-30 15:28:14 +03:00
bluncan ddc3524b41 docs: user_guide: architecture: Added vpk180
Signed-off-by: bluncan <bogdan.luncan@analog.com>
2024-04-26 15:01:50 +03:00
PIoandan a87dc3ac7e
docs: Add ad7606x documentation
docs/projects/ad7606x_fmcz: Add ad7606_fmcz project documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-04-26 13:18:36 +03:00
AndreiGrozav e79091eecd axi_pwm_gen: Add/update github documentation
Signed-off-by: AndreiGrozav <andrei.grozav@analog.com>
Signed-off-by: Iulia Moldovan <iulia.moldovan@analog.com>
2024-04-19 15:23:55 +03:00
AndreiGrozav 344ca6fc3d axi_pwm_gen: New features and fixes
New features:

1. External sync force the phase align. The external sync was used to align
   the phases of enabled pwms, but only after being armed by a
   load_config signal toggle.
   This feature lets the user decide between using load_config to
   arm and wait for a neg-edge of sync or automatic phase align trigger
   on the ext_sync neg-edge.
2. Force align. Lets the user chose between immediately stopping the
   active pulses and realigning them, or waiting for all running pulse
   periods end, before realigning.
3. Start at sync. When this feature is activated, the pulses will start immediately
   after the trigger event. Otherwise, each pulse will start after a period
   equal to the one for which it is set.
4. Use parameters to set the default status after reset of the
   - soft reset
   - start at sync
   - force align
   - ext sync align

Update regmap.

Fixes:

1. The polarity on disabled channels was staying high instead of low.
2. Fix 0 and 100 proc duty cycle configuration.

Signed-off-by: AndreiGrozav <andrei.grozav@analog.com>
Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com>
2024-04-19 15:23:55 +03:00
PIoandan bffd8d1c09
Add pulsar_lvds project documentation
* docs: Add pulsar_lvds project documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-04-16 11:40:31 +03:00
Jorge Marques 15ff99a9bd docs: i3c_controller: Add documentation
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-04-12 09:19:18 -03:00
ladace 393a1f6fd6
ADD adaq42xx (#1209)
* ad4630_fmc: Initial version of ADAQ4224 w/ and w/o fully isolated power supply

Signed-off-by: Liviu Adace <liviu.adace@analog.com>

* docs:ad4630_fmc: Add documentation for ADAQ4224

Signed-off-by: Liviu Adace <liviu.adace@analog.com>

---------

Signed-off-by: Liviu Adace <liviu.adace@analog.com>
2024-04-02 14:50:25 +03:00
Stanca Pop a990883237 Change axi_spi_engine to uppercase 2024-03-27 16:58:20 +02:00
Stanca Pop 4d587b2c0e regmap: Update SPI Engine regmap 2024-03-27 16:58:20 +02:00
caosjr 075378fb92
docs: Add JESD204 documentation (#1280)
docs: Add JESD204 documentation in sphinx

Fixes several semantic issues from the original doc in wiki
Implicit path to library when the doc is hierarchically coherent with the
library.

Signed-off-by: Carlos Souza <carlos.souza@analog.com>
Co-authored-by: Jorge Marques <jorge.marques@analog.com>
2024-03-27 09:33:20 -03:00
PIoandan 9ba4c66c63
docs: Add ad7768 documentation (#1283)
docs: Add ad7768 documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-03-26 09:26:45 +02:00
Stanca Pop 9de7990027 Add axi_ad7616 regmap 2024-03-20 10:16:14 +02:00
Sergiu Arpadi a9e0836a77 doc: Update hdl coding guidelines
Since parameters/local parameters can be involved in the declaration of
registers/wires, it is best practice to declare them first.
2024-03-11 09:22:56 +02:00
LBFFilho 2052817dcb
SPI Engine: Add registers for Offload memory and FIFO sizes (#1279)
* SPI Engine: Add registers for Offload memory and FIFO sizes

Adds registers at dword 0x04 and 0x05, respectively allowing software
to get the sizes of the Offload Module memories (command and sdo) or
the sizes of the FIFOs on the AXI regmap.

Signed-off-by: Laez Barbosa <laez.barbosa@analog.com>
2024-03-08 08:40:48 -03:00
Jorge Marques e2ca5a991a
spi_engine: Create interface_ip.tcl (#1251)
Use tcl script instead of static xmls for the interface.
Easier to maintain and are not gitignored.
Rename spi_master to spi_engine because every interface should be
prefixed by the IP name; in this case, spi_engine.
Also, remove interface/*.sv files on make clean and git ignore them.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-02-28 10:31:46 -03:00
Jorge Marques be0e2809e9
docs: Use doctools (#1258)
The extensions have been moved to docs tools.
The source code is available at
https://github.com/analogdevicesinc/doctools
And is installed as before:
(cd docs ; pip install -r requirements.txt --upgrade)
Since the package is listed on the requirements.txt file.

Also, add index for library and projects

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-02-22 11:32:04 -03:00
PIoandan af64c55613
docs: Add pulsar_adc project documentation (#1275)
Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-02-21 15:54:50 +02:00
PIoandan a7442d3c78
docs: Add cn0363_pmdz project documentation (#1278)
* docs: Add cn0363_pmdz project documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-02-21 15:51:15 +02:00
PIoandan 3bf7cbbe45
docs: Add ad463x_fmc project documentation (#1277)
Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-02-20 14:41:08 +02:00
Iulia Moldovan b786ceac10 docs/ad9434_fmc: Fix links
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2024-02-02 15:47:59 +02:00
Alin-Tudor Sferle 73c4cfe88e docs/regmap: Update pwm_gen regmap
Update the pwm_gen regmap's registers related to period/width/offset

Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com>
2024-02-02 15:46:55 +02:00
PIoandan a31eb76366
docs: Add cn0540 documentation (#1248)
docs: Add cn0540 documentation.

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2024-01-31 16:59:51 +02:00
Jorge Marques c3f6f8685b
docs: Fixups on ad7134_fmc and cn0561 (#1261)
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-01-29 13:35:57 +00:00
laurent-19 265a3287a3
docs: Add ad4134_fmc doc (#1247)
* docs: Add ad4134_fmc doc. Update by guidelines

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
---------

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 14:41:13 +02:00
laurent-19 cba731f19c
docs: Add ad7134_fmc doc (#1246)
* docs: Add ad7134_fmc doc. Update by guidelines

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
---------

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 14:40:23 +02:00
laurent-19 0c3b8a1069
docs: Add cn0561 doc (#1245)
* docs: Add cn0561 doc. Update by guidelines

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>

---------

Signed-off-by: laurent-19 <laurentiu.popa@analog.com>
2024-01-29 14:38:53 +02:00
Jorge Marques e1dd6e5d56
docs: Update user guide, remove legacy code (#1242)
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2024-01-29 12:36:25 +00:00
Iulia Moldovan b45e7a7313 Replace other master branch references to main
* README.md
* adi_regmap_xcvr.txt
* build_hdl.rst
* hdl_coding_guideline.rst
* data_offload/README.md

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
2024-01-16 16:48:45 +02:00
PIoandan d4f33da416
docs: Add ad738x documentation (#1240)
docs/projects/ad738x_fmc: Add ad738x_fmc project documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2023-12-21 11:58:16 +02:00
caosjr bad1d03678
spi_engine: Fixup param ranges and CPHA info (#1239)
Set validation ranges for DATA_WIDTH and NUM_OF_CS for the expected
min/max values in the verilog source code.
Also, fix swapped description for CPHA in the documentation.

Signed-off-by: Carlos Oliveira <caosjr8@gmail.com>
2023-12-18 10:52:26 -03:00
Jorge Marques 940c3ccd35 docs: Add component diagram generator
Replaces Symbolator with custom component diagram generator for more
reliable diagrams.
It uses the IP-XACT file, if it is not found, a placeholder is added
instead.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-12-13 10:38:29 -03:00
Jorge Marques 9f4d5ff71f docs: General improvements
Import aiohttp and asyncio only when needed.
Better warning for unknown signals, params.
Use pattern matching in regmap parsing.
Fixup bundle count.
Add lists clarification to guidelines.
Enforce #1229 rules.
Clean-up Makefile.
Use non-breaking hyphen.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-12-13 10:38:29 -03:00
PIoandan 06201d5ee1
docs: Add ad5766 documentation (#1227)
docs: Add ad5766_sdz documentation

Signed-off-by: Ioan-daniel Pop <Pop.Ioan-daniel@analog.com>
2023-12-12 12:12:47 +02:00
cristianmihaipopa c1e0698719
AD9434: Zed porting and documentation (#1210) 2023-12-07 15:18:59 +02:00
Ionut Podgoreanu b3c58abcdc docs: Include the DMA SG documentation
Signed-off-by: Ionut Podgoreanu <ionut.podgoreanu@analog.com>
2023-12-04 14:34:33 +02:00
LBFFilho 0f87d845d3
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 18:08:51 -03:00
cristianmihaipopa 6a6e1f97f9
AD719x: Documentation (#1211)
docs/projects/ad719x_asdz: Add documentation for AD719x
2023-11-27 13:27:55 +02:00
StancaPop 9dfd00018a
docs: Improve consistency (#1229)
* docs: Improve consistency

The following rules have been implemented:
1. Tables/lists should contain only the carriers that we support for
   that reference design.
2. Hexadecimal addresses should be written in caps and separated
   by an underscore (eg. 0x9C4A_0000).
3. Block diagrams should contain subtitles only if there are at
   least two different diagrams.
4. The GPIOs should be listed in descending order and should have
   the number of bits specified next to their name.
5. All the source code links references should contain the project
   name.
6. The infrastructure documentation, if exists, should be listed
   after the IP list.
2023-11-27 12:53:21 +02:00
Stanca Pop 679d8e71ab docs: Add ad469x_fmc doc 2023-11-20 16:57:35 +02:00
Stanca Pop e626d80b99 docs/common: Remove default branch 2023-11-20 15:11:09 +02:00
Stanca Pop de2dbc5a56 docs: Fix tables consistency 2023-11-20 15:11:09 +02:00
StancaPop c0ffdefe9d docs: Add adaq7980 documentation 2023-11-16 16:45:51 +02:00
Jorge Marques ed0f496d56
docs: flatten images paths, toctree and images guidelines (#1222)
Recommend storing images like any other artifact: in a hierarchical
manner, without "images" subfolders.
This is intended to avoid dangling artifacts when projects are moved,
renamed, or deleted.
Recommend overwriting the page title with a shorter title in the
toctree, so the navigation bar doesn't overflow or get too cluttered.
Add acostina to CODEOWNERS

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-15 12:13:26 -03:00
Ramon Cristopher Calam 12495eb282
docs: Edits on Build an HDL Project section of the user guide documentation (#1204)
* user_guide/build_hdl: Text rephrasing and proof reading.

---------

Signed-off-by: Ramon Cristopher Calam <ramoncristopher.calam@analog.com>
2023-11-15 09:01:36 +08:00
StancaPop 75c6560567 docs/ad7616: Remove duplicated info 2023-11-14 09:56:54 +02:00
Jorge Marques c66cc5e79a
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
StancaPop 0e0e1e4655 docs/projects/ad7616_sdz: Update block diagrams 2023-11-09 14:43:20 +02:00