Add start of a SDP service table, which will be linked to the Bluetooth SDP code.

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Host.h

diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index d91c1d8..a8a5b01 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.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
-\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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


@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief USB host mode definitions.\r
+ *\r
+ *  This file contains structures, function prototypes and macros related to USB host mode.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r

 /** \ingroup Group_USB\r
  *  @defgroup Group_Host Host Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_Host Host Management\r
  *\r


@@ -55,6 +64,11 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+               #endif\r
+               \r

        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Indicates the fixed USB device address which any attached device is enumerated to when in\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Indicates the fixed USB device address which any attached device is enumerated to when in\r


@@ -186,7 +200,7 @@
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
                         */\r
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
                         */\r

-                       uint8_t USB_Host_SetDeviceConfiguration(uint8_t ConfigNumber);\r
+                       uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);\r

                        \r
                        /** Convenience function. This routine sends a GetDescriptor standard request to the attached\r
                         *  device, requesting the device descriptor. This can be used to easily retrieve information\r
                        \r
                        /** Convenience function. This routine sends a GetDescriptor standard request to the attached\r
                         *  device, requesting the device descriptor. This can be used to easily retrieve information\r


@@ -199,7 +213,23 @@
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
                         */\r
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
                         */\r

-                       uint8_t USB_Host_GetDeviceDescriptor(void* DeviceDescriptorPtr);\r
+                       uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);\r
+                       \r
+                       /** Convenience function. This routine sends a GetDescriptor standard request to the attached\r
+                        *  device, requesting the string descriptor of the specified index. This can be used to easily\r
+                        *  retrieve string descriptors from the device by index, after the index is obtained from the\r
+                        *  Device or Configuration descriptors.\r
+                        *\r
+                        *  \note After this routine returns, the control pipe will be selected.\r
+                        *\r
+                        *  \param[in] Index  Index of the string index to retrieve\r
+                        *  \param[out] Buffer  Pointer to the destination buffer where the retrieved string decriptor is\r
+                        *                      to be stored\r
+                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+                        */\r
+                       uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index, void* const Buffer, const uint8_t BufferLength);\r

                        \r
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.\r
                         *\r
                        \r
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.\r
                         *\r


@@ -215,7 +245,9 @@
                        /** Enum for the various states of the USB Host state machine. Only some states are\r
                         *  implemented in the LUFA library - other states are left to the user to implement.\r
                         *\r
                        /** Enum for the various states of the USB Host state machine. Only some states are\r
                         *  implemented in the LUFA library - other states are left to the user to implement.\r
                         *\r

-                        *  For information on each state, refer to the USB 2.0 specification. Some states have\r
+                        *  For information on each possible USB host state, refer to the USB 2.0 specification.\r
+                        *  Several of the USB host states are broken up further into multiple smaller sub-states,\r
+                        *  so that they can be internally implemented inside the library in an efficient manner.\r

                         *\r
                         *  \see \ref USB_HostState, which stores the current host state machine state.\r
                         */\r
                         *\r
                         *  \see \ref USB_HostState, which stores the current host state machine state.\r
                         */\r


@@ -241,32 +273,32 @@
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached                     = 3,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered                      = 3,  /**< Internally implemented by the library. This state indicates\r

                                                                               *   that a device has been attached, and the library's internals\r
                                                                               *   are being configured to begin the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that a device has been attached, and the library's internals\r
                                                                               *   are being configured to begin the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_WaitForDeviceSettle = 4,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_WaitForDeviceSettle = 4,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the stack is waiting for the initial settling period to\r
                                                                               *   elapse before beginning the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that the stack is waiting for the initial settling period to\r
                                                                               *   elapse before beginning the enumeration process.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_WaitForConnect      = 5,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_WaitForConnect      = 5,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the stack is waiting for a connection event from the USB\r
                                                                               *   controller to indicate a valid USB device has been attached to\r
                                                                               *   the bus and is ready to be enumerated.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that the stack is waiting for a connection event from the USB\r
                                                                               *   controller to indicate a valid USB device has been attached to\r
                                                                               *   the bus and is ready to be enumerated.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Attached_DoReset             = 6,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_DoReset             = 6,   /**< Internally implemented by the library. This state indicates\r

                                                                               *   that a valid USB device has been attached, and that it is\r
                                                                               *   will now be reset to ensure it is ready for enumeration.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r
                                                                               *   that a valid USB device has been attached, and that it is\r
                                                                               *   will now be reset to ensure it is ready for enumeration.\r
                                                                               *   \r
                                                                               *   \note Do not manually change to this state in the user code.\r
                                                                               */\r

