Projects/XPLAINBridge/XPLAINBridge.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 XPLAINBridge project. This file contains the main tasks of
  34  *  the project 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_USART_BRIDGE;
  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         /* Only try to read in bytes from the CDC interface if the transmit buffer is not full */
 123         if (!(RingBuffer_IsFull(&USBtoUART_Buffer)))
 124         {
 125                 int16_t ReceivedByte = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
 126
 127                 /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
 128                 if (!(ReceivedByte < 0))
 129                   RingBuffer_Insert(&USBtoUART_Buffer, ReceivedByte);
 130         }
 131
 132         /* Check if the UART receive buffer flush timer has expired or buffer is nearly full */
 133         RingBuff_Count_t BufferCount = RingBuffer_GetCount(&UARTtoUSB_Buffer);
 134         if ((TIFR0 & (1 << TOV0)) || (BufferCount > 200))
 135         {
 136                 /* Clear flush timer expiry flag */
 137                 TIFR0 |= (1 << TOV0);
 138
 139                 /* Read bytes from the UART receive buffer into the USB IN endpoint */
 140                 while (BufferCount--)
 141                   CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_Remove(&UARTtoUSB_Buffer));
 142         }
 143
 144         CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 145 }
 146
 147 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 148 void SetupHardware(void)
 149 {
 150         /* Disable watchdog if enabled by bootloader/fuses */
 151         MCUSR &= ~(1 << WDRF);
 152         wdt_disable();
 153
 154         /* Disable clock division */
 155         clock_prescale_set(clock_div_1);
 156
 157         /* Hardware Initialization */
 158         SoftUART_Init();
 159         LEDs_Init();
 160         USB_Init();
 161
 162         /* Disable JTAG debugging */
 163         MCUCR |= (1 << JTD);
 164         MCUCR |= (1 << JTD);
 165
 166         /* Enable pull-up on the JTAG TDI pin so we can use it to select the mode */
 167         PORTF |= (1 << 7);
 168         _delay_ms(10);
 169
 170         /* Select the firmware mode based on the JTD pin's value */
 171         CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
 172
 173         /* Re-enable JTAG debugging */
 174         MCUCR &= ~(1 << JTD);
 175         MCUCR &= ~(1 << JTD);
 176 }
 177
 178 /** Event handler for the library USB Configuration Changed event. */
 179 void EVENT_USB_Device_ConfigurationChanged(void)
 180 {
 181         bool ConfigSuccess = true;
 182
 183         /* Configure the device endpoints according to the selected mode */
 184         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 185         {
 186                 ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 187
 188                 /* Configure the UART flush timer - run at Fcpu/1024 for maximum interval before overflow */
 189                 TCCR0B = ((1 << CS02) | (1 << CS00));
 190
 191                 /* Initialize ring buffers used to hold serial data between USB and software UART interfaces */
 192                 RingBuffer_InitBuffer(&USBtoUART_Buffer);
 193                 RingBuffer_InitBuffer(&UARTtoUSB_Buffer);
 194
 195                 /* Start the software USART */
 196                 SoftUART_Init();
 197         }
 198         else
 199         {
 200                 ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
 201                                                             AVRISP_DATA_EPSIZE, ENDPOINT_BANK_SINGLE);
 202
 203                 #if defined(LIBUSB_DRIVER_COMPAT)
 204                 ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN,
 205                                                             AVRISP_DATA_EPSIZE, ENDPOINT_BANK_SINGLE);
 206                 #endif
 207
 208                 /* Configure the V2 protocol packet handler */
 209                 V2Protocol_Init();
 210         }
 211
 212         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 213 }
 214
 215 /** Event handler for the library USB Control Request reception event. */
 216 void EVENT_USB_Device_ControlRequest(void)
 217 {
 218         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 219           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 220 }
 221
 222 /** Event handler for the library USB Connection event. */
 223 void EVENT_USB_Device_Connect(void)
 224 {
 225         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 226 }
 227
 228 /** Event handler for the library USB Disconnection event. */
 229 void EVENT_USB_Device_Disconnect(void)
 230 {
 231         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 232 }
 233
 234 /** Event handler for the CDC Class driver Line Encoding Changed event.
 235  *
 236  *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
 237  */
 238 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 239 {
 240         /* Change the software UART's baud rate to match the new baud rate */
 241         SoftUART_SetBaud(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
 242 }
 243
 244 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 245  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 246  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 247  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 248  *  USB host.
 249  *
 250  *  \param[in]  wValue  Descriptor type and index to retrieve
 251  *  \param[in]  wIndex  Sub-index to retrieve (such as a localized string language)
 252  *  \param[out] DescriptorAddress  Address of the retrieved descriptor
 253  *
 254  *  \return Length of the retrieved descriptor in bytes, or NO_DESCRIPTOR if the descriptor was not found
 255  */
 256 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 257                                     const uint8_t wIndex,
 258                                     const void** const DescriptorAddress)
 259 {
 260         /* Return the correct descriptors based on the selected mode */
 261         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 262           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 263         else
 264           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 265 }
 266