Bootloaders/CDC/BootloaderCDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 <util/delay.h>
  47                 #include <stdbool.h>
  48
  49                 #include "Descriptors.h"
  50                 #include "BootloaderAPI.h"
  51                 #include "Config/AppConfig.h"
  52
  53                 #include <LUFA/Drivers/USB/USB.h>
  54                 #include <LUFA/Drivers/Board/LEDs.h>
  55                 #include <LUFA/Platform/Platform.h>
  56
  57         /* Preprocessor Checks: */
  58                 #if !defined(__OPTIMIZE_SIZE__)
  59                         #error This bootloader requires that it be optimized for size, not speed, to fit into the target device. Change optimization settings and try again.
  60                 #endif
  61
  62         /* Macros: */
  63                 /** Version major of the CDC bootloader. */
  64                 #define BOOTLOADER_VERSION_MAJOR     0x01
  65
  66                 /** Version minor of the CDC bootloader. */
  67                 #define BOOTLOADER_VERSION_MINOR     0x00
  68
  69                 /** Hardware version major of the CDC bootloader. */
  70                 #define BOOTLOADER_HWVERSION_MAJOR   0x01
  71
  72                 /** Hardware version minor of the CDC bootloader. */
  73                 #define BOOTLOADER_HWVERSION_MINOR   0x00
  74
  75                 /** Eight character bootloader firmware identifier reported to the host when requested. */
  76                 #define SOFTWARE_IDENTIFIER          "LUFACDC"
  77
  78                 /** Magic bootloader key to unlock forced application start mode. */
  79                 #define MAGIC_BOOT_KEY               0xDC42
  80
  81         /* Enums: */
  82                 /** Possible memory types that can be addressed via the bootloader. */
  83                 enum AVR109_Memories
  84                 {
  85                         MEMORY_TYPE_FLASH  = 'F',
  86                         MEMORY_TYPE_EEPROM = 'E',
  87                 };
  88
  89                 /** Possible commands that can be issued to the bootloader. */
  90                 enum AVR109_Commands
  91                 {
  92                         AVR109_COMMAND_Sync                     = 27,
  93                         AVR109_COMMAND_ReadEEPROM               = 'd',
  94                         AVR109_COMMAND_WriteEEPROM              = 'D',
  95                         AVR109_COMMAND_ReadFLASHWord            = 'R',
  96                         AVR109_COMMAND_WriteFlashPage           = 'm',
  97                         AVR109_COMMAND_FillFlashPageWordLow     = 'c',
  98                         AVR109_COMMAND_FillFlashPageWordHigh    = 'C',
  99                         AVR109_COMMAND_GetBlockWriteSupport     = 'b',
 100                         AVR109_COMMAND_BlockWrite               = 'B',
 101                         AVR109_COMMAND_BlockRead                = 'g',
 102                         AVR109_COMMAND_ReadExtendedFuses        = 'Q',
 103                         AVR109_COMMAND_ReadHighFuses            = 'N',
 104                         AVR109_COMMAND_ReadLowFuses             = 'F',
 105                         AVR109_COMMAND_ReadLockbits             = 'r',
 106                         AVR109_COMMAND_WriteLockbits            = 'l',
 107                         AVR109_COMMAND_EraseFLASH               = 'e',
 108                         AVR109_COMMAND_ReadSignature            = 's',
 109                         AVR109_COMMAND_ReadBootloaderSWVersion  = 'V',
 110                         AVR109_COMMAND_ReadBootloaderHWVersion  = 'v',
 111                         AVR109_COMMAND_ReadBootloaderIdentifier = 'S',
 112                         AVR109_COMMAND_ReadBootloaderInterface  = 'p',
 113                         AVR109_COMMAND_SetCurrentAddress        = 'A',
 114                         AVR109_COMMAND_ReadAutoAddressIncrement = 'a',
 115                         AVR109_COMMAND_ReadPartCode             = 't',
 116                         AVR109_COMMAND_EnterProgrammingMode     = 'P',
 117                         AVR109_COMMAND_LeaveProgrammingMode     = 'L',
 118                         AVR109_COMMAND_SelectDeviceType         = 'T',
 119                         AVR109_COMMAND_SetLED                   = 'x',
 120                         AVR109_COMMAND_ClearLED                 = 'y',
 121                         AVR109_COMMAND_ExitBootloader           = 'E',
 122                 };
 123
 124         /* Type Defines: */
 125                 /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
 126                 typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
 127
 128         /* Function Prototypes: */
 129                 static void CDC_Task(void);
 130                 static void SetupHardware(void);
 131
 132                 void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
 133
 134                 void EVENT_USB_Device_ConfigurationChanged(void);
 135
 136                 #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
 137                         #if !defined(NO_BLOCK_SUPPORT)
 138                         static void    ReadWriteMemoryBlock(const uint8_t Command);
 139                         #endif
 140                         static uint8_t FetchNextCommandByte(void);
 141                         static void    WriteNextResponseByte(const uint8_t Response);
 142                 #endif
 143
 144 #endif
 145