projects / pub / lufa.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add short delays before detaching from the USB bus in the bootloaders (thanks to...
[pub/lufa.git] / Bootloaders / CDC / BootloaderCDC.h
diff --git a/Bootloaders/CDC/BootloaderCDC.h b/Bootloaders/CDC/BootloaderCDC.h
index 64811c8..3c19bdf 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.h
+++ b/Bootloaders/CDC/BootloaderCDC.h
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2018.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  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 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   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 
+  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.
 
   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
@@ -32,7 +32,7 @@
  *
  *  Header file for BootloaderCDC.c.
  */
  *
  *  Header file for BootloaderCDC.c.
  */
- 
+
 #ifndef _CDC_H_
 #define _CDC_H_
 
 #ifndef _CDC_H_
 #define _CDC_H_
 
@@ -43,88 +43,103 @@
                #include <avr/eeprom.h>
                #include <avr/power.h>
                #include <avr/interrupt.h>
                #include <avr/eeprom.h>
                #include <avr/power.h>
                #include <avr/interrupt.h>
+               #include <util/delay.h>
                #include <stdbool.h>
 
                #include "Descriptors.h"
                #include <stdbool.h>
 
                #include "Descriptors.h"
+               #include "BootloaderAPI.h"
+               #include "Config/AppConfig.h"
 
                #include <LUFA/Drivers/USB/USB.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: */
 
        /* Macros: */
-               /** CDC Class Specific request to get the line encoding on a CDC-ACM virtual serial port, including the
-                *  baud rate, parity, stop bits and data bits.
-                */
-               #define REQ_GetLineEncoding          0x21
-
-               /** CDC Class Specific request to set the line encoding on a CDC-ACM virtual serial port, including the
-                *  baud rate, parity, stop bits and data bits.
-                */
-               #define REQ_SetLineEncoding          0x20
-
-               /** CDC Class Specific request to set the state of the serial handshake lines (such as DCD and RTS) on
-                *  a CDC-ACM virtual serial port.
-                */
-               #define REQ_SetControlLineState      0x22
-               
                /** Version major of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MAJOR     0x01
 
                /** Version minor of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MINOR     0x00
                /** 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
 
                /** 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 */
+               /** Eight character bootloader firmware identifier reported to the host when requested. */
                #define SOFTWARE_IDENTIFIER          "LUFACDC"
                #define SOFTWARE_IDENTIFIER          "LUFACDC"
-               
-       /* 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;
 
 
-               /** Type define for the CDC-ACM virtual serial port line encoding options, including baud rate, format, parity
-                *  and size of each data chunk in bits.
-                */
-               typedef struct
-               {
-                       uint32_t BaudRateBPS; /**< Baud rate in BPS */
-                       uint8_t  CharFormat; /**< Character format, an entry from the BootloaderCDC_CDC_LineCodingFormats_t enum */
-                       uint8_t  ParityType; /**< Parity mode, an entry from the BootloaderCDC_CDC_LineCodeingParity_t enum */
-                       uint8_t  DataBits; /**< Size of each data chunk, in bits */
-               } CDC_Line_Coding_t;
-               
+               /** Magic bootloader key to unlock forced application start mode. */
+               #define MAGIC_BOOT_KEY               0xDC42
+
        /* Enums: */
        /* Enums: */
-               /** Enum for the possible line encoding formats on a CDC-ACM virtual serial port */
-               enum BootloaderCDC_CDC_LineCodingFormats_t
+               /** Possible memory types that can be addressed via the bootloader. */
+               enum AVR109_Memories
                {
                {
-                       OneStopBit          = 0, /**< Single stop bit */
-                       OneAndAHalfStopBits = 1, /**< 1.5 stop bits */
-                       TwoStopBits         = 2, /**< Two stop bits */
+                       MEMORY_TYPE_FLASH  = 'F',
+                       MEMORY_TYPE_EEPROM = 'E',
                };
                };
-               
-               /** Enum for the possible parity modes on a CDC-ACM virtual serial port */
-               enum BootloaderCDC_CDC_LineCodingParity_t
+
+               /** Possible commands that can be issued to the bootloader. */
+               enum AVR109_Commands
                {
                {
-                       Parity_None         = 0, /**< No data parity checking */
-                       Parity_Odd          = 1, /**< Odd data parity checking */
-                       Parity_Even         = 2, /**< Even data parity checking */
-                       Parity_Mark         = 3, /**< Mark data parity checking */
-                       Parity_Space        = 4, /**< Space data parity checking */
+                       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: */
        /* Function Prototypes: */
-               void CDC_Task(void);
-               void SetupHardware(void);
+               static void CDC_Task(void);
+               static void SetupHardware(void);
+
+               void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
 
                void EVENT_USB_Device_ConfigurationChanged(void);
 
                void EVENT_USB_Device_ConfigurationChanged(void);
-               void EVENT_USB_Device_UnhandledControlRequest(void);
 
                #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
 
                #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
+                       #if !defined(NO_BLOCK_SUPPORT)
                        static void    ReadWriteMemoryBlock(const uint8_t Command);
                        static void    ReadWriteMemoryBlock(const uint8_t Command);
+                       #endif
                        static uint8_t FetchNextCommandByte(void);
                        static void    WriteNextResponseByte(const uint8_t Response);
                #endif
 
 #endif
                        static uint8_t FetchNextCommandByte(void);
                        static void    WriteNextResponseByte(const uint8_t Response);
                #endif
 
 #endif
+
Lightweight USB Framework for AVRs