Fixed incorrect endpoint bank setup on the UC3 architecture (thanks to Andrus Aaslaid).

[pub/USBasp.git] / Projects / AVRISP-MKII / AVRISPDescriptors.c

diff --git a/Projects/AVRISP-MKII/AVRISPDescriptors.c b/Projects/AVRISP-MKII/AVRISPDescriptors.c
index ab30c0e..783e8d8 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISPDescriptors.c
+++ b/Projects/AVRISP-MKII/AVRISPDescriptors.c
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2018.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   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


@@ -37,17 +37,6 @@
 
 #include "AVRISPDescriptors.h"
 
 
 #include "AVRISPDescriptors.h"
 

-#if defined(RESET_TOGGLES_LIBUSB_COMPAT) || defined(__DOXYGEN__)
-       /** Indicates if an external reset has ocurred and the compatibility mode needs to be altered */
-       static bool AVRISP_NeedCompatibilitySwitch ATTR_NO_INIT;
-
-       /** Current AVRISP data IN endpoint address. */
-       uint8_t AVRISP_CurrDataINEndpointAddress;
-       
-       /** Saved AVRISP data IN endpoint address in EEPROM. */
-       uint8_t AVRISP_CurrDataINEndpointAddress_EEPROM EEMEM;
-#endif
-

 /** Device descriptor structure. This descriptor, located in FLASH 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
 /** Device descriptor structure. This descriptor, located in FLASH 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


@@ -57,7 +46,7 @@ const USB_Descriptor_Device_t PROGMEM AVRISP_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(1,1,0),

        .Class                  = USB_CSCP_VendorSpecificClass,
        .SubClass               = USB_CSCP_NoDeviceSubclass,
        .Protocol               = USB_CSCP_NoDeviceProtocol,
        .Class                  = USB_CSCP_VendorSpecificClass,
        .SubClass               = USB_CSCP_NoDeviceSubclass,
        .Protocol               = USB_CSCP_NoDeviceProtocol,


@@ -66,11 +55,11 @@ const USB_Descriptor_Device_t PROGMEM AVRISP_DeviceDescriptor =
 
        .VendorID               = 0x03EB,
        .ProductID              = 0x2104,
 
        .VendorID               = 0x03EB,
        .ProductID              = 0x2104,

-       .ReleaseNumber          = VERSION_BCD(02.00),
+       .ReleaseNumber          = VERSION_BCD(2,0,0),

 
 

-       .ManufacturerStrIndex   = 0x01,
-       .ProductStrIndex        = 0x02,
-       .SerialNumStrIndex      = 0x03,
+       .ManufacturerStrIndex   = AVRISP_STRING_ID_Manufacturer,
+       .ProductStrIndex        = AVRISP_STRING_ID_Product,
+       .SerialNumStrIndex      = AVRISP_STRING_ID_Serial,

 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };


@@ -80,7 +69,7 @@ const USB_Descriptor_Device_t PROGMEM AVRISP_DeviceDescriptor =
  *  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.
  */
  *  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.
  */

-AVRISP_USB_Descriptor_Configuration_t AVRISP_ConfigurationDescriptor =
+const AVRISP_USB_Descriptor_Configuration_t PROGMEM AVRISP_ConfigurationDescriptor =

 {
        .Config =
                {
 {
        .Config =
                {


@@ -101,7 +90,7 @@ AVRISP_USB_Descriptor_Configuration_t AVRISP_ConfigurationDescriptor =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 

-                       .InterfaceNumber        = 0,
+                       .InterfaceNumber        = INTERFACE_ID_AVRISP,

                        .AlternateSetting       = 0,
 
                        .TotalEndpoints         = 2,
                        .AlternateSetting       = 0,
 
                        .TotalEndpoints         = 2,


@@ -117,11 +106,7 @@ AVRISP_USB_Descriptor_Configuration_t AVRISP_ConfigurationDescriptor =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 

-#if defined(RESET_TOGGLES_LIBUSB_COMPAT)
-                       .EndpointAddress        = 0,
-#else

                        .EndpointAddress        = AVRISP_DATA_IN_EPADDR,
                        .EndpointAddress        = AVRISP_DATA_IN_EPADDR,

-#endif

                        .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = AVRISP_DATA_EPSIZE,
                        .PollingIntervalMS      = 0x0A
                        .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = AVRISP_DATA_EPSIZE,
                        .PollingIntervalMS      = 0x0A


@@ -142,44 +127,26 @@ AVRISP_USB_Descriptor_Configuration_t AVRISP_ConfigurationDescriptor =
  *  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.
  */

-const USB_Descriptor_String_t PROGMEM AVRISP_LanguageString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
-
-       .UnicodeString          = {LANGUAGE_ID_ENG}
-};
+const USB_Descriptor_String_t PROGMEM AVRISP_LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG);

 
 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
 
 /** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */

-const USB_Descriptor_String_t PROGMEM AVRISP_ManufacturerString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(5), .Type = DTYPE_String},
-
-       .UnicodeString          = L"ATMEL"
-};
+const USB_Descriptor_String_t PROGMEM AVRISP_ManufacturerString = USB_STRING_DESCRIPTOR(L"ATMEL");

 
 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
 
 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */

