gitback/pico-sdk
1
0
Fork 0
mirror of https://github.com/raspberrypi/pico-sdk.git synced 2024-09-29 03:28:49 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

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

Browse Source 
See https://github.com/raspberrypi/pico-feedback/issues/357
This commit is contained in:
Andrew Scheller 2024-06-21 20:30:13 +01:00 committed by GitHub
parent 5be87f1e22
commit cea8211834
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/rp2_common/hardware_adc/include/hardware/adc.h
View File

@ -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
*
@ -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
@ -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
@ -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;