-/** \file\r
- *\r
- * This file contains special DoxyGen information for the generation of the main page and other special\r
- * documentation pages. It is not a project source file.\r
- */\r
-\r
-/**\r
- * \page Page_SoftwareBootloaderStart Entering the Bootloader via Software\r
- *\r
- * A common requirement of many applications is the ability to jump to the programmed bootloader of a chip\r
- * on demand, via the code's firmware (i.e. not as a result of any physical user interaction with the\r
- * hardware). This might be required because the device does not have any physical user input, or simply\r
- * just to streamline the device upgrade process on the host PC.\r
- *\r
- * The following C code snippet may be used to enter the bootloader upon request by the user application.\r
- * By using the watchdog to physically reset the controller, it is ensured that all system hardware is\r
- * completely reset to their defaults before the bootloader is run. This is important; since bootloaders\r
- * are written to occupy a very limited space, they usually make assumptions about the register states based\r
- * on the default values after a hard-reset of the chip.\r
- *\r
- * \code\r
- * #include <avr/wdt.h>\r
- * #include <avr/io.h>\r
- * #include <util/delay.h>\r
- *\r
- * #include <LUFA/Common/Common.h>\r
- * #include <LUFA/Drivers/USB/USB.h>\r
- *\r
- * uint32_t Boot_Key ATTR_NO_INIT;\r
- *\r
- * #define MAGIC_BOOT_KEY 0xDC42ACCA\r
- * #define BOOTLOADER_START_ADDRESS ({FLASH_SIZE_BYTES} - {BOOTLOADER_SEC_SIZE_BYTES})\r
- * \r
- * void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);\r
- * void Bootloader_Jump_Check(void)\r
- * {\r
- * // If the reset source was the bootloader and the key is correct, clear it and jump to the bootloader\r
- * if ((MCUSR & (1<<WDRF)) && (Boot_Key == MAGIC_BOOT_KEY))\r
- * {\r
- * Boot_Key = 0;\r
- * ((void (*)(void))BOOTLOADER_START_ADDRESS)(); \r
- * }\r
- * }\r
- *\r
- * void Jump_To_Bootloader(void)\r
- * {\r
- * // If USB is used, detatch from the bus and wait 2 seconds for the host to register it\r
- * USB_ShutDown();\r
- * for (uint8_t i = 0; i < 128; i++)\r
- * _delay_ms(16);\r
- *\r
- * // Set the bootloader key to the magic value and force a reset\r
- * Boot_Key = MAGIC_BOOT_KEY;\r
- * wdt_enable(WDTO_250MS);\r
- * for (;;); \r
- * }\r
- * \endcode\r
- *\r
- * Note that the bootloader magic key can be any arbitrary value. The {FLASH_SIZE_BYTES} and\r
- * {BOOTLOADER_SEC_SIZE_BYTES} tokens should be replaced with the total flash size of the AVR\r
- * in bytes, and the allocated size of the bootloader section for the target AVR.\r
- * \r
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/**
+ * \page Page_SoftwareBootloaderStart Entering the Bootloader via Software
+ *
+ * A common requirement of many applications is the ability to jump to the programmed bootloader of a chip
+ * on demand, via the code's firmware (i.e. not as a result of any physical user interaction with the
+ * hardware). This might be required because the device does not have any physical user input, or simply
+ * just to streamline the device upgrade process on the host PC.
+ *
+ * The following C code snippet may be used to enter the bootloader upon request by the user application.
+ * By using the watchdog to physically reset the controller, it is ensured that all system hardware is
+ * completely reset to their defaults before the bootloader is run. This is important; since bootloaders
+ * are written to occupy a very limited space, they usually make assumptions about the register states based
+ * on the default values after a hard-reset of the chip.
+ *
+ * \code
+ * #include <avr/wdt.h>
+ * #include <avr/io.h>
+ * #include <util/delay.h>
+ *
+ * #include <LUFA/Common/Common.h>
+ * #include <LUFA/Drivers/USB/USB.h>
+ *
+ * uint32_t Boot_Key ATTR_NO_INIT;
+ *
+ * #define MAGIC_BOOT_KEY 0xDC42ACCA
+ * #define BOOTLOADER_START_ADDRESS ({FLASH_SIZE_BYTES} - {BOOTLOADER_SEC_SIZE_BYTES})
+ *
+ * void Bootloader_Jump_Check(void) ATTR_INIT_SECTION(3);
+ * void Bootloader_Jump_Check(void)
+ * {
+ * // If the reset source was the bootloader and the key is correct, clear it and jump to the bootloader
+ * if ((MCUSR & (1<<WDRF)) && (Boot_Key == MAGIC_BOOT_KEY))
+ * {
+ * Boot_Key = 0;
+ * ((void (*)(void))BOOTLOADER_START_ADDRESS)();
+ * }
+ * }
+ *
+ * void Jump_To_Bootloader(void)
+ * {
+ * // If USB is used, detatch from the bus and wait 2 seconds for the host to register it
+ * USB_ShutDown();
+ * for (uint8_t i = 0; i < 128; i++)
+ * _delay_ms(16);
+ *
+ * // Set the bootloader key to the magic value and force a reset
+ * Boot_Key = MAGIC_BOOT_KEY;
+ * wdt_enable(WDTO_250MS);
+ * for (;;);
+ * }
+ * \endcode
+ *
+ * Note that the bootloader magic key can be any arbitrary value. The {FLASH_SIZE_BYTES} and
+ * {BOOTLOADER_SEC_SIZE_BYTES} tokens should be replaced with the total flash size of the AVR
+ * in bytes, and the allocated size of the bootloader section for the target AVR.
+ *
*/
\ No newline at end of file
projects / pub / USBasp.git / blobdiff