Added HOST_STATE_AS_GPIOR1 and DEVICE_STATE_AS_GPIOR0 compile time options, the latte...
[pub/lufa.git] / LUFA / Drivers / USB / HighLevel / USBTask.h
index 12acb11..768057a 100644 (file)
@@ -52,7 +52,7 @@
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
-\r
+               \r
        /* Public Interface - May be used in end-application: */\r
                /* Global Variables: */\r
                        /** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
                         extern USB_Request_Header_t USB_ControlRequest;\r
                        \r
                        #if defined(USB_CAN_BE_HOST) || 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
-                        *  This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,\r
-                        *  \ref HOST_STATE_Configured and \ref HOST_STATE_Suspended states which are not implemented by\r
-                        *  the library.\r
-                        *\r
-                        *  \note This global is only present if the user application can be a USB host.\r
-                        *\r
-                        *  \see \ref USB_Host_States_t for a list of possible device states\r
-                        *\r
-                        *  \ingroup Group_Host\r
-                        */\r
-                       extern volatile uint8_t USB_HostState;\r
+                               #if !defined(HOST_STATE_AS_GPIOR1) || 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
+                                        *  This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,\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
+                                        *\r
+                                        *  \note This global is only present if the user application can be a USB host.\r
+                                        *\r
+                                        *  \see \ref USB_Host_States_t for a list of possible device states\r
+                                        *\r
+                                        *  \ingroup Group_Host\r
+                                        */\r
+                                       extern volatile uint8_t USB_HostState;\r
+                               #else\r
+                                       #define USB_HostState GPIOR1\r
+                               #endif\r
                        #endif\r
 \r
                        #if defined(USB_CAN_BE_DEVICE) || 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
-                        *\r
-                        *  \note This global is only present if the user application can be a USB device.\r
-                        *\r
-                        *  \note This variable should be treated as read-only in the user application, and never manually\r
-                        *        changed in value except in the circumstances outlined above.\r
-                        *\r
-                        *  \see \ref USB_Device_States_t for a list of possible device states\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern volatile uint8_t USB_DeviceState;\r
+                               #if !defined(DEVICE_STATE_AS_GPIOR0) || 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
+                                        *\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
+                                        *\r
+                                        *  \note This global is only present if the user application can be a USB device.\r
+                                        *\r
+                                        *  \note This variable should be treated as read-only in the user application, and never manually\r
+                                        *        changed in value except in the circumstances outlined above.\r
+                                        *\r
+                                        *  \see \ref USB_Device_States_t for a list of possible device states\r
+                                        *\r
+                                        *  \ingroup Group_Device\r
+                                        */\r
+                                       extern volatile uint8_t USB_DeviceState;\r
+                               #else\r
+                                       #define USB_DeviceState GPIOR0\r
+                               #endif\r
                        #endif\r
 \r
                /* Function Prototypes: */\r