diff options
Diffstat (limited to 'os/hal/src/adc.c')
| -rw-r--r-- | os/hal/src/adc.c | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c index 16bdeac43..dff7d828b 100644 --- a/os/hal/src/adc.c +++ b/os/hal/src/adc.c @@ -18,8 +18,9 @@ */
/**
- * @file adc.c
- * @brief ADC Driver code.
+ * @file adc.c
+ * @brief ADC Driver code.
+ *
* @addtogroup ADC
* @{
*/
@@ -46,7 +47,7 @@ /*===========================================================================*/
/**
- * @brief ADC Driver initialization.
+ * @brief ADC Driver initialization.
*/
void adcInit(void) {
@@ -54,7 +55,7 @@ void adcInit(void) { }
/**
- * @brief Initializes the standard part of a @p ADCDriver structure.
+ * @brief Initializes the standard part of a @p ADCDriver structure.
*
* @param[in] adcp pointer to the @p ADCDriver object
*/
@@ -70,7 +71,7 @@ void adcObjectInit(ADCDriver *adcp) { }
/**
- * @brief Configures and activates the ADC peripheral.
+ * @brief Configures and activates the ADC peripheral.
*
* @param[in] adcp pointer to the @p ADCDriver object
* @param[in] config pointer to the @p ADCConfig object
@@ -90,7 +91,7 @@ void adcStart(ADCDriver *adcp, const ADCConfig *config) { }
/**
- * @brief Deactivates the ADC peripheral.
+ * @brief Deactivates the ADC peripheral.
*
* @param[in] adcp pointer to the @p ADCDriver object
*/
@@ -108,7 +109,7 @@ void adcStop(ADCDriver *adcp) { }
/**
- * @brief Starts an ADC conversion.
+ * @brief Starts an ADC conversion.
* @details Starts a conversion operation, there are two kind of conversion
* modes:
* - <b>LINEAR</b>, this mode is activated when the @p callback
@@ -122,6 +123,10 @@ void adcStop(ADCDriver *adcp) { * time. This kind of conversion can only be stopped by explicitly
* invoking @p adcStopConversion().
* .
+ * @note The buffer is organized as a matrix of M*N elements where M is the
+ * channels number configured into the conversion group and N is the
+ * buffer depth. The samples are sequentially written into the buffer
+ * with no gaps. * * @param[in] adcp pointer to the @p ADCDriver object * @param[in] grpp pointer to a @p ADCConversionGroup object @@ -129,14 +134,9 @@ void adcStop(ADCDriver *adcp) { * @param[in] depth buffer depth (matrix rows number). The buffer depth
* must be one or an even number.
* @param[in] callback pointer to the conversion callback function
- * @return The operation status.
+ * @return The operation status.
* @retval FALSE the conversion has been started.
* @retval TRUE the driver is busy, conversion not started.
- *
- * @note The buffer is organized as a matrix of M*N elements where M is the
- * channels number configured into the conversion group and N is the
- * buffer depth. The samples are sequentially written into the buffer
- * with no gaps. */
bool_t adcStartConversion(ADCDriver *adcp,
const ADCConversionGroup *grpp,
@@ -169,9 +169,9 @@ bool_t adcStartConversion(ADCDriver *adcp, }
/**
- * @brief Stops an ongoing conversion.
+ * @brief Stops an ongoing conversion.
* - * @param[in] adcp pointer to the @p ADCDriver object + * @param[in] adcp pointer to the @p ADCDriver object */
void adcStopConversion(ADCDriver *adcp) {
@@ -196,7 +196,7 @@ void adcStopConversion(ADCDriver *adcp) { }
/**
- * @brief Waits for completion.
+ * @brief Waits for completion.
* @details If the conversion is not completed or not yet started then the
* invoking thread waits for a conversion completion event.
* @@ -206,9 +206,9 @@ void adcStopConversion(ADCDriver *adcp) { * - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
- * @return The operation result.
- * @retval RDY_OK conversion finished.
- * @retval RDY_TIMEOUT conversion not finished within the specified time. + * @return The operation result.
+ * @retval RDY_OK conversion finished.
+ * @retval RDY_TIMEOUT conversion not finished within the specified time. */
msg_t adcWaitConversion(ADCDriver *adcp, systime_t timeout) {
|