X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..6380d057f8911f5d09bdffff4220aa9602df49e2:/LUFA/Drivers/Board/Temperature.h diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index c205093a8..7069e3e99 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -33,6 +33,14 @@ * Temperature sensor board driver for the USB boards which contain a temperature sensor. */ +/** \ingroup Group_BoardDrivers + * @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h + * + * Functions, macros, variables, enums and types related to the control of board temperature sensors. + * + * @{ + */ + #ifndef __TEMPERATURE_H__ #define __TEMPERATURE_H__ @@ -44,8 +52,8 @@ /* Includes: */ #include - #include "../AT90USBXXX/ADC.h" #include "../../Common/Common.h" + #include "../Peripheral/ADC.h" #if !defined(BOARD) #error #error BOARD must be set in makefile to a value specified in BoardTypes.h. @@ -68,20 +76,25 @@ /** Maximum returnable temperature from the Temperature_GetTemperature() function. */ #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET) - - /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. - * This must be called before any other temperature sensor routines. - * - * The ADC itself (not the ADC channel) must be configured seperately before calling the temperature - * sensor functions. - */ - #define Temperature_Init() ADC_SetupChannel(TEMP_ADC_CHANNEL); + + /* Psuedo-Functions: */ + #if defined(__DOXYGEN__) + /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. + * This must be called before any other temperature sensor routines. + * + * The ADC itself (not the ADC channel) must be configured separately before calling the temperature + * sensor functions. + */ + static inline void Temperature_Init(void); + #else + #define Temperature_Init() ADC_SetupChannel(TEMP_ADC_CHANNEL); + #endif /* Function Prototypes: */ /** Performs a complete ADC on the temperature sensor channel, and converts the result into a - * valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celcius. + * valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius. * - * \return Signed temperature in degrees Celcius + * \return Signed temperature in degrees Celsius */ int8_t Temperature_GetTemperature(void) ATTR_WARN_UNUSED_RESULT; @@ -98,3 +111,5 @@ #endif #endif + +/** @} */