diff options
author | Andrew Hannam <andrewh@inmarket.com.au> | 2013-05-06 14:44:47 +1000 |
---|---|---|
committer | Andrew Hannam <andrewh@inmarket.com.au> | 2013-05-06 14:44:47 +1000 |
commit | 3374aa25c6e4e118df670c18eaeefa0f6f29377f (patch) | |
tree | 99bdea0be61386bd3ae70c8516198dd857e4db13 /include/gadc/gadc.h | |
parent | bbfeec2dd7b312745856236214c91fce6b9ec22c (diff) | |
download | uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.gz uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.bz2 uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.zip |
Reinsertion of doxygen headers
Reinsertion of doxygen headers that got lost in license change
Diffstat (limited to 'include/gadc/gadc.h')
-rw-r--r-- | include/gadc/gadc.h | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/include/gadc/gadc.h b/include/gadc/gadc.h index 17d1f028..af43ce06 100644 --- a/include/gadc/gadc.h +++ b/include/gadc/gadc.h @@ -5,6 +5,35 @@ * http://chibios-gfx.com/license.html */ +/** + * @file include/gadc/gadc.h + * @brief GADC - Periodic ADC subsystem header file. + * + * @addtogroup GADC + * + * @details The reason why ChibiOS/GFX has it's own ADC abstraction is because + * the Chibi-OS drivers are very CPU specific and do not + * provide a way across all hardware platforms to create periodic + * ADC conversions. There are also issues with devices with different + * characteristics or periodic requirements on the same ADC + * device (but different channels). This layer attempts to solve these + * problems to provide a architecture neutral API. It also provides extra + * features such as multi-buffer chaining for high speed ADC sources. + * It provides one high speed virtual ADC device (eg a microphone) and + * numerous low speed (less than 100Hz) virtual ADC devices (eg dials, + * temperature sensors etc). The high speed device has timer based polling + * to ensure exact conversion periods and a buffer management system. + * The low speed devices are assumed to be non-critical timing devices + * and do not have any buffer management. + * Note that while only one high speed device has been provided it can + * be used to read multiple physical ADC channels on the one physical + * ADC device. + * All callback routines are thread based unlike the Chibi-OS interrupt based + * routines. + * + * @{ + */ + #ifndef _GADC_H #define _GADC_H |