X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/253deb996f321c59c102a64e17f95d0b5b0a0e6d..d03d6513d0d24cf63225c8d3dfa07675d9107f40:/LUFA/Drivers/Board/Temperature.h?ds=inline

diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index db2643c1d..7cfdb13bc 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2009.
+     Copyright (C) Dean Camera, 2010.
               
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
 
 /*
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-
-  Permission to use, copy, modify, and distribute this software
-  and its documentation for any purpose and without fee is hereby
-  granted, provided that the above copyright notice appear in all
-  copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting
-  documentation, and that the name of the author not be used in
-  advertising or publicity pertaining to distribution of the
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -29,19 +29,23 @@
 */
 
 /** \file
+ *  \brief Master include file for the board temperature sensor driver.
  *
- *  Temperature sensor board driver for the USB boards which contain a temperature sensor.
+ *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
  */
 
 /** \ingroup Group_BoardDrivers
- *  @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h
+ *  @defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/Board/Temperature.c
  *
  *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board temperature sensors.
+ *  Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
+ *  on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
+ *  current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
+ *  official Atmel USB AVR boards, as each sensor has different characteristics.
  *
  *  @{
  */
@@ -49,20 +53,17 @@
 #ifndef __TEMPERATURE_H__
 #define __TEMPERATURE_H__
 
-	/* Macros: */
-	#if !defined(__DOXYGEN__)
-		#define INCLUDE_FROM_BOARD_DRIVER
-	#endif
-	
 	/* Includes: */
 		#include <avr/pgmspace.h>
 
 		#include "../../Common/Common.h"
 		#include "../Peripheral/ADC.h"
 	
-		#if !defined(BOARD)
-			#error BOARD must be set in makefile to a value specified in BoardTypes.h.	
-		#elif (BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && (BOARD != BOARD_STK526)
+		#if (BOARD == BOARD_NONE)
+			#error The Board Temperature Sensor driver cannot be used if the makefile BOARD option is not set.
+		#elif ((BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && \
+		       (BOARD != BOARD_STK526) && (BOARD != BOARD_USER) &&   \
+			   (BOARD != BOARD_EVK527))
 			#error The selected board does not contain a temperature sensor.
 		#endif
 
@@ -74,21 +75,24 @@
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** ADC channel number for the temperature sensor. */
-			#define TEMP_ADC_CHANNEL   0
+			#define TEMP_ADC_CHANNEL       0
 			
+			/** ADC channel MUX mask for the temperature sensor. */
+			#define TEMP_ADC_CHANNEL_MASK  ADC_CHANNEL0
+
 			/** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */
-			#define TEMP_MIN_TEMP      TEMP_TABLE_OFFSET
+			#define TEMP_MIN_TEMP          TEMP_TABLE_OFFSET
 
 			/** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */
-			#define TEMP_MAX_TEMP      ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
+			#define TEMP_MAX_TEMP          ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
 		
 		/* Pseudo-Function Macros: */
 			#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.
+				 *  \note The ADC itself (not the ADC channel) must be configured separately before calling the
+				 *        temperature sensor functions.
 				 */
 				static inline void Temperature_Init(void);
 			#else