-const USB_Descriptor_String_t PROGMEM AVRISP_ProductString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
-
-       .UnicodeString          = L"AVRISP mkII"
-};
+const USB_Descriptor_String_t PROGMEM AVRISP_ProductString = USB_STRING_DESCRIPTOR(L"AVRISP mkII");

 
 /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
  *  series of uppercase hexadecimal digits.
  */
 
 /** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
  *  series of uppercase hexadecimal digits.
  */

-const USB_Descriptor_String_t PROGMEM AVRISP_SerialString =
-{
-       .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},
-       
-       .UnicodeString          = L"000200012345\0" // Note: Real AVRISP-MKII has the embedded NUL byte, bug in firmware?
-};
+const USB_Descriptor_String_t PROGMEM AVRISP_SerialString = USB_STRING_DESCRIPTOR(L"000200012345\0"
+    // Note: Real AVRISP-MKII has the embedded NUL byte, bug in firmware?
+);

 
 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 
 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  *  documentation) by the application code so that the address and size of a requested descriptor can be given


@@ -188,9 +155,8 @@ const USB_Descriptor_String_t PROGMEM AVRISP_SerialString =
  *  USB host.
  */
 uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
  *  USB host.
  */
 uint16_t AVRISP_GetDescriptor(const uint16_t wValue,

-                              const uint8_t wIndex,
-                              const void** const DescriptorAddress,
-                              uint8_t* DescriptorMemorySpace)
+                              const uint16_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);


@@ -198,8 +164,6 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
        const void* Address = NULL;
        uint16_t    Size    = NO_DESCRIPTOR;
 
        const void* Address = NULL;
        uint16_t    Size    = NO_DESCRIPTOR;
 

