Projects/XPLAINBridge/XPLAINBridge.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 XPLAINBridge project. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "XPLAINBridge.h"
  38
  39 /* Current firmware mode, making the device behave as either a programmer or a USART bridge */
  40 bool CurrentFirmwareMode = MODE_PDI_PROGRAMMER;
  41
  42 /** LUFA CDC Class driver interface configuration and state information. This structure is
  43  *  passed to all CDC Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .ControlInterfaceNumber         = 0,
  51
  52                                 .DataINEndpointNumber           = CDC_TX_EPNUM,
  53                                 .DataINEndpointSize             = CDC_TXRX_EPSIZE,
  54                                 .DataINEndpointDoubleBank       = true,
  55
  56                                 .DataOUTEndpointNumber          = CDC_RX_EPNUM,
  57                                 .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
  58                                 .DataOUTEndpointDoubleBank      = true,
  59
  60                                 .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
  61                                 .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
  62                                 .NotificationEndpointDoubleBank = false,
  63                         },
  64         };
  65
  66 /** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
  67 RingBuff_t USBtoUART_Buffer;
  68
  69 /** Circular buffer to hold data from the serial port before it is sent to the host. */
  70 RingBuff_t UARTtoUSB_Buffer;
  71
  72
  73 /** Main program entry point. This routine contains the overall program flow, including initial
  74  *  setup of all components and the main program loop.
  75  */
  76 int main(void)
  77 {
  78         SetupHardware();
  79
  80         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  81         sei();
  82
  83         for (;;)
  84         {
  85                 if (CurrentFirmwareMode == MODE_USART_BRIDGE)
  86                   UARTBridge_Task();
  87                 else
  88                   AVRISP_Task();
  89
  90                 USB_USBTask();
  91         }
  92 }
  93
  94 void AVRISP_Task(void)
  95 {
  96         /* Must be in the configured state for the AVRISP code to process data */
  97         if (USB_DeviceState != DEVICE_STATE_Configured)
  98           return;
  99
 100         V2Params_UpdateParamValues();
 101
 102         Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
 103
 104         /* Check to see if a V2 Protocol command has been received */
 105         if (Endpoint_IsOUTReceived())
 106         {
 107                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 108
 109                 /* Pass off processing of the V2 Protocol command to the V2 Protocol handler */
 110                 V2Protocol_ProcessCommand();
 111
 112                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 113         }
 114 }
 115
 116 void UARTBridge_Task(void)
 117 {
 118         /* Must be in the configured state for the USART Bridge code to process data */
 119         if (USB_DeviceState != DEVICE_STATE_Configured)
 120           return;
 121
 122         /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
 123         int16_t ReceivedByte = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
 124         if (!(ReceivedByte < 0) && !(RingBuffer_IsFull(&USBtoUART_Buffer)))
 125           RingBuffer_AtomicInsert(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
 126
 127         /* Check if the software UART flush timer has expired */
 128         if (TIFR0 & (1 << TOV0))
 129         {
 130                 TIFR0 |= (1 << TOV0);
 131
 132                 /* Read bytes from the UART receive buffer into the USB IN endpoint */
 133                 while (UARTtoUSB_Buffer.Count)
 134                   CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_AtomicRemove(&UARTtoUSB_Buffer));
 135         }
 136
 137         CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 138 }
 139
 140 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 141 void SetupHardware(void)
 142 {
 143         /* Disable watchdog if enabled by bootloader/fuses */
 144         MCUSR &= ~(1 << WDRF);
 145         wdt_disable();
 146
 147         /* Disable clock division */
 148         clock_prescale_set(clock_div_1);
 149
 150         /* Hardware Initialization */
 151         SoftUART_Init();
 152         LEDs_Init();
 153         USB_Init();
 154
 155         /* Disable JTAG debugging */
 156         MCUCR |= (1 << JTD);
 157         MCUCR |= (1 << JTD);
 158
 159         /* Enable pull-up on the JTAG TDI pin so we can use it to select the mode */
 160         PORTF |= (1 << 7);
 161         _delay_ms(10);
 162
 163         /* Select the firmware mode based on the JTD pin's value */
 164         CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
 165
 166         /* Re-enable JTAG debugging */
 167         MCUCR &= ~(1 << JTD);
 168         MCUCR &= ~(1 << JTD);
 169 }
 170
 171 /** Event handler for the library USB Configuration Changed event. */
 172 void EVENT_USB_Device_ConfigurationChanged(void)
 173 {
 174         bool EndpointConfigSuccess = true;
 175
 176         /* Configure the device endpoints according to the selected mode */
 177         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 178         {
 179                 EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 180
 181                 /* Configure the UART flush timer - run at Fcpu/1024 for maximum interval before overflow */
 182                 TCCR0B = ((1 << CS02) | (1 << CS00));
 183
 184                 /* Initialize ring buffers used to hold serial data between USB and software UART interfaces */
 185                 RingBuffer_InitBuffer(&USBtoUART_Buffer);
 186                 RingBuffer_InitBuffer(&UARTtoUSB_Buffer);
 187         }
 188         else
 189         {
 190                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK,
 191                                                                                                     ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
 192                                                                                                     ENDPOINT_BANK_SINGLE);
 193
 194                 #if defined(LIBUSB_DRIVER_COMPAT)
 195                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK,
 196                                                                     ENDPOINT_DIR_IN, AVRISP_DATA_EPSIZE,
 197                                                                     ENDPOINT_BANK_SINGLE);
 198                 #endif
 199
 200                 /* Configure the V2 protocol packet handler */
 201                 V2Protocol_Init();
 202         }
 203
 204         if (EndpointConfigSuccess)
 205           LEDs_SetAllLEDs(LEDMASK_USB_READY);
 206         else
 207           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 208 }
 209
 210 /** Event handler for the library USB Unhandled Control Request event. */
 211 void EVENT_USB_Device_UnhandledControlRequest(void)
 212 {
 213         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 214           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 215 }
 216
 217 /** Event handler for the library USB Connection event. */
 218 void EVENT_USB_Device_Connect(void)
 219 {
 220         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 221 }
 222
 223 /** Event handler for the library USB Disconnection event. */
 224 void EVENT_USB_Device_Disconnect(void)
 225 {
 226         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 227 }
 228
 229 /** Event handler for the CDC Class driver Line Encoding Changed event.
 230  *
 231  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 232  */
 233 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 234 {
 235         /* Change the software UART's baud rate to match the new baud rate */
 236         SoftUART_SetBaud(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
 237 }
 238
 239 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 240  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 241  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 242  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 243  *  USB host.
 244  *
 245  *  \param[in]  wValue  Descriptor type and index to retrieve
 246  *  \param[in]  wIndex  Sub-index to retrieve (such as a localized string language)
 247  *  \param[out] DescriptorAddress  Address of the retrieved descriptor
 248  *
 249  *  \return Length of the retrieved descriptor in bytes, or NO_DESCRIPTOR if the descriptor was not found
 250  */
 251 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 252                                     const uint8_t wIndex,
 253                                     void** const DescriptorAddress)
 254 {
 255         /* Return the correct descriptors based on the selected mode */
 256         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 257           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 258         else
 259           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 260 }