Bootloaders/CDC/BootloaderCDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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
  50                 #include <LUFA/Drivers/USB/USB.h>
  51
  52         /* Macros: */
  53                 /** Version major of the CDC bootloader. */
  54                 #define BOOTLOADER_VERSION_MAJOR     0x01
  55
  56                 /** Version minor of the CDC bootloader. */
  57                 #define BOOTLOADER_VERSION_MINOR     0x00
  58
  59                 /** Hardware version major of the CDC bootloader. */
  60                 #define BOOTLOADER_HWVERSION_MAJOR   0x01
  61
  62                 /** Hardware version minor of the CDC bootloader. */
  63                 #define BOOTLOADER_HWVERSION_MINOR   0x00
  64
  65                 /** Eight character bootloader firmware identifier reported to the host when requested */
  66                 #define SOFTWARE_IDENTIFIER          "LUFACDC"
  67
  68                 /** CDC Class specific request to get the current virtual serial port configuration settings. */
  69                 #define REQ_GetLineEncoding          0x21
  70
  71                 /** CDC Class specific request to set the current virtual serial port configuration settings. */
  72                 #define REQ_SetLineEncoding          0x20
  73
  74         /* Type Defines: */
  75                 /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration
  76                  *  as set by the host via a class specific request.
  77                  */
  78                 typedef struct
  79                 {
  80                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  81                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  82                                               *   CDCDevice_CDC_LineCodingFormats_t enum
  83                                               */
  84                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
  85                                               *   CDCDevice_LineCodingParity_t enum
  86                                               */
  87                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
  88                 } CDC_Line_Coding_t;
  89
  90                 /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
  91                 typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
  92
  93         /* Enums: */
  94                 /** Enum for the possible line encoding formats of a virtual serial port. */
  95                 enum CDCDevice_CDC_LineCodingFormats_t
  96                 {
  97                         OneStopBit          = 0, /**< Each frame contains one stop bit */
  98                         OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
  99                         TwoStopBits         = 2, /**< Each frame contains two stop bits */
 100                 };
 101
 102                 /** Enum for the possible line encoding parity settings of a virtual serial port. */
 103                 enum CDCDevice_LineCodingParity_t
 104                 {
 105                         Parity_None         = 0, /**< No parity bit mode on each frame */
 106                         Parity_Odd          = 1, /**< Odd parity bit mode on each frame */
 107                         Parity_Even         = 2, /**< Even parity bit mode on each frame */
 108                         Parity_Mark         = 3, /**< Mark parity bit mode on each frame */
 109                         Parity_Space        = 4, /**< Space parity bit mode on each frame */
 110                 };
 111
 112         /* Function Prototypes: */
 113                 void CDC_Task(void);
 114                 void SetupHardware(void);
 115
 116                 void EVENT_USB_Device_ConfigurationChanged(void);
 117
 118                 #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
 119                         static void    ReadWriteMemoryBlock(const uint8_t Command);
 120                         static uint8_t FetchNextCommandByte(void);
 121                         static void    WriteNextResponseByte(const uint8_t Response);
 122                 #endif
 123
 124 #endif
 125