Projects/Benito/Benito.c

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