Add incomplete Android Accessory Host LowLevel demo.
[pub/lufa.git] / Demos / Host / Incomplete / AndroidAccessoryHost / ConfigDescriptor.c
diff --git a/Demos/Host/Incomplete/AndroidAccessoryHost/ConfigDescriptor.c b/Demos/Host/Incomplete/AndroidAccessoryHost/ConfigDescriptor.c
new file mode 100644 (file)
index 0000000..6fce72b
--- /dev/null
@@ -0,0 +1,138 @@
+/*\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
+/** 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 the first interface containing bulk IN and OUT data endpoints.\r
+ *\r
+ *  \return An error code from the \ref AndroidHost_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_Endpoint_t* DataINEndpoint  = NULL;\r
+       USB_Descriptor_Endpoint_t* DataOUTEndpoint = 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 DevControlError;\r
+       }\r
+\r
+       /* The Android Accessory Mode specification mandates that the accessory communications endpoints\r
+          be in the first interface descriptor (interface 0) */\r
+       USB_GetNextDescriptorOfType(&CurrConfigBytesRem, &CurrConfigLocation, DTYPE_Interface);\r
+\r
+       /* Ensure that an interface was found, and the end of the descriptor was not reached */\r
+       if (!(CurrConfigBytesRem))\r
+         return NoCompatibleInterfaceFound;\r
+\r
+       while (!(DataINEndpoint) || !(DataOUTEndpoint))\r
+       {\r
+               /* Get the next Still Image interface's data endpoint descriptor */\r
+               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
+                                             DCOMP_NextInterfaceBulkEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
+               {\r
+                       /* Data endpoints not found within the first Android Accessory device interface, error out */\r
+                       return NoCompatibleInterfaceFound;\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
+               /* If the endpoint is a IN type endpoint */\r
+               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
+                 DataINEndpoint = EndpointData;\r
+               else\r
+                 DataOUTEndpoint = EndpointData;\r
+       }\r
+\r
+       /* Configure the Android Accessory data IN pipe */\r
+       Pipe_ConfigurePipe(ANDROID_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,\r
+                          DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, PIPE_BANK_SINGLE);\r
+\r
+       /* Configure the Android Accessory data OUT pipe */\r
+       Pipe_ConfigurePipe(ANDROID_DATA_OUT_PIPE, EP_TYPE_BULK, PIPE_TOKEN_OUT,\r
+                                          DataOUTEndpoint->EndpointAddress, DataOUTEndpoint->EndpointSize, PIPE_BANK_SINGLE);\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 Endpoint descriptor inside the current interface descriptor, aborting the\r
+ *  search if another interface descriptor is found before the required endpoint.\r
+ *\r
+ *  \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+uint8_t DCOMP_NextInterfaceBulkEndpoint(void* const 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
+               uint8_t EndpointType = (Endpoint->Attributes & EP_TYPE_MASK);\r
+               if ((EndpointType == EP_TYPE_BULK) && (!(Pipe_IsEndpointBound(Endpoint->EndpointAddress))))\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
+\r