Fix up the incomplete Webserver project so that it integrates with the uIP stack...

[pub/USBasp.git] / LUFA / Drivers / Board / Temperature.h

diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index 7069e3e..f7f0034 100644 (file)
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
 \r

-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -34,9 +34,17 @@
  */\r
 \r
 /** \ingroup Group_BoardDrivers\r
  */\r
 \r
 /** \ingroup Group_BoardDrivers\r

- *  @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h\r
+ *  @defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h\r

  *\r
  *\r

- *  Functions, macros, variables, enums and types related to the control of board temperature sensors.\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\r
+ *\r
+ *  \section 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
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -56,8 +64,10 @@
                #include "../Peripheral/ADC.h"\r
        \r
                #if !defined(BOARD)\r
                #include "../Peripheral/ADC.h"\r
        \r
                #if !defined(BOARD)\r

-                       #error #error BOARD must be set in makefile to a value specified in BoardTypes.h.       \r
-               #elif (BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && (BOARD != BOARD_STK526)\r
+                       #error BOARD must be set in makefile to a value specified in BoardTypes.h.      \r
+               #elif ((BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && \\r
+                      (BOARD != BOARD_STK526) && (BOARD != BOARD_USER) &&   \\r
+                          (BOARD != BOARD_EVK527))\r

                        #error The selected board does not contain a temperature sensor.\r
                #endif\r
 \r
                        #error The selected board does not contain a temperature sensor.\r
                #endif\r
 \r


@@ -71,19 +81,19 @@
                        /** ADC channel number for the temperature sensor. */\r
                        #define TEMP_ADC_CHANNEL   0\r
                        \r
                        /** ADC channel number for the temperature sensor. */\r
                        #define TEMP_ADC_CHANNEL   0\r
                        \r

-                       /** Minimum returnable temperature from the Temperature_GetTemperature() function. */\r
+                       /** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */\r

                        #define TEMP_MIN_TEMP      TEMP_TABLE_OFFSET\r
 \r
                        #define TEMP_MIN_TEMP      TEMP_TABLE_OFFSET\r
 \r

-                       /** Maximum returnable temperature from the Temperature_GetTemperature() function. */\r
+                       /** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */\r

                        #define TEMP_MAX_TEMP      ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)\r
                \r
                        #define TEMP_MAX_TEMP      ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)\r
                \r

-               /* Psuedo-Functions: */\r
+               /* Pseudo-Function Macros: */\r

                        #if defined(__DOXYGEN__)\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
                        #if defined(__DOXYGEN__)\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

-                                *  The ADC itself (not the ADC channel) must be configured separately before calling the temperature\r
-                                *  sensor functions.\r
+                                *  \note 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);\r
                        #else\r
                                 */\r
                                static inline void Temperature_Init(void);\r
                        #else\r


@@ -92,7 +102,7 @@
 \r
                /* Function Prototypes: */\r
                        /** Performs a complete ADC on the temperature sensor channel, and converts the result into a\r
 \r
                /* Function Prototypes: */\r
                        /** Performs a complete ADC on the temperature sensor channel, and converts the result into a\r

-                        *  valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius.\r
+                        *  valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius.\r

                         *\r
                         *  \return Signed temperature in degrees Celsius\r
                         */\r
                         *\r
                         *  \return Signed temperature in degrees Celsius\r
                         */\r