+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this\r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in\r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief NTC Temperature Sensor board hardware driver.\r
- *\r
- * Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.\r
- */\r
-\r
-/** \ingroup Group_BoardDrivers\r
- * \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h\r
- * \brief NTC Temperature Sensor board hardware driver.\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>\r
- *\r
- * \section Sec_ModDescription Module Description\r
- * Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located\r
- * on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the\r
- * current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the\r
- * official Atmel USB AVR boards, as each sensor has different characteristics.\r
- *\r
- * \section Sec_ExampleUsage Example Usage\r
- * The following snippet is an example of how this module may be used within a typical\r
- * application.\r
- *\r
- * \code\r
- * // Initialize the ADC and board temperature sensor drivers before first use\r
- * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);\r
- * Temperature_Init();\r
- * \r
- * // Display converted temperature in degrees Celsius\r
- * printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature());\r
- * \endcode\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __TEMPERATURE_H__\r
-#define __TEMPERATURE_H__\r
-\r
- /* Includes: */\r
- #include "../../Common/Common.h"\r
-\r
- /* Preprocessor Checks: */\r
- #if ((BOARD == BOARD_USBKEY) || (BOARD == BOARD_STK525) || \\r
- (BOARD == BOARD_STK526) || (BOARD == BOARD_EVK527))\r
- #define TEMPERATURE_SENSOR_DRIVER_COMPATIBLE\r
- #endif\r
- \r
- #if !defined(__INCLUDE_FROM_TEMPERATURE_C) && !defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE)\r
- #error The selected board does not contain a compatible temperature sensor.\r
- #endif\r
-\r
- #if defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE)\r
-\r
- /* Includes: */\r
- #include "../Peripheral/ADC.h"\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** ADC channel number for the temperature sensor. */\r
- #define TEMP_ADC_CHANNEL 0\r
-\r
- /** ADC channel MUX mask for the temperature sensor. */\r
- #define TEMP_ADC_CHANNEL_MASK ADC_CHANNEL0\r
-\r
- /** Size of the temperature sensor lookup table, in lookup values */\r
- #define TEMP_TABLE_SIZE 120\r
-\r
- /** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */\r
- #define TEMP_MIN_TEMP TEMP_TABLE_OFFSET_DEGREES\r
-\r
- /** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */\r
- #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES)\r
-\r
- /* Inline Functions: */\r
- /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.\r
- * This must be called before any other temperature sensor routines.\r
- *\r
- * \pre The ADC itself (not the ADC channel) must be configured separately before calling the\r
- * temperature sensor functions.\r
- */\r
- static inline void Temperature_Init(void) ATTR_ALWAYS_INLINE;\r
- static inline void Temperature_Init(void)\r
- {\r
- ADC_SetupChannel(TEMP_ADC_CHANNEL);\r
- }\r
-\r
- /* Function Prototypes: */\r
- /** Performs a complete ADC on the temperature sensor channel, and converts the result into a\r
- * valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius.\r
- *\r
- * \return Signed temperature value in degrees Celsius.\r
- */\r
- int8_t Temperature_GetTemperature(void) ATTR_WARN_UNUSED_RESULT;\r
-\r
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define TEMP_TABLE_OFFSET_DEGREES -21\r
- #endif\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
-\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
-\r
projects / qmk_firmware.git / blobdiff