projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
More updates to remove architecture-specific comments from the documentation, alter...
[pub/USBasp.git] / Bootloaders / DFU / Descriptors.c
diff --git a/Bootloaders/DFU/Descriptors.c b/Bootloaders/DFU/Descriptors.c
index 1e9ec45..55449c6 100644 (file)
--- a/Bootloaders/DFU/Descriptors.c
+++ b/Bootloaders/DFU/Descriptors.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   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 2011  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
@@ -30,99 +30,99 @@
 
 /** \file
  *
 
 /** \file
  *
- *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
+ *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  *  computer-readable structures which the host requests upon device enumeration, to determine
  *  computer-readable structures which the host requests upon device enumeration, to determine
- *  the device's capabilities and functions.  
+ *  the device's capabilities and functions.
  */
 
 #include "Descriptors.h"
 
  */
 
 #include "Descriptors.h"
 
-/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
+/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall
  *  device characteristics, including the supported USB version, control endpoint size and the
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
  *  device characteristics, including the supported USB version, control endpoint size and the
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
-USB_Descriptor_Device_t DeviceDescriptor =
+const USB_Descriptor_Device_t DeviceDescriptor =
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
-               
+
        .USBSpecification       = VERSION_BCD(01.10),
        .USBSpecification       = VERSION_BCD(01.10),
-       .Class                  = 0x00,
-       .SubClass               = 0x00,
-       .Protocol               = 0x00,
-                               
+       .Class                  = USB_CSCP_NoDeviceClass,
+       .SubClass               = USB_CSCP_NoDeviceSubclass,
+       .Protocol               = USB_CSCP_NoDeviceProtocol,
+
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
-               
+
        .VendorID               = 0x03EB,
        .ProductID              = PRODUCT_ID_CODE,
        .VendorID               = 0x03EB,
        .ProductID              = PRODUCT_ID_CODE,
-       .ReleaseNumber          = 0x0000,
-               
+       .ReleaseNumber          = VERSION_BCD(00.00),
+
        .ManufacturerStrIndex   = NO_DESCRIPTOR,
        .ProductStrIndex        = 0x01,
        .SerialNumStrIndex      = NO_DESCRIPTOR,
        .ManufacturerStrIndex   = NO_DESCRIPTOR,
        .ProductStrIndex        = 0x01,
        .SerialNumStrIndex      = NO_DESCRIPTOR,
-               
+
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
-/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
+/** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage
  *  of the device in one of its supported configurations, including information about any device interfaces
  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  *  a configuration so that the host may correctly communicate with the USB device.
  */
  *  of the device in one of its supported configurations, including information about any device interfaces
  *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  *  a configuration so that the host may correctly communicate with the USB device.
  */
-USB_Descriptor_Configuration_t ConfigurationDescriptor =
+const USB_Descriptor_Configuration_t ConfigurationDescriptor =
 {
 {
-       .Config = 
+       .Config =
                {
                {
-                       .Header                   = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
+                       .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
+
+                       .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
+                       .TotalInterfaces        = 1,
+
+                       .ConfigurationNumber    = 1,
+                       .ConfigurationStrIndex  = NO_DESCRIPTOR,
 
 
-                       .TotalConfigurationSize   = sizeof(USB_Descriptor_Configuration_t),
-                       .TotalInterfaces          = 1,
+                       .ConfigAttributes       = USB_CONFIG_ATTR_BUSPOWERED,
 
 
-                       .ConfigurationNumber      = 1,
-                       .ConfigurationStrIndex    = NO_DESCRIPTOR,
-                               
-                       .ConfigAttributes         = USB_CONFIG_ATTR_BUSPOWERED,
-                       
-                       .MaxPowerConsumption      = USB_CONFIG_POWER_MA(100)
+                       .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
                },
                },
-               
-       .DFU_Interface = 
+
+       .DFU_Interface =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 0,
                        .AlternateSetting       = 0,
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 0,
                        .AlternateSetting       = 0,
-                       
+
                        .TotalEndpoints         = 0,
                        .TotalEndpoints         = 0,
-                               
+
                        .Class                  = 0xFE,
                        .SubClass               = 0x01,
                        .Protocol               = 0x02,
 
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
                        .Class                  = 0xFE,
                        .SubClass               = 0x01,
                        .Protocol               = 0x02,
 
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
-               
-       .DFU_Functional = 
+
+       .DFU_Functional =
                {
                {
-                       .Header                 = {.Size = sizeof(USB_DFU_Functional_Descriptor_t), .Type = DTYPE_DFUFunctional},
-                       
+                       .Header                 = {.Size = sizeof(USB_Descriptor_DFU_Functional_t), .Type = DTYPE_DFUFunctional},
+
                        .Attributes             = (ATTR_CAN_UPLOAD | ATTR_CAN_DOWNLOAD),
 
                        .DetachTimeout          = 0x0000,
                        .Attributes             = (ATTR_CAN_UPLOAD | ATTR_CAN_DOWNLOAD),
 
                        .DetachTimeout          = 0x0000,
-                       .TransferSize           = 0x0c00,
-               
+                       .TransferSize           = 0x0C00,
+
                        .DFUSpecification       = VERSION_BCD(01.01)
                }
 };
 
                        .DFUSpecification       = VERSION_BCD(01.01)
                }
 };
 
