Minor documentation improvements.

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

diff --git a/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.c b/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.c
index 8a808d7..56aa116 100644 (file)
--- a/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.c
+++ b/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.c
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2013.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   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 
+  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.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims 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
   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


@@ -34,7 +34,7 @@
  *  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.
  */
  *  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
 #include "ConfigDescriptor.h"
 
 /** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This


@@ -50,7 +50,10 @@ uint8_t ProcessConfigurationDescriptor(void)
        uint8_t  ConfigDescriptorData[512];
        void*    CurrConfigLocation = ConfigDescriptorData;
        uint16_t CurrConfigBytesRem;
        uint8_t  ConfigDescriptorData[512];
        void*    CurrConfigLocation = ConfigDescriptorData;
        uint16_t CurrConfigBytesRem;

-       uint8_t  FoundEndpoints     = 0;
+
+       USB_Descriptor_Interface_t* MSInterface     = NULL;
+       USB_Descriptor_Endpoint_t*  DataINEndpoint  = NULL;
+       USB_Descriptor_Endpoint_t*  DataOUTEndpoint = NULL;

 
        /* Retrieve the entire configuration descriptor into the allocated buffer */
        switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))
 
        /* Retrieve the entire configuration descriptor into the allocated buffer */
        switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))


@@ -64,51 +67,49 @@ uint8_t ProcessConfigurationDescriptor(void)
                default:
                        return ControlError;
        }
                default:
                        return ControlError;
        }

-       
-       /* Get the mass storage interface from the configuration descriptor */
-       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
-                                     DComp_NextMSInterface) != DESCRIPTOR_SEARCH_COMP_Found)
-       {
-               /* Descriptor not found, error out */
-               return NoInterfaceFound;
-       }

 
 

-       /* Get the IN and OUT data endpoints for the mass storage interface */
-       while (FoundEndpoints != ((1 << MASS_STORE_DATA_IN_PIPE) | (1 << MASS_STORE_DATA_OUT_PIPE)))
+       while (!(DataINEndpoint) || !(DataOUTEndpoint))

        {
        {

-               /* Fetch the next bulk endpoint from the current mass storage interface */
-               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+               /* See if we've found a likely compatible interface, and if there is an endpoint within that interface */
+               if (!(MSInterface) ||
+                   USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,

                                              DComp_NextMSInterfaceBulkDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
                {
                                              DComp_NextMSInterfaceBulkDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
                {

-                       /* Descriptor not found, error out */
-                       return NoEndpointFound;
-               }
-               
-               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
+                       /* Get the next Mass Storage interface from the configuration descriptor */
+                       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+                                                                                 DComp_NextMSInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+                       {
+                               /* Descriptor not found, error out */
+                               return NoCompatibleInterfaceFound;
+                       }

 
 

-               /* 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(MASS_STORE_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN,
-                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,
-                                          PIPE_BANK_DOUBLE);
+                       /* Save the interface in case we need to refer back to it later */
+                       MSInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);

 
 

-                       /* Set the flag indicating that the data IN pipe has been found */
-                       FoundEndpoints |= (1 << MASS_STORE_DATA_IN_PIPE);
+                       /* Clear any found endpoints */
+                       DataINEndpoint  = NULL;
+                       DataOUTEndpoint = NULL;
+
+                       /* Skip the remainder of the loop as we have not found an endpoint yet */
+                       continue;

                }
                }

+
+               /* 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_DIR_MASK) == ENDPOINT_DIR_IN)
+                 DataINEndpoint  = EndpointData;

                else
                else

-               {
-                       /* Configure the data OUT pipe */
-                       Pipe_ConfigurePipe(MASS_STORE_DATA_OUT_PIPE, EP_TYPE_BULK, PIPE_TOKEN_OUT,
-                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,
-                                          PIPE_BANK_DOUBLE);
-
-                       /* Set the flag indicating that the data OUT pipe has been found */
-                       FoundEndpoints |= (1 << MASS_STORE_DATA_OUT_PIPE);
-               }               
+                 DataOUTEndpoint = EndpointData;

        }
 
        }
 

+       /* Configure the Mass Storage data IN pipe */
+       Pipe_ConfigurePipe(MASS_STORE_DATA_IN_PIPE, EP_TYPE_BULK, DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, 1);
+
+       /* Configure the Mass Storage data OUT pipe */
+       Pipe_ConfigurePipe(MASS_STORE_DATA_OUT_PIPE, EP_TYPE_BULK, DataOUTEndpoint->EndpointAddress, DataOUTEndpoint->EndpointSize, 1);
+

        /* Valid data found, return success */
        return SuccessfulConfigRead;
 }
        /* Valid data found, return success */
        return SuccessfulConfigRead;
 }


@@ -123,17 +124,21 @@ uint8_t ProcessConfigurationDescriptor(void)
  */
 uint8_t DComp_NextMSInterface(void* CurrentDescriptor)
 {
  */
 uint8_t DComp_NextMSInterface(void* CurrentDescriptor)
 {

-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Interface)

        {
        {

+               USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
+

                /* Check the descriptor class and protocol, break out if correct class/protocol interface found */
                /* Check the descriptor class and protocol, break out if correct class/protocol interface found */

-               if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class    == MASS_STORE_CLASS)    &&
-                   (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == MASS_STORE_SUBCLASS) &&
-                   (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == MASS_STORE_PROTOCOL))
+               if ((Interface->Class    == MASS_STORE_CLASS)    &&
+                   (Interface->SubClass == MASS_STORE_SUBCLASS) &&
+                   (Interface->Protocol == MASS_STORE_PROTOCOL))

                {
                        return DESCRIPTOR_SEARCH_Found;
                }
        }
                {
                        return DESCRIPTOR_SEARCH_Found;
                }
        }

-       
+

        return DESCRIPTOR_SEARCH_NotFound;
 }
 
        return DESCRIPTOR_SEARCH_NotFound;
 }
 


@@ -148,19 +153,21 @@ uint8_t DComp_NextMSInterface(void* CurrentDescriptor)
  */
 uint8_t DComp_NextMSInterfaceBulkDataEndpoint(void* CurrentDescriptor)
 {
  */
 uint8_t DComp_NextMSInterfaceBulkDataEndpoint(void* CurrentDescriptor)
 {

-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Endpoint)

        {
        {

-               uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,
-                                                       USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);
+               USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);

 
                /* Check the endpoint type, break out if correct BULK type endpoint found */
 
                /* Check the endpoint type, break out if correct BULK type endpoint found */

-               if (EndpointType == EP_TYPE_BULK)
+               if ((Endpoint->Attributes & EP_TYPE_MASK) == EP_TYPE_BULK)

                  return DESCRIPTOR_SEARCH_Found;
        }
                  return DESCRIPTOR_SEARCH_Found;
        }

-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       else if (Header->Type == DTYPE_Interface)

        {
                return DESCRIPTOR_SEARCH_Fail;
        }
 
        return DESCRIPTOR_SEARCH_NotFound;
 }
        {
                return DESCRIPTOR_SEARCH_Fail;
        }
 
        return DESCRIPTOR_SEARCH_NotFound;
 }

+