Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / ConfigDescriptor.c

diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
index b5d98c0..c9510da 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
+++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  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.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -46,7 +46,7 @@ uint8_t USB_Host_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const
                        .wIndex        = 0,
                        .wLength       = sizeof(USB_Descriptor_Configuration_Header_t),
                };
                        .wIndex        = 0,
                        .wLength       = sizeof(USB_Descriptor_Configuration_Header_t),
                };

-       
+

        Pipe_SelectPipe(PIPE_CONTROLPIPE);
 
        if ((ErrorCode = USB_Host_SendControlRequest(ConfigHeader)) != HOST_SENDCONTROL_Successful)
        Pipe_SelectPipe(PIPE_CONTROLPIPE);
 
        if ((ErrorCode = USB_Host_SendControlRequest(ConfigHeader)) != HOST_SENDCONTROL_Successful)


@@ -56,15 +56,15 @@ uint8_t USB_Host_GetDeviceConfigDescriptor(uint8_t ConfigNumber, uint16_t* const
 
        if (*ConfigSizePtr > BufferSize)
          return HOST_GETCONFIG_BuffOverflow;
 
        if (*ConfigSizePtr > BufferSize)
          return HOST_GETCONFIG_BuffOverflow;

-         
+

        USB_ControlRequest.wLength = *ConfigSizePtr;
        USB_ControlRequest.wLength = *ConfigSizePtr;

-       
+

        if ((ErrorCode = USB_Host_SendControlRequest(BufferPtr)) != HOST_SENDCONTROL_Successful)
          return ErrorCode;
 
        if (DESCRIPTOR_TYPE(BufferPtr) != DTYPE_Configuration)
          return HOST_GETCONFIG_InvalidData;
        if ((ErrorCode = USB_Host_SendControlRequest(BufferPtr)) != HOST_SENDCONTROL_Successful)
          return ErrorCode;
 
        if (DESCRIPTOR_TYPE(BufferPtr) != DTYPE_Configuration)
          return HOST_GETCONFIG_InvalidData;

-       
+

        return HOST_GETCONFIG_Successful;
 }
 #endif
        return HOST_GETCONFIG_Successful;
 }
 #endif


@@ -75,7 +75,7 @@ void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
 {
        while (*BytesRem)
        {
 {
        while (*BytesRem)
        {

-               USB_GetNextDescriptor(BytesRem, CurrConfigLoc);   
+               USB_GetNextDescriptor(BytesRem, CurrConfigLoc);

 
                if (DESCRIPTOR_TYPE(*CurrConfigLoc) == Type)
                  return;
 
                if (DESCRIPTOR_TYPE(*CurrConfigLoc) == Type)
                  return;


@@ -109,22 +109,22 @@ void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
                                       const uint8_t AfterType)
 {
        USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, AfterType);
                                       const uint8_t AfterType)
 {
        USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, AfterType);

-       
+

        if (*BytesRem)
          USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, Type);
 }
        if (*BytesRem)
          USB_GetNextDescriptorOfType(BytesRem, CurrConfigLoc, Type);
 }

-                       
+

 uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem, void** const CurrConfigLoc, ConfigComparatorPtr_t const ComparatorRoutine)
 {
        uint8_t ErrorCode;
 uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem, void** const CurrConfigLoc, ConfigComparatorPtr_t const ComparatorRoutine)
 {
        uint8_t ErrorCode;

-               
+

        while (*BytesRem)
        {
                uint8_t* PrevDescLoc  = *CurrConfigLoc;
                uint16_t PrevBytesRem = *BytesRem;
 
                USB_GetNextDescriptor(BytesRem, CurrConfigLoc);
        while (*BytesRem)
        {
                uint8_t* PrevDescLoc  = *CurrConfigLoc;
                uint16_t PrevBytesRem = *BytesRem;
 
                USB_GetNextDescriptor(BytesRem, CurrConfigLoc);

-                               
+

                if ((ErrorCode = ComparatorRoutine(*CurrConfigLoc)) != DESCRIPTOR_SEARCH_NotFound)
                {
                        if (ErrorCode == DESCRIPTOR_SEARCH_Fail)
                if ((ErrorCode = ComparatorRoutine(*CurrConfigLoc)) != DESCRIPTOR_SEARCH_NotFound)
                {
                        if (ErrorCode == DESCRIPTOR_SEARCH_Fail)


@@ -132,10 +132,11 @@ uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem, void** const CurrCon
                                *CurrConfigLoc = PrevDescLoc;
                                *BytesRem      = PrevBytesRem;
                        }
                                *CurrConfigLoc = PrevDescLoc;
                                *BytesRem      = PrevBytesRem;
                        }

-               
+

                        return ErrorCode;
                }
        }
                        return ErrorCode;
                }
        }

-       
+

        return DESCRIPTOR_SEARCH_COMP_EndOfDescriptor;
 }
        return DESCRIPTOR_SEARCH_COMP_EndOfDescriptor;
 }

+