-       *DescriptorMemorySpace = MEMSPACE_FLASH;
-       

        switch (DescriptorType)
        {
                case DTYPE_Device:
        switch (DescriptorType)
        {
                case DTYPE_Device:


@@ -207,33 +171,27 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
                case DTYPE_Configuration:
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
                case DTYPE_Configuration:

-                       *DescriptorMemorySpace = MEMSPACE_RAM;
-                       #if defined(RESET_TOGGLES_LIBUSB_COMPAT)
-                               /* Update the configuration descriptor with the current endpoint address */
-                               AVRISP_ConfigurationDescriptor.AVRISP_DataInEndpoint.EndpointAddress = AVRISP_CurrDataINEndpointAddress;
-                       #endif
-

                        Address = &AVRISP_ConfigurationDescriptor;
                        Size    = sizeof(AVRISP_USB_Descriptor_Configuration_t);
                        break;
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {
                        Address = &AVRISP_ConfigurationDescriptor;
                        Size    = sizeof(AVRISP_USB_Descriptor_Configuration_t);
                        break;
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {

-                               case 0x00:
+                               case AVRISP_STRING_ID_Language:

                                        Address = &AVRISP_LanguageString;
                                        Size    = pgm_read_byte(&AVRISP_LanguageString.Header.Size);
                                        break;
                                        Address = &AVRISP_LanguageString;
                                        Size    = pgm_read_byte(&AVRISP_LanguageString.Header.Size);
                                        break;

-                               case 0x01:
+                               case AVRISP_STRING_ID_Manufacturer:

                                        Address = &AVRISP_ManufacturerString;
                                        Size    = pgm_read_byte(&AVRISP_ManufacturerString.Header.Size);
                                        break;
                                        Address = &AVRISP_ManufacturerString;
                                        Size    = pgm_read_byte(&AVRISP_ManufacturerString.Header.Size);
                                        break;

-                               case 0x02:
+                               case AVRISP_STRING_ID_Product:

                                        Address = &AVRISP_ProductString;
                                        Size    = pgm_read_byte(&AVRISP_ProductString.Header.Size);
                                        break;
                                        Address = &AVRISP_ProductString;
                                        Size    = pgm_read_byte(&AVRISP_ProductString.Header.Size);
                                        break;

-                               case 0x03:
+                               case AVRISP_STRING_ID_Serial:

                                        Address = &AVRISP_SerialString;
                                        Address = &AVRISP_SerialString;

-                                       Size    = pgm_read_byte(&AVRISP_SerialString.Header.Size);
+                                       Size    = AVRISP_SerialString.Header.Size;

                                        break;
                        }
 
                                        break;
                        }
 


@@ -243,73 +201,3 @@ uint16_t AVRISP_GetDescriptor(const uint16_t wValue,
        *DescriptorAddress = Address;
        return Size;
 }
        *DescriptorAddress = Address;
        return Size;
 }

-
-#if defined(RESET_TOGGLES_LIBUSB_COMPAT) || defined(__DOXYGEN__)
-/** Checks the state of the system status register MCUSR and indicates via a flag if
- *  the current AVRISP driver compatibility mode needs to be reset.
- *
- *  When the \c RESET_TOGGLES_LIBUSB_COMPAT compile time option is enabled, pulling
- *  the reset line of the AVR low will toggle between Jungo and libUSB compatibility
- *  modes. Other forms of reset (such as power on or watchdog) will not force a mode
- *  change.
- */
-void CheckExternalReset(void)
-{      
-       /* If an external reset occured, we need to change compatibility mode */
-       AVRISP_NeedCompatibilitySwitch = (MCUSR == (1 << EXTRF));
-
-       MCUSR = 0;
-}
-
-/** Updates the device descriptors so that the correct compatibility mode is used
- *  when the \c RESET_TOGGLES_LIBUSB_COMPAT compile time option is enabled. This
- *  configures the programmer for either Jungo or libUSB driver compatibility. Each
- *  time the AVR is reset via pulling the reset line low the compatibility mode will
- *  be toggled. The current mode is stored in EEPROM and preserved through power
- *  cycles of the AVR.
- */
-void UpdateCurrentCompatibilityMode(void)
-{
-       /* Load the current IN endpoint address stored in EEPROM */
-       AVRISP_CurrDataINEndpointAddress = eeprom_read_byte(&AVRISP_CurrDataINEndpointAddress_EEPROM);
-       
-       /* Check if we need to switch compatibility modes */
-       if (AVRISP_NeedCompatibilitySwitch)
-       {
-               /* Toggle between compatibility modes */
-               AVRISP_CurrDataINEndpointAddress = (AVRISP_CurrDataINEndpointAddress == AVRISP_DATA_IN_EPADDR_LIBUSB) ?
-                               AVRISP_DATA_IN_EPADDR_JUNGO : AVRISP_DATA_IN_EPADDR_LIBUSB;
-
-               /* Save the new mode into EEPROM */
-               eeprom_update_byte(&AVRISP_CurrDataINEndpointAddress_EEPROM, AVRISP_CurrDataINEndpointAddress);
-       }
-
-       LEDs_SetAllLEDs(LEDS_NO_LEDS);
-
-       /* Validate IN endpoint address and indicate current mode via LED flashes */
-       switch (AVRISP_CurrDataINEndpointAddress)
-       {
-               default:
-                       /* Default to Jungo compatibility mode if saved EEPROM is invalid */
-                       AVRISP_CurrDataINEndpointAddress = AVRISP_DATA_IN_EPADDR_JUNGO;
-               case AVRISP_DATA_IN_EPADDR_JUNGO:
-                       /* Two flashes for Jungo compatibility mode */
-                       for (uint8_t i = 0; i < 4; i++)
-                       {
-                               LEDs_ToggleLEDs(LEDS_ALL_LEDS);
-                               Delay_MS(100);
-                       }               
-                       break;
-               case AVRISP_DATA_IN_EPADDR_LIBUSB:
-                       /* Five flashes for libUSB compatibility mode */
-                       for (uint8_t i = 0; i < 10; i++)
-                       {
-                               LEDs_ToggleLEDs(LEDS_ALL_LEDS);
-                               Delay_MS(100);
-                       }
-                       break;
-       }
-       
-       Delay_MS(500);
-}
-#endif