-/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
+/** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests
  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
  *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
  *  via the language ID table available at USB.org what languages the device supports for its string descriptors.
- */ 
-USB_Descriptor_String_t LanguageString =
+ */
+const USB_Descriptor_String_t LanguageString =
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
-               
+
        .UnicodeString          = {LANGUAGE_ID_ENG}
 };
 
        .UnicodeString          = {LANGUAGE_ID_ENG}
 };
 
@@ -130,10 +130,10 @@ USB_Descriptor_String_t LanguageString =
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t ProductString =
+const USB_Descriptor_String_t ProductString =
 {
        .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 {
        .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
-               
+
        .UnicodeString          = L"AVR DFU Bootloader"
 };
 
        .UnicodeString          = L"AVR DFU Bootloader"
 };
 
@@ -143,39 +143,33 @@ USB_Descriptor_String_t ProductString =
  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  *  USB host.
  */
  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  *  USB host.
  */
-uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
+uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                    const uint8_t wIndex,
+                                    const void** const DescriptorAddress)
 {
 {
-       const uint8_t  DescriptorType   = (wValue >> 8);
-       const uint8_t  DescriptorNumber = (wValue & 0xFF);
+       const uint8_t DescriptorType   = (wValue >> 8);
+       const uint8_t DescriptorNumber = (wValue & 0xFF);
 
 
-       void*    Address = NULL;
-       uint16_t Size    = NO_DESCRIPTOR;
+       const void* Address = NULL;
 
        switch (DescriptorType)
        {
                case DTYPE_Device:
                        Address = &DeviceDescriptor;
 
        switch (DescriptorType)
        {
                case DTYPE_Device:
                        Address = &DeviceDescriptor;
-                       Size    = sizeof(USB_Descriptor_Device_t);
                        break;
                        break;
-               case DTYPE_Configuration: 
+               case DTYPE_Configuration:
                        Address = &ConfigurationDescriptor;
                        Address = &ConfigurationDescriptor;
-                       Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
                        break;
-               case DTYPE_String: 
+               case DTYPE_String:
                        if (!(DescriptorNumber))
                        if (!(DescriptorNumber))
-                       {
-                               Address = &LanguageString;
-                               Size    = LanguageString.Header.Size;
-                       }
+                         Address = &LanguageString;
                        else
                        else
-                       {
-                               Address = &ProductString;
-                               Size    = ProductString.Header.Size;
-                       }
-                       
+                         Address = &ProductString;
+
                        break;
        }
                        break;
        }
-       
+
        *DescriptorAddress = Address;
        *DescriptorAddress = Address;
-       return Size;
+       return (Address != NULL) ? ((USB_Descriptor_Header_t*)Address)->Size : NO_DESCRIPTOR;
 }
 }
+
USB isp AVR programmer