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 /** 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(&Tx_Buffer);
  89
  90         sei();
  91
  92         for (;;)
  93         {
  94                 /* Echo bytes from the host to the target via the hardware USART */
  95                 if (CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface) && (UCSR1A & (1 << UDRE1)))
  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                         if (!(--FlushPeriodRemaining) || (Tx_Buffer.Count > 200))
 130                         {
 131                                 /* Echo bytes from the target to the host via the virtual serial port */
 132                                 if (Tx_Buffer.Count)
 133                                 {
 134                                         while (Tx_Buffer.Count)
 135                                           CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_AtomicRemove(&Tx_Buffer));
 136
 137                                         LEDs_TurnOnLEDs(LEDMASK_RX);
 138                                         PulseMSRemaining.RxLEDPulse = TX_RX_LED_PULSE_MS;
 139                                 }
 140
 141                                 FlushPeriodRemaining = RECEIVE_BUFFER_FLUSH_MS;
 142                         }
 143
 144                         /* Clear the millisecond timer CTC flag (cleared by writing logic one to the register) */
 145                         TIFR0 |= (1 << OCF0A);
 146                 }
 147
 148                 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 149                 USB_USBTask();
 150         }
 151 }
 152
 153 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 154 void SetupHardware(void)
 155 {
 156         /* Disable watchdog if enabled by bootloader/fuses */
 157         MCUSR &= ~(1 << WDRF);
 158         wdt_disable();
 159
 160         /* Hardware Initialization */
 161         LEDs_Init();
 162         USB_Init();
 163
 164         /* Millisecond Timer Interrupt */
 165         OCR0A  = (F_CPU / 64 / 1000);
 166         TCCR0A = (1 << WGM01);
 167         TCCR0B = ((1 << CS01) | (1 << CS00));
 168
 169         /* Tristate target /RESET Line */
 170         AVR_RESET_LINE_PORT &= ~AVR_RESET_LINE_MASK;
 171         AVR_RESET_LINE_DDR  &= ~AVR_RESET_LINE_MASK;
 172 }
 173
 174 /** Event handler for the library USB Connection event. */
 175 void EVENT_USB_Device_Connect(void)
 176 {
 177         PulseMSRemaining.PingPongLEDPulse = PING_PONG_LED_PULSE_MS;
 178         LEDs_SetAllLEDs(LEDMASK_TX);
 179 }
 180
 181 /** Event handler for the library USB Disconnection event. */
 182 void EVENT_USB_Device_Disconnect(void)
 183 {
 184         PulseMSRemaining.PingPongLEDPulse = 0;
 185         LEDs_SetAllLEDs(LEDS_NO_LEDS);
 186 }
 187
 188 /** Event handler for the library USB Configuration Changed event. */
 189 void EVENT_USB_Device_ConfigurationChanged(void)
 190 {
 191         PulseMSRemaining.PingPongLEDPulse = 0;
 192         LEDs_SetAllLEDs(LEDS_NO_LEDS);
 193
 194         if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
 195           LEDs_SetAllLEDs(LEDMASK_ERROR);
 196 }
 197
 198 /** Event handler for the library USB Unhandled Control Request event. */
 199 void EVENT_USB_Device_UnhandledControlRequest(void)
 200 {
 201         CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 202 }
 203
 204 /** Event handler for the CDC Class driver Line Encoding Changed event.
 205  *
 206  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 207  */
 208 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 209 {
 210         uint8_t ConfigMask = 0;
 211
 212         switch (CDCInterfaceInfo->State.LineEncoding.ParityType)
 213         {
 214                 case CDC_PARITY_Odd:
 215                         ConfigMask = ((1 << UPM11) | (1 << UPM10));
 216                         break;
 217                 case CDC_PARITY_Even:
 218                         ConfigMask = (1 << UPM11);
 219                         break;
 220         }
 221
 222         if (CDCInterfaceInfo->State.LineEncoding.CharFormat == CDC_LINEENCODING_TwoStopBits)
 223           ConfigMask |= (1 << USBS1);
 224
 225         switch (CDCInterfaceInfo->State.LineEncoding.DataBits)
 226         {
 227                 case 6:
 228                         ConfigMask |= (1 << UCSZ10);
 229                         break;
 230                 case 7:
 231                         ConfigMask |= (1 << UCSZ11);
 232                         break;
 233                 case 8:
 234                         ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));
 235                         break;
 236         }
 237
 238         /* Must turn off USART before reconfiguring it, otherwise incorrect operation may occur */
 239         UCSR1B = 0;
 240         UCSR1A = 0;
 241         UCSR1C = 0;
 242
 243         /* Set the new baud rate before configuring the USART */
 244         UBRR1  = SERIAL_2X_UBBRVAL(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
 245
 246         /* Reconfigure the USART in double speed mode for a wider baud rate range at the expense of accuracy */
 247         UCSR1C = ConfigMask;
 248         UCSR1A = (1 << U2X1);
 249         UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));
 250 }
 251
 252 /** ISR to manage the reception of data from the serial port, placing received bytes into a circular buffer
 253  *  for later transmission to the host.
 254  */
 255 ISR(USART1_RX_vect, ISR_BLOCK)
 256 {
 257         uint8_t ReceivedByte = UDR1;
 258
 259         if (USB_DeviceState == DEVICE_STATE_Configured)
 260           RingBuffer_Insert(&Tx_Buffer, ReceivedByte);
 261 }
 262
 263 /** Event handler for the CDC Class driver Host-to-Device Line Encoding Changed event.
 264  *
 265  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 266  */
 267 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 268 {
 269         bool CurrentDTRState = (CDCInterfaceInfo->State.ControlLineStates.HostToDevice & CDC_CONTROL_LINE_OUT_DTR);
 270
 271         /* Check if the DTR line has been asserted - if so, start the target AVR's reset pulse */
 272         if (!(PreviousDTRState) && CurrentDTRState)
 273         {
 274                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 275
 276                 AVR_RESET_LINE_DDR |= AVR_RESET_LINE_MASK;
 277                 PulseMSRemaining.ResetPulse = AVR_RESET_PULSE_MS;
 278         }
 279
 280         PreviousDTRState = CurrentDTRState;
 281 }