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       = false,
  55
  56                                 .DataOUTEndpointNumber          = CDC_RX_EPNUM,
  57                                 .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
  58                                 .DataOUTEndpointDoubleBank      = false,
  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         for (;;)
  84         {
  85                 if (USB_DeviceState == DEVICE_STATE_Configured)
  86                 {
  87                         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
  88                           USARTBridge_Task();
  89                         else
  90                           AVRISP_Task();
  91                 }
  92
  93                 USB_USBTask();
  94         }
  95 }
  96
  97 void AVRISP_Task(void)
  98 {
  99         Endpoint_SelectEndpoint(AVRISP_DATA_EPNUM);
 100
 101         /* Check to see if a V2 Protocol command has been received */
 102         if (Endpoint_IsOUTReceived())
 103         {
 104                 LEDs_SetAllLEDs(LEDMASK_BUSY);
 105
 106                 /* Pass off processing of the V2 Protocol command to the V2 Protocol handler */
 107                 V2Protocol_ProcessCommand();
 108
 109                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 110         }
 111 }
 112
 113 void USARTBridge_Task(void)
 114 {
 115         /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
 116         for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
 117         {
 118                 if (!(BUFF_STATICSIZE - USBtoUART_Buffer.Elements))
 119                   break;
 120
 121                 Buffer_StoreElement(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
 122         }
 123
 124         /* Read bytes from the UART receive buffer into the USB IN endpoint */
 125         if (UARTtoUSB_Buffer.Elements)
 126           CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&UARTtoUSB_Buffer));
 127
 128         /* Load bytes from the UART transmit buffer into the UART */
 129         if ((USBtoUART_Buffer.Elements) && SoftUART_IsReady())
 130           SoftUART_TxByte(Buffer_GetElement(&USBtoUART_Buffer));
 131
 132         /* Load bytes from the UART into the UART receive buffer */
 133         if(SoftUART_IsReceived())
 134                 Buffer_StoreElement(&UARTtoUSB_Buffer, SoftUART_RxByte());
 135
 136         CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 137 }
 138
 139 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 140 void SetupHardware(void)
 141 {
 142         /* Disable watchdog if enabled by bootloader/fuses */
 143         MCUSR &= ~(1 << WDRF);
 144         wdt_disable();
 145
 146         /* Disable clock division */
 147         clock_prescale_set(clock_div_1);
 148
 149         /* Hardware Initialization */
 150         SoftUART_Init();
 151         LEDs_Init();
 152         USB_Init();
 153         V2Protocol_Init();
 154
 155         /* Disable JTAG debugging */
 156         MCUCR |= (1 << JTD);
 157         MCUCR |= (1 << JTD);
 158
 159         /* Enable pullup on the JTAG TDI pin so we can use it to select the mode */
 160         PORTF |= (1 << 7);
 161         _delay_ms(10);
 162
 163         /* Select the firmware mode based on the JTD pin's value */
 164         CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
 165 }
 166
 167 /** Event handler for the library USB Configuration Changed event. */
 168 void EVENT_USB_Device_ConfigurationChanged(void)
 169 {
 170         bool EndpointConfigSuccess;
 171
 172         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 173         {
 174                 EndpointConfigSuccess = CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 175         }
 176         else
 177         {
 178                 EndpointConfigSuccess = Endpoint_ConfigureEndpoint(AVRISP_DATA_EPNUM, EP_TYPE_BULK,
 179                                                                                                    ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
 180                                                                                                    ENDPOINT_BANK_SINGLE);
 181         }
 182
 183         if (EndpointConfigSuccess)
 184           LEDs_SetAllLEDs(LEDMASK_USB_READY);
 185         else
 186           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187 }
 188
 189 /** Event handler for the library USB Unhandled Control Request event. */
 190 void EVENT_USB_Device_UnhandledControlRequest(void)
 191 {
 192         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 193           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 194 }
 195
 196 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 197  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 198  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 199  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 200  *  USB host.
 201  */
 202 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 203 {
 204         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 205           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 206         else
 207           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 208 }