Enhance the HotmailNotifier project so that the LEDs' individual brightness can be...

[pub/USBasp.git] / Demos / Host / LowLevel / PrinterHost / ConfigDescriptor.c

diff --git a/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.c b/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.c
index 22d84c5..41df460 100644 (file)
--- a/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.c
+++ b/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.c
@@ -30,19 +30,29 @@
 \r
 #include "ConfigDescriptor.h"\r
 \r
+/** Interface number for the bidirectional Printer interface found within the device. */\r
 uint8_t PrinterInterfaceNumber;\r
-uint8_t PrinterAltSetting;\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
-       uint8_t* CurrConfigLocation = ConfigDescriptorData;\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_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))\r
+       switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))\r
        {\r
                case HOST_GETCONFIG_Successful:\r
                        break;\r
@@ -61,20 +71,20 @@ uint8_t ProcessConfigurationDescriptor(void)
                return NoInterfaceFound;\r
        }\r
        \r
-       PrinterInterfaceNumber = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber;\r
-       PrinterAltSetting      = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).AlternateSetting;\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_NextInterfaceBulkDataEndpoint))\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(ConfigDescriptorData, USB_Descriptor_Endpoint_t);\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
@@ -105,10 +115,17 @@ uint8_t ProcessConfigurationDescriptor(void)
        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
-       /* PURPOSE: Find next bidirectional protocol printer 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
@@ -123,10 +140,17 @@ uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor)
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r
-uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor)\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
-       /* 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