Fix up the incomplete Webserver project so that it integrates with the uIP stack...
[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / USBTask.h
index 768057a..68d04af 100644 (file)
@@ -1,21 +1,21 @@
 /*\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
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  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
+  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
        /* Includes: */\r
                #include <avr/io.h>\r
                #include <avr/interrupt.h>\r
-               #include <util/atomic.h>\r
                #include <stdbool.h>\r
-               #include <stddef.h>\r
                \r
                #include "../LowLevel/LowLevel.h"\r
-               #include "StdRequestType.h"\r
-               #include "USBMode.h"\r
                #include "Events.h"\r
+               #include "StdRequestType.h"\r
                #include "StdDescriptors.h"\r
+               #include "USBMode.h"\r
+\r
+               #if defined(USB_CAN_BE_DEVICE)\r
+                       #include "../LowLevel/DevChapter9.h"\r
+               #endif\r
 \r
                #if defined(USB_CAN_BE_HOST)\r
                        #include "../LowLevel/HostChapter9.h"\r
-               #endif          \r
+               #endif\r
                \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
@@ -66,7 +68,7 @@
                        extern volatile bool USB_IsInitialized;\r
 \r
                        /** Structure containing the last received Control request when in Device mode (for use in user-applications\r
-                        *  inside of the \ref EVENT_USB_UnhandledControlPacket() event, or for filling up with a control request to issue when\r
+                        *  inside of the \ref EVENT_USB_Device_UnhandledControlRequest() event, or for filling up with a control request to issue when\r
                         *  in Host mode before calling \ref USB_Host_SendControlRequest().\r
                         *\r
                         *  \ingroup Group_USBManagement\r
@@ -74,7 +76,7 @@
                         extern USB_Request_Header_t USB_ControlRequest;\r
                        \r
                        #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
-                               #if !defined(HOST_STATE_AS_GPIOR1) || defined(__DOXYGEN__)\r
+                               #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)\r
                                        /** Indicates the current host state machine state. When in host mode, this indicates the state\r
                                         *  via one of the values of the \ref USB_Host_States_t enum values.\r
                                         *\r
                                         *  \ref HOST_STATE_Configured and \ref HOST_STATE_Suspended states which are not implemented by\r
                                         *  the library.\r
                                         *\r
-                                        *  To reduce program size and speed up checks of this global, it can be placed into the AVR's GPIOR1\r
-                                        *  hardware register instead of RAM by defining the HOST_STATE_AS_GPIOR1 token in the project\r
-                                        *  makefile and passing it to the compiler via the -D switch. When defined, the GPIOR1 register should\r
-                                        *  not be used in the user application except implicitly via the library APIs.\r
+                                        *  To reduce program size and speed up checks of this global, it can be placed into one of the AVR's\r
+                                        *  GPIOR hardware registers instead of RAM by defining the HOST_STATE_AS_GPIOR token to a value \r
+                                        *  between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When\r
+                                        *  defined, the corresponding GPIOR register should not be used in the user application except\r
+                                        *  implicitly via the library APIs.\r
                                         *\r
                                         *  \note This global is only present if the user application can be a USB host.\r
                                         *\r
                                         */\r
                                        extern volatile uint8_t USB_HostState;\r
                                #else\r
-                                       #define USB_HostState GPIOR1\r
+                                       #define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y\r
+                                       #define _GET_HOST_GPIOR_NAME(x)  _GET_HOST_GPIOR_NAME2(x)\r
+                                       #define USB_HostState            _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)\r
                                #endif\r
                        #endif\r
 \r
                        #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
-                               #if !defined(DEVICE_STATE_AS_GPIOR0) || defined(__DOXYGEN__)\r
+                               #if !defined(DEVICE_STATE_AS_GPIOR) || defined(__DOXYGEN__)\r
                                        /** Indicates the current device state machine state. When in device mode, this indicates the state\r
                                         *  via one of the values of the \ref USB_Device_States_t enum values.\r
                                         *\r
                                         *  This value should not be altered by the user application as it is handled automatically by the\r
                                         *  library. The only exception to this rule is if the NO_LIMITED_CONTROLLER_CONNECT token is used\r
-                                        *  (see \ref EVENT_USB_Connect() and \ref EVENT_USB_Disconnect() events).\r
+                                        *  (see \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events).\r
                                         *\r
-                                        *  To reduce program size and speed up checks of this global, it can be placed into the AVR's GPIOR0\r
-                                        *  hardware register instead of RAM by defining the DEVICE_STATE_AS_GPIOR0 token in the project\r
-                                        *  makefile and passing it to the compiler via the -D switch. When defined, the GPIOR0 register should\r
-                                        *  not be used in the user application except implicitly via the library APIs.\r
+                                        *  To reduce program size and speed up checks of this global, it can be placed into one of the AVR's\r
+                                        *  GPIOR hardware registers instead of RAM by defining the DEVICE_STATE_AS_GPIOR token to a value \r
+                                        *  between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When\r
+                                        *  defined, the corresponding GPIOR register should not be used in the user application except\r
+                                        *  implicitly via the library APIs.\r
                                         *\r
                                         *  \note This global is only present if the user application can be a USB device.\r
                                         *\r
                                         */\r
                                        extern volatile uint8_t USB_DeviceState;\r
                                #else\r
-                                       #define USB_DeviceState GPIOR0\r
+                                       #define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y\r
+                                       #define _GET_DEVICE_GPIOR_NAME(x)  _GET_DEVICE_GPIOR_NAME2(x)\r
+                                       #define USB_DeviceState            _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)\r
                                #endif\r
                        #endif\r
 \r
                         *  The USB task must be serviced within 30ms while in device mode, or within 1ms while in host mode.\r
                         *  The task may be serviced at all times, or (for minimum CPU consumption):\r
                         *\r
-                        *    - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Connect() event\r
-                        *    and disabled again on the firing of the \ref EVENT_USB_Disconnect() event.\r
+                        *    - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Device_Connect() \r
+                        *      event and disabled again on the firing of the \ref EVENT_USB_Device_Disconnect() event.\r
                         *\r
-                        *    - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_DeviceAttached()\r
-                        *    event and disabled again on the firing of the \ref EVENT_USB_DeviceEnumerationComplete() or\r
-                        *    \ref EVENT_USB_DeviceEnumerationFailed() events.\r
+                        *    - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Host_DeviceAttached()\r
+                        *      event and disabled again on the firing of the \ref EVENT_USB_Host_DeviceEnumerationComplete() or\r
+                        *      \ref EVENT_USB_Host_DeviceEnumerationFailed() events.\r
                         *\r
                         *  If in device mode (only), the control endpoint can instead be managed via interrupts entirely by the library\r
                         *  by defining the INTERRUPT_CONTROL_ENDPOINT token and passing it to the compiler via the -D switch.\r
                        #endif\r
                        \r
                /* Macros: */\r
-                       #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) {USB_HostState = HOST_STATE_WaitForDevice; WaitMSRemaining = duration; PostWaitState = nextstate; }\r
+                       #define HOST_TASK_NONBLOCK_WAIT(duration, nextstate) MACROS{ USB_HostState = HOST_STATE_WaitForDevice; \\r
+                                                                                    WaitMSRemaining = (duration);             \\r
+                                                                                    PostWaitState = (nextstate);        }MACROE\r
        #endif\r
        \r
        /* Disable C linkage for C++ Compilers: */\r