Add UUID Class matching to the Service Discovery Protocol code - SDP is now correctly...
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / DevChapter9.h
index 55e3b82..7bafcbf 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-\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
-  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
-#ifndef __DEVCHAPTER9_H__\r
-#define __DEVCHAPTER9_H__\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/pgmspace.h>\r
-               #include <avr/eeprom.h>\r
-               #include <avr/boot.h>\r
-               \r
-               #include "../HighLevel/StdDescriptors.h"\r
-               #include "../HighLevel/Events.h"\r
-               #include "../HighLevel/StdRequestType.h"\r
-               #include "../HighLevel/USBTask.h"\r
-               #include "LowLevel.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
-                       #if defined(USE_SINGLE_DEVICE_CONFIGURATION)\r
-                               #define TOTAL_NUM_CONFIGURATIONS           1\r
-                       #endif\r
-       \r
-               /* Enums: */\r
-                       #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)\r
-                               /** Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the\r
-                                *  \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS\r
-                                *  compile time options are used, to indicate in which memory space the descriptor is stored.\r
-                                *\r
-                                *  \ingroup Group_Device\r
-                                */\r
-                               enum USB_DescriptorMemorySpaces_t\r
-                               {\r
-                                       MEMSPACE_FLASH    = 0, /**< Indicates the requested descriptor is located in FLASH memory */\r
-                                       MEMSPACE_EEPROM   = 1, /**< Indicates the requested descriptor is located in EEPROM memory */\r
-                                       MEMSPACE_RAM      = 2, /**< Indicates the requested descriptor is located in RAM memory */\r
-                               };\r
-                       #endif\r
-       \r
-               /* Global Variables: */\r
-                       /** Indicates the currently set configuration number of the device. USB devices may have several\r
-                        *  different configurations which the host can select between; this indicates the currently selected\r
-                        *  value, or 0 if no configuration has been selected.\r
-                        *\r
-                        *  \note This variable should be treated as read-only in the user application, and never manually\r
-                        *        changed in value.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern uint8_t USB_ConfigurationNumber;\r
-                       \r
-                       /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this\r
-                        *  flag is cleared, the device should not issue remote wakeup events to the host.\r
-                        *\r
-                        *  \note This variable should be treated as read-only in the user application, and never manually\r
-                        *        changed in value.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern bool USB_RemoteWakeupEnabled;\r
-                       \r
-                       /** Indicates if the device is currently being powered by its own power supply, rather than being\r
-                        *  powered by the host's USB supply. This flag should remain cleared if the device does not\r
-                        *  support self powered mode, as indicated in the device descriptors.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern bool USB_CurrentlySelfPowered;\r
-       \r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)\r
-                       #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.\r
-               #elif defined(USE_RAM_DESCRIPTORS) && defined(USE_FLASH_DESCRIPTORS)\r
-                       #error USE_RAM_DESCRIPTORS and USE_FLASH_DESCRIPTORS are mutually exclusive.\r
-               #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)\r
-                       #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.\r
-               #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS)\r
-                       #error Only one of the USE_*_DESCRIPTORS modes should be selected.\r
-               #endif\r
-       \r
-               /* Function Prototypes: */\r
-                       void USB_Device_ProcessControlPacket(void);\r
-                       \r
-                       #if defined(INCLUDE_FROM_DEVCHAPTER9_C)\r
-                               static void USB_Device_SetAddress(void);\r
-                               static void USB_Device_SetConfiguration(void);\r
-                               static void USB_Device_GetConfiguration(void);\r
-                               static void USB_Device_GetDescriptor(void);\r
-                               static void USB_Device_GetStatus(void);\r
-                               static void USB_Device_ClearSetFeature(void);\r
-                               \r
-                               #if !defined(NO_INTERNAL_SERIAL) && (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))\r
-                                       static void USB_Device_GetInternalSerialDescriptor(void);\r
-                               #endif                          \r
-                       #endif\r
-       #endif\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-               \r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  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
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief USB device standard request management.
+ *
+ *  This file contains the function prototypes neccesary for the processing of incomming standard control requests
+ *  when the library is in USB device mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+#ifndef __DEVCHAPTER9_H__
+#define __DEVCHAPTER9_H__
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/pgmspace.h>
+               #include <avr/eeprom.h>
+               #include <avr/boot.h>
+               #include <util/atomic.h>
+               
+               #include "../HighLevel/StdDescriptors.h"
+               #include "../HighLevel/Events.h"
+               #include "../HighLevel/StdRequestType.h"
+               #include "../HighLevel/USBTask.h"
+               #include "LowLevel.h"
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+               #endif
+               
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       #if defined(USE_SINGLE_DEVICE_CONFIGURATION)
+                               #define FIXED_NUM_CONFIGURATIONS           1
+                       #endif
+       
+               /* Enums: */
+                       #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
+                               /** Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the
+                                *  \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS
+                                *  compile time options are used, to indicate in which memory space the descriptor is stored.
+                                *
+                                *  \ingroup Group_Device
+                                */
+                               enum USB_DescriptorMemorySpaces_t
+                               {
+                                       MEMSPACE_FLASH    = 0, /**< Indicates the requested descriptor is located in FLASH memory */
+                                       MEMSPACE_EEPROM   = 1, /**< Indicates the requested descriptor is located in EEPROM memory */
+                                       MEMSPACE_RAM      = 2, /**< Indicates the requested descriptor is located in RAM memory */
+                               };
+                       #endif
+       
+               /* Global Variables: */
+                       /** Indicates the currently set configuration number of the device. USB devices may have several
+                        *  different configurations which the host can select between; this indicates the currently selected
+                        *  value, or 0 if no configuration has been selected.
+                        *
+                        *  \note This variable should be treated as read-only in the user application, and never manually
+                        *        changed in value.
+                        *
+                        *  \ingroup Group_Device
+                        */
+                       extern uint8_t USB_ConfigurationNumber;
+                       
+                       #if !defined(NO_DEVICE_REMOTE_WAKEUP)
+                               /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
+                                *  flag is cleared, the device should not issue remote wakeup events to the host.
+                                *
+                                *  \note This variable should be treated as read-only in the user application, and never manually
+                                *        changed in value.
+                                *        \n\n
+                                *
+                                *  \note To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported,
+                                *        this global and the underlying management code can be disabled by defining the 
+                                *        NO_DEVICE_REMOTE_WAKEUP token in the project makefile and passing it to the compiler via
+                                *        the -D switch.
+                                *
+                                *  \ingroup Group_Device
+                                */
+                               extern bool USB_RemoteWakeupEnabled;
+                       #endif
+                       
+                       #if !defined(NO_DEVICE_SELF_POWER)
+                               /** Indicates if the device is currently being powered by its own power supply, rather than being
+                                *  powered by the host's USB supply. This flag should remain cleared if the device does not
+                                *  support self powered mode, as indicated in the device descriptors.
+                                *
+                                *  \ingroup Group_Device
+                                */
+                               extern bool USB_CurrentlySelfPowered;
+                       #endif
+       
+       /* Private Interface - For use in library only: */
+       #if !defined(__DOXYGEN__)
+               #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
+                       #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
+               #elif defined(USE_RAM_DESCRIPTORS) && defined(USE_FLASH_DESCRIPTORS)
+                       #error USE_RAM_DESCRIPTORS and USE_FLASH_DESCRIPTORS are mutually exclusive.
+               #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
+                       #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
+               #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS)
+                       #error Only one of the USE_*_DESCRIPTORS modes should be selected.
+               #endif
+       
+               /* Function Prototypes: */
+                       void USB_Device_ProcessControlRequest(void);
+                       
+                       #if defined(__INCLUDE_FROM_DEVCHAPTER9_C)
+                               static void USB_Device_SetAddress(void);
+                               static void USB_Device_SetConfiguration(void);
+                               static void USB_Device_GetConfiguration(void);
+                               static void USB_Device_GetDescriptor(void);
+                               static void USB_Device_GetStatus(void);
+                               static void USB_Device_ClearSetFeature(void);
+                               
+                               #if !defined(NO_INTERNAL_SERIAL) && (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
+                                       static char USB_Device_NibbleToASCII(uint8_t Nibble) ATTR_ALWAYS_INLINE;
+                                       static void USB_Device_GetInternalSerialDescriptor(void);
+                               #endif                          
+                       #endif
+       #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+               
+#endif