Make HID device class driver reselect the correct endpoint after the user callbacks...

[pub/USBasp.git] / Bootloaders / CDC / BootloaderCDC.c

diff --git a/Bootloaders/CDC/BootloaderCDC.c b/Bootloaders/CDC/BootloaderCDC.c
index a1394bd..925385d 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.c
+++ b/Bootloaders/CDC/BootloaderCDC.c
@@ -36,17 +36,16 @@
 #define  INCLUDE_FROM_BOOTLOADERCDC_C\r
 #include "BootloaderCDC.h"\r
 \r
 #define  INCLUDE_FROM_BOOTLOADERCDC_C\r
 #include "BootloaderCDC.h"\r
 \r

-/* Globals: */\r

 /** Line coding options for the virtual serial port. Although the virtual serial port data is never\r
  *  sent through a physical serial port, the line encoding data must still be read and preserved from\r
  *  the host, or the host will detect a problem and fail to open the port. This structure contains the\r
  *  current encoding options, including baud rate, character format, parity mode and total number of \r
  *  bits in each data chunk.\r
  */\r
 /** Line coding options for the virtual serial port. Although the virtual serial port data is never\r
  *  sent through a physical serial port, the line encoding data must still be read and preserved from\r
  *  the host, or the host will detect a problem and fail to open the port. This structure contains the\r
  *  current encoding options, including baud rate, character format, parity mode and total number of \r
  *  bits in each data chunk.\r
  */\r

-CDC_Line_Coding_t LineCoding = { BaudRateBPS: 9600,\r
-                                 CharFormat:  OneStopBit,\r
-                                 ParityType:  Parity_None,\r
-                                 DataBits:    8            };\r
+CDC_Line_Coding_t LineCoding = { .BaudRateBPS = 9600,\r
+                                 .CharFormat  = OneStopBit,\r
+                                 .ParityType  = Parity_None,\r
+                                 .DataBits    = 8            };\r

 \r
 /** Current address counter. This stores the current address of the FLASH or EEPROM as set by the host,\r
  *  and is used when reading or writing to the AVRs memory (either FLASH or EEPROM depending on the issued\r
 \r
 /** Current address counter. This stores the current address of the FLASH or EEPROM as set by the host,\r
  *  and is used when reading or writing to the AVRs memory (either FLASH or EEPROM depending on the issued\r


@@ -67,6 +66,26 @@ bool RunBootloader = true;
  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r

+       /* Setup hardware required for the bootloader */\r
+       SetupHardware();\r
+\r
+       while (RunBootloader)\r
+       {\r
+               CDC_Task();\r
+               USB_USBTask();\r
+       }\r
+       \r
+       /* Reset all configured hardware to their default states for the user app */\r
+       ResetHardware();\r
+\r
+       /* Start the user application */\r
+       AppPtr_t AppStartPtr = (AppPtr_t)0x0000;\r
+       AppStartPtr();  \r
+}\r
+\r
+/** Configures all hardware required for the bootloader. */\r
+void SetupHardware(void)\r
+{\r

        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r


@@ -80,18 +99,11 @@ int main(void)
        \r
        /* Initialize USB Subsystem */\r
        USB_Init();\r
        \r
        /* Initialize USB Subsystem */\r
        USB_Init();\r

+}\r

 \r
 \r

