Remove USB_MODE_* macros, replace with a semantically linked USB_Modes_t enum.
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / ConfigDescriptor.c
index 487cac6..cc75703 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-  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
-#include "ConfigDescriptor.h"\r
-\r
-uint8_t ProcessConfigurationDescriptor(void)\r
-{\r
-       uint8_t  ConfigDescriptorData[512];\r
-       uint8_t* CurrConfigLocation = ConfigDescriptorData;\r
-       uint16_t CurrConfigBytesRem;\r
-       uint8_t  FoundEndpoints = 0;\r
-\r
-       /* Retrieve the entire configuration descriptor into the allocated buffer */\r
-       switch (USB_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 ControlErrorDuringConfigRead;\r
-       }\r
-       \r
-       /* The bluetooth USB transport addendium mandates that the data (not streaming voice) 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 NoInterfaceFound;\r
-\r
-       /* Get the data IN, data OUT and event notification endpoints for the bluetooth interface */\r
-       while (FoundEndpoints != ((1 << BLUETOOTH_DATA_IN_PIPE) | (1 << BLUETOOTH_DATA_OUT_PIPE) |\r
-                                 (1 << BLUETOOTH_EVENTS_PIPE)))\r
-       {\r
-               /* Fetch the next endpoint from the current bluetooth interface */\r
-               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
-                                             NextInterfaceBluetoothDataEndpoint))\r
-               {\r
-                       /* Descriptor not found, error out */\r
-                       return NoEndpointFound;\r
-               }\r
-               \r
-               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);\r
-\r
-               /* Check if the endpoint is a bulk or interrupt type endpoint */\r
-               if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)\r
-               {\r
-                       if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
-                       {\r
-                               /* Configure the events IN pipe */\r
-                               Pipe_ConfigurePipe(BLUETOOTH_EVENTS_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r
-                                                                  EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                                                  PIPE_BANK_SINGLE);\r
-\r
-                               Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);\r
-                               \r
-                               /* Set the flag indicating that the events notification pipe has been found */\r
-                               FoundEndpoints |= (1 << BLUETOOTH_EVENTS_PIPE); \r
-                       }\r
-               }\r
-               else\r
-               {\r
-                       if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
-                       {\r
-                               /* Configure the data IN pipe */\r
-                               Pipe_ConfigurePipe(BLUETOOTH_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,\r
-                                                                  EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                                                  PIPE_BANK_SINGLE);\r
-\r
-                               /* Set the flag indicating that the data IN pipe has been found */\r
-                               FoundEndpoints |= (1 << BLUETOOTH_DATA_IN_PIPE);\r
-                       }\r
-                       else\r
-                       {\r
-                               /* Configure the data OUT pipe */\r
-                               Pipe_ConfigurePipe(BLUETOOTH_DATA_OUT_PIPE, EP_TYPE_BULK, PIPE_TOKEN_OUT,\r
-                                                                  EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                                                  PIPE_BANK_SINGLE);\r
-\r
-                               /* Set the flag indicating that the data OUT pipe has been found */\r
-                               FoundEndpoints |= (1 << BLUETOOTH_DATA_OUT_PIPE);\r
-                       }               \r
-               }\r
-\r
-       }\r
-\r
-       /* Valid data found, return success */\r
-       return SuccessfulConfigRead;\r
-}\r
-\r
-uint8_t NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor)\r
-{\r
-       /* PURPOSE: Find next interface endpoint descriptor before next interface descriptor */\r
-\r
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
-         return DESCRIPTOR_SEARCH_Found;\r
-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-         return DESCRIPTOR_SEARCH_Fail;\r
-\r
-       return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  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"
+
+/** 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 BT interface descriptor containing bulk IN and OUT data endpoints.
+ *
+ *  \return An error code from the \ref BluetoothHost_GetConfigDescriptorDataCodes_t enum.
+ */
+uint8_t ProcessConfigurationDescriptor(void)
+{
+       uint8_t  ConfigDescriptorData[512];
+       void*    CurrConfigLocation = ConfigDescriptorData;
+       uint16_t CurrConfigBytesRem;
+       
+       USB_Descriptor_Endpoint_t* DataINEndpoint  = NULL;
+       USB_Descriptor_Endpoint_t* DataOUTEndpoint = NULL;
+       USB_Descriptor_Endpoint_t* EventsEndpoint  = 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 DevControlError;
+       }
+       
+       /* The Bluetooth USB transport addendum mandates that the data (not streaming voice) endpoints
+          be in the first interface descriptor (interface 0) */
+       USB_GetNextDescriptorOfType(&CurrConfigBytesRem, &CurrConfigLocation, DTYPE_Interface);
+       
+       /* Ensure that an interface was found, and the end of the descriptor was not reached */
+       if (!(CurrConfigBytesRem))
+         return NoCompatibleInterfaceFound;
+
+       while (!(DataINEndpoint) || !(DataOUTEndpoint))
+       {
+               /* Get the next Still Image interface's data endpoint descriptor */
+               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+                                             DComp_NextInterfaceBluetoothDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
+               {
+                       /* Data endpoints not found within the first bluetooth device interface, error out */
+                       return NoCompatibleInterfaceFound;
+               }
+
+               /* Retrieve the endpoint address from the endpoint descriptor */
+               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
+
+               /* If the endpoint is a IN type endpoint */
+               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
+               {
+                       /* Check if the found endpoint is a interrupt or bulk type descriptor */
+                       if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
+                         EventsEndpoint = EndpointData;
+                       else
+                         DataINEndpoint = EndpointData;
+               }
+               else
+               {
+                       DataOUTEndpoint = EndpointData;
+               }
+       }
+       
+       /* Configure the Bluetooth data IN pipe */
+       Pipe_ConfigurePipe(BLUETOOTH_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,
+                          DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, PIPE_BANK_SINGLE);
+
+       /* Configure the Bluetooth data OUT pipe */
+       Pipe_ConfigurePipe(BLUETOOTH_DATA_OUT_PIPE, EP_TYPE_BULK, PIPE_TOKEN_OUT,
+                                          DataOUTEndpoint->EndpointAddress, DataOUTEndpoint->EndpointSize, PIPE_BANK_SINGLE);
+
+       /* Configure the Bluetooth events pipe */
+       Pipe_ConfigurePipe(BLUETOOTH_EVENTS_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
+                                          EventsEndpoint->EndpointAddress, EventsEndpoint->EndpointSize, PIPE_BANK_SINGLE);
+       Pipe_SetInterruptPeriod(EventsEndpoint->PollingIntervalMS);
+
+       /* 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 Endpoint descriptor inside the current interface descriptor, aborting the 
+ *  search if another interface descriptor is found before the required endpoint.
+ *
+ *  \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ */
+uint8_t DComp_NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor)
+{
+       /* Determine the type of the current descriptor */
+       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
+         return DESCRIPTOR_SEARCH_Found;
+       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+         return DESCRIPTOR_SEARCH_Fail;
+       else
+         return DESCRIPTOR_SEARCH_NotFound;
+}
+