Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / Demos / Host / LowLevel / PrinterHost / ConfigDescriptor.c
index f7fe251..1e0f1be 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\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, 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
-/** Interface number for the bidirectional Printer interface found within the device. */\r
-uint8_t PrinterInterfaceNumber;\r
-\r
-/** Interface Alternate Setting number for the bidirectional Printer interface found within the device. */\r
-uint8_t PrinterAltSetting;\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 bidirectional Printer interface descriptor containing bulk IN and OUT data endpoints.\r
- *\r
- *  \return An error code from the \ref PrinterHost_GetConfigDescriptorDataCodes_t enum.\r
- */\r
-uint8_t ProcessConfigurationDescriptor(void)\r
-{\r
-       uint8_t  ConfigDescriptorData[512];\r
-       void*    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_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
-       /* Get the printer interface from the configuration descriptor */\r
-       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextBidirectionalPrinterInterface))\r
-       {\r
-               /* Descriptor not found, error out */\r
-               return NoInterfaceFound;\r
-       }\r
-       \r
-       PrinterInterfaceNumber = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).InterfaceNumber;\r
-       PrinterAltSetting      = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).AlternateSetting;\r
-\r
-       /* Get the IN and OUT data endpoints for the printer interface */\r
-       while (FoundEndpoints != ((1 << PRINTER_DATA_OUT_PIPE) | (1 << PRINTER_DATA_IN_PIPE)))\r
-       {\r
-               /* Fetch the next bulk endpoint from the current printer interface */\r
-               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextPrinterInterfaceBulkDataEndpoint))\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 IN or bulk OUT endpoint, set appropriate globals */\r
-               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
-               {\r
-                       /* Configure the data IN pipe */\r
-                       Pipe_ConfigurePipe(PRINTER_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,\r
-                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                          PIPE_BANK_SINGLE);\r
-\r
-                       Pipe_SetInfiniteINRequests();\r
-\r
-                       /* Set the flag indicating that the data IN pipe has been found */\r
-                       FoundEndpoints |= (1 << PRINTER_DATA_IN_PIPE);\r
-               }\r
-               else\r
-               {\r
-                       /* Configure the data OUT pipe */\r
-                       Pipe_ConfigurePipe(PRINTER_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 << PRINTER_DATA_OUT_PIPE);\r
-               }               \r
-       }\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 Bidirectional Printer Interface descriptor of the current Printer interface,\r
- *  aborting the search if the end of the descriptors is found.\r
- *\r
- *  \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor)\r
-{\r
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-       {\r
-               /* Check the descriptor class and protocol, break out if correct class/protocol interface found */\r
-               if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == PRINTER_CLASS)    &&\r
-                   (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == PRINTER_SUBCLASS) &&\r
-                       (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == PRINTER_PROTOCOL))\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 Bulk Endpoint descriptor of the current Printer 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_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor)\r
-{\r
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
-       {\r
-               uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,\r
-                                                       USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);\r
-\r
-               /* Check the endpoint type, break out if correct BULK type endpoint found */\r
-               if (EndpointType == EP_TYPE_BULK)\r
-                 return DESCRIPTOR_SEARCH_Found;\r
-       }\r
-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-       {\r
-               return DESCRIPTOR_SEARCH_Fail;\r
-       }\r
-\r
-       return DESCRIPTOR_SEARCH_NotFound;\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.
+*/
+
+#include "ConfigDescriptor.h"
+
+/** Interface number for the bidirectional Printer interface found within the device. */
+uint8_t PrinterInterfaceNumber;
+
+/** Interface Alternate Setting number for the bidirectional Printer interface found within the device. */
+uint8_t PrinterAltSetting;
+
+/** 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 bidirectional Printer interface descriptor containing bulk IN and OUT data endpoints.
+ *
+ *  \return An error code from the \ref PrinterHost_GetConfigDescriptorDataCodes_t enum.
+ */
+uint8_t ProcessConfigurationDescriptor(void)
+{
+       uint8_t  ConfigDescriptorData[512];
+       void*    CurrConfigLocation = ConfigDescriptorData;
+       uint16_t CurrConfigBytesRem;
+       uint8_t  FoundEndpoints = 0;
+
+       /* 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;
+       }
+       
+       /* Get the printer interface from the configuration descriptor */
+       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextBidirectionalPrinterInterface))
+       {
+               /* Descriptor not found, error out */
+               return NoInterfaceFound;
+       }
+       
+       PrinterInterfaceNumber = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).InterfaceNumber;
+       PrinterAltSetting      = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).AlternateSetting;
+
+       /* Get the IN and OUT data endpoints for the printer interface */
+       while (FoundEndpoints != ((1 << PRINTER_DATA_OUT_PIPE) | (1 << PRINTER_DATA_IN_PIPE)))
+       {
+               /* Fetch the next bulk endpoint from the current printer interface */
+               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextPrinterInterfaceBulkDataEndpoint))
+               {
+                       /* Descriptor not found, error out */
+                       return NoEndpointFound;
+               }
+               
+               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
+
+               /* Check if the endpoint is a bulk IN or bulk OUT endpoint, set appropriate globals */
+               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
+               {
+                       /* Configure the data IN pipe */
+                       Pipe_ConfigurePipe(PRINTER_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,
+                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,
+                                          PIPE_BANK_SINGLE);
+
+                       Pipe_SetInfiniteINRequests();
+
+                       /* Set the flag indicating that the data IN pipe has been found */
+                       FoundEndpoints |= (1 << PRINTER_DATA_IN_PIPE);
+               }
+               else
+               {
+                       /* Configure the data OUT pipe */
+                       Pipe_ConfigurePipe(PRINTER_DATA_OUT_PIPE, EP_TYPE_BULK, PIPE_TOKEN_OUT,
+                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,
+                                          PIPE_BANK_SINGLE);
+
+                       /* Set the flag indicating that the data OUT pipe has been found */
+                       FoundEndpoints |= (1 << PRINTER_DATA_OUT_PIPE);
+               }               
+       }
+
+       /* 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 Bidirectional Printer Interface descriptor of the current Printer interface,
+ *  aborting the search if the end of the descriptors is found.
+ *
+ *  \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ */
+uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor)
+{
+       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       {
+               /* Check the descriptor class and protocol, break out if correct class/protocol interface found */
+               if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == PRINTER_CLASS)    &&
+                   (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == PRINTER_SUBCLASS) &&
+                       (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == PRINTER_PROTOCOL))
+               {
+                       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 Bulk Endpoint descriptor of the current Printer 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_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor)
+{
+       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
+       {
+               uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,
+                                                       USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);
+
+               /* Check the endpoint type, break out if correct BULK type endpoint found */
+               if (EndpointType == EP_TYPE_BULK)
+                 return DESCRIPTOR_SEARCH_Found;
+       }
+       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       {
+               return DESCRIPTOR_SEARCH_Fail;
+       }
+
+       return DESCRIPTOR_SEARCH_NotFound;
+}