Projects/Benito/Benito.c

   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  *  Main source file for the Benito project. This file contains the main tasks of
  34  *  the project and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "Benito.h"
  38
  39 /** Circular buffer to hold data from the serial port before it is sent to the host. */
  40 RingBuff_t Tx_Buffer;
  41
  42 /** Pulse generation counters to keep track of the number of milliseconds remaining for each pulse type */
  43 volatile struct
  44 {
  45         uint8_t ResetPulse; /**< Milliseconds remaining for target /RESET pulse */
  46         uint8_t TxLEDPulse; /**< Milliseconds remaining for data Tx LED pulse */
  47         uint8_t RxLEDPulse; /**< Milliseconds remaining for data Rx LED pulse */
  48         uint8_t PingPongLEDPulse; /**< Milliseconds remaining for enumeration Tx/Rx ping-pong LED pulse */
  49 } PulseMSRemaining;
  50
  51 /** Previous state of the virtual DTR control line from the host */
  52 bool PreviousDTRState = false;
  53
  54 /** LUFA CDC Class driver interface configuration and state information. This structure is
  55  *  passed to all CDC Class driver functions, so that multiple instances of the same class
  56  *  within a device can be differentiated from one another.
  57  */
  58 USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
  59         {
  60                 .Config =
  61                         {
  62                                 .ControlInterfaceNumber         = 0,
  63
  64                                 .DataINEndpointNumber           = CDC_TX_EPNUM,
  65                                 .DataINEndpointSize             = CDC_TXRX_EPSIZE,
  66                                 .DataINEndpointDoubleBank       = false,
  67
  68                                 .DataOUTEndpointNumber          = CDC_RX_EPNUM,
  69                                 .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
  70                                 .DataOUTEndpointDoubleBank      = false,
  71
  72                                 .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
  73                                 .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
  74                                 .NotificationEndpointDoubleBank = false,
  75                         },
  76         };
  77
  78 /** Main program entry point. This routine contains the overall program flow, including initial
  79  *  setup of all components and the main program loop.
  80  */
  81 int main(void)
  82 {
  83         SetupHardware();
  84
  85         Buffer_Initialize(&Tx_Buffer);
  86
  87         sei();
  88
  89         for (;;)
  90         {
  91                 /* Echo bytes from the host to the target via the hardware USART */
  92                 while (CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface) > 0)
  93                 {
  94                         Serial_TxByte(CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
  95
  96                         LEDs_TurnOnLEDs(LEDMASK_TX);
  97                         PulseMSRemaining.TxLEDPulse = TX_RX_LED_PULSE_MS;
  98                 }
  99
 100                 /* Echo bytes from the target to the host via the virtual serial port */
 101                 while (Tx_Buffer.Elements > 0)
 102                 {
 103                         CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&Tx_Buffer));
 104
 105                         LEDs_TurnOnLEDs(LEDMASK_RX);
 106                         PulseMSRemaining.RxLEDPulse = TX_RX_LED_PULSE_MS;
 107                 }
 108
 109                 /* Check if the millisecond timer has elapsed */
 110                 if (TIFR0 & (1 << OCF0A))
 111                 {
 112                         /* Check if the reset pulse period has elapsed, if so tristate the target reset line */
 113                         if (PulseMSRemaining.ResetPulse && !(--PulseMSRemaining.ResetPulse))
 114                         {
 115                                 LEDs_TurnOffLEDs(LEDMASK_BUSY);
 116                                 AVR_RESET_LINE_DDR &= ~AVR_RESET_LINE_MASK;
 117                         }
 118
 119                         /* Check if the LEDs should be ping-ponging (during enumeration) */
 120                         if (PulseMSRemaining.PingPongLEDPulse && !(--PulseMSRemaining.PingPongLEDPulse))
 121                         {
 122                                 LEDs_ToggleLEDs(LEDMASK_TX | LEDMASK_RX);
 123                                 PulseMSRemaining.PingPongLEDPulse = PING_PONG_LED_PULSE_MS;
 124                         }
 125
 126                         /* Turn off TX LED(s) once the TX pulse period has elapsed */
 127                         if (PulseMSRemaining.TxLEDPulse && !(--PulseMSRemaining.TxLEDPulse))
 128                           LEDs_TurnOffLEDs(LEDMASK_TX);
 129
 130                         /* Turn off RX LED(s) once the RX pulse period has elapsed */
 131                         if (PulseMSRemaining.RxLEDPulse && !(--PulseMSRemaining.RxLEDPulse))
 132                           LEDs_TurnOffLEDs(LEDMASK_RX);
 133
 134                         /* Clear the millisecond timer CTC flag (cleared by writing logic one to the register) */
 135                         TIFR0 |= (1 << OCF0A);
 136                 }
 137
 138                 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 139                 USB_USBTask();
 140         }
 141 }
 142
 143 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 144 void SetupHardware(void)
 145 {
 146         /* Disable watchdog if enabled by bootloader/fuses */
 147         MCUSR &= ~(1 << WDRF);
 148         wdt_disable();
 149
 150         /* Hardware Initialization */
 151         Serial_Init(9600, false);
 152         LEDs_Init();
 153         USB_Init();
 154
 155         /* Millisecond Timer Interrupt */
 156         OCR0A  = (F_CPU / 64 / 1000);
 157         TCCR0A = (1 << WGM01);
 158         TCCR0B = ((1 << CS01) | (1 << CS00));
 159
 160         /* Tristate target /RESET Line */
 161         AVR_RESET_LINE_PORT &= ~AVR_RESET_LINE_MASK;
 162         AVR_RESET_LINE_DDR  &= ~AVR_RESET_LINE_MASK;
 163 }
 164
 165 /** Event handler for the library USB Connection event. */
 166 void EVENT_USB_Device_Connect(void)
 167 {
 168         PulseMSRemaining.PingPongLEDPulse = PING_PONG_LED_PULSE_MS;
 169         LEDs_SetAllLEDs(LEDMASK_TX);
 170 }
 171
 172 /** Event handler for the library USB Disconnection event. */
 173 void EVENT_USB_Device_Disconnect(void)
 174 {
 175         PulseMSRemaining.PingPongLEDPulse = 0;
 176         LEDs_SetAllLEDs(LEDS_NO_LEDS);
 177 }
 178
 179 /** Event handler for the library USB Configuration Changed event. */
 180 void EVENT_USB_Device_ConfigurationChanged(void)
 181 {
 182         PulseMSRemaining.PingPongLEDPulse = 0;
 183         LEDs_SetAllLEDs(LEDS_NO_LEDS);
 184
 185         if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
 186           LEDs_SetAllLEDs(LEDMASK_ERROR);
 187 }
 188
 189 /** Event handler for the library USB Unhandled Control Request event. */
 190 void EVENT_USB_Device_UnhandledControlRequest(void)
 191 {
 192         CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 193 }
 194
 195 /** Event handler for the CDC Class driver Line Encoding Changed event.
 196  *
 197  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 198  */
 199 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 200 {
 201         uint8_t ConfigMask = 0;
 202
 203         switch (CDCInterfaceInfo->State.LineEncoding.ParityType)
 204         {
 205                 case CDC_PARITY_Odd:
 206                         ConfigMask = ((1 << UPM11) | (1 << UPM10));
 207                         break;
 208                 case CDC_PARITY_Even:
 209                         ConfigMask = (1 << UPM11);
 210                         break;
 211         }
 212
 213         if (CDCInterfaceInfo->State.LineEncoding.CharFormat == CDC_LINEENCODING_TwoStopBits)
 214           ConfigMask |= (1 << USBS1);
 215
 216         switch (CDCInterfaceInfo->State.LineEncoding.DataBits)
 217         {
 218                 case 6:
 219                         ConfigMask |= (1 << UCSZ10);
 220                         break;
 221                 case 7:
 222                         ConfigMask |= (1 << UCSZ11);
 223                         break;
 224                 case 8:
 225                         ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));
 226                         break;
 227         }
 228
 229         UCSR1A = (1 << U2X1);
 230         UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));
 231         UCSR1C = ConfigMask;
 232         UBRR1  = SERIAL_2X_UBBRVAL((uint16_t)CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
 233 }
 234
 235 /** ISR to manage the reception of data from the serial port, placing received bytes into a circular buffer
 236  *  for later transmission to the host.
 237  */
 238 ISR(USART1_RX_vect, ISR_BLOCK)
 239 {
 240         uint8_t ReceivedByte = UDR1;
 241
 242         if (USB_DeviceState == DEVICE_STATE_Configured)
 243           Buffer_StoreElement(&Tx_Buffer, ReceivedByte);
 244 }
 245
 246 /** Event handler for the CDC Class driver Host-to-Device Line Encoding Changed event.
 247  *
 248  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 249  */
 250 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 251 {
 252         bool CurrentDTRState = (CDCInterfaceInfo->State.ControlLineStates.HostToDevice & CDC_CONTROL_LINE_OUT_DTR);
 253
 254         /* Check if the DTR line has been asserted - if so, start the target AVR's reset pulse */
 255         if (!(PreviousDTRState) && CurrentDTRState)
 256         {
 257                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 258
 259                 AVR_RESET_LINE_DDR |= AVR_RESET_LINE_MASK;
 260                 PulseMSRemaining.ResetPulse = AVR_RESET_PULSE_MS;
 261         }
 262
 263         PreviousDTRState = CurrentDTRState;
 264 }