Add extra LUFA TAR archive export exclusions.
[pub/USBasp.git] / Projects / XPLAINBridge / XPLAINBridge.c
index d92e2b4..bee770a 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
 /** \file
  *
  *  Main source file for the XPLAINBridge project. This file contains the main tasks of
- *  the demo and is responsible for the initial application hardware configuration.
+ *  the project and is responsible for the initial application hardware configuration.
  */
 
 #include "XPLAINBridge.h"
 
-/* Current firmware mode, making the device behave as either a programmer or a USART bridge */
-bool CurrentFirmwareMode = MODE_PDI_PROGRAMMER;
+/** Current firmware mode, making the device behave as either a programmer or a USART bridge */
+bool CurrentFirmwareMode = MODE_USART_BRIDGE;
 
 /** LUFA CDC Class driver interface configuration and state information. This structure is
  *  passed to all CDC Class driver functions, so that multiple instances of the same class
@@ -45,7 +45,7 @@ bool CurrentFirmwareMode = MODE_PDI_PROGRAMMER;
  */
 USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
        {
-               .Config = 
+               .Config =
                        {
                                .ControlInterfaceNumber         = 0,
 
@@ -64,10 +64,16 @@ USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
        };
 
 /** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
-RingBuff_t USBtoUART_Buffer;
+RingBuffer_t   USBtoUART_Buffer;
+
+/** Underlying data buffer for \ref USBtoUART_Buffer, where the stored bytes are located. */
+static uint8_t USBtoUART_Buffer_Data[128];
 
 /** Circular buffer to hold data from the serial port before it is sent to the host. */
-RingBuff_t UARTtoUSB_Buffer;
+RingBuffer_t   UARTtoUSB_Buffer;
+
+/** Underlying data buffer for \ref UARTtoUSB_Buffer, where the stored bytes are located. */
+static uint8_t UARTtoUSB_Buffer_Data[128];
 
 
 /** Main program entry point. This routine contains the overall program flow, including initial
@@ -76,17 +82,14 @@ RingBuff_t UARTtoUSB_Buffer;
 int main(void)
 {
        SetupHardware();
-       
-       RingBuffer_InitBuffer(&USBtoUART_Buffer);
-       RingBuffer_InitBuffer(&UARTtoUSB_Buffer);
-       
+
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        for (;;)
        {
                if (CurrentFirmwareMode == MODE_USART_BRIDGE)
-                 USARTBridge_Task();
+                 UARTBridge_Task();
                else
                  AVRISP_Task();
 
@@ -100,8 +103,10 @@ void AVRISP_Task(void)
        if (USB_DeviceState != DEVICE_STATE_Configured)
          return;
 
+       V2Params_UpdateParamValues();
+
        Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
-       
+
        /* Check to see if a V2 Protocol command has been received */
        if (Endpoint_IsOUTReceived())
        {
@@ -114,20 +119,44 @@ void AVRISP_Task(void)
        }
 }
 
-void USARTBridge_Task(void)
+void UARTBridge_Task(void)
 {
        /* Must be in the configured state for the USART Bridge code to process data */
        if (USB_DeviceState != DEVICE_STATE_Configured)
          return;
 
-       /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
-       for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
-         RingBuffer_Insert(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
-       
-       /* Read bytes from the UART receive buffer into the USB IN endpoint */
-       if (UARTtoUSB_Buffer.Count)
-         CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_Remove(&UARTtoUSB_Buffer));
-         
+       /* Only try to read in bytes from the CDC interface if the transmit buffer is not full */
+       if (!(RingBuffer_IsFull(&USBtoUART_Buffer)))
+       {
+               int16_t ReceivedByte = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
+
+               /* Read bytes from the USB OUT endpoint into the UART transmit buffer */
+               if (!(ReceivedByte < 0))
+                 RingBuffer_Insert(&USBtoUART_Buffer, ReceivedByte);
+       }
+
+       /* Check if the UART receive buffer flush timer has expired or buffer is nearly full */
+       uint16_t BufferCount = RingBuffer_GetCount(&UARTtoUSB_Buffer);
+       if ((TIFR0 & (1 << TOV0)) || (BufferCount > 200))
+       {
+               /* Clear flush timer expiry flag */
+               TIFR0 |= (1 << TOV0);
+
+               /* Read bytes from the USART receive buffer into the USB IN endpoint */
+               while (BufferCount--)
+               {
+                       /* Try to send the next byte of data to the host, abort if there is an error without dequeuing */
+                       if (CDC_Device_SendByte(&VirtualSerial_CDC_Interface,
+                                                                       RingBuffer_Peek(&UARTtoUSB_Buffer)) != ENDPOINT_READYWAIT_NoError)
+                       {
+                               break;
+                       }
+
+                       /* Dequeue the already sent byte from the buffer now we have confirmed that no transmission error occurred */
+                       RingBuffer_Remove(&UARTtoUSB_Buffer);
+               }
+       }
+
        CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 }
 
