Moved USBtoSerial demo the Projects directory, as it is simply an expanded CDC demo...
[pub/lufa.git] / Demos / Device / LowLevel / USBtoSerial / USBtoSerial.c
diff --git a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c
deleted file mode 100644 (file)
index 577d2ba..0000000
+++ /dev/null
@@ -1,340 +0,0 @@
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
-#include "USBtoSerial.h"\r
-\r
-/** Contains the current baud rate and other settings of the virtual serial port.\r
- *\r
- *  These values are set by the host via a class-specific request, and the physical USART should be reconfigured to match the\r
- *  new settings each time they are changed by the host.\r
- */\r
-CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,\r
-                                   .CharFormat  = OneStopBit,\r
-                                   .ParityType  = Parity_None,\r
-                                   .DataBits    = 8            };\r
-\r
-/** Ring (circular) buffer to hold the RX data - data from the host to the attached device on the serial port. */\r
-RingBuff_t Rx_Buffer;\r
-\r
-/** Ring (circular) buffer to hold the TX data - data from the attached device on the serial port to the host. */\r
-RingBuff_t Tx_Buffer;\r
-\r
-/** Flag to indicate if the USART is currently transmitting data from the Rx_Buffer circular buffer. */\r
-volatile bool Transmitting = false;\r
-\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  enters a loop to run the application tasks in sequence.\r
- */\r
-int main(void)\r
-{\r
-       SetupHardware();\r
-\r
-       /* Ring buffer Initialization */\r
-       Buffer_Initialize(&Rx_Buffer);\r
-       Buffer_Initialize(&Tx_Buffer);\r
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-       \r
-       for (;;)\r
-       {\r
-               CDC_Task();\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
-       Serial_Init(9600, false);\r
-       LEDs_Init();\r
-       USB_Init();\r
-}\r
-\r
-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
- *  starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-void EVENT_USB_Device_Connect(void)\r
-{\r
-       /* Indicate USB enumerating */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- *  the status LEDs and stops the USB management and CDC management tasks.\r
- */\r
-void EVENT_USB_Device_Disconnect(void)\r
-{      \r
-       /* Reset Tx and Rx buffers, device disconnected */\r
-       Buffer_Initialize(&Rx_Buffer);\r
-       Buffer_Initialize(&Tx_Buffer);\r
-\r
-       /* Indicate USB not ready */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
- *  of the USB device after enumeration - the device endpoints are configured and the CDC management task started.\r
- */\r
-void EVENT_USB_Device_ConfigurationChanged(void)\r
-{\r
-       /* Indicate USB connected and ready */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
-\r
-       /* Setup CDC Notification, Rx and Tx Endpoints */\r
-       if (!(Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
-                                            ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\r
-       \r
-       if (!(Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
-                                            ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }                                                          \r
-\r
-       if (!(Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
-                                            ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\r
-\r
-       /* Reset line encoding baud rate so that the host knows to send new values */\r
-       LineEncoding.BaudRateBPS = 0;\r
-}\r
-\r
-/** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific\r
- *  control requests that are not handled internally by the USB library (including the CDC control commands,\r
- *  which are all issued via the control endpoint), so that they can be handled appropriately for the application.\r
- */\r
-void EVENT_USB_Device_UnhandledControlRequest(void)\r
-{\r
-       /* Process CDC specific control requests */\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case REQ_GetLineEncoding:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {       \r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSETUP();\r
-\r
-                               /* Write the line coding data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(LineEncoding));\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearOUT();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetLineEncoding:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSETUP();\r
-\r
-                               /* Read the line coding data in from the host into the global struct */\r
-                               Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(LineEncoding));\r
-\r
-                               /* Finalize the stream transfer to clear the last packet from the host */\r
-                               Endpoint_ClearIN();\r
-                               \r
-                               /* Reconfigure the USART with the new settings */\r
-                               ReconfigureUSART();\r
-                       }\r
-       \r
-                       break;\r
-               case REQ_SetControlLineState:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {                               \r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* NOTE: Here you can read in the line state mask from the host, to get the current state of the output handshake\r
-                                        lines. The mask is read in from the wValue parameter in USB_ControlRequest, and can be masked against the\r
-                                                CONTROL_LINE_OUT_* masks to determine the RTS and DTR line states using the following code:\r
-                               */\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-       \r
-                       break;\r
-       }\r
-}\r
-\r
-/** Task to manage CDC data transmission and reception to and from the host, from and to the physical USART. */\r
-void CDC_Task(void)\r
-{\r
-       /* Device must be connected and configured for the task to run */\r
-       if (USB_DeviceState != DEVICE_STATE_Configured)\r
-         return;\r
-         \r
-#if 0\r
-       /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232\r
-                        handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
-       */\r
-\r
-       USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
-               {\r
-                       .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                       .Notification     = NOTIF_SerialState,\r
-                       .wValue           = 0,\r
-                       .wIndex           = 0,\r
-                       .wLength          = sizeof(uint16_t),\r
-               };\r
-               \r
-       uint16_t LineStateMask;\r
-       \r
-       // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host\r
-       \r
-       Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
-       Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
-       Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
-       Endpoint_ClearIN();\r
-#endif\r
-\r
-       /* Select the Serial Rx Endpoint */\r
-       Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
-       \r
-       /* Check to see if a packet has been received from the host */\r
-       if (Endpoint_IsOUTReceived())\r
-       {\r
-               /* Read the bytes in from the endpoint into the buffer while space is available */\r
-               while (Endpoint_BytesInEndpoint() && (Rx_Buffer.Elements != BUFF_STATICSIZE))\r
-               {\r
-                       /* Store each character from the endpoint */\r
-                       Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
-               }\r
-               \r
-               /* Check to see if all bytes in the current packet have been read */\r
-               if (!(Endpoint_BytesInEndpoint()))\r
-               {\r
-                       /* Clear the endpoint buffer */\r
-                       Endpoint_ClearOUT();\r
-               }\r
-       }\r
-       \r
-       /* Check if Rx buffer contains data - if so, send it */\r
-       if (Rx_Buffer.Elements)\r
-         Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\r
-\r
-       /* Select the Serial Tx Endpoint */\r
-       Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
-\r
-       /* Check if the Tx buffer contains anything to be sent to the host */\r
-       if ((Tx_Buffer.Elements) && LineEncoding.BaudRateBPS)\r
-       {\r
-               /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
-               Endpoint_WaitUntilReady();\r
-               \r
-               /* Write the bytes from the buffer to the endpoint while space is available */\r
-               while (Tx_Buffer.Elements && Endpoint_IsReadWriteAllowed())\r
-               {\r
-                       /* Write each byte retreived from the buffer to the endpoint */\r
-                       Endpoint_Write_Byte(Buffer_GetElement(&Tx_Buffer));\r
-               }\r
-               \r
-               /* Remember if the packet to send completely fills the endpoint */\r
-               bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
-               \r
-               /* Send the data */\r
-               Endpoint_ClearIN();\r
-\r
-               /* If no more data to send and the last packet filled the endpoint, send an empty packet to release\r
-                * the buffer on the receiver (otherwise all data will be cached until a non-full packet is received) */\r
-               if (IsFull && !(Tx_Buffer.Elements))\r
-               {\r
-                       /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
-                       Endpoint_WaitUntilReady();\r
-                               \r
-                       /* Send an empty packet to terminate the transfer */\r
-                       Endpoint_ClearIN();\r
-               }\r
-       }\r
-}\r
-\r
-/** ISR to handle the USART receive complete interrupt, fired each time the USART has received a character. This stores the received\r
- *  character into the Tx_Buffer circular buffer for later transmission to the host.\r
- */\r
-ISR(USART1_RX_vect, ISR_BLOCK)\r
-{\r
-       uint8_t ReceivedByte = UDR1;\r
-\r
-       /* Only store received characters if the USB interface is connected */\r
-       if ((USB_DeviceState == DEVICE_STATE_Configured) && LineEncoding.BaudRateBPS)\r
-         Buffer_StoreElement(&Tx_Buffer, ReceivedByte);\r
-}\r
-\r
-/** Reconfigures the USART to match the current serial port settings issued by the host as closely as possible. */\r
-void ReconfigureUSART(void)\r
-{\r
-       uint8_t ConfigMask = 0;\r
-\r
-       /* Determine parity - non odd/even parity mode defaults to no parity */\r
-       if (LineEncoding.ParityType == Parity_Odd)\r
-         ConfigMask = ((1 << UPM11) | (1 << UPM10));\r
-       else if (LineEncoding.ParityType == Parity_Even)\r
-         ConfigMask = (1 << UPM11);\r
-\r
-       /* Determine stop bits - 1.5 stop bits is set as 1 stop bit due to hardware limitations */\r
-       if (LineEncoding.CharFormat == TwoStopBits)\r
-         ConfigMask |= (1 << USBS1);\r
-\r
-       /* Determine data size - 5, 6, 7, or 8 bits are supported */\r
-       if (LineEncoding.DataBits == 6)\r
-         ConfigMask |= (1 << UCSZ10);\r
-       else if (LineEncoding.DataBits == 7)\r
-         ConfigMask |= (1 << UCSZ11);\r
-       else if (LineEncoding.DataBits == 8)\r
-         ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));\r
-       \r
-       /* Enable double speed, gives better error percentages at 8MHz */\r
-       UCSR1A = (1 << U2X1);\r
-       \r
-       /* Enable transmit and receive modules and interrupts */\r
-       UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));\r
-\r
-       /* Set the USART mode to the mask generated by the Line Coding options */\r
-       UCSR1C = ConfigMask;\r
-       \r
-       /* Set the USART baud rate register to the desired baud rate value */\r
-       UBRR1  = SERIAL_2X_UBBRVAL((uint16_t)LineEncoding.BaudRateBPS);\r
-}\r