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
  85         for (;;)
  86         {
  87                 if (CurrentFirmwareMode == MODE_USART_BRIDGE)
  88                   USARTBridge_Task();
  89                 else
  90                   AVRISP_Task();
  91
  92                 USB_USBTask();
  93         }
  94 }
  95
  96 void AVRISP_Task(void)
  97 {
  98         /* Must be in the configured state for the AVRISP code to process data */
  99         if (USB_DeviceState != DEVICE_STATE_Configured)
 100           return;
 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 USARTBridge_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         for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
 124         {
 125                 if (!(BUFF_STATICSIZE - USBtoUART_Buffer.Elements))
 126                   break;
 127
 128                 Buffer_StoreElement(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
 129         }
 130
 131         /* Read bytes from the UART receive buffer into the USB IN endpoint */
 132         if (UARTtoUSB_Buffer.Elements)
 133           CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&UARTtoUSB_Buffer));
 134
 135         /* Load bytes from the UART transmit buffer into the UART */
 136         if ((USBtoUART_Buffer.Elements) && SoftUART_IsReady())
 137           SoftUART_TxByte(Buffer_GetElement(&USBtoUART_Buffer));
 138
 139         /* Load bytes from the UART into the UART receive buffer */
 140         if (SoftUART_IsReceived())
 141           Buffer_StoreElement(&UARTtoUSB_Buffer, SoftUART_RxByte());
 142
 143         CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 144 }
 145
 146 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 147 void SetupHardware(void)
 148 {
 149         /* Disable watchdog if enabled by bootloader/fuses */
 150         MCUSR &= ~(1 << WDRF);
 151         wdt_disable();
 152
 153         /* Disable clock division */
 154         clock_prescale_set(clock_div_1);
 155
 156         /* Hardware Initialization */
 157         SoftUART_Init();
 158         LEDs_Init();
 159         USB_Init();
 160         V2Protocol_Init();
 161
 162         /* Disable JTAG debugging */
 163         MCUCR |= (1 << JTD);
 164         MCUCR |= (1 << JTD);
 165
 166         /* Enable pullup 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 EndpointConfigSuccess = true;
 182
 183         /* Configure the device endpoints according to the selected mode */
 184         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 185         {
 186                 EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 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_FILTERDRV_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
 201         if (EndpointConfigSuccess)
 202           LEDs_SetAllLEDs(LEDMASK_USB_READY);
 203         else
 204           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 205 }
 206
 207 /** Event handler for the library USB Unhandled Control Request event. */
 208 void EVENT_USB_Device_UnhandledControlRequest(void)
 209 {
 210         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 211           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 212 }
 213
 214 /** Event handler for the library USB Connection event. */
 215 void EVENT_USB_Device_Connect(void)
 216 {
 217         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 218 }
 219
 220 /** Event handler for the library USB Disconnection event. */
 221 void EVENT_USB_Device_Disconnect(void)
 222 {
 223         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 224 }
 225
 226 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 227  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 228  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 229  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 230  *  USB host.
 231  */
 232 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 233 {
 234         /* Return the correct descriptors based on the selected mode */
 235         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 236           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 237         else
 238           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 239 }