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         RingBuffer_InitBuffer(&USBtoUART_Buffer);
  81         RingBuffer_InitBuffer(&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           RingBuffer_Insert(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
 126
 127         /* Read bytes from the UART receive buffer into the USB IN endpoint */
 128         if (!(RingBuffer_Empty(&UARTtoUSB_Buffer)))
 129           CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_Remove(&UARTtoUSB_Buffer));
 130
 131         /* Load bytes from the UART transmit buffer into the UART */
 132         if (!(RingBuffer_Empty(&USBtoUART_Buffer)) && SoftUART_IsReady())
 133           SoftUART_TxByte(RingBuffer_Remove(&USBtoUART_Buffer));
 134
 135         /* Load bytes from the UART into the UART receive buffer */
 136         if (SoftUART_IsReceived())
 137           RingBuffer_Insert(&UARTtoUSB_Buffer, SoftUART_RxByte());
 138
 139         CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 140 }
 141
 142 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 143 void SetupHardware(void)
 144 {
 145         /* Disable watchdog if enabled by bootloader/fuses */
 146         MCUSR &= ~(1 << WDRF);
 147         wdt_disable();
 148
 149         /* Disable clock division */
 150         clock_prescale_set(clock_div_1);
 151
 152         /* Hardware Initialization */
 153         SoftUART_Init();
 154         LEDs_Init();
 155         USB_Init();
 156         V2Protocol_Init();
 157
 158         /* Disable JTAG debugging */
 159         MCUCR |= (1 << JTD);
 160         MCUCR |= (1 << JTD);
 161
 162         /* Enable pullup on the JTAG TDI pin so we can use it to select the mode */
 163         PORTF |= (1 << 7);
 164         _delay_ms(10);
 165
 166         /* Select the firmware mode based on the JTD pin's value */
 167         CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
 168
 169         /* Re-enable JTAG debugging */
 170         MCUCR &= ~(1 << JTD);
 171         MCUCR &= ~(1 << JTD);
 172 }
 173
 174 /** Event handler for the library USB Configuration Changed event. */
 175 void EVENT_USB_Device_ConfigurationChanged(void)
 176 {
 177         bool EndpointConfigSuccess = true;
 178
 179         /* Configure the device endpoints according to the selected mode */
 180         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 181         {
 182                 EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 183         }
 184         else
 185         {
 186                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK,
 187                                                                                                     ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
 188                                                                                                     ENDPOINT_BANK_SINGLE);
 189
 190                 #if defined(LIBUSB_DRIVER_COMPAT)
 191                 EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK,
 192                                                                     ENDPOINT_DIR_IN, AVRISP_DATA_EPSIZE,
 193                                                                     ENDPOINT_BANK_SINGLE);
 194                 #endif
 195         }
 196
 197         if (EndpointConfigSuccess)
 198           LEDs_SetAllLEDs(LEDMASK_USB_READY);
 199         else
 200           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 201 }
 202
 203 /** Event handler for the library USB Unhandled Control Request event. */
 204 void EVENT_USB_Device_UnhandledControlRequest(void)
 205 {
 206         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 207           CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 208 }
 209
 210 /** Event handler for the library USB Connection event. */
 211 void EVENT_USB_Device_Connect(void)
 212 {
 213         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 214 }
 215
 216 /** Event handler for the library USB Disconnection event. */
 217 void EVENT_USB_Device_Disconnect(void)
 218 {
 219         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 220 }
 221
 222 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 223  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 224  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 225  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 226  *  USB host.
 227  */
 228 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 229 {
 230         /* Return the correct descriptors based on the selected mode */
 231         if (CurrentFirmwareMode == MODE_USART_BRIDGE)
 232           return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
 233         else
 234           return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 235 }