-       while (RunBootloader)\r
-       {\r
-               USB_USBTask();\r
-               CDC_Task();\r
-       }\r
-       \r
-       Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
-\r
-       /* Wait until any pending transmissions have completed before shutting down */\r
-       while (!(Endpoint_ReadWriteAllowed()));\r
-       \r
+/** Resets all configured hardware required for the bootloader back to their original states. */\r
+void ResetHardware(void)\r
+{\r

        /* Shut down the USB subsystem */\r
        USB_ShutDown();\r
        \r
        /* Shut down the USB subsystem */\r
        USB_ShutDown();\r
        \r


@@ -99,36 +111,14 @@ int main(void)
        MCUCR = (1 << IVCE);\r
        MCUCR = 0;\r
 \r
        MCUCR = (1 << IVCE);\r
        MCUCR = 0;\r
 \r

-       /* Reset any used hardware ports back to their defaults */\r
-       PORTD = 0;\r
-       DDRD  = 0;\r
-       \r
-       #if defined(PORTE)\r
-       PORTE = 0;\r
-       DDRE  = 0;\r
-       #endif\r
-       \r

        /* Re-enable RWW section */\r
        boot_rww_enable();\r
        /* Re-enable RWW section */\r
        boot_rww_enable();\r

-\r
-       /* Start the user application */\r
-       AppPtr_t AppStartPtr = (AppPtr_t)0x0000;\r
-       AppStartPtr();  \r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This indicates that the bootloader should exit and the user\r
- *  application started.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
-       /* Upon disconnection, run user application */\r
-       RunBootloader = false;\r

 }\r
 \r
 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready\r
  *  to relay data to and from the attached USB host.\r
  */\r
 }\r
 \r
 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready\r
  *  to relay data to and from the attached USB host.\r
  */\r

-EVENT_HANDLER(USB_ConfigurationChanged)\r
+void EVENT_USB_Device_ConfigurationChanged(void)\r

 {\r
        /* Setup CDC Notification, Rx and Tx Endpoints */\r
        Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
 {\r
        /* Setup CDC Notification, Rx and Tx Endpoints */\r
        Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r


@@ -144,61 +134,57 @@ EVENT_HANDLER(USB_ConfigurationChanged)
                                   ENDPOINT_BANK_SINGLE);\r
 }\r
 \r
                                   ENDPOINT_BANK_SINGLE);\r
 }\r
 \r

-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
+/** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific\r

  *  control requests that are not handled internally by the USB library, so that they can be handled appropriately\r
  *  for the application.\r
  */\r
  *  control requests that are not handled internally by the USB library, so that they can be handled appropriately\r
  *  for the application.\r
  */\r

