tmk_core/protocol/lufa/LUFA-git/Bootloaders/HID/BootloaderHID.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 BootloaderHID.c.
  34  */
  35
  36 #ifndef _BOOTLOADERHID_H_
  37 #define _BOOTLOADERHID_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/boot.h>
  43                 #include <avr/power.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdbool.h>
  46
  47                 #include "Descriptors.h"
  48
  49                 #include <LUFA/Drivers/USB/USB.h>
  50                 #include <LUFA/Platform/Platform.h>
  51
  52         /* Preprocessor Checks: */
  53                 #if !defined(__OPTIMIZE_SIZE__)
  54                         #error This bootloader requires that it be optimized for size, not speed, to fit into the target device. Change optimization settings and try again.
  55                 #endif
  56
  57         /* Macros: */
  58                 /** Bootloader special address to start the user application */
  59                 #define COMMAND_STARTAPPLICATION   0xFFFF
  60
  61                 /** Magic bootloader key to unlock forced application start mode. */
  62                 #define MAGIC_BOOT_KEY             0xDC42
  63
  64         /* Function Prototypes: */
  65                 static void SetupHardware(void);
  66
  67                 void Application_Jump_Check(void) ATTR_INIT_SECTION(3);
  68
  69                 void EVENT_USB_Device_ConfigurationChanged(void);
  70                 void EVENT_USB_Device_UnhandledControlRequest(void);
  71
  72 #endif
  73