Get rid of the redundant ATTR_NEVER_INLINE macro which translated to the same as...
[pub/USBasp.git] / Projects / XPLAINBridge / XPLAINBridge.c
index 37509a9..1c63b71 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the XPLAINBridge project. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "XPLAINBridge.h"\r
-\r
-/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */\r
-RingBuff_t USBtoUART_Buffer;\r
-\r
-/** Circular buffer to hold data from the serial port before it is sent to the host. */\r
-RingBuff_t UARTtoUSB_Buffer;\r
-\r
-/** LUFA CDC Class driver interface configuration and state information. This structure is\r
- *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
- *  within a device can be differentiated from one another.\r
- */\r
-USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =\r
-       {\r
-               .Config = \r
-                       {\r
-                               .ControlInterfaceNumber         = 0,\r
-\r
-                               .DataINEndpointNumber           = CDC_TX_EPNUM,\r
-                               .DataINEndpointSize             = CDC_TXRX_EPSIZE,\r
-                               .DataINEndpointDoubleBank       = false,\r
-\r
-                               .DataOUTEndpointNumber          = CDC_RX_EPNUM,\r
-                               .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,\r
-                               .DataOUTEndpointDoubleBank      = false,\r
-\r
-                               .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,\r
-                               .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,\r
-                               .NotificationEndpointDoubleBank = false,\r
-                       },\r
-       };\r
-\r
-/** Main program entry point. This routine contains the overall program flow, including initial\r
- *  setup of all components and the main program loop.\r
- */\r
-int main(void)\r
-{\r
-       SetupHardware();\r
-       \r
-       Buffer_Initialize(&USBtoUART_Buffer);\r
-       Buffer_Initialize(&UARTtoUSB_Buffer);\r
-\r
-       for (;;)\r
-       {\r
-               /* Read bytes from the USB OUT endpoint into the UART transmit buffer */\r
-               for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)\r
-               {\r
-                       if (!(BUFF_STATICSIZE - USBtoUART_Buffer.Elements))\r
-                         break;\r
-                         \r
-                       Buffer_StoreElement(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));\r
-               }\r
-               \r
-               /* Read bytes from the UART receive buffer into the USB IN endpoint */\r
-               if (UARTtoUSB_Buffer.Elements)\r
-                 CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&UARTtoUSB_Buffer));\r
-               \r
-               /* Load bytes from the UART transmit buffer into the UART */\r
-               if ((USBtoUART_Buffer.Elements) && SoftUART_IsReady())\r
-                 SoftUART_TxByte(Buffer_GetElement(&USBtoUART_Buffer));\r
-               \r
-               /* Load bytes from the UART into the UART receive buffer */\r
-               if(SoftUART_IsReceived())\r
-                       Buffer_StoreElement(&UARTtoUSB_Buffer, SoftUART_RxByte());\r
-\r
-               CDC_Device_USBTask(&VirtualSerial_CDC_Interface);\r
-               USB_USBTask();\r
-       }\r
-}\r
-\r
-/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
-void SetupHardware(void)\r
-{\r
-       /* Disable watchdog if enabled by bootloader/fuses */\r
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       SoftUART_Init();\r
-       LEDs_Init();\r
-       USB_Init();\r
-       \r
-       PORTD |= (1 << 5); // PD5 is connected to the XMEGA /RESET, enable pullup\r
-}\r
-\r
-/** Event handler for the library USB Configuration Changed event. */\r
-void EVENT_USB_Device_ConfigurationChanged(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDS_LED1);\r
-\r
-       if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))\r
-               LEDs_SetAllLEDs(LEDS_NO_LEDS);\r
-}\r
-\r
-/** Event handler for the library USB Unhandled Control Request event. */\r
-void EVENT_USB_Device_UnhandledControlRequest(void)\r
-{\r
-       CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2013.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  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
+  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
+  software without specific, written prior permission.
+
+  The author disclaims all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the XPLAINBridge project. This file contains the main tasks of
+ *  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_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
+ *  within a device can be differentiated from one another.
+ */
+USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
+       {
+               .Config =
+                       {
+                               .ControlInterfaceNumber         = INTERFACE_ID_CDC_CCI,
+                               .DataINEndpoint                 =
+                                       {
+                                               .Address                = CDC_TX_EPADDR,
+                                               .Size                   = CDC_TXRX_EPSIZE,
+                                               .Banks                  = 1,
+                                       },
+                               .DataOUTEndpoint                =
+                                       {
+                                               .Address                = CDC_RX_EPADDR,
+                                               .Size                   = CDC_TXRX_EPSIZE,
+                                               .Banks                  = 1,
+                                       },
+                               .NotificationEndpoint           =
+                                       {
+                                               .Address                = CDC_NOTIFICATION_EPADDR,
+                                               .Size                   = CDC_NOTIFICATION_EPSIZE,
+                                               .Banks                  = 1,
+                                       },
+                       },
+       };
+
+/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
+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. */
+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
+ *  setup of all components and the main program loop.
+ */
+int main(void)
+{
+       SetupHardware();
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       GlobalInterruptEnable();
+
+       for (;;)
+       {
+               if (CurrentFirmwareMode == MODE_USART_BRIDGE)
+                 UARTBridge_Task();
+               else
+                 AVRISP_Task();
+
+               USB_USBTask();
+       }
+}
+
+void AVRISP_Task(void)
+{
+       /* Must be in the configured state for the AVRISP code to process data */
+       if (USB_DeviceState != DEVICE_STATE_Configured)
+         return;
+
+       V2Params_UpdateParamValues();
+
+       Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPADDR);
+
+       /* Check to see if a V2 Protocol command has been received */
+       if (Endpoint_IsOUTReceived())
+       {
+               LEDs_SetAllLEDs(LEDMASK_BUSY);
+
+               /* Pass off processing of the V2 Protocol command to the V2 Protocol handler */
+               V2Protocol_ProcessCommand();
+
+               LEDs_SetAllLEDs(LEDMASK_USB_READY);
+       }
+}
+
+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;
+
+       /* 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);
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware(void)
+{
+#if (ARCH == ARCH_AVR8)
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Disable clock division */
+       clock_prescale_set(clock_div_1);
+#endif
+
+       /* Disable JTAG debugging */
+       MCUCR |= (1 << JTD);
+       MCUCR |= (1 << JTD);
+
+       /* 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 */
+       CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
+
+       /* Re-enable JTAG debugging */
+       MCUCR &= ~(1 << JTD);
+       MCUCR &= ~(1 << JTD);
+
+       /* Hardware Initialization */
+       SoftUART_Init();
+       LEDs_Init();
+       #if defined(RESET_TOGGLES_LIBUSB_COMPAT)
+       UpdateCurrentCompatibilityMode();
+       #endif
+
+       /* USB Stack Initialization */
+       USB_Init();
+}
+
+/** Event handler for the library USB Configuration Changed event. */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       /* Configure the device endpoints according to the selected mode */
+       if (CurrentFirmwareMode == MODE_USART_BRIDGE)
+       {
+               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
+       {
+               ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPADDR, EP_TYPE_BULK, AVRISP_DATA_EPSIZE, 1);
+
+               if ((AVRISP_DATA_IN_EPADDR & ENDPOINT_EPNUM_MASK) != (AVRISP_DATA_OUT_EPADDR & ENDPOINT_EPNUM_MASK))
+                 ConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPADDR, EP_TYPE_BULK, AVRISP_DATA_EPSIZE, 1);
+
+               /* Configure the V2 protocol packet handler */
+               V2Protocol_Init();
+       }
+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+/** 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);
+}
+
+/** Event handler for the library USB Connection event. */
+void EVENT_USB_Device_Connect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+/** Event handler for the library USB Disconnection event. */
+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
+ *  \param[out] DescriptorMemorySpace  Memory space that the descriptor is stored in
+ *
+ *  \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,
+                                    const void** const DescriptorAddress,
+                                           uint8_t* const DescriptorMemorySpace)
+{
+       /* Return the correct descriptors based on the selected mode */
+       if (CurrentFirmwareMode == MODE_USART_BRIDGE)
+         return USART_GetDescriptor(wValue, wIndex, DescriptorAddress, DescriptorMemorySpace);
+       else
+         return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress, DescriptorMemorySpace);
+}
+