/ bootloaders / caterina / Caterina.h
Caterina.h
  1  /*
  2               LUFA Library
  3       Copyright (C) Dean Camera, 2011.
  4  
  5    dean [at] fourwalledcubicle [dot] com
  6             www.lufa-lib.org
  7  */
  8  
  9  /*
 10    Copyright 2011  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  	/* Macros: */
 52  		/** Version major of the CDC bootloader. */
 53  		#define BOOTLOADER_VERSION_MAJOR     0x01
 54  
 55  		/** Version minor of the CDC bootloader. */
 56  		#define BOOTLOADER_VERSION_MINOR     0x00
 57  
 58  		/** Hardware version major of the CDC bootloader. */
 59  		#define BOOTLOADER_HWVERSION_MAJOR   0x01
 60  
 61  		/** Hardware version minor of the CDC bootloader. */
 62  		#define BOOTLOADER_HWVERSION_MINOR   0x00
 63  
 64  		/** Eight character bootloader firmware identifier reported to the host when requested */
 65  		#define SOFTWARE_IDENTIFIER          "CATERINA"
 66  		
 67  		#define CPU_PRESCALE(n)	(CLKPR = 0x80, CLKPR = (n))
 68  		#define LED_SETUP()		DDRC |= (1<<7); DDRB |= (1<<0); DDRD |= (1<<5);
 69  		#define L_LED_OFF()		PORTC &= ~(1<<7)
 70  		#define L_LED_ON()		PORTC |= (1<<7)
 71  		#define L_LED_TOGGLE()	PORTC ^= (1<<7)
 72  		#if DEVICE_PID == 0x0037	// polarity of the RX and TX LEDs is reversed on the Micro
 73  			#define TX_LED_OFF()	PORTD &= ~(1<<5)
 74  			#define TX_LED_ON()		PORTD |= (1<<5)
 75  			#define RX_LED_OFF()	PORTB &= ~(1<<0)
 76  			#define RX_LED_ON()		PORTB |= (1<<0)			
 77  		#else 
 78  			#define TX_LED_OFF()	PORTD |= (1<<5)
 79  			#define TX_LED_ON()		PORTD &= ~(1<<5)
 80  			#define RX_LED_OFF()	PORTB |= (1<<0)
 81  			#define RX_LED_ON()		PORTB &= ~(1<<0)
 82  		#endif
 83  
 84  	/* Type Defines: */
 85  		/** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
 86  		typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
 87  
 88  	/* Function Prototypes: */
 89  		void StartSketch(void);
 90  		void LEDPulse(void);
 91  	
 92  		void CDC_Task(void);
 93  		void SetupHardware(void);
 94  
 95  		void EVENT_USB_Device_ConfigurationChanged(void);
 96  
 97  		#if defined(INCLUDE_FROM_CATERINA_C) || defined(__DOXYGEN__)
 98  			#if !defined(NO_BLOCK_SUPPORT)
 99  			static void    ReadWriteMemoryBlock(const uint8_t Command);
100  			#endif
101  			static uint8_t FetchNextCommandByte(void);
102  			static void    WriteNextResponseByte(const uint8_t Response);
103  		#endif
104  
105  #endif
106