-EVENT_HANDLER(USB_UnhandledControlPacket)\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r

 {\r
        uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
 \r
 {\r
        uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
 \r

-       Endpoint_Discard_Word();\r
-\r

        /* Process CDC specific control requests */\r
        /* Process CDC specific control requests */\r

-       switch (bRequest)\r
+       switch (USB_ControlRequest.bRequest)\r

        {\r
                case REQ_GetLineEncoding:\r
        {\r
                case REQ_GetLineEncoding:\r

-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r

                        {\r
                        {\r

-                               Endpoint_ClearSetupReceived();\r
+                               Endpoint_ClearSETUP();\r

 \r
                                for (uint8_t i = 0; i < sizeof(LineCoding); i++)\r
                                  Endpoint_Write_Byte(*(LineCodingData++));     \r
                                \r
 \r
                                for (uint8_t i = 0; i < sizeof(LineCoding); i++)\r
                                  Endpoint_Write_Byte(*(LineCodingData++));     \r
                                \r

-                               Endpoint_ClearSetupIN();\r
+                               Endpoint_ClearIN();\r

                                \r
                                \r

-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupOUTReceived()));\r
-                               Endpoint_ClearSetupOUT();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
                        \r
                        break;\r
                case REQ_SetLineEncoding:\r
                        }\r
                        \r
                        break;\r
                case REQ_SetLineEncoding:\r

-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r

                        {\r
                        {\r

-                               Endpoint_ClearSetupReceived();\r
-\r
-                               while (!(Endpoint_IsSetupOUTReceived()));\r
+                               Endpoint_ClearSETUP();\r

 \r
 \r

+                               while (!(Endpoint_IsOUTReceived()))\r
+                               {                               \r
+                                       if (USB_DeviceState == DEVICE_STATE_Unattached)\r
+                                         return;\r
+                               }\r
+                       \r

                                for (uint8_t i = 0; i < sizeof(LineCoding); i++)\r
                                  *(LineCodingData++) = Endpoint_Read_Byte();\r
 \r
                                for (uint8_t i = 0; i < sizeof(LineCoding); i++)\r
                                  *(LineCodingData++) = Endpoint_Read_Byte();\r
 \r

-                               Endpoint_ClearSetupOUT();\r
+                               Endpoint_ClearOUT();\r

 \r
 \r

-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupINReady()));\r
-                               Endpoint_ClearSetupIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
        \r
                        break;\r
                case REQ_SetControlLineState:\r
                        }\r
        \r
                        break;\r
                case REQ_SetControlLineState:\r

-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r

                        {\r
                        {\r

-                               Endpoint_ClearSetupReceived();\r
+                               Endpoint_ClearSETUP();\r

                                \r
                                \r

-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupINReady()));\r
-                               Endpoint_ClearSetupIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
        \r
                        break;\r
                        }\r
        \r
                        break;\r


@@ -208,7 +194,7 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
 /** Reads or writes a block of EEPROM or FLASH memory to or from the appropriate CDC data endpoint, depending\r
  *  on the AVR910 protocol command issued.\r
  *\r
 /** Reads or writes a block of EEPROM or FLASH memory to or from the appropriate CDC data endpoint, depending\r
  *  on the AVR910 protocol command issued.\r
  *\r

- *  \param Command  Single character AVR910 protocol command indicating what memory operation to perform\r
+ *  \param[in] Command  Single character AVR910 protocol command indicating what memory operation to perform\r

  */\r
 static void ReadWriteMemoryBlock(const uint8_t Command)\r
 {\r
  */\r
 static void ReadWriteMemoryBlock(const uint8_t Command)\r
 {\r


@@ -239,18 +225,10 @@ static void ReadWriteMemoryBlock(const uint8_t Command)
 \r
                while (BlockSize--)\r
                {\r
 \r
                while (BlockSize--)\r
                {\r

-                       if (MemoryType == 'E')\r
-                       {\r
-                               /* Read the next EEPROM byte into the endpoint */\r
-                               WriteNextResponseByte(eeprom_read_byte((uint8_t*)(uint16_t)(CurrAddress >> 1)));\r
-\r
-                               /* Increment the address counter after use */\r
-                               CurrAddress += 2;\r
-                       }\r
-                       else\r
+                       if (MemoryType == 'F')\r

                        {\r
                                /* Read the next FLASH byte from the current FLASH page */\r
                        {\r
                                /* Read the next FLASH byte from the current FLASH page */\r

-                               #if defined(RAMPZ)\r
+                               #if (FLASHEND > 0xFFFF)\r

                                WriteNextResponseByte(pgm_read_byte_far(CurrAddress | HighByte));\r
                                #else\r
                                WriteNextResponseByte(pgm_read_byte(CurrAddress | HighByte));                                   \r
                                WriteNextResponseByte(pgm_read_byte_far(CurrAddress | HighByte));\r
                                #else\r
                                WriteNextResponseByte(pgm_read_byte(CurrAddress | HighByte));                                   \r


@@ -262,6 +240,14 @@ static void ReadWriteMemoryBlock(const uint8_t Command)
                                \r
                                HighByte = !HighByte;\r
                        }\r
                                \r
                                HighByte = !HighByte;\r
                        }\r

+                       else\r
+                       {\r
+                               /* Read the next EEPROM byte into the endpoint */\r
+                               WriteNextResponseByte(eeprom_read_byte((uint8_t*)(uint16_t)(CurrAddress >> 1)));\r
+\r
+                               /* Increment the address counter after use */\r
+                               CurrAddress += 2;\r
+                       }                       \r

                }\r
        }\r
        else\r
                }\r
        }\r
        else\r


@@ -332,10 +318,15 @@ static uint8_t FetchNextCommandByte(void)
        Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
        \r
        /* If OUT endpoint empty, clear it and wait for the next packet from the host */\r
        Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
        \r
        /* If OUT endpoint empty, clear it and wait for the next packet from the host */\r

-       if (!(Endpoint_ReadWriteAllowed()))\r
+       while (!(Endpoint_IsReadWriteAllowed()))\r

        {\r
        {\r

-               Endpoint_ClearCurrentBank();\r
-               while (!(Endpoint_ReadWriteAllowed()));\r
+               Endpoint_ClearOUT();\r
+\r
+               while (!(Endpoint_IsOUTReceived()))\r
+               {\r
+                       if (USB_DeviceState == DEVICE_STATE_Unattached)\r
+                         return 0;\r
+               }\r

        }\r
        \r
        /* Fetch the next byte from the OUT endpoint */\r
        }\r
        \r
        /* Fetch the next byte from the OUT endpoint */\r


@@ -345,18 +336,23 @@ static uint8_t FetchNextCommandByte(void)
 /** Writes the next response byte to the CDC data IN endpoint, and sends the endpoint back if needed to free up the\r
  *  bank when full ready for the next byte in the packet to the host.\r
  *\r
 /** Writes the next response byte to the CDC data IN endpoint, and sends the endpoint back if needed to free up the\r
  *  bank when full ready for the next byte in the packet to the host.\r
  *\r

- *  \param Response  Next response byte to send to the host\r
+ *  \param[in] Response  Next response byte to send to the host\r

  */\r
 static void WriteNextResponseByte(const uint8_t Response)\r
 {\r
        /* Select the IN endpoint so that the next data byte can be written */\r
        Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
        \r
  */\r
 static void WriteNextResponseByte(const uint8_t Response)\r
 {\r
        /* Select the IN endpoint so that the next data byte can be written */\r
        Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
        \r

-       /* If OUT endpoint empty, clear it and wait for the next packet from the host */\r
-       if (!(Endpoint_ReadWriteAllowed()))\r
+       /* If IN endpoint full, clear it and wait util ready for the next packet to the host */\r
+       if (!(Endpoint_IsReadWriteAllowed()))\r

        {\r
        {\r

-               Endpoint_ClearCurrentBank();\r
-               while (!(Endpoint_ReadWriteAllowed()));\r
+               Endpoint_ClearIN();\r
+               \r
+               while (!(Endpoint_IsINReady()))\r
+               {                               \r
+                       if (USB_DeviceState == DEVICE_STATE_Unattached)\r
+                         return;\r
+               }\r

        }\r
        \r
        /* Write the next byte to the OUT endpoint */\r
        }\r
        \r
        /* Write the next byte to the OUT endpoint */\r


@@ -366,13 +362,13 @@ static void WriteNextResponseByte(const uint8_t Response)
 /** Task to read in AVR910 commands from the CDC data OUT endpoint, process them, perform the required actions\r
  *  and send the appropriate response back to the host.\r
  */\r
 /** Task to read in AVR910 commands from the CDC data OUT endpoint, process them, perform the required actions\r
  *  and send the appropriate response back to the host.\r
  */\r

-TASK(CDC_Task)\r
+void CDC_Task(void)\r

 {\r
        /* Select the OUT endpoint */\r
        Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
        \r
        /* Check if endpoint has a command in it sent from the host */\r
 {\r
        /* Select the OUT endpoint */\r
        Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
        \r
        /* Check if endpoint has a command in it sent from the host */\r

-       if (Endpoint_ReadWriteAllowed())\r
+       if (Endpoint_IsOUTReceived())\r

        {\r
                /* Read in the bootloader command (first byte sent from host) */\r
                uint8_t Command = FetchNextCommandByte();\r
        {\r
                /* Read in the bootloader command (first byte sent from host) */\r
                uint8_t Command = FetchNextCommandByte();\r


@@ -426,9 +422,9 @@ TASK(CDC_Task)
                }\r
                else if (Command == 's')\r
                {\r
                }\r
                else if (Command == 's')\r
                {\r

-                       WriteNextResponseByte(SIGNATURE_0);\r
-                       WriteNextResponseByte(SIGNATURE_1);\r
-                       WriteNextResponseByte(SIGNATURE_2);             \r
+                       WriteNextResponseByte(AVR_SIGNATURE_3);         \r
+                       WriteNextResponseByte(AVR_SIGNATURE_2);\r
+                       WriteNextResponseByte(AVR_SIGNATURE_1);\r

                }\r
                else if (Command == 'b')\r
                {\r
                }\r
                else if (Command == 'b')\r
                {\r


@@ -510,12 +506,12 @@ TASK(CDC_Task)
                }\r
                else if ((Command == 'B') || (Command == 'g'))\r
                {\r
                }\r
                else if ((Command == 'B') || (Command == 'g'))\r
                {\r

-                       /* Delegate the block write/read to a seperate function for clarity */\r
+                       /* Delegate the block write/read to a separate function for clarity */\r

                        ReadWriteMemoryBlock(Command);\r
                }\r
                else if (Command == 'R')\r
                {\r
                        ReadWriteMemoryBlock(Command);\r
                }\r
                else if (Command == 'R')\r
                {\r

-                       #if defined(RAMPZ)\r
+                       #if (FLASHEND > 0xFFFF)\r

                        uint16_t ProgramWord = pgm_read_word_far(CurrAddress);\r
                        #else\r
                        uint16_t ProgramWord = pgm_read_word(CurrAddress);                      \r
                        uint16_t ProgramWord = pgm_read_word_far(CurrAddress);\r
                        #else\r
                        uint16_t ProgramWord = pgm_read_word(CurrAddress);                      \r


@@ -527,7 +523,7 @@ TASK(CDC_Task)
                else if (Command == 'D')\r
                {\r
                        /* Read the byte from the endpoint and write it to the EEPROM */\r
                else if (Command == 'D')\r
                {\r
                        /* Read the byte from the endpoint and write it to the EEPROM */\r

-                       eeprom_write_byte((uint8_t*)(uint16_t)(CurrAddress >> 1), FetchNextCommandByte());\r
+                       eeprom_write_byte((uint8_t*)((uint16_t)(CurrAddress >> 1)), FetchNextCommandByte());\r

                        \r
                        /* Increment the address after use */                   \r
                        CurrAddress += 2;\r
                        \r
                        /* Increment the address after use */                   \r
                        CurrAddress += 2;\r


@@ -538,7 +534,7 @@ TASK(CDC_Task)
                else if (Command == 'd')\r
                {\r
                        /* Read the EEPROM byte and write it to the endpoint */\r
                else if (Command == 'd')\r
                {\r
                        /* Read the EEPROM byte and write it to the endpoint */\r

-                       WriteNextResponseByte(eeprom_read_byte((uint8_t*)(uint16_t)(CurrAddress >> 1)));\r
+                       WriteNextResponseByte(eeprom_read_byte((uint8_t*)((uint16_t)(CurrAddress >> 1))));\r

 \r
                        /* Increment the address after use */\r
                        CurrAddress += 2;\r
 \r
                        /* Increment the address after use */\r
                        CurrAddress += 2;\r


@@ -557,22 +553,34 @@ TASK(CDC_Task)
                Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
 \r
                /* Remember if the endpoint is completely full before clearing it */\r
                Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
 \r
                /* Remember if the endpoint is completely full before clearing it */\r

-               bool IsEndpointFull = !(Endpoint_ReadWriteAllowed());\r
+               bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());\r

 \r
                /* Send the endpoint data to the host */\r
 \r
                /* Send the endpoint data to the host */\r

-               Endpoint_ClearCurrentBank();\r
+               Endpoint_ClearIN();\r

                \r
                /* If a full endpoint's worth of data was sent, we need to send an empty packet afterwards to signal end of transfer */\r
                if (IsEndpointFull)\r
                {\r
                \r
                /* If a full endpoint's worth of data was sent, we need to send an empty packet afterwards to signal end of transfer */\r
                if (IsEndpointFull)\r
                {\r

-                       while (!(Endpoint_ReadWriteAllowed()));\r
-                       Endpoint_ClearCurrentBank();\r
+                       while (!(Endpoint_IsINReady()))\r
+                       {                               \r
+                               if (USB_DeviceState == DEVICE_STATE_Unattached)\r
+                                 return;\r
+                       }\r
+\r
+                       Endpoint_ClearIN();\r
+               }\r
+\r
+               /* Wait until the data has been sent to the host */\r
+               while (!(Endpoint_IsINReady()))\r
+               {                               \r
+                       if (USB_DeviceState == DEVICE_STATE_Unattached)\r
+                         return;\r

                }\r
                \r
                /* Select the OUT endpoint */\r
                Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
 \r
                /* Acknowledge the command from the host */\r
                }\r
                \r
                /* Select the OUT endpoint */\r
                Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
 \r
                /* Acknowledge the command from the host */\r

-               Endpoint_ClearCurrentBank();\r
+               Endpoint_ClearOUT();\r

        }\r
 }\r
        }\r
 }\r