aboutsummaryrefslogtreecommitdiffstats
path: root/src/gadc/sys_defs.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2014-03-24 10:08:15 +1000
committerinmarket <andrewh@inmarket.com.au>2014-03-24 10:08:15 +1000
commitc354639f7b8ab1c33866b3d57a243de95a75decc (patch)
tree74db3a736e6839de1ef49b1df719c5d92e0189b7 /src/gadc/sys_defs.h
parentc7566aa5531b35a84f06940966f31acadfc85ade (diff)
downloaduGFX-c354639f7b8ab1c33866b3d57a243de95a75decc.tar.gz
uGFX-c354639f7b8ab1c33866b3d57a243de95a75decc.tar.bz2
uGFX-c354639f7b8ab1c33866b3d57a243de95a75decc.zip
Update GADC
Diffstat (limited to 'src/gadc/sys_defs.h')
-rw-r--r--src/gadc/sys_defs.h10
1 files changed, 2 insertions, 8 deletions
diff --git a/src/gadc/sys_defs.h b/src/gadc/sys_defs.h
index 21e81fb6..035fa9ad 100644
--- a/src/gadc/sys_defs.h
+++ b/src/gadc/sys_defs.h
@@ -209,12 +209,9 @@ void gadcHighSpeedStop(void);
* completion.
* @note The result buffer must be large enough to store one sample per device
* described by the 'physdev' parameter.
- * @note If calling this routine would exceed @p GADC_MAX_LOWSPEED_DEVICES simultaneous low
- * speed devices, the routine will wait for an available slot to complete the
- * conversion.
* @note Specifying more than one device in physdev is possible but discouraged as the
* calculations to ensure the high speed ADC correctness will be incorrect. Symptoms
- * from over-running the high speed ADC include high speed samples being lost.
+ * from over-running the high speed ADC include high speed device stalling or samples being lost.
*
* @api
*/
@@ -222,7 +219,7 @@ void gadcLowSpeedGet(uint32_t physdev, adcsample_t *buffer);
/**
* @brief Perform a low speed ADC conversion with callback (in a thread context)
- * @details Returns FALSE if there are no free low speed ADC slots. See @p GADC_MAX_LOWSPEED_DEVICES for details.
+ * @details Returns FALSE if internal memory allocation fails
*
* @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
* @param[in] buffer The static buffer to put the ADC samples into.
@@ -237,8 +234,6 @@ void gadcLowSpeedGet(uint32_t physdev, adcsample_t *buffer);
* completion.
* @note The result buffer must be large enough to store one sample per device
* described by the 'physdev' parameter.
- * @note As this routine uses a low speed ADC, it asserts if you try to run more than @p GADC_MAX_LOWSPEED_DEVICES
- * at the same time.
* @note Specifying more than one device in physdev is possible but discouraged as the
* calculations to ensure the high speed ADC correctness will be incorrect. Symptoms
* from over-running the high speed ADC include high speed samples being lost.
@@ -255,4 +250,3 @@ bool_t gadcLowSpeedStart(uint32_t physdev, adcsample_t *buffer, GADCCallbackFunc
#endif /* _GADC_H */
/** @} */
-