tmk_core/protocol/lufa/LUFA-git/Bootloaders/CDC/BootloaderCDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for BootloaderCDC.c.
  34  */
  35
  36 #ifndef _CDC_H_
  37 #define _CDC_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/boot.h>
  43                 #include <avr/eeprom.h>
  44                 #include <avr/power.h>
  45                 #include <avr/interrupt.h>
  46                 #include <stdbool.h>
  47
  48                 #include "Descriptors.h"
  49                 #include "BootloaderAPI.h"
  50                 #include "Config/AppConfig.h"
  51
  52                 #include <LUFA/Drivers/USB/USB.h>
  53                 #include <LUFA/Drivers/Board/LEDs.h>
  54                 #include <LUFA/Platform/Platform.h>
  55
  56         /* Preprocessor Checks: */
  57                 #if !defined(__OPTIMIZE_SIZE__)
  58                         #error This bootloader requires that it be optimized for size, not speed, to fit into the target device. Change optimization settings and try again.
  59                 #endif
  60
  61         /* Macros: */
  62                 /** Version major of the CDC bootloader. */
  63                 #define BOOTLOADER_VERSION_MAJOR     0x01
  64
  65                 /** Version minor of the CDC bootloader. */
  66                 #define BOOTLOADER_VERSION_MINOR     0x00
  67
  68                 /** Hardware version major of the CDC bootloader. */
  69                 #define BOOTLOADER_HWVERSION_MAJOR   0x01
  70
  71                 /** Hardware version minor of the CDC bootloader. */
  72                 #define BOOTLOADER_HWVERSION_MINOR   0x00
  73
  74                 /** Eight character bootloader firmware identifier reported to the host when requested. */
  75                 #define SOFTWARE_IDENTIFIER          "LUFACDC"
  76
  77                 /** Magic bootloader key to unlock forced application start mode. */
  78                 #define MAGIC_BOOT_KEY               0xDC42
  79
  80         /* Enums: */
  81                 /** Possible memory types that can be addressed via the bootloader. */
  82                 enum AVR109_Memories
  83                 {
  84                         MEMORY_TYPE_FLASH  = 'F',
  85                         MEMORY_TYPE_EEPROM = 'E',
  86                 };
  87
  88                 /** Possible commands that can be issued to the bootloader. */
  89                 enum AVR109_Commands
  90                 {
  91                         AVR109_COMMAND_Sync                     = 27,
  92                         AVR109_COMMAND_ReadEEPROM               = 'd',
  93                         AVR109_COMMAND_WriteEEPROM              = 'D',
  94                         AVR109_COMMAND_ReadFLASHWord            = 'R',
  95                         AVR109_COMMAND_WriteFlashPage           = 'm',
  96                         AVR109_COMMAND_FillFlashPageWordLow     = 'c',
  97                         AVR109_COMMAND_FillFlashPageWordHigh    = 'C',
  98                         AVR109_COMMAND_GetBlockWriteSupport     = 'b',
  99                         AVR109_COMMAND_BlockWrite               = 'B',
 100                         AVR109_COMMAND_BlockRead                = 'g',
 101                         AVR109_COMMAND_ReadExtendedFuses        = 'Q',
 102                         AVR109_COMMAND_ReadHighFuses            = 'N',
 103                         AVR109_COMMAND_ReadLowFuses             = 'F',
 104                         AVR109_COMMAND_ReadLockbits             = 'r',
 105                         AVR109_COMMAND_WriteLockbits            = 'l',
 106                         AVR109_COMMAND_EraseFLASH               = 'e',
 107                         AVR109_COMMAND_ReadSignature            = 's',
 108                         AVR109_COMMAND_ReadBootloaderSWVersion  = 'V',
 109                         AVR109_COMMAND_ReadBootloaderHWVersion  = 'v',
 110                         AVR109_COMMAND_ReadBootloaderIdentifier = 'S',
 111                         AVR109_COMMAND_ReadBootloaderInterface  = 'p',
 112                         AVR109_COMMAND_SetCurrentAddress        = 'A',
 113                         AVR109_COMMAND_ReadAutoAddressIncrement = 'a',
 114                         AVR109_COMMAND_ReadPartCode             = 't',
 115                         AVR109_COMMAND_EnterProgrammingMode     = 'P',
 116                         AVR109_COMMAND_LeaveProgrammingMode     = 'L',
 117                         AVR109_COMMAND_SelectDeviceType         = 'T',
 118                         AVR109_COMMAND_SetLED                   = 'x',
 119                         AVR109_COMMAND_ClearLED                 = 'y',
 120                         AVR109_COMMAND_ExitBootloader           = 'E',
 121                 };
 122
 123         /* Type Defines: */
 124                 /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
 125                 typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
 126
 127         /* Function Prototypes: */
 128                 static void CDC_Task(void);
 129                 static void SetupHardware(void);
 130
 131                 void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
 132
 133                 void EVENT_USB_Device_ConfigurationChanged(void);
 134
 135                 #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
 136                         #if !defined(NO_BLOCK_SUPPORT)
 137                         static void    ReadWriteMemoryBlock(const uint8_t Command);
 138                         #endif
 139                         static uint8_t FetchNextCommandByte(void);
 140                         static void    WriteNextResponseByte(const uint8_t Response);
 141                 #endif
 142
 143 #endif
 144