Minor documentation enhancements.

[pub/USBasp.git] / Projects / XPLAINBridge / XPLAINBridge.c

diff --git a/Projects/XPLAINBridge/XPLAINBridge.c b/Projects/XPLAINBridge/XPLAINBridge.c
index ce23862..0764bb9 100644 (file)
--- a/Projects/XPLAINBridge/XPLAINBridge.c
+++ b/Projects/XPLAINBridge/XPLAINBridge.c
@@ -36,8 +36,8 @@
 
 #include "XPLAINBridge.h"
 
 
 #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
 
 /** 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


@@ -76,19 +76,14 @@ RingBuff_t UARTtoUSB_Buffer;
 int main(void)
 {
        SetupHardware();
 int main(void)
 {
        SetupHardware();

-       
-       USBtoUART_Buffer.In  = USBtoUART_Buffer.Buffer;
-       USBtoUART_Buffer.Out = USBtoUART_Buffer.Buffer;
-       UARTtoUSB_Buffer.In  = UARTtoUSB_Buffer.Buffer;
-       UARTtoUSB_Buffer.Out = UARTtoUSB_Buffer.Buffer;
-       
+

        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        for (;;)
        {
                if (CurrentFirmwareMode == MODE_USART_BRIDGE)
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        for (;;)
        {
                if (CurrentFirmwareMode == MODE_USART_BRIDGE)

-                 USARTBridge_Task();
+                 UARTBridge_Task();

                else
                  AVRISP_Task();
 
                else
                  AVRISP_Task();
 


@@ -102,6 +97,8 @@ void AVRISP_Task(void)
        if (USB_DeviceState != DEVICE_STATE_Configured)
          return;
 
        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 */
        Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
        
        /* Check to see if a V2 Protocol command has been received */


@@ -116,43 +113,26 @@ 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 */
 {
        /* 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--)
-       {
-               *USBtoUART_Buffer.In = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
-
-               if (++USBtoUART_Buffer.In == &USBtoUART_Buffer.Buffer[128])
-                 USBtoUART_Buffer.In = USBtoUART_Buffer.Buffer;
-       }
+       int16_t ReceivedByte = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
+       if (!(ReceivedByte < 0) && !(RingBuffer_IsFull(&USBtoUART_Buffer)))
+         RingBuffer_Insert(&USBtoUART_Buffer, ReceivedByte);

        
        

-       /* Read bytes from the UART receive buffer into the USB IN endpoint */
-       if (UARTtoUSB_Buffer.In != UARTtoUSB_Buffer.Out)
+       /* Check if the UART receive buffer flush timer has expired or buffer is nearly full */
+       RingBuff_Count_t BufferCount = RingBuffer_GetCount(&UARTtoUSB_Buffer);
+       if ((TIFR0 & (1 << TOV0)) || (BufferCount > 200))

        {
        {

-               CDC_Device_SendByte(&VirtualSerial_CDC_Interface, *UARTtoUSB_Buffer.Out);
-               if (++UARTtoUSB_Buffer.Out == &UARTtoUSB_Buffer.Buffer[128])
-                 UARTtoUSB_Buffer.Out = UARTtoUSB_Buffer.Buffer;
-       }
-       
-       /* Load bytes from the UART transmit buffer into the UART */
-       if ((USBtoUART_Buffer.In != USBtoUART_Buffer.Out) && SoftUART_IsReady())
-       {
-               SoftUART_TxByte(*USBtoUART_Buffer.Out);
-               if (++USBtoUART_Buffer.Out == &USBtoUART_Buffer.Buffer[128])
-                 USBtoUART_Buffer.Out = USBtoUART_Buffer.Buffer;
-       }
-       
-       /* Load bytes from the UART into the UART receive buffer */
-       if (SoftUART_IsReceived())
-       {
-               *UARTtoUSB_Buffer.In = SoftUART_RxByte();
-               if (++UARTtoUSB_Buffer.In == &UARTtoUSB_Buffer.Buffer[128])
-                 UARTtoUSB_Buffer.In = UARTtoUSB_Buffer.Buffer;                
+               TIFR0 |= (1 << TOV0);
+
+               /* Read bytes from the UART receive buffer into the USB IN endpoint */
+               while (BufferCount--)
+                 CDC_Device_SendByte(&VirtualSerial_CDC_Interface, RingBuffer_Remove(&UARTtoUSB_Buffer));

        }
 
        CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
        }
 
        CDC_Device_USBTask(&VirtualSerial_CDC_Interface);


@@ -172,18 +152,17 @@ void SetupHardware(void)
        SoftUART_Init();
        LEDs_Init();
        USB_Init();
        SoftUART_Init();
        LEDs_Init();
        USB_Init();

-       V2Protocol_Init();
-       
+

        /* Disable JTAG debugging */
        MCUCR |= (1 << JTD);
        MCUCR |= (1 << JTD);
 
        /* 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);
 
        /* Select the firmware mode based on the JTD pin's value */
        PORTF |= (1 << 7);
        _delay_ms(10);
 
        /* Select the firmware mode based on the JTD pin's value */

-       CurrentFirmwareMode = MODE_USART_BRIDGE; // TEMP (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
+       CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;

 
        /* Re-enable JTAG debugging */
        MCUCR &= ~(1 << JTD);
 
        /* Re-enable JTAG debugging */
        MCUCR &= ~(1 << JTD);


@@ -193,30 +172,38 @@ void SetupHardware(void)
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(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)
        {
 
        /* 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);
+               RingBuffer_InitBuffer(&UARTtoUSB_Buffer);
+               
+               /* Start the software USART */
+               SoftUART_Init();

        }
        else
        {
        }
        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)
 
                #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
                #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. */
 }
 
 /** Event handler for the library USB Unhandled Control Request event. */


@@ -238,13 +225,31 @@ void EVENT_USB_Device_Disconnect(void)
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 }
 
        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.
 /** 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)
 {
        /* Return the correct descriptors based on the selected mode */
        if (CurrentFirmwareMode == MODE_USART_BRIDGE)