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