aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/adc.c
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-08-05 10:30:37 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-08-05 10:30:37 +0000
commit04e29829b64a64a405125595dc371bd731766c68 (patch)
treeffaadc6d10888b4cbe7b574a5ccee2a26712662f /os/hal/src/adc.c
parent31981145cf8b3d43848bfeb75d21ae5e0b2e0a81 (diff)
downloadChibiOS-04e29829b64a64a405125595dc371bd731766c68.tar.gz
ChibiOS-04e29829b64a64a405125595dc371bd731766c68.tar.bz2
ChibiOS-04e29829b64a64a405125595dc371bd731766c68.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2114 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/src/adc.c')
-rw-r--r--os/hal/src/adc.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c
index 2a329d003..5348d7e93 100644
--- a/os/hal/src/adc.c
+++ b/os/hal/src/adc.c
@@ -112,11 +112,10 @@ void adcStop(ADCDriver *adcp) {
* @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
- * parameter is set to @p NULL, in this mode the buffer is filled
- * once and then the conversion stops automatically.
- * - <b>CIRCULAR</b>, when a callback function is defined the
- * conversion never stops and the buffer is filled circularly.
+ * - <b>LINEAR</b>, in this mode the buffer is filled once and then
+ * the conversion stops automatically.
+ * - <b>CIRCULAR</b>, in this mode the conversion never stops and
+ * the buffer is filled circularly.<br>
* During the conversion the callback function is invoked when
* the buffer is 50% filled and when the buffer is 100% filled,
* this way is possible to process the conversion stream in real
@@ -133,7 +132,8 @@ void adcStop(ADCDriver *adcp) {
* @param[out] samples pointer to the samples buffer
* @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
+ * @param[in] callback pointer to the conversion callback function, this
+ * parameter can be @p NULL if a callback is not required
* @return The operation status.
* @retval FALSE the conversion has been started.
* @retval TRUE the driver is busy, conversion not started.