Bootloaders/Printer/BootloaderPrinter.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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 BootloaderPrinter.c.
  34  */
  35
  36 #ifndef _BOOTLOADER_PRINTER_H_
  37 #define _BOOTLOADER_PRINTER_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <avr/interrupt.h>
  44                 #include <util/delay.h>
  45
  46                 #include "Descriptors.h"
  47                 #include "BootloaderAPI.h"
  48
  49                 #include <LUFA/Drivers/Board/LEDs.h>
  50                 #include <LUFA/Drivers/USB/USB.h>
  51                 #include <LUFA/Platform/Platform.h>
  52
  53         /* Preprocessor Checks: */
  54                 #if !defined(__OPTIMIZE_SIZE__)
  55                         #error This bootloader requires that it be optimized for size, not speed, to fit into the target device. Change optimization settings and try again.
  56                 #endif
  57
  58         /* Macros: */
  59                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  60                 #define LEDMASK_USB_NOTREADY       LEDS_LED1
  61
  62                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  63                 #define LEDMASK_USB_ENUMERATING   (LEDS_LED2 | LEDS_LED3)
  64
  65                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  66                 #define LEDMASK_USB_READY         (LEDS_LED2 | LEDS_LED4)
  67
  68                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  69                 #define LEDMASK_USB_ERROR         (LEDS_LED1 | LEDS_LED3)
  70
  71                 /** LED mask for the library LED driver, to indicate that the USB interface is busy. */
  72                 #define LEDMASK_USB_BUSY           LEDS_LED2
  73
  74                 /** Magic bootloader key to unlock forced application start mode. */
  75                 #define MAGIC_BOOT_KEY             0xDC42
  76
  77         /* Type Defines: */
  78                 #if (FLASHEND > 0xFFFF)
  79                         typedef uint32_t flashaddr_t;
  80                 #else
  81                         typedef uint16_t flashaddr_t;
  82                 #endif
  83
  84         /* Enums: */
  85                 /** Intel HEX parser state machine states. */
  86                 enum HEX_Parser_States_t
  87                 {
  88                         HEX_PARSE_STATE_WAIT_LINE,    /**< Parser is waiting for a HEX Start of Line character. */
  89                         HEX_PARSE_STATE_BYTE_COUNT,   /**< Parser is waiting for a record byte count. */
  90                         HEX_PARSE_STATE_ADDRESS_HIGH, /**< Parser is waiting for the MSB of a record address. */
  91                         HEX_PARSE_STATE_ADDRESS_LOW,  /**< Parser is waiting for the LSB of a record address. */
  92                         HEX_PARSE_STATE_RECORD_TYPE,  /**< Parser is waiting for the record type. */
  93                         HEX_PARSE_STATE_READ_DATA,    /**< Parser is waiting for more data in the current record. */
  94                         HEX_PARSE_STATE_CHECKSUM,     /**< Parser is waiting for the checksum of the current record. */
  95                 };
  96
  97                 /** Intel HEX record types, used to indicate the type of record contained in a line of a HEX file. */
  98                 enum HEX_Record_Types_t
  99                 {
 100                         HEX_RECORD_TYPE_Data                   = 0, /**< Record contains loadable data. */
 101                         HEX_RECORD_TYPE_EndOfFile              = 1, /**< End of file record. */
 102                         HEX_RECORD_TYPE_ExtendedSegmentAddress = 2, /**< Extended segment start record. */
 103                         HEX_RECORD_TYPE_StartSegmentAddress    = 3, /**< Normal segment start record. */
 104                         HEX_RECORD_TYPE_ExtendedLinearAddress  = 4, /**< Extended linear address start record. */
 105                         HEX_RECORD_TYPE_StartLinearAddress     = 5, /**< Linear address start record. */
 106                 };
 107
 108         /* Function Prototypes: */
 109                 static void SetupHardware(void);
 110
 111                 void EVENT_USB_Device_Connect(void);
 112                 void EVENT_USB_Device_Disconnect(void);
 113                 void EVENT_USB_Device_ConfigurationChanged(void);
 114                 void EVENT_USB_Device_ControlRequest(void);
 115
 116 #endif
 117