Bootloaders/CDC/BootloaderCDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 <stdbool.h>
  46
  47                 #include "Descriptors.h"
  48
  49                 #include <LUFA/Drivers/USB/USB.h>
  50
  51         /* Macros: */
  52                 /** CDC Class Specific request to get the line encoding on a CDC-ACM virtual serial port, including the
  53                  *  baud rate, parity, stop bits and data bits.
  54                  */
  55                 #define REQ_GetLineEncoding          0x21
  56
  57                 /** CDC Class Specific request to set the line encoding on a CDC-ACM virtual serial port, including the
  58                  *  baud rate, parity, stop bits and data bits.
  59                  */
  60                 #define REQ_SetLineEncoding          0x20
  61
  62                 /** CDC Class Specific request to set the state of the serial handshake lines (such as DCD and RTS) on
  63                  *  a CDC-ACM virtual serial port.
  64                  */
  65                 #define REQ_SetControlLineState      0x22
  66
  67                 /** Version major of the CDC bootloader. */
  68                 #define BOOTLOADER_VERSION_MAJOR     0x01
  69
  70                 /** Version minor of the CDC bootloader. */
  71                 #define BOOTLOADER_VERSION_MINOR     0x00
  72
  73                 /** Hardware version major of the CDC bootloader. */
  74                 #define BOOTLOADER_HWVERSION_MAJOR   0x01
  75
  76                 /** Hardware version minor of the CDC bootloader. */
  77                 #define BOOTLOADER_HWVERSION_MINOR   0x00
  78
  79                 /** Eight character bootloader firmware identifier reported to the host when requested */
  80                 #define SOFTWARE_IDENTIFIER          "LUFACDC"
  81
  82         /* Type Defines: */
  83                 /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
  84                 typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
  85
  86                 /** Type define for the CDC-ACM virtual serial port line encoding options, including baud rate, format, parity
  87                  *  and size of each data chunk in bits.
  88                  */
  89                 typedef struct
  90                 {
  91                         uint32_t BaudRateBPS; /**< Baud rate in BPS */
  92                         uint8_t  CharFormat; /**< Character format, an entry from the BootloaderCDC_CDC_LineCodingFormats_t enum */
  93                         uint8_t  ParityType; /**< Parity mode, an entry from the BootloaderCDC_CDC_LineCodeingParity_t enum */
  94                         uint8_t  DataBits; /**< Size of each data chunk, in bits */
  95                 } CDC_Line_Coding_t;
  96
  97         /* Enums: */
  98                 /** Enum for the possible line encoding formats on a CDC-ACM virtual serial port */
  99                 enum BootloaderCDC_CDC_LineCodingFormats_t
 100                 {
 101                         OneStopBit          = 0, /**< Single stop bit */
 102                         OneAndAHalfStopBits = 1, /**< 1.5 stop bits */
 103                         TwoStopBits         = 2, /**< Two stop bits */
 104                 };
 105
 106                 /** Enum for the possible parity modes on a CDC-ACM virtual serial port */
 107                 enum BootloaderCDC_CDC_LineCodeingParity_t
 108                 {
 109                         Parity_None         = 0, /**< No data parity checking */
 110                         Parity_Odd          = 1, /**< Odd data parity checking */
 111                         Parity_Even         = 2, /**< Even data parity checking */
 112                         Parity_Mark         = 3, /**< Mark data parity checking */
 113                         Parity_Space        = 4, /**< Space data parity checking */
 114                 };
 115
 116         /* Function Prototypes: */
 117                 void CDC_Task(void);
 118                 void SetupHardware(void);
 119                 void ResetHardware(void);
 120
 121                 void EVENT_USB_Device_Disconnect(void);
 122                 void EVENT_USB_Device_ConfigurationChanged(void);
 123                 void EVENT_USB_Device_UnhandledControlRequest(void);
 124
 125                 #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
 126                         static void    ReadWriteMemoryBlock(const uint8_t Command);
 127                         static uint8_t FetchNextCommandByte(void);
 128                         static void    WriteNextResponseByte(const uint8_t Response);
 129                 #endif
 130
 131 #endif