Bootloaders/CDC/BootloaderCDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 disclaim 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
  51                 #include <LUFA/Drivers/USB/USB.h>
  52                 #include <LUFA/Drivers/Board/LEDs.h>
  53
  54         /* Macros: */
  55                 /** Version major of the CDC bootloader. */
  56                 #define BOOTLOADER_VERSION_MAJOR     0x01
  57
  58                 /** Version minor of the CDC bootloader. */
  59                 #define BOOTLOADER_VERSION_MINOR     0x00
  60
  61                 /** Hardware version major of the CDC bootloader. */
  62                 #define BOOTLOADER_HWVERSION_MAJOR   0x01
  63
  64                 /** Hardware version minor of the CDC bootloader. */
  65                 #define BOOTLOADER_HWVERSION_MINOR   0x00
  66
  67                 /** Eight character bootloader firmware identifier reported to the host when requested */
  68                 #define SOFTWARE_IDENTIFIER          "LUFACDC"
  69
  70                 /** Magic bootloader key to unlock forced application start mode. */
  71                 #define MAGIC_BOOT_KEY            0xDC42CACA
  72
  73         /* Type Defines: */
  74                 /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
  75                 typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
  76
  77         /* Function Prototypes: */
  78                 static void CDC_Task(void);
  79                 static void SetupHardware(void);
  80
  81                 void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
  82
  83                 void EVENT_USB_Device_ConfigurationChanged(void);
  84
  85                 #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
  86                         #if !defined(NO_BLOCK_SUPPORT)
  87                         static void    ReadWriteMemoryBlock(const uint8_t Command);
  88                         #endif
  89                         static uint8_t FetchNextCommandByte(void);
  90                         static void    WriteNextResponseByte(const uint8_t Response);
  91                 #endif
  92
  93 #endif
  94