Skip to content

drivers: rf-transceiver: navassa: Added README documentation for ADRV9001/2 driver. #2604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jvelasc2
Copy link
Contributor

@jvelasc2 jvelasc2 commented May 16, 2025

Added the readme file for the ADRV9001 device driver. Also modified the sphinx drivers_doc.rst file to add the corresponding source for this new readme.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the Coding style guidelines
  • I have complied with the Submission Checklist
  • I have performed a self-review of the changes
  • I have commented my code, at least hard-to-understand parts
  • I have build all projects affected by the changes in this PR
  • I have tested in hardware affected projects, at the relevant boards
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe etc), if applies


#define IIO_DEV_COUNT 2 // Define the number of IIO devices

/* Define ADC and DAC buffers */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the code the one from the sample project? As far as I know, the DMA buffers need to be aligned.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hello @danmois ,
Yes, the code came from the example project. I'll modify this sample to include the dma buffers.

Copy link
Contributor

@danmois danmois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commit message seems to be too long. Limiting to 52 characters would be recommended.

@jvelasc2 jvelasc2 force-pushed the navassa-driver-readme branch from a7912e2 to 6a64fb0 Compare May 20, 2025 07:40
@gastmaier
Copy link
Contributor

gastmaier commented May 23, 2025

@danmois under Linux territory, dt-bindings documentation pages examples are verified.
Creating a

.. no-os-example::

that extracts and tries to compile is doable, to replace the current

.. code-block:: C

Is this a sort of feature that is interesting to implement? or manually checking is enough?

here is the source code for no-os-doxygen, implemented previously to bridge the doxygen pages.

Supported Devices
-----------------

- :adi:`ADRV9002`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link not working?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @danmois ,
I've updated the product link. Thanks!

@jvelasc2 jvelasc2 force-pushed the navassa-driver-readme branch 2 times, most recently from f73587e to 5af04f3 Compare May 27, 2025 01:25
Added the readme file for the ADRV9001 driver.

Modified the sphinx drivers_doc.rst file to add the corresponding
source.

Signed-off-by: Joyce Velasco <[email protected]>
@jvelasc2 jvelasc2 force-pushed the navassa-driver-readme branch from 5af04f3 to fd3f930 Compare July 8, 2025 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants