Clean up excessive whitespace at the end of each line using the wspurify tool made...
[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StdDescriptors.h
index 00b60c3..2a87619 100644 (file)
@@ -1,7 +1,7 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
-              
+
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
@@ -9,13 +9,13 @@
 /*
   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
@@ -45,7 +45,7 @@
  *
  *  @{
  */
  *
  *  @{
  */
+
 #ifndef __USBDESCRIPTORS_H__
 #define __USBDESCRIPTORS_H__
 
 #ifndef __USBDESCRIPTORS_H__
 #define __USBDESCRIPTORS_H__
 
@@ -58,7 +58,7 @@
                #include "../../../Common/Common.h"
                #include "USBMode.h"
                #include "Events.h"
                #include "../../../Common/Common.h"
                #include "USBMode.h"
                #include "Events.h"
-               
+
                #if defined(USB_CAN_BE_DEVICE)
                        #include "../LowLevel/Device.h"
                #endif
                #if defined(USB_CAN_BE_DEVICE)
                        #include "../LowLevel/Device.h"
                #endif
@@ -72,7 +72,7 @@
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
-               
+
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Indicates that a given descriptor does not exist in the device. This can be used inside descriptors
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Indicates that a given descriptor does not exist in the device. This can be used inside descriptors
@@ -98,7 +98,7 @@
                        #else
                                #define USE_INTERNAL_SERIAL           NO_DESCRIPTOR
                        #endif
                        #else
                                #define USE_INTERNAL_SERIAL           NO_DESCRIPTOR
                        #endif
-                       
+
                        /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamperes. */
                        #define USB_CONFIG_POWER_MA(mA)           ((mA) >> 1)
 
                        /** Macro to calculate the power value for the configuration descriptor, from a given number of milliamperes. */
                        #define USB_CONFIG_POWER_MA(mA)           ((mA) >> 1)
 
                         *  Should be used in string descriptor's headers for giving the string descriptor's byte length.
                         */
                        #define USB_STRING_LEN(str)               (sizeof(USB_Descriptor_Header_t) + ((str) << 1))
                         *  Should be used in string descriptor's headers for giving the string descriptor's byte length.
                         */
                        #define USB_STRING_LEN(str)               (sizeof(USB_Descriptor_Header_t) + ((str) << 1))
-                       
+
                        /** Macro to encode a given four digit floating point version number (e.g. 01.23) into Binary Coded
                         *  Decimal format for descriptor fields requiring BCD encoding, such as the USB version number in the
                         *  standard device descriptor.
                        /** Macro to encode a given four digit floating point version number (e.g. 01.23) into Binary Coded
                         *  Decimal format for descriptor fields requiring BCD encoding, such as the USB version number in the
                         *  standard device descriptor.
                         *  EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from
                         *  host to device).
                         */
                         *  EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from
                         *  host to device).
                         */
-                       #define ENDPOINT_DESCRIPTOR_DIR_OUT       0x00          
+                       #define ENDPOINT_DESCRIPTOR_DIR_OUT       0x00
 
                        /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t
                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power
 
                        /** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t
                         *  descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power
                         *  \see The USB specification for more details on the possible Endpoint attributes.
                         */
                        #define ENDPOINT_ATTR_SYNC                (3 << 2)
                         *  \see The USB specification for more details on the possible Endpoint attributes.
                         */
                        #define ENDPOINT_ATTR_SYNC                (3 << 2)
-                       
+
                        /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's
                         *  Attributes value to indicate that the specified endpoint is used for data transfers.
                         *
                        /** Can be masked with other endpoint descriptor attributes for a \ref USB_Descriptor_Endpoint_t descriptor's
                         *  Attributes value to indicate that the specified endpoint is used for data transfers.
                         *
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.
                         */
                        #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK  (2 << 4)
                         *  \see The USB specification for more details on the possible Endpoint usage attributes.
                         */
                        #define ENDPOINT_USAGE_IMPLICIT_FEEDBACK  (2 << 4)
-                       
+
                /* Enums: */
                        /** Enum for the possible standard descriptor types, as given in each descriptor's header. */
                        enum USB_DescriptorTypes_t
                /* Enums: */
                        /** Enum for the possible standard descriptor types, as given in each descriptor's header. */
                        enum USB_DescriptorTypes_t
                                               *   given by the specific class.
                                               */
                        } USB_Descriptor_Header_t;
                                               *   given by the specific class.
                                               */
                        } USB_Descriptor_Header_t;
-                       
+
                        /** \brief Standard USB Descriptor Header (USB-IF naming conventions).
                         *
                         *  Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
                        /** \brief Standard USB Descriptor Header (USB-IF naming conventions).
                         *
                         *  Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
                                                          *   given by the specific class.
                                                          */
                        } USB_StdDescriptor_Header_t;
                                                          *   given by the specific class.
                                                          */
                        } USB_StdDescriptor_Header_t;
-                       
+
                        /** \brief Standard USB Device Descriptor (LUFA naming conventions).
                         *
                         *  Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
                        /** \brief Standard USB Device Descriptor (LUFA naming conventions).
                         *
                         *  Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */
                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */
-                               
+
                                uint8_t  Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in bytes. */
                                uint8_t  Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in bytes. */
