Skip to content

docs: ad4170_asdz: Fixed documentation #1715

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

Merged
merged 1 commit into from
May 21, 2025
Merged

docs: ad4170_asdz: Fixed documentation #1715

merged 1 commit into from
May 21, 2025

Conversation

ladace
Copy link
Contributor

@ladace ladace commented May 9, 2025

PR Description

Fixed documentation and removed not yet released parts

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)
  • Documentation

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

@ladace
Copy link
Contributor Author

ladace commented May 9, 2025

v1:

  • Fixed comments

@ladace ladace requested a review from StancaPop May 9, 2025 14:14
The HDL reference design for the :adi:`AD4170-4` and :adi:`AD4170-8` provides a
high resolution, 24-Bit, DC to 50 kHz Input Bandwidth, Multichannel, Low Noise
Precision Sigma-Delta ADC with PGA.
The HDL reference design for the :adi:`AD4170-4` provides a high resolution,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The HDL reference design for the :adi:`AD4170-4` provides a high resolution,
The HDL reference design for the :adi:`AD4170-4` provides a high resolution,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done :)

high resolution, 24-Bit, DC to 50 kHz Input Bandwidth, Multichannel, Low Noise
Precision Sigma-Delta ADC with PGA.
The HDL reference design for the :adi:`AD4170-4` provides a high resolution,
24-Bit, DC to 50 kHz Input Bandwidth, Multichannel, Low Noise Precision
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
24-Bit, DC to 50 kHz Input Bandwidth, Multichannel, Low Noise Precision
24-Bit, DC to 50 kHz Input Bandwidth, Multichannel, Low Noise Precision

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done :)

@ladace ladace force-pushed the doc_ad4170 branch 2 times, most recently from 5c4d73c to bafc024 Compare May 21, 2025 09:59
@ladace ladace requested a review from StancaPop May 21, 2025 10:01
@StancaPop
Copy link
Contributor

It looks like your branch has conflicts.

@ladace ladace force-pushed the doc_ad4170 branch 2 times, most recently from ed0ea5e to 04b2a63 Compare May 21, 2025 12:03
@ladace
Copy link
Contributor Author

ladace commented May 21, 2025

V1:

  • Fixed branch conflicts and resolved remarks

:adi:`AD4190-4` provides a high resolution, 24-Bit, Multichannel, Low Noise,
Precision Sigma-Delta ADC with PGA.
The HDL reference design for the :adi:`AD4170-4` :adi:`AD4190-4`provides
a high resolution, 24-Bit, DC to 50 kHz Input Bandwidth, Multichannel,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
a high resolution, 24-Bit, DC to 50 kHz Input Bandwidth, Multichannel,
a high resolution, 24-Bit, DC to 50 kHz Input Bandwidth, Multichannel,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@@ -66,7 +63,7 @@ The addresses are dependent on the architecture of the FPGA, having an offset
added to the base address from HDL (see more at :ref:`architecture cpu-intercon-addr`).

======================== =================
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
======================== =================
======================== ===============

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@@ -66,7 +63,7 @@ The addresses are dependent on the architecture of the FPGA, having an offset
added to the base address from HDL (see more at :ref:`architecture cpu-intercon-addr`).

======================== =================
Instance Zynq*/DE10-Nano**
Instance Zynq/DE10-Nano
======================== =================
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
======================== =================
======================== ===============

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Fixed documentation and removed not yet released ADC parts.

Signed-off-by: Liviu 'Ceshu' Adace <[email protected]>
@ladace
Copy link
Contributor Author

ladace commented May 21, 2025

V2:

  • Fixed latest remarks

@ladace ladace requested a review from StancaPop May 21, 2025 12:42
@ladace ladace merged commit fac72c9 into main May 21, 2025
2 checks passed
@ladace ladace deleted the doc_ad4170 branch May 21, 2025 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants