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