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