Added new USB_DeviceState variable to keep track of the current Device mode USB state.

[pub/lufa.git] / LUFA / Drivers / USB / HighLevel / USBTask.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h
index 2a9bf19..12acb11 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBTask.h
+++ b/LUFA/Drivers/USB/HighLevel/USBTask.h
@@ -55,23 +55,6 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Global Variables: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Global Variables: */\r

-                       /** Indicates if the USB interface is currently connected to a host if in device mode, or to a\r
-                        *  device while running in host mode.\r
-                        *\r
-                        *  \note This variable should be treated as read-only in the user application, and never manually\r
-                        *        changed in value.\r
-                        *\r
-                        *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
-                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
-                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
-                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
-                        *        and disconnection events may be manually fired, and the \ref USB_IsConnected global changed manually.\r
-                        *\r
-                        *  \ingroup Group_USBManagement\r
-                        */\r
-                       extern volatile bool USB_IsConnected;\r
-\r

                        /** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
                         *  or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.\r
                         *\r
                        /** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
                         *  or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.\r
                         *\r


@@ -90,39 +73,43 @@
                         */\r
                         extern USB_Request_Header_t USB_ControlRequest;\r
                        \r
                         */\r
                         extern USB_Request_Header_t USB_ControlRequest;\r
                        \r

-                       #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
-                       /** Indicates if the USB interface is currently suspended by the host when in device mode. When suspended,\r
-                        *  the device should consume minimal power, and cannot communicate to the host. If Remote Wakeup is\r
-                        *  supported by the device and \ref USB_RemoteWakeupEnabled is true, suspension can be terminated by the device\r
-                        *  by issuing a Remote Wakeup request.\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.\r
-                        *\r
-                        *  \ingroup Group_Device\r
-                        */\r
-                       extern volatile bool USB_IsSuspended;\r
-                       #endif\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
                        #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 in Host.h.\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
                         *\r
                         *  This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,\r

-                        *  \ref HOST_STATE_Configured, \ref HOST_STATE_Ready and \ref HOST_STATE_Suspended states which\r
-                        *  are not implemented by the library.\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
                         *\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 host states\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
                        #endif\r
 \r
                         *\r
                         *  \ingroup Group_Host\r
                         */\r
                        extern volatile uint8_t USB_HostState;\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
+                       #endif\r
+\r

                /* Function Prototypes: */\r
                        /** This is the main USB management task. The USB driver requires that this task be executed\r
                         *  continuously when the USB system is active (device attached in host mode, or attached to a host\r
                /* Function Prototypes: */\r
                        /** This is the main USB management task. The USB driver requires that this task be executed\r
                         *  continuously when the USB system is active (device attached in host mode, or attached to a host\r