Add short delays before detaching from the USB bus in the bootloaders (thanks to...
[pub/lufa.git] / Bootloaders / CDC / BootloaderCDC.h
index 8367002..3c19bdf 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  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
- *  Header file for BootloaderCDC.c.\r
- */\r
\r
-#ifndef _CDC_H_\r
-#define _CDC_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/wdt.h>\r
-               #include <avr/boot.h>\r
-               #include <avr/eeprom.h>\r
-               #include <avr/power.h>\r
-               #include <stdbool.h>\r
-\r
-               #include "Descriptors.h"\r
-\r
-               #include <LUFA/Drivers/USB/USB.h>\r
-\r
-       /* Macros: */\r
-               /** CDC Class Specific request to get the line encoding on a CDC-ACM virtual serial port, including the\r
-                *  baud rate, parity, stop bits and data bits.\r
-                */\r
-               #define REQ_GetLineEncoding          0x21\r
-\r
-               /** CDC Class Specific request to set the line encoding on a CDC-ACM virtual serial port, including the\r
-                *  baud rate, parity, stop bits and data bits.\r
-                */\r
-               #define REQ_SetLineEncoding          0x20\r
-\r
-               /** CDC Class Specific request to set the state of the serial handshake lines (such as DCD and RTS) on\r
-                *  a CDC-ACM virtual serial port.\r
-                */\r
-               #define REQ_SetControlLineState      0x22\r
-               \r
-               /** Version major of the CDC bootloader. */\r
-               #define BOOTLOADER_VERSION_MAJOR     0x01\r
-\r
-               /** Version minor of the CDC bootloader. */\r
-               #define BOOTLOADER_VERSION_MINOR     0x00\r
-                               \r
-               /** Hardware version major of the CDC bootloader. */\r
-               #define BOOTLOADER_HWVERSION_MAJOR   0x01\r
-\r
-               /** Hardware version minor of the CDC bootloader. */\r
-               #define BOOTLOADER_HWVERSION_MINOR   0x00\r
-\r
-               /** Eight character bootloader firmware identifier reported to the host when requested */\r
-               #define SOFTWARE_IDENTIFIER          "LUFACDC"\r
-               \r
-       /* Type Defines: */\r
-               /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */\r
-               typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;\r
-\r
-               /** Type define for the CDC-ACM virtual serial port line encoding options, including baud rate, format, parity\r
-                *  and size of each data chunk in bits.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint32_t BaudRateBPS; /**< Baud rate in BPS */\r
-                       uint8_t  CharFormat; /**< Character format, an entry from the BootloaderCDC_CDC_LineCodingFormats_t enum */\r
-                       uint8_t  ParityType; /**< Parity mode, an entry from the BootloaderCDC_CDC_LineCodeingParity_t enum */\r
-                       uint8_t  DataBits; /**< Size of each data chunk, in bits */\r
-               } CDC_Line_Coding_t;\r
-               \r
-       /* Enums: */\r
-               /** Enum for the possible line encoding formats on a CDC-ACM virtual serial port */\r
-               enum BootloaderCDC_CDC_LineCodingFormats_t\r
-               {\r
-                       OneStopBit          = 0, /**< Single stop bit */\r
-                       OneAndAHalfStopBits = 1, /**< 1.5 stop bits */\r
-                       TwoStopBits         = 2, /**< Two stop bits */\r
-               };\r
-               \r
-               /** Enum for the possible parity modes on a CDC-ACM virtual serial port */\r
-               enum BootloaderCDC_CDC_LineCodingParity_t\r
-               {\r
-                       Parity_None         = 0, /**< No data parity checking */\r
-                       Parity_Odd          = 1, /**< Odd data parity checking */\r
-                       Parity_Even         = 2, /**< Even data parity checking */\r
-                       Parity_Mark         = 3, /**< Mark data parity checking */\r
-                       Parity_Space        = 4, /**< Space data parity checking */\r
-               };\r
-               \r
-       /* Function Prototypes: */\r
-               void CDC_Task(void);\r
-               void SetupHardware(void);\r
-               void ResetHardware(void);\r
-\r
-               void EVENT_USB_Device_ConfigurationChanged(void);\r
-               void EVENT_USB_Device_UnhandledControlRequest(void);\r
-\r
-               #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)\r
-                       static void    ReadWriteMemoryBlock(const uint8_t Command);\r
-                       static uint8_t FetchNextCommandByte(void);\r
-                       static void    WriteNextResponseByte(const uint8_t Response);\r
-               #endif\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2018.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  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
+  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 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
+  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
+ *
+ *  Header file for BootloaderCDC.c.
+ */
+
+#ifndef _CDC_H_
+#define _CDC_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/wdt.h>
+               #include <avr/boot.h>
+               #include <avr/eeprom.h>
+               #include <avr/power.h>
+               #include <avr/interrupt.h>
+               #include <util/delay.h>
+               #include <stdbool.h>
+
+               #include "Descriptors.h"
+               #include "BootloaderAPI.h"
+               #include "Config/AppConfig.h"
+
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Board/LEDs.h>
+               #include <LUFA/Platform/Platform.h>
+
+       /* Preprocessor Checks: */
+               #if !defined(__OPTIMIZE_SIZE__)
+                       #error This bootloader requires that it be optimized for size, not speed, to fit into the target device. Change optimization settings and try again.
+               #endif
+
+       /* Macros: */
+               /** Version major of the CDC bootloader. */
+               #define BOOTLOADER_VERSION_MAJOR     0x01
+
+               /** Version minor of the CDC bootloader. */
+               #define BOOTLOADER_VERSION_MINOR     0x00
+
+               /** Hardware version major of the CDC bootloader. */
+               #define BOOTLOADER_HWVERSION_MAJOR   0x01
+
+               /** Hardware version minor of the CDC bootloader. */
+               #define BOOTLOADER_HWVERSION_MINOR   0x00
+
+               /** Eight character bootloader firmware identifier reported to the host when requested. */
+               #define SOFTWARE_IDENTIFIER          "LUFACDC"
+
+               /** Magic bootloader key to unlock forced application start mode. */
+               #define MAGIC_BOOT_KEY               0xDC42
+
+       /* Enums: */
+               /** Possible memory types that can be addressed via the bootloader. */
+               enum AVR109_Memories
+               {
+                       MEMORY_TYPE_FLASH  = 'F',
+                       MEMORY_TYPE_EEPROM = 'E',
+               };
+
+               /** Possible commands that can be issued to the bootloader. */
+               enum AVR109_Commands
+               {
+                       AVR109_COMMAND_Sync                     = 27,
+                       AVR109_COMMAND_ReadEEPROM               = 'd',
+                       AVR109_COMMAND_WriteEEPROM              = 'D',
+                       AVR109_COMMAND_ReadFLASHWord            = 'R',
+                       AVR109_COMMAND_WriteFlashPage           = 'm',
+                       AVR109_COMMAND_FillFlashPageWordLow     = 'c',
+                       AVR109_COMMAND_FillFlashPageWordHigh    = 'C',
+                       AVR109_COMMAND_GetBlockWriteSupport     = 'b',
+                       AVR109_COMMAND_BlockWrite               = 'B',
+                       AVR109_COMMAND_BlockRead                = 'g',
+                       AVR109_COMMAND_ReadExtendedFuses        = 'Q',
+                       AVR109_COMMAND_ReadHighFuses            = 'N',
+                       AVR109_COMMAND_ReadLowFuses             = 'F',
+                       AVR109_COMMAND_ReadLockbits             = 'r',
+                       AVR109_COMMAND_WriteLockbits            = 'l',
+                       AVR109_COMMAND_EraseFLASH               = 'e',
+                       AVR109_COMMAND_ReadSignature            = 's',
+                       AVR109_COMMAND_ReadBootloaderSWVersion  = 'V',
+                       AVR109_COMMAND_ReadBootloaderHWVersion  = 'v',
+                       AVR109_COMMAND_ReadBootloaderIdentifier = 'S',
+                       AVR109_COMMAND_ReadBootloaderInterface  = 'p',
+                       AVR109_COMMAND_SetCurrentAddress        = 'A',
+                       AVR109_COMMAND_ReadAutoAddressIncrement = 'a',
+                       AVR109_COMMAND_ReadPartCode             = 't',
+                       AVR109_COMMAND_EnterProgrammingMode     = 'P',
+                       AVR109_COMMAND_LeaveProgrammingMode     = 'L',
+                       AVR109_COMMAND_SelectDeviceType         = 'T',
+                       AVR109_COMMAND_SetLED                   = 'x',
+                       AVR109_COMMAND_ClearLED                 = 'y',
+                       AVR109_COMMAND_ExitBootloader           = 'E',
+               };
+
+       /* Type Defines: */
+               /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
+               typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
+
+       /* Function Prototypes: */
+               static void CDC_Task(void);
+               static void SetupHardware(void);
+
+               void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
+
+               void EVENT_USB_Device_ConfigurationChanged(void);
+
+               #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
+                       #if !defined(NO_BLOCK_SUPPORT)
+                       static void    ReadWriteMemoryBlock(const uint8_t Command);
+                       #endif
+                       static uint8_t FetchNextCommandByte(void);
+                       static void    WriteNextResponseByte(const uint8_t Response);
+               #endif
+
+#endif
+