Projects/Benito/Benito.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   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 USARTtoUSB_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 /** Milliseconds remaining until the receive buffer is flushed to the USB host */
  55 uint8_t FlushPeriodRemaining = RECEIVE_BUFFER_FLUSH_MS;
  56
  57 /** LUFA CDC Class driver interface configuration and state information. This structure is
  58  *  passed to all CDC Class driver functions, so that multiple instances of the same class
  59  *  within a device can be differentiated from one another.
  60  */
  61 USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
  62         {
  63                 .Config =
  64                         {
  65                                 .ControlInterfaceNumber         = 0,
  66
  67                                 .DataINEndpointNumber           = CDC_TX_EPNUM,
  68                                 .DataINEndpointSize             = CDC_TXRX_EPSIZE,
  69                                 .DataINEndpointDoubleBank       = false,
  70
  71                                 .DataOUTEndpointNumber          = CDC_RX_EPNUM,
  72                                 .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
  73                                 .DataOUTEndpointDoubleBank      = false,
  74
  75                                 .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
  76                                 .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
  77                                 .NotificationEndpointDoubleBank = false,
  78                         },
  79         };
  80
  81 /** Main program entry point. This routine contains the overall program flow, including initial
  82  *  setup of all components and the main program loop.
  83  */
  84 int main(void)
  85 {
  86         SetupHardware();
  87
  88         RingBuffer_InitBuffer(&USARTtoUSB_Buffer);
  89
  90         sei();
  91
  92         for (;;)
  93         {
  94                 /* Echo bytes from the host to the target via the hardware USART */
  95                 if ((UCSR1A & (1 << UDRE1)) && CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface))
  96                 {
  97                         UDR1 = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
  98
  99                         LEDs_TurnOnLEDs(LEDMASK_TX);
 100                         PulseMSRemaining.TxLEDPulse = TX_RX_LED_PULSE_MS;
 101                 }
 102
 103                 /* Check if the millisecond timer has elapsed */
 104                 if (TIFR0 & (1 << OCF0A))
 105                 {
 106                         /* Check if the reset pulse period has elapsed, if so tristate the target reset line */
 107                         if (PulseMSRemaining.ResetPulse && !(--PulseMSRemaining.ResetPulse))
 108                         {
 109                                 LEDs_TurnOffLEDs(LEDMASK_BUSY);
 110                                 AVR_RESET_LINE_DDR &= ~AVR_RESET_LINE_MASK;
 111                         }
 112
 113                         /* Check if the LEDs should be ping-ponging (during enumeration) */
 114                         if (PulseMSRemaining.PingPongLEDPulse && !(--PulseMSRemaining.PingPongLEDPulse))
 115                         {
 116                                 LEDs_ToggleLEDs(LEDMASK_TX | LEDMASK_RX);
 117                                 PulseMSRemaining.PingPongLEDPulse = PING_PONG_LED_PULSE_MS;
 118                         }
 119
 120                         /* Turn off TX LED(s) once the TX pulse period has elapsed */
 121                         if (PulseMSRemaining.TxLEDPulse && !(--PulseMSRemaining.TxLEDPulse))
 122                           LEDs_TurnOffLEDs(LEDMASK_TX);
 123
 124                         /* Turn off RX LED(s) once the RX pulse period has elapsed */
 125                         if (PulseMSRemaining.RxLEDPulse && !(--PulseMSRemaining.RxLEDPulse))
 126                           LEDs_TurnOffLEDs(LEDMASK_RX);
 127
 128                         /* Check if the receive buffer flush period has expired */
 129                         RingBuff_Count_t BufferCount = RingBuffer_GetCount(&USARTtoUSB_Buffer);
 130                         if (!(--FlushPeriodRemaining) || (BufferCount > 200))
 131                         {
 132                                 /* Echo bytes from the target to the host via the virtual serial port */
 133                                 if (BufferCount)
 134                                 {
 135                                         while (BufferCount--)
 136                                         {
 137                                                 /* Try to send the next byte of data to the host, abort if there is an error without dequeuing */
 138                                                 if (CDC_Device_SendByte(&VirtualSerial_CDC_Interface,
 139                                                                                                 RingBuffer_Peek(&USARTtoUSB_Buffer)) != ENDPOINT_READYWAIT_NoError)
 140                                                 {
 141                                                         break;
 142                                                 }
 143
 144                                                 /* Dequeue the already sent byte from the buffer now we have confirmed that no transmission error occurred */
 145                                                 RingBuffer_Remove(&USARTtoUSB_Buffer);
 146                                         }
 147
 148                                         LEDs_TurnOnLEDs(LEDMASK_RX);
 149                                         PulseMSRemaining.RxLEDPulse = TX_RX_LED_PULSE_MS;
 150                                 }
 151
 152                                 FlushPeriodRemaining = RECEIVE_BUFFER_FLUSH_MS;
 153                         }
 154
 155                         /* Clear the millisecond timer CTC flag (cleared by writing logic one to the register) */
 156                         TIFR0 |= (1 << OCF0A);
 157                 }
 158
 159                 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 160                 USB_USBTask();
 161         }
 162 }
 163
 164 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 165 void SetupHardware(void)
 166 {
 167         /* Disable watchdog if enabled by bootloader/fuses */
 168         MCUSR &= ~(1 << WDRF);
 169         wdt_disable();
 170
 171         /* Hardware Initialization */
 172         LEDs_Init();
 173         USB_Init();
 174
 175         /* Millisecond Timer Interrupt */
 176         OCR0A  = (F_CPU / 64 / 1000);
 177         TCCR0A = (1 << WGM01);
 178         TCCR0B = ((1 << CS01) | (1 << CS00));
 179
 180         /* Tristate target /RESET Line */
 181         AVR_RESET_LINE_PORT &= ~AVR_RESET_LINE_MASK;
 182         AVR_RESET_LINE_DDR  &= ~AVR_RESET_LINE_MASK;
 183 }
 184
 185 /** Event handler for the library USB Connection event. */
 186 void EVENT_USB_Device_Connect(void)
 187 {
 188         PulseMSRemaining.PingPongLEDPulse = PING_PONG_LED_PULSE_MS;
 189         LEDs_SetAllLEDs(LEDMASK_TX);
 190 }
 191
 192 /** Event handler for the library USB Disconnection event. */
 193 void EVENT_USB_Device_Disconnect(void)
 194 {
 195         PulseMSRemaining.PingPongLEDPulse = 0;
 196         LEDs_SetAllLEDs(LEDS_NO_LEDS);
 197 }
 198
 199 /** Event handler for the library USB Configuration Changed event. */
 200 void EVENT_USB_Device_ConfigurationChanged(void)
 201 {
 202         bool ConfigSuccess = true;
 203
 204         ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 205
 206         PulseMSRemaining.PingPongLEDPulse = 0;
 207
 208         LEDs_SetAllLEDs(ConfigSuccess ? LEDS_NO_LEDS : LEDMASK_ERROR);
 209 }
 210
 211 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 212  *  the device from the USB host before passing along unhandled control requests to the library for processing
 213  *  internally.
 214  */
 215 void EVENT_USB_Device_ControlRequest(void)
 216 {
 217         CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 218 }
 219
 220 /** Event handler for the CDC Class driver Line Encoding Changed event.
 221  *
 222  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 223  */
 224 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 225 {
 226         uint8_t ConfigMask = 0;
 227
 228         switch (CDCInterfaceInfo->State.LineEncoding.ParityType)
 229         {
 230                 case CDC_PARITY_Odd:
 231                         ConfigMask = ((1 << UPM11) | (1 << UPM10));
 232                         break;
 233                 case CDC_PARITY_Even:
 234                         ConfigMask = (1 << UPM11);
 235                         break;
 236         }
 237
 238         if (CDCInterfaceInfo->State.LineEncoding.CharFormat == CDC_LINEENCODING_TwoStopBits)
 239           ConfigMask |= (1 << USBS1);
 240
 241         switch (CDCInterfaceInfo->State.LineEncoding.DataBits)
 242         {
 243                 case 6:
 244                         ConfigMask |= (1 << UCSZ10);
 245                         break;
 246                 case 7:
 247                         ConfigMask |= (1 << UCSZ11);
 248                         break;
 249                 case 8:
 250                         ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));
 251                         break;
 252         }
 253
 254         /* Must turn off USART before reconfiguring it, otherwise incorrect operation may occur */
 255         UCSR1B = 0;
 256         UCSR1A = 0;
 257         UCSR1C = 0;
 258
 259         /* Set the new baud rate before configuring the USART */
 260         UBRR1  = SERIAL_2X_UBBRVAL(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
 261
 262         /* Reconfigure the USART in double speed mode for a wider baud rate range at the expense of accuracy */
 263         UCSR1C = ConfigMask;
 264         UCSR1A = (1 << U2X1);
 265         UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));
 266 }
 267
 268 /** ISR to manage the reception of data from the serial port, placing received bytes into a circular buffer
 269  *  for later transmission to the host.
 270  */
 271 ISR(USART1_RX_vect, ISR_BLOCK)
 272 {
 273         uint8_t ReceivedByte = UDR1;
 274
 275         if (USB_DeviceState == DEVICE_STATE_Configured)
 276           RingBuffer_Insert(&USARTtoUSB_Buffer, ReceivedByte);
 277 }
 278
 279 /** Event handler for the CDC Class driver Host-to-Device Line Encoding Changed event.
 280  *
 281  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 282  */
 283 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 284 {
 285         bool CurrentDTRState = (CDCInterfaceInfo->State.ControlLineStates.HostToDevice & CDC_CONTROL_LINE_OUT_DTR);
 286
 287         /* Check if the DTR line has been asserted - if so, start the target AVR's reset pulse */
 288         if (!(PreviousDTRState) && CurrentDTRState)
 289         {
 290                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 291
 292                 AVR_RESET_LINE_DDR |= AVR_RESET_LINE_MASK;
 293                 PulseMSRemaining.ResetPulse = AVR_RESET_PULSE_MS;
 294         }
 295
 296         PreviousDTRState = CurrentDTRState;
 297 }
 298