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         Buffer_Initialize(&USBtoUART_Buffer);
  81         Buffer_Initialize(&UARTtoUSB_Buffer);
  82
  83         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  84         sei();
  85
  86         for (;;)
  87         {
  88                 if (CurrentFirmwareMode == MODE_USART_BRIDGE)
  89                   USARTBridge_Task();
  90                 else
  91                   AVRISP_Task();
  92
  93                 USB_USBTask();
  94         }
  95 }
  96
  97 void AVRISP_Task(void)
  98 {
  99         /* Must be in the configured state for the AVRISP code to process data */
 100         if (USB_DeviceState != DEVICE_STATE_Configured)
 101           return;
 102
 103         Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
 104
 105         /* Check to see if a V2 Protocol command has been received */
 106         if (Endpoint_IsOUTReceived())
 107         {
 108                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 109
 110                 /* Pass off processing of the V2 Protocol command to the V2 Protocol handler */
 111                 V2Protocol_ProcessCommand();
 112
 113                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 114         }
 115 }
 116
 117 void USARTBridge_Task(void)
 118 {
 119         /* Must be in the configured state for the USART Bridge code to process data */
 120         if (USB_DeviceState != DEVICE_STATE_Configured)
 121           return;
 122
 123         /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
 124         for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
 125         {
 126                 if (!(BUFF_STATICSIZE - USBtoUART_Buffer.Elements))
 127                   break;
 128
 129                 Buffer_StoreElement(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
 130         }
 131
 132         /* Read bytes from the UART receive buffer into the USB IN endpoint */
 133         if (UARTtoUSB_Buffer.Elements)
 134           CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&UARTtoUSB_Buffer));
 135
 136         /* Load bytes from the UART transmit buffer into the UART */
 137         if ((USBtoUART_Buffer.Elements) && SoftUART_IsReady())
 138           SoftUART_TxByte(Buffer_GetElement(&USBtoUART_Buffer));
 139
 140         /* Load bytes from the UART into the UART receive buffer */
 141         if (SoftUART_IsReceived())
 142           Buffer_StoreElement(&UARTtoUSB_Buffer, SoftUART_RxByte());
 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         V2Protocol_Init();
 162
 163         /* Disable JTAG debugging */
 164         MCUCR |= (1 << JTD);
 165         MCUCR |= (1 << JTD);
 166
 167         /* Enable pullup on the JTAG TDI pin so we can use it to select the mode */
 168         PORTF |= (1 << 7);
 169         _delay_ms(10);
 170
 171         /* Select the firmware mode based on the JTD pin's value */
 172         CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
 173
 174         /* Re-enable JTAG debugging */
 175         MCUCR &= ~(1 << JTD);
 176         MCUCR &= ~(1 << JTD);
 177 }
 178
 179 /** Event handler for the library USB Configuration Changed event. */
 180 void EVENT_USB_Device_ConfigurationChanged(void)
 181 {
 182         bool EndpointConfigSuccess = true;
 183
 184         /* Configure the device endpoints according to the selected mode */
 185         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 186         {
 187                 EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 188         }
 189         else
 190         {
 191                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK,
 192                                                                                                     ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
 193                                                                                                     ENDPOINT_BANK_SINGLE);
 194
 195                 #if defined(LIBUSB_DRIVER_COMPAT)
 196                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK,
 197                                                                     ENDPOINT_DIR_IN, AVRISP_DATA_EPSIZE,
 198                                                                     ENDPOINT_BANK_SINGLE);
 199                 #endif
 200         }
 201
 202         if (EndpointConfigSuccess)
 203           LEDs_SetAllLEDs(LEDMASK_USB_READY);
 204         else
 205           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 206 }
 207
 208 /** Event handler for the library USB Unhandled Control Request event. */
 209 void EVENT_USB_Device_UnhandledControlRequest(void)
 210 {
 211         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 212           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 213 }
 214
 215 /** Event handler for the library USB Connection event. */
 216 void EVENT_USB_Device_Connect(void)
 217 {
 218         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 219 }
 220
 221 /** Event handler for the library USB Disconnection event. */
 222 void EVENT_USB_Device_Disconnect(void)
 223 {
 224         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 225 }
 226
 227 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 228  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 229  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 230  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 231  *  USB host.
 232  */
 233 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 234 {
 235         /* Return the correct descriptors based on the selected mode */
 236         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 237           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 238         else
 239           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 240 }