Add LUFA-111009-BETA tag.
[pub/USBasp.git] / Bootloaders / HID / BootloaderHID.c
index 4a43954..f4cb0f1 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2011.\r
-\r
-  dean [at] fourwalledcubicle [dot] com\r
-           www.lufa-lib.org\r
-*/\r
-\r
-/*\r
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the HID class bootloader. This file contains the complete bootloader logic.\r
- */\r
\r
-#include "BootloaderHID.h"\r
-\r
-/** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run\r
- *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application\r
- *  started via a forced watchdog reset.\r
- */\r
-static bool RunBootloader = true;\r
-\r
-/** Main program entry point. This routine configures the hardware required by the bootloader, then continuously \r
- *  runs the bootloader processing routine until instructed to soft-exit.\r
- */\r
-int main(void)\r
-{\r
-       /* Setup hardware required for the bootloader */\r
-       SetupHardware();\r
-       \r
-       /* Enable global interrupts so that the USB stack can function */\r
-       sei();\r
-\r
-       while (RunBootloader)\r
-         USB_USBTask();\r
-       \r
-       /* Disconnect from the host - USB interface will be reset later along with the AVR */\r
-       USB_Detach();\r
-\r
-       /* Enable the watchdog and force a timeout to reset the AVR */\r
-       wdt_enable(WDTO_250MS);\r
-\r
-       for (;;);\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
-\r
-       /* Relocate the interrupt vector table to the bootloader section */\r
-       MCUCR = (1 << IVCE);\r
-       MCUCR = (1 << IVSEL);\r
-\r
-       /* Initialize USB subsystem */\r
-       USB_Init();\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
-void EVENT_USB_Device_ConfigurationChanged(void)\r
-{\r
-       /* Setup HID Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(HID_IN_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, HID_IN_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-}\r
-\r
-/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to\r
- *  the device from the USB host before passing along unhandled control requests to the library for processing\r
- *  internally.\r
- */\r
-void EVENT_USB_Device_ControlRequest(void)\r
-{\r
-       /* Ignore any requests that aren't directed to the HID interface */\r
-       if ((USB_ControlRequest.bmRequestType & (CONTROL_REQTYPE_TYPE | CONTROL_REQTYPE_RECIPIENT)) !=\r
-           (REQTYPE_CLASS | REQREC_INTERFACE))\r
-       {\r
-               return;\r
-       }\r
-\r
-       /* Process HID specific control requests */\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case HID_REQ_SetReport:\r
-                       Endpoint_ClearSETUP();\r
-                       \r
-                       /* Wait until the command has been sent by the host */\r
-                       while (!(Endpoint_IsOUTReceived()));\r
-               \r
-                       /* Read in the write destination address */\r
-                       #if (FLASHEND > 0xFFFF)\r
-                       uint32_t PageAddress = ((uint32_t)Endpoint_Read_16_LE() << 8);\r
-                       #else\r
-                       uint16_t PageAddress = Endpoint_Read_16_LE();\r
-                       #endif\r
-                       \r
-                       /* Check if the command is a program page command, or a start application command */\r
-                       #if (FLASHEND > 0xFFFF)\r
-                       if ((uint16_t)(PageAddress >> 8) == COMMAND_STARTAPPLICATION)\r
-                       #else\r
-                       if (PageAddress == COMMAND_STARTAPPLICATION)\r
-                       #endif\r
-                       {\r
-                               RunBootloader = false;\r
-                       }\r
-                       else\r
-                       {\r
-                               /* Erase the given FLASH page, ready to be programmed */\r
-                               boot_page_erase(PageAddress);\r
-                               boot_spm_busy_wait();\r
-                               \r
-                               /* Write each of the FLASH page's bytes in sequence */\r
-                               for (uint8_t PageWord = 0; PageWord < (SPM_PAGESIZE / 2); PageWord++)                           \r
-                               {\r
-                                       /* Check if endpoint is empty - if so clear it and wait until ready for next packet */\r
-                                       if (!(Endpoint_BytesInEndpoint()))\r
-                                       {\r
-                                               Endpoint_ClearOUT();\r
-                                               while (!(Endpoint_IsOUTReceived()));\r
-                                       }\r
-\r
-                                       /* Write the next data word to the FLASH page */\r
-                                       boot_page_fill(PageAddress + ((uint16_t)PageWord << 1), Endpoint_Read_16_LE());\r
-                               }\r
-\r
-                               /* Write the filled FLASH page to memory */\r
-                               boot_page_write(PageAddress);\r
-                               boot_spm_busy_wait();\r
-\r
-                               /* Re-enable RWW section */\r
-                               boot_rww_enable();\r
-                       }\r
-\r
-                       Endpoint_ClearOUT();\r
-\r
-                       Endpoint_ClearStatusStage();\r
-                       break;\r
-       }\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  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
+  without fee, provided that the above copyright notice appear in 
+  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 
+  software without specific, written prior permission.
+
+  The author disclaim 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
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the HID class bootloader. This file contains the complete bootloader logic.
+ */
+#include "BootloaderHID.h"
+
+/** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
+ *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
+ *  started via a forced watchdog reset.
+ */
+static bool RunBootloader = true;
+
+/** Main program entry point. This routine configures the hardware required by the bootloader, then continuously 
+ *  runs the bootloader processing routine until instructed to soft-exit.
+ */
+int main(void)
+{
+       /* Setup hardware required for the bootloader */
+       SetupHardware();
+       
+       /* Enable global interrupts so that the USB stack can function */
+       sei();
+
+       while (RunBootloader)
+         USB_USBTask();
+       
+       /* Disconnect from the host - USB interface will be reset later along with the AVR */
+       USB_Detach();
+
+       /* Enable the watchdog and force a timeout to reset the AVR */
+       wdt_enable(WDTO_250MS);
+
+       for (;;);
+}
+
+/** Configures all hardware required for the bootloader. */
+void SetupHardware(void)
+{
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Relocate the interrupt vector table to the bootloader section */
+       MCUCR = (1 << IVCE);
+       MCUCR = (1 << IVSEL);
+
+       /* Initialize USB subsystem */
+       USB_Init();
+}
+
+/** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
+ *  to relay data to and from the attached USB host.
+ */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       /* Setup HID Report Endpoint */
+       Endpoint_ConfigureEndpoint(HID_IN_EPNUM, EP_TYPE_INTERRUPT,
+                                      ENDPOINT_DIR_IN, HID_IN_EPSIZE,
+                                  ENDPOINT_BANK_SINGLE);
+}
+
+/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
+ *  the device from the USB host before passing along unhandled control requests to the library for processing
+ *  internally.
+ */
+void EVENT_USB_Device_ControlRequest(void)
+{
+       /* Ignore any requests that aren't directed to the HID interface */
+       if ((USB_ControlRequest.bmRequestType & (CONTROL_REQTYPE_TYPE | CONTROL_REQTYPE_RECIPIENT)) !=
+           (REQTYPE_CLASS | REQREC_INTERFACE))
+       {
+               return;
+       }
+
+       /* Process HID specific control requests */
+       switch (USB_ControlRequest.bRequest)
+       {
+               case HID_REQ_SetReport:
+                       Endpoint_ClearSETUP();
+                       
+                       /* Wait until the command has been sent by the host */
+                       while (!(Endpoint_IsOUTReceived()));
+               
+                       /* Read in the write destination address */
+                       #if (FLASHEND > 0xFFFF)
+                       uint32_t PageAddress = ((uint32_t)Endpoint_Read_16_LE() << 8);
+                       #else
+                       uint16_t PageAddress = Endpoint_Read_16_LE();
+                       #endif
+                       
+                       /* Check if the command is a program page command, or a start application command */
+                       #if (FLASHEND > 0xFFFF)
+                       if ((uint16_t)(PageAddress >> 8) == COMMAND_STARTAPPLICATION)
+                       #else
+                       if (PageAddress == COMMAND_STARTAPPLICATION)
+                       #endif
+                       {
+                               RunBootloader = false;
+                       }
+                       else
+                       {
+                               /* Erase the given FLASH page, ready to be programmed */
+                               boot_page_erase(PageAddress);
+                               boot_spm_busy_wait();
+                               
+                               /* Write each of the FLASH page's bytes in sequence */
+                               for (uint8_t PageWord = 0; PageWord < (SPM_PAGESIZE / 2); PageWord++)                           
+                               {
+                                       /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
+                                       if (!(Endpoint_BytesInEndpoint()))
+                                       {
+                                               Endpoint_ClearOUT();
+                                               while (!(Endpoint_IsOUTReceived()));
+                                       }
+
+                                       /* Write the next data word to the FLASH page */
+                                       boot_page_fill(PageAddress + ((uint16_t)PageWord << 1), Endpoint_Read_16_LE());
+                               }
+
+                               /* Write the filled FLASH page to memory */
+                               boot_page_write(PageAddress);
+                               boot_spm_busy_wait();
+
+                               /* Re-enable RWW section */
+                               boot_rww_enable();
+                       }
+
+                       Endpoint_ClearOUT();
+
+                       Endpoint_ClearStatusStage();
+                       break;
+       }
+}