@@ -145,15 +174,14 @@ void SetupHardware(void)
        SoftUART_Init();
        LEDs_Init();
        USB_Init();
-       V2Protocol_Init();
-       
+
        /* Disable JTAG debugging */
        MCUCR |= (1 << JTD);
        MCUCR |= (1 << JTD);
 
-       /* Enable pullup on the JTAG TDI pin so we can use it to select the mode */
+       /* Enable pull-up on the JTAG TDI pin so we can use it to select the mode */
        PORTF |= (1 << 7);
-       _delay_ms(10);
+       Delay_MS(10);
 
        /* Select the firmware mode based on the JTD pin's value */
        CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
@@ -166,34 +194,42 @@ void SetupHardware(void)
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(void)
 {
-       bool EndpointConfigSuccess = true;
+       bool ConfigSuccess = true;
 
        /* Configure the device endpoints according to the selected mode */
        if (CurrentFirmwareMode == MODE_USART_BRIDGE)
        {
-               EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
+               ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
+
+               /* Configure the UART flush timer - run at Fcpu/1024 for maximum interval before overflow */
+               TCCR0B = ((1 << CS02) | (1 << CS00));
+
+               /* Initialize ring buffers used to hold serial data between USB and software UART interfaces */
+               RingBuffer_InitBuffer(&USBtoUART_Buffer, USBtoUART_Buffer_Data, sizeof(USBtoUART_Buffer_Data));
+               RingBuffer_InitBuffer(&UARTtoUSB_Buffer, UARTtoUSB_Buffer_Data, sizeof(UARTtoUSB_Buffer_Data));
+
+               /* Start the software USART */
+               SoftUART_Init();
        }
        else
        {
-               EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK,
-                                                                                                   ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
-                                                                                                   ENDPOINT_BANK_SINGLE);
+               ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
+                                                           AVRISP_DATA_EPSIZE, ENDPOINT_BANK_SINGLE);
 
                #if defined(LIBUSB_DRIVER_COMPAT)
-               EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK,
-                                                                   ENDPOINT_DIR_IN, AVRISP_DATA_EPSIZE,
-                                                                   ENDPOINT_BANK_SINGLE);
+               ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_IN,
+                                                           AVRISP_DATA_EPSIZE, ENDPOINT_BANK_SINGLE);
                #endif
+
+               /* Configure the V2 protocol packet handler */
+               V2Protocol_Init();
        }
 
-       if (EndpointConfigSuccess)
-         LEDs_SetAllLEDs(LEDMASK_USB_READY);
-       else
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 }
 
-/** Event handler for the library USB Unhandled Control Request event. */
-void EVENT_USB_Device_UnhandledControlRequest(void)
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)
 {
        if (CurrentFirmwareMode == MODE_USART_BRIDGE)
          CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
@@ -211,13 +247,31 @@ void EVENT_USB_Device_Disconnect(void)
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 }
 
+/** Event handler for the CDC Class driver Line Encoding Changed event.
+ *
+ *  \param[in] CDCInterfaceInfo  Pointer to the CDC class interface configuration structure being referenced
+ */
+void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
+{
+       /* Change the software UART's baud rate to match the new baud rate */
+       SoftUART_SetBaud(CDCInterfaceInfo->State.LineEncoding.BaudRateBPS);
+}
+
 /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  *  documentation) by the application code so that the address and size of a requested descriptor can be given
  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  *  USB host.
+ *
+ *  \param[in]  wValue  Descriptor type and index to retrieve
+ *  \param[in]  wIndex  Sub-index to retrieve (such as a localized string language)
+ *  \param[out] DescriptorAddress  Address of the retrieved descriptor
+ *
+ *  \return Length of the retrieved descriptor in bytes, or NO_DESCRIPTOR if the descriptor was not found
  */
-uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
+uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                    const uint8_t wIndex,
+                                    const void** const DescriptorAddress)
 {
        /* Return the correct descriptors based on the selected mode */
        if (CurrentFirmwareMode == MODE_USART_BRIDGE)
@@ -225,3 +279,4 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex,
        else
          return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
 }
+