Added incomplete PrinterHost demo application.
[pub/lufa.git] / Demos / Host / Incomplete / PrinterHost / ConfigDescriptor.c
diff --git a/Demos/Host/Incomplete/PrinterHost/ConfigDescriptor.c b/Demos/Host/Incomplete/PrinterHost/ConfigDescriptor.c
new file mode 100644 (file)
index 0000000..ed4bdb9
--- /dev/null
@@ -0,0 +1,162 @@
+/*\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;\r
+       uint16_t ConfigDescriptorSize;\r
+       uint8_t  ErrorCode;\r
+       uint8_t  FoundEndpoints = 0;\r
+       uint8_t  FoundEndpointMask;\r
+       \r
+       /* Get Configuration Descriptor size from the device */\r
+       if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
+         return ControlError;\r
+       \r
+       /* Ensure that the Configuration Descriptor isn't too large */\r
+       if (ConfigDescriptorSize > MAX_CONFIG_DESCRIPTOR_SIZE)\r
+         return DescriptorTooLarge;\r
+         \r
+       /* Allocate enough memory for the entire config descriptor */\r
+       ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
+\r
+       /* Retrieve the entire configuration descriptor into the allocated buffer */\r
+       USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData);\r
+       \r
+       /* Validate returned data - ensure first entry is a configuration header descriptor */\r
+       if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
+         return InvalidConfigDataReturned;\r
+       \r
+       /* Get the printer interface from the configuration descriptor */\r
+       if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+                                                  NextPrinterInterface)))\r
+       {\r
+               /* Descriptor not found, error out */\r
+               return NoInterfaceFound;\r
+       }\r
+\r
+       /* Get the printer's communication protocol */\r
+       PrinterProtocol = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).Protocol;\r
+       \r
+       /* Determine what endpoints to look for from the protocol */\r
+       switch (PrinterProtocol)\r
+       {\r
+               case PROTOCOL_UNIDIRECTIONAL:\r
+                       FoundEndpointMask = (1 << PRINTER_DATA_OUT_PIPE);\r
+                       break;\r
+               case PROTOCOL_BIDIRECTIONAL:\r
+               case PROTOCOL_IEEE1284:\r
+                       FoundEndpointMask = ((1 << PRINTER_DATA_OUT_PIPE) | (1 << PRINTER_DATA_IN_PIPE));\r
+                       break;\r
+               default:\r
+                       return NoInterfaceFound;\r
+       }\r
+\r
+       /* Get the IN and OUT data endpoints for the mass storage interface */\r
+       while (FoundEndpoints != FoundEndpointMask)\r
+       {\r
+               /* Fetch the next bulk endpoint from the current printer interface */\r
+               if ((ErrorCode = USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+                                                          NextInterfaceBulkDataEndpoint)))\r
+               {\r
+                       /* Descriptor not found, error out */\r
+                       return NoEndpointFound;\r
+               }\r
+               \r
+               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, 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
+uint8_t NextPrinterInterface(void* CurrentDescriptor)\r
+{\r
+       /* PURPOSE: Find next mass storage class interface descriptor */\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
+               {\r
+                       return DESCRIPTOR_SEARCH_Found;\r
+               }\r
+       }\r
+       \r
+       return DESCRIPTOR_SEARCH_NotFound;\r
+}\r
+\r
+uint8_t NextInterfaceBulkDataEndpoint(void* CurrentDescriptor)\r
+{\r
+       /* PURPOSE: Find next interface bulk endpoint descriptor before next interface descriptor */\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