Skip to content
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

Fix FIFO size in Doxygen in hardware/adc.h #1720

Merged
merged 1 commit into from
Jun 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/rp2_common/hardware_adc/include/hardware/adc.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* - 5 input mux:
* - 4 inputs that are available on package pins shared with GPIO[29:26]
* - 1 input is dedicated to the internal temperature sensor
* - 4 element receive sample FIFO
* - 8 element receive sample FIFO
* - Interrupt generation
* - DMA interface
*
Expand All @@ -36,7 +36,7 @@
*
* T = 27 - (ADC_Voltage - 0.706)/0.001721
*
* The FIFO, if used, can contain up to 4 entries.
* The FIFO, if used, can contain up to 8 entries.
*
* \subsection adc_example Example
* \addtogroup hardware_adc
Expand Down Expand Up @@ -167,7 +167,7 @@ static inline void adc_set_clkdiv(float clkdiv) {
/*! \brief Setup the ADC FIFO
* \ingroup hardware_adc
*
* FIFO is 4 samples long, if a conversion is completed and the FIFO is full, the result is dropped.
* FIFO is 8 samples long, if a conversion is completed and the FIFO is full, the result is dropped.
*
* \param en Enables write each conversion result to the FIFO
* \param dreq_en Enable DMA requests when FIFO contains data
Expand Down Expand Up @@ -202,7 +202,7 @@ static inline bool adc_fifo_is_empty(void) {
/*! \brief Get number of entries in the ADC FIFO
* \ingroup hardware_adc
*
* The ADC FIFO is 4 entries long. This function will return how many samples are currently present.
* The ADC FIFO is 8 entries long. This function will return how many samples are currently present.
*/
static inline uint8_t adc_fifo_get_level(void) {
return (adc_hw->fcs & ADC_FCS_LEVEL_BITS) >> ADC_FCS_LEVEL_LSB;
Expand Down
Loading