-                               HOST_STATE_Powered                      = 7,  /**< Internally implemented by the library. This state indicates\r
+                               HOST_STATE_Powered_ConfigPipe           = 7,  /**< Internally implemented by the library. This state indicates\r

                                                                               *   that the attached device is currently powered and reset, and\r
                                                                               *   that the control pipe is now being configured by the stack.\r
                                                                               *   \r
                                                                               *   that the attached device is currently powered and reset, and\r
                                                                               *   that the control pipe is now being configured by the stack.\r
                                                                               *   \r


@@ -301,26 +333,18 @@
                                                                               *   retrieval and processing of the device descriptor) should also\r
                                                                               *   be placed in this state.\r
                                                                               */\r
                                                                               *   retrieval and processing of the device descriptor) should also\r
                                                                               *   be placed in this state.\r
                                                                               */\r

-                               HOST_STATE_Configured                   = 12, /**< May be implemented by the user project. This state should\r
-                                                                              *   implement any extra device configuration (such as the setting of\r
-                                                                              *   class-specific parameters) before normal communication is begun\r
-                                                                              *   in the HOST_STATE_Ready state.\r
-                                                                              */\r
-                               HOST_STATE_Ready                        = 13, /**< May be implemented by the user project. This state should\r
-                                                                              *   contain the main communications with the attached device. From this\r
-                                                                              *   this state the host state machine should be changed to either\r
-                                                                              *   HOST_STATE_Suspended (after the bus is manually suspended using the\r
-                                                                              *   USB_Host_SuspendBus() macro) or HOST_STATE_WaitForDeviceRemoval as\r
-                                                                              *   needed.\r
+                               HOST_STATE_Configured                   = 12, /**< May be implemented by the user project. This state should implement the\r
+                                                                              *   actual work performed on the attached device and changed to the\r
+                                                                              *   HOST_STATE_Suspended or HOST_STATE_WaitForDeviceRemoval states as needed.\r

                                                                               */\r
                                HOST_STATE_Suspended                    = 15, /**< May be implemented by the user project. This state should be maintained\r
                                                                               */\r
                                HOST_STATE_Suspended                    = 15, /**< May be implemented by the user project. This state should be maintained\r

-                                                                              *   while the bus is suspended, and changed to either the HOST_STATE_Ready\r
+                                                                              *   while the bus is suspended, and changed to either the HOST_STATE_Configured\r

                                                                               *   (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
                                                                               *   HOST_STATE_WaitForDeviceRemoval states as needed.\r
                                                                               */\r
                        };\r
                        \r
                                                                               *   (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
                                                                               *   HOST_STATE_WaitForDeviceRemoval states as needed.\r
                                                                               */\r
                        };\r
                        \r

-                       /** Enum for the error codes for the \ref EVENT_USB_HostError() event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.\r

                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r


@@ -334,14 +358,14 @@
                                                                      */\r
                        };\r
                        \r
                                                                      */\r
                        };\r
                        \r

-                       /** Enum for the error codes for the \ref EVENT_USB_DeviceEnumerationFailed() event.\r
+                       /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.\r

                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                        enum USB_Host_EnumerationErrorCodes_t\r
                        {\r
                                HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid\r
                         *\r
                         *  \see \ref Group_Events for more information on this event.\r
                         */\r
                        enum USB_Host_EnumerationErrorCodes_t\r
                        {\r
                                HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid\r

-                                                                     *   ErrorCode parameter value for the \ref EVENT_USB_DeviceEnumerationFailed()\r
+                                                                     *   ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()\r

                                                                      *   event.\r
                                                                      */\r
                                HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed\r
                                                                      *   event.\r
                                                                      */\r
                                HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed\r


@@ -374,7 +398,7 @@
                        #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE\r
                        #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE\r
 \r
                        #define USB_Host_VBUS_Auto_Off()        MACROS{ OTGCON |=  (1 << VBUSRQC);        }MACROE\r
                        #define USB_Host_VBUS_Manual_Off()      MACROS{ PORTE  &= ~(1 << 7);              }MACROE\r
 \r

-                       #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  (addr & 0x7F);         }MACROE\r
+                       #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR  =  ((addr) & 0x7F);       }MACROE\r

 \r
                /* Enums: */\r
                        enum USB_Host_WaitMSErrorCodes_t\r
 \r
                /* Enums: */\r
                        enum USB_Host_WaitMSErrorCodes_t\r


@@ -389,7 +413,7 @@
                        void    USB_Host_ProcessNextHostState(void);\r
                        uint8_t USB_Host_WaitMS(uint8_t MS);\r
                        \r
                        void    USB_Host_ProcessNextHostState(void);\r
                        uint8_t USB_Host_WaitMS(uint8_t MS);\r
                        \r

-                       #if defined(INCLUDE_FROM_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_HOST_C)\r

                                static void USB_Host_ResetDevice(void);\r
                        #endif\r
        #endif\r
                                static void USB_Host_ResetDevice(void);\r
                        #endif\r
        #endif\r