Skip to content
Snippets Groups Projects
Unverified Commit cea82118 authored by Andrew Scheller's avatar Andrew Scheller Committed by GitHub
Browse files

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

parent 5be87f1e
No related branches found
No related tags found
No related merge requests found
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
* - 5 input mux: * - 5 input mux:
* - 4 inputs that are available on package pins shared with GPIO[29:26] * - 4 inputs that are available on package pins shared with GPIO[29:26]
* - 1 input is dedicated to the internal temperature sensor * - 1 input is dedicated to the internal temperature sensor
* - 4 element receive sample FIFO * - 8 element receive sample FIFO
* - Interrupt generation * - Interrupt generation
* - DMA interface * - DMA interface
* *
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
* *
* T = 27 - (ADC_Voltage - 0.706)/0.001721 * 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 * \subsection adc_example Example
* \addtogroup hardware_adc * \addtogroup hardware_adc
...@@ -167,7 +167,7 @@ static inline void adc_set_clkdiv(float clkdiv) { ...@@ -167,7 +167,7 @@ static inline void adc_set_clkdiv(float clkdiv) {
/*! \brief Setup the ADC FIFO /*! \brief Setup the ADC FIFO
* \ingroup hardware_adc * \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 en Enables write each conversion result to the FIFO
* \param dreq_en Enable DMA requests when FIFO contains data * \param dreq_en Enable DMA requests when FIFO contains data
...@@ -202,7 +202,7 @@ static inline bool adc_fifo_is_empty(void) { ...@@ -202,7 +202,7 @@ static inline bool adc_fifo_is_empty(void) {
/*! \brief Get number of entries in the ADC FIFO /*! \brief Get number of entries in the ADC FIFO
* \ingroup hardware_adc * \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) { static inline uint8_t adc_fifo_get_level(void) {
return (adc_hw->fcs & ADC_FCS_LEVEL_BITS) >> ADC_FCS_LEVEL_LSB; return (adc_hw->fcs & ADC_FCS_LEVEL_BITS) >> ADC_FCS_LEVEL_LSB;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment