Minor documentation improvements. Remove AS4 project generator script as it is buggy...
[pub/USBasp.git] / Bootloaders / CDC / BootloaderCDC.h
index b445913..b11fa8f 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
                #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>
 
        /* Macros: */
                /** Version major of the CDC bootloader. */
                /** 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"
 
-               /** CDC Class specific request to get the current virtual serial port configuration settings. */
-               #define REQ_GetLineEncoding          0x21
-
-               /** CDC Class specific request to set the current virtual serial port configuration settings. */
-               #define REQ_SetLineEncoding          0x20
-
-       /* Type Defines: */
-               /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration
-                *  as set by the host via a class specific request.
-                */
-               typedef struct
-               {
-                       uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
-                       uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
-                                             *   CDCDevice_CDC_LineCodingFormats_t enum
-                                             */
-                       uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
-                                             *   CDCDevice_LineCodingParity_t enum
-                                             */
-                       uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
-               } CDC_Line_Coding_t;
-
-               /** 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;
-
+               /** Magic bootloader key to unlock forced application start mode. */
+               #define MAGIC_BOOT_KEY               0xDC42
+       
        /* Enums: */
-               /** Enum for the possible line encoding formats of a virtual serial port. */
-               enum CDCDevice_CDC_LineCodingFormats_t
+               /** Possible memory types that can be addressed via the bootloader. */
+               enum AVR109_Memories
                {
-                       OneStopBit          = 0, /**< Each frame contains one stop bit */
-                       OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
-                       TwoStopBits         = 2, /**< Each frame contains two stop bits */
+                       MEMORY_TYPE_FLASH  = 'F',
+                       MEMORY_TYPE_EEPROM = 'E',
                };
-
-               /** Enum for the possible line encoding parity settings of a virtual serial port. */
-               enum CDCDevice_LineCodingParity_t
+               
+               /** Possible commands that can be issued to the bootloader. */
+               enum AVR109_Commands
                {
-                       Parity_None         = 0, /**< No parity bit mode on each frame */
-                       Parity_Odd          = 1, /**< Odd parity bit mode on each frame */
-                       Parity_Even         = 2, /**< Even parity bit mode on each frame */
-                       Parity_Mark         = 3, /**< Mark parity bit mode on each frame */
-                       Parity_Space        = 4, /**< Space parity bit mode on each frame */
+                       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_ReadBootloaderVersion    = '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: */
-               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);