-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2011.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2011 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, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations\r
- * needed to communication with an attached USB device. Descriptors are special computer-readable structures\r
- * which the host requests upon device enumeration, to determine the device's capabilities and functions.\r
- */\r
-\r
-#include "ConfigDescriptor.h"\r
-\r
-/** Index of the currently used Audio Streaming Interface within the device. */\r
-uint8_t StreamingInterfaceIndex = 0;\r
-\r
-/** Alternative Setting of the currently used Audio Streaming Interface within the device. */\r
-uint8_t StreamingInterfaceAltSetting = 0;\r
-\r
-/** Address of the streaming audio endpoint currently in use within the device. */\r
-uint8_t StreamingEndpointAddress = 0;\r
-\r
-\r
-/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This\r
- * routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate\r
- * with compatible devices.\r
- *\r
- * This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.\r
- *\r
- * \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.\r
- */\r
-uint8_t ProcessConfigurationDescriptor(void)\r
-{\r
- uint8_t ConfigDescriptorData[512];\r
- void* CurrConfigLocation = ConfigDescriptorData;\r
- uint16_t CurrConfigBytesRem;\r
-\r
- USB_Descriptor_Interface_t* AudioControlInterface = NULL;\r
- USB_Descriptor_Interface_t* AudioStreamingInterface = NULL;\r
- USB_Descriptor_Endpoint_t* DataINEndpoint = NULL;\r
-\r
- /* Retrieve the entire configuration descriptor into the allocated buffer */\r
- switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))\r
- {\r
- case HOST_GETCONFIG_Successful:\r
- break;\r
- case HOST_GETCONFIG_InvalidData:\r
- return InvalidConfigDataReturned;\r
- case HOST_GETCONFIG_BuffOverflow:\r
- return DescriptorTooLarge;\r
- default:\r
- return ControlError;\r
- }\r
-\r
- while (!(DataINEndpoint))\r
- {\r
- /* See if we've found a likely compatible interface, and if there is an endpoint within that interface */\r
- if (!(AudioControlInterface) ||\r
- USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
- DComp_NextAudioInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Check if we haven't found an Audio Control interface yet, or if we have run out of related Audio Streaming interfaces */\r
- if (!(AudioControlInterface) ||\r
- USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
- DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Find a new Audio Control interface if the current one doesn't contain a compatible streaming interface */\r
- if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
- DComp_NextAudioControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Descriptor not found, error out */\r
- return NoCompatibleInterfaceFound;\r
- }\r
-\r
- /* Save the interface in case we need to refer back to it later */\r
- AudioControlInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t); \r
-\r
- /* Find the next Audio Streaming interface within that Audio Control interface */\r
- if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
- DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Descriptor not found, error out */\r
- return NoCompatibleInterfaceFound;\r
- }\r
- }\r
-\r
- /* Save the interface in case we need to refer back to it later */\r
- AudioStreamingInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);\r
-\r
- /* Skip the remainder of the loop as we have not found an endpoint yet */\r
- continue;\r
- }\r
-\r
- /* Retrieve the endpoint address from the endpoint descriptor */\r
- USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);\r
-\r
- /* Save the endpoint if it is an IN type endpoint */\r
- if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
- DataINEndpoint = EndpointData;\r
- }\r
-\r
- StreamingInterfaceIndex = AudioStreamingInterface->InterfaceNumber;\r
- StreamingInterfaceAltSetting = AudioStreamingInterface->AlternateSetting;\r
- StreamingEndpointAddress = DataINEndpoint->EndpointAddress;\r
-\r
- /* Configure the Audio data IN pipe */\r
- Pipe_ConfigurePipe(AUDIO_DATA_IN_PIPE, EP_TYPE_ISOCHRONOUS, PIPE_TOKEN_IN,\r
- DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, PIPE_BANK_DOUBLE);\r
-\r
- /* Valid data found, return success */\r
- return SuccessfulConfigRead;\r
-}\r
-\r
-/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
- * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
- * descriptor processing if an incompatible descriptor configuration is found.\r
- *\r
- * This comparator searches for the next Interface descriptor of the correct Audio Control Class, Subclass and Protocol values.\r
- *\r
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextAudioControlInterface(void* CurrentDescriptor)\r
-{\r
- USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);\r
-\r
- if (Header->Type == DTYPE_Interface)\r
- {\r
- USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);\r
-\r
- if ((Interface->Class == AUDIO_CSCP_AudioClass) &&\r
- (Interface->SubClass == AUDIO_CSCP_ControlSubclass) &&\r
- (Interface->Protocol == AUDIO_CSCP_ControlProtocol))\r
- {\r
- return DESCRIPTOR_SEARCH_Found;\r
- }\r
- }\r
-\r
- return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
-/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
- * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
- * descriptor processing if an incompatible descriptor configuration is found.\r
- *\r
- * This comparator searches for the next Interface descriptor of the correct Audio Streaming Class, Subclass and Protocol values.\r
- *\r
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextAudioStreamInterface(void* CurrentDescriptor)\r
-{\r
- USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);\r
-\r
- if (Header->Type == DTYPE_Interface)\r
- {\r
- USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);\r
-\r
- if ((Interface->Class == AUDIO_CSCP_AudioClass) &&\r
- (Interface->SubClass == AUDIO_CSCP_AudioStreamingSubclass) &&\r
- (Interface->Protocol == AUDIO_CSCP_StreamingProtocol))\r
- {\r
- return DESCRIPTOR_SEARCH_Found;\r
- }\r
- }\r
-\r
- return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
-/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
- * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
- * descriptor processing if an incompatible descriptor configuration is found.\r
- *\r
- * This comparator searches for the next Isochronous Endpoint descriptor within the current interface, aborting the\r
- * search if another interface descriptor is found before the next endpoint.\r
- *\r
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor)\r
-{\r
- USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);\r
-\r
- if (Header->Type == DTYPE_Endpoint)\r
- {\r
- USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);\r
-\r
- if ((Endpoint->Attributes & EP_TYPE_MASK) == EP_TYPE_ISOCHRONOUS)\r
- return DESCRIPTOR_SEARCH_Found;\r
- }\r
- else if (Header->Type == DTYPE_Interface)\r
- {\r
- return DESCRIPTOR_SEARCH_Fail;\r
- }\r
-\r
- return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2012.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations
+ * needed to communication with an attached USB device. Descriptors are special computer-readable structures
+ * which the host requests upon device enumeration, to determine the device's capabilities and functions.
+ */
+
+#include "ConfigDescriptor.h"
+
+/** Index of the currently used Audio Streaming Interface within the device. */
+uint8_t StreamingInterfaceIndex = 0;
+
+/** Alternative Setting of the currently used Audio Streaming Interface within the device. */
+uint8_t StreamingInterfaceAltSetting = 0;
+
+/** Address of the streaming audio endpoint currently in use within the device. */
+uint8_t StreamingEndpointAddress = 0;
+
+
+/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This
+ * routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate
+ * with compatible devices.
+ *
+ * This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.
+ *
+ * \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.
+ */
+uint8_t ProcessConfigurationDescriptor(void)
+{
+ uint8_t ConfigDescriptorData[512];
+ void* CurrConfigLocation = ConfigDescriptorData;
+ uint16_t CurrConfigBytesRem;
+
+ USB_Descriptor_Interface_t* AudioControlInterface = NULL;
+ USB_Descriptor_Interface_t* AudioStreamingInterface = NULL;
+ USB_Descriptor_Endpoint_t* DataINEndpoint = NULL;
+
+ /* Retrieve the entire configuration descriptor into the allocated buffer */
+ switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))
+ {
+ case HOST_GETCONFIG_Successful:
+ break;
+ case HOST_GETCONFIG_InvalidData:
+ return InvalidConfigDataReturned;
+ case HOST_GETCONFIG_BuffOverflow:
+ return DescriptorTooLarge;
+ default:
+ return ControlError;
+ }
+
+ while (!(DataINEndpoint))
+ {
+ /* See if we've found a likely compatible interface, and if there is an endpoint within that interface */
+ if (!(AudioControlInterface) ||
+ USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+ DComp_NextAudioInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
+ {
+ /* Check if we haven't found an Audio Control interface yet, or if we have run out of related Audio Streaming interfaces */
+ if (!(AudioControlInterface) ||
+ USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+ DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+ {
+ /* Find a new Audio Control interface if the current one doesn't contain a compatible streaming interface */
+ if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+ DComp_NextAudioControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+ {
+ /* Descriptor not found, error out */
+ return NoCompatibleInterfaceFound;
+ }
+
+ /* Save the interface in case we need to refer back to it later */
+ AudioControlInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);
+
+ /* Find the next Audio Streaming interface within that Audio Control interface */
+ if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+ DComp_NextAudioStreamInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+ {
+ /* Descriptor not found, error out */
+ return NoCompatibleInterfaceFound;
+ }
+ }
+
+ /* Save the interface in case we need to refer back to it later */
+ AudioStreamingInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);
+
+ /* Skip the remainder of the loop as we have not found an endpoint yet */
+ continue;
+ }
+
+ /* Retrieve the endpoint address from the endpoint descriptor */
+ USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
+
+ /* Save the endpoint if it is an IN type endpoint */
+ if ((EndpointData->EndpointAddress & ENDPOINT_DIR_MASK) == ENDPOINT_DIR_IN)
+ DataINEndpoint = EndpointData;
+ }
+
+ StreamingInterfaceIndex = AudioStreamingInterface->InterfaceNumber;
+ StreamingInterfaceAltSetting = AudioStreamingInterface->AlternateSetting;
+ StreamingEndpointAddress = DataINEndpoint->EndpointAddress;
+
+ /* Configure the Audio data IN pipe */
+ Pipe_ConfigurePipe(AUDIO_DATA_IN_PIPE, EP_TYPE_ISOCHRONOUS, PIPE_TOKEN_IN,
+ DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, PIPE_BANK_DOUBLE);
+
+ /* Valid data found, return success */
+ return SuccessfulConfigRead;
+}
+
+/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
+ * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
+ * descriptor processing if an incompatible descriptor configuration is found.
+ *
+ * This comparator searches for the next Interface descriptor of the correct Audio Control Class, Subclass and Protocol values.
+ *
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ */
+uint8_t DComp_NextAudioControlInterface(void* CurrentDescriptor)
+{
+ USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+ if (Header->Type == DTYPE_Interface)
+ {
+ USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
+
+ if ((Interface->Class == AUDIO_CSCP_AudioClass) &&
+ (Interface->SubClass == AUDIO_CSCP_ControlSubclass) &&
+ (Interface->Protocol == AUDIO_CSCP_ControlProtocol))
+ {
+ return DESCRIPTOR_SEARCH_Found;
+ }
+ }
+
+ return DESCRIPTOR_SEARCH_NotFound;
+}
+
+/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
+ * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
+ * descriptor processing if an incompatible descriptor configuration is found.
+ *
+ * This comparator searches for the next Interface descriptor of the correct Audio Streaming Class, Subclass and Protocol values.
+ *
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ */
+uint8_t DComp_NextAudioStreamInterface(void* CurrentDescriptor)
+{
+ USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+ if (Header->Type == DTYPE_Interface)
+ {
+ USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
+
+ if ((Interface->Class == AUDIO_CSCP_AudioClass) &&
+ (Interface->SubClass == AUDIO_CSCP_AudioStreamingSubclass) &&
+ (Interface->Protocol == AUDIO_CSCP_StreamingProtocol))
+ {
+ return DESCRIPTOR_SEARCH_Found;
+ }
+ }
+
+ return DESCRIPTOR_SEARCH_NotFound;
+}
+
+/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
+ * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
+ * descriptor processing if an incompatible descriptor configuration is found.
+ *
+ * This comparator searches for the next Isochronous Endpoint descriptor within the current interface, aborting the
+ * search if another interface descriptor is found before the next endpoint.
+ *
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ */
+uint8_t DComp_NextAudioInterfaceDataEndpoint(void* CurrentDescriptor)
+{
+ USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+ if (Header->Type == DTYPE_Endpoint)
+ {
+ USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
+
+ if ((Endpoint->Attributes & EP_TYPE_MASK) == EP_TYPE_ISOCHRONOUS)
+ return DESCRIPTOR_SEARCH_Found;
+ }
+ else if (Header->Type == DTYPE_Interface)
+ {
+ return DESCRIPTOR_SEARCH_Fail;
+ }
+
+ return DESCRIPTOR_SEARCH_NotFound;
+}
+
projects / pub / USBasp.git / blobdiff