-                               
+
                                uint16_t VendorID; /**< Vendor ID for the USB product. */
                                uint16_t ProductID; /**< Unique product ID for the USB product. */
                                uint16_t ReleaseNumber; /**< Product release (version) number. */
                                uint16_t VendorID; /**< Vendor ID for the USB product. */
                                uint16_t ProductID; /**< Unique product ID for the USB product. */
                                uint16_t ReleaseNumber; /**< Product release (version) number. */
-                               
+
                                uint8_t  ManufacturerStrIndex; /**< String index for the manufacturer's name. The
                                                                *   host will request this string via a separate
                                                                *   control request for the string descriptor.
                                uint8_t  ManufacturerStrIndex; /**< String index for the manufacturer's name. The
                                                                *   host will request this string via a separate
                                                                *   control request for the string descriptor.
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
-                       
+
                                uint16_t TotalConfigurationSize; /**< Size of the configuration descriptor header,
                                                                  *   and all sub descriptors inside the configuration.
                                                                  */
                                uint16_t TotalConfigurationSize; /**< Size of the configuration descriptor header,
                                                                  *   and all sub descriptors inside the configuration.
                                                                  */
 
                                uint8_t  ConfigurationNumber; /**< Configuration index of the current configuration. */
                                uint8_t  ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */
 
                                uint8_t  ConfigurationNumber; /**< Configuration index of the current configuration. */
                                uint8_t  ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */
-                               
+
                                uint8_t  ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or
                                                            *   more USB_CONFIG_ATTR_* masks.
                                                            */
                                uint8_t  ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or
                                                            *   more USB_CONFIG_ATTR_* masks.
                                                            */
-                               
+
                                uint8_t  MaxPowerConsumption; /**< Maximum power consumption of the device while in the
                                                               *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()
                                                               *   macro.
                                                               */
                        } USB_Descriptor_Configuration_Header_t;
                                uint8_t  MaxPowerConsumption; /**< Maximum power consumption of the device while in the
                                                               *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()
                                                               *   macro.
                                                               */
                        } USB_Descriptor_Configuration_Header_t;
-                       
+
                        /** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
                        /** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
                                                           *   selected by the host.
                                                           */
                                uint8_t TotalEndpoints; /**< Total number of endpoints in the interface. */
                                                           *   selected by the host.
                                                           */
                                uint8_t TotalEndpoints; /**< Total number of endpoints in the interface. */
-                               
+
                                uint8_t Class; /**< Interface class ID. */
                                uint8_t SubClass; /**< Interface subclass ID. */
                                uint8_t Protocol; /**< Interface protocol ID. */
 
                                uint8_t InterfaceStrIndex; /**< Index of the string descriptor describing the interface. */
                        } USB_Descriptor_Interface_t;
                                uint8_t Class; /**< Interface class ID. */
                                uint8_t SubClass; /**< Interface subclass ID. */
                                uint8_t Protocol; /**< Interface protocol ID. */
 
                                uint8_t InterfaceStrIndex; /**< Index of the string descriptor describing the interface. */
                        } USB_Descriptor_Interface_t;
-                       
+
                        /** \brief Standard USB Interface Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
                        /** \brief Standard USB Interface Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
-                               
+
                                uint8_t FirstInterfaceIndex; /**< Index of the first associated interface. */
                                uint8_t TotalInterfaces; /**< Total number of associated interfaces. */
 
                                uint8_t FirstInterfaceIndex; /**< Index of the first associated interface. */
                                uint8_t TotalInterfaces; /**< Total number of associated interfaces. */
 
                                                      *   interface association.
                                                      */
                        } USB_Descriptor_Interface_Association_t;
                                                      *   interface association.
                                                      */
                        } USB_Descriptor_Interface_Association_t;
-                               
+
                        /** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
                        /** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
                                                             *   or ISOCHRONOUS type.
                                                             */
                        } USB_Descriptor_Endpoint_t;
                                                             *   or ISOCHRONOUS type.
                                                             */
                        } USB_Descriptor_Endpoint_t;
-                               
+
                        /** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
                        /** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).
                         *
                         *  Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
                                                           *   value given by the specific class.
                                                           */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
                                                           *   value given by the specific class.
                                                           */
-                               uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current 
+                               uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
                                                            *   configuration, including direction mask.
                                                            */
                                                            *   configuration, including direction mask.
                                                            */
-                               uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*) 
+                               uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*)
                                                        *   and attributes (ENDPOINT_ATTR_*) masks.
                                                        */
                                uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
                                                        *   and attributes (ENDPOINT_ATTR_*) masks.
                                                        */
                                uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
                        typedef struct
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
-                               
+
                                wchar_t UnicodeString[]; /**< String data, as unicode characters (alternatively,
                                                          *   string language IDs). If normal ASCII characters are
                                                          *   to be used, they must be added as an array of characters
                                wchar_t UnicodeString[]; /**< String data, as unicode characters (alternatively,
                                                          *   string language IDs). If normal ASCII characters are
                                                          *   to be used, they must be added as an array of characters
                        #define VERSION_TENTHS(x)                 (int)(((x) - (int)(x)) * 10)
                        #define VERSION_HUNDREDTHS(x)             (int)((((x) - (int)(x)) * 100) - (10 * VERSION_TENTHS(x)))
        #endif
                        #define VERSION_TENTHS(x)                 (int)(((x) - (int)(x)) * 10)
                        #define VERSION_HUNDREDTHS(x)             (int)((((x) - (int)(x)) * 100) - (10 * VERSION_TENTHS(x)))
        #endif
-       
+
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
-       
+
 #endif
 
 /** @} */
 #endif
 
 /** @} */
+