Fix up the incomplete Webserver project so that it integrates with the uIP stack...
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Host.h
index 8cf1fe0..07ff0fc 100644 (file)
@@ -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
                         */\r
                        uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);\r
                        \r
                         */\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(uint8_t Index, void* const Buffer, uint8_t BufferLength);\r
+                       \r
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.\r
                         *\r
                         *  \note After this routine returns, the control pipe will be selected.\r
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.\r
                         *\r
                         *  \note After this routine returns, the control pipe will be selected.\r