--- /dev/null
+/*\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
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName, "LUFA USB RS232 App");\r
+BUTTLOADTAG(BuildTime, __TIME__);\r
+BUTTLOADTAG(BuildDate, __DATE__);\r
+BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
+\r
+/* Scheduler Task List */\r
+TASK_LIST\r
+{\r
+ { Task: USB_USBTask , TaskStatus: TASK_STOP },\r
+ { Task: CDC_Task , TaskStatus: TASK_STOP },\r
+};\r
+\r
+/* Globals: */\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 LineCoding = { BaudRateBPS: 9600,\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
+/** Main program entry point. This routine configures the hardware required by the application, then\r
+ * starts the scheduler to run the application tasks.\r
+ */\r
+int main(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
+ LEDs_Init();\r
+ ReconfigureUSART();\r
+ \r
+ /* Ringbuffer Initialization */\r
+ Buffer_Initialize(&Rx_Buffer);\r
+ Buffer_Initialize(&Tx_Buffer);\r
+ \r
+ /* Indicate USB not ready */\r
+ UpdateStatus(Status_USBNotReady);\r
+ \r
+ /* Initialize Scheduler so that it can be used */\r
+ Scheduler_Init();\r
+\r
+ /* Initialize USB Subsystem */\r
+ USB_Init();\r
+\r
+ /* Scheduling - routine never returns, so put this last in the main function */\r
+ Scheduler_Start();\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
+EVENT_HANDLER(USB_Connect)\r
+{\r
+ /* Start USB management task */\r
+ Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+\r
+ /* Indicate USB enumerating */\r
+ UpdateStatus(Status_USBEnumerating);\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
+EVENT_HANDLER(USB_Disconnect)\r
+{\r
+ /* Stop running CDC and USB management tasks */\r
+ Scheduler_SetTaskMode(CDC_Task, TASK_STOP);\r
+ Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\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
+ UpdateStatus(Status_USBNotReady);\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
+EVENT_HANDLER(USB_ConfigurationChanged)\r
+{\r
+ /* Setup CDC Notification, Rx and Tx Endpoints */\r
+ Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
+ ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
+ ENDPOINT_BANK_SINGLE);\r
+\r
+ Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
+ ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
+ ENDPOINT_BANK_SINGLE);\r
+\r
+ Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
+ ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
+ ENDPOINT_BANK_SINGLE);\r
+\r
+ /* Indicate USB connected and ready */\r
+ UpdateStatus(Status_USBReady);\r
+\r
+ /* Start CDC task */\r
+ Scheduler_SetTaskMode(CDC_Task, TASK_RUN);\r
+}\r
+\r
+/** Event handler for the USB_UnhandledControlPacket 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
+EVENT_HANDLER(USB_UnhandledControlPacket)\r
+{\r
+ uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
+\r
+ /* Process CDC specific control requests */\r
+ switch (bRequest)\r
+ {\r
+ case REQ_GetLineEncoding:\r
+ if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+ { \r
+ /* Acknowledge the SETUP packet, ready for data transfer */\r
+ Endpoint_ClearSetupReceived();\r
+\r
+ /* Write the line coding data to the control endpoint */\r
+ Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
+ \r
+ /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+ Endpoint_ClearSetupOUT();\r
+ }\r
+ \r
+ break;\r
+ case REQ_SetLineEncoding:\r
+ if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+ {\r
+ /* Acknowledge the SETUP packet, ready for data transfer */\r
+ Endpoint_ClearSetupReceived();\r
+\r
+ /* Read the line coding data in from the host into the global struct */\r
+ Endpoint_Read_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
+\r
+ /* Finalize the stream transfer to clear the last packet from the host */\r
+ Endpoint_ClearSetupIN();\r
+ \r
+ /* Reconfigure the USART with the new settings */\r
+ ReconfigureUSART();\r
+ }\r
+ \r
+ break;\r
+ case REQ_SetControlLineState:\r
+ if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+ {\r
+#if 0\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, and can be masked against the CONTROL_LINE_OUT_* masks\r
+ to determine the RTS and DTR line states using the following code:\r
+ */\r
+\r
+ uint16_t wIndex = Endpoint_Read_Word_LE();\r
+ \r
+ // Do something with the given line states in wIndex\r
+#endif\r
+ \r
+ /* Acknowledge the SETUP packet, ready for data transfer */\r
+ Endpoint_ClearSetupReceived();\r
+ \r
+ /* Acknowledge status stage */\r
+ while (!(Endpoint_IsSetupINReady()));\r
+ Endpoint_ClearSetupIN();\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
+TASK(CDC_Task)\r
+{\r
+ if (USB_IsConnected)\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_ClearCurrentBank();\r
+#endif\r
+\r
+ /* Select the Serial Rx Endpoint */\r
+ Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+ \r
+ if (Endpoint_ReadWriteAllowed())\r
+ {\r
+ /* Read the received data endpoint into the transmission buffer */\r
+ while (Endpoint_BytesInEndpoint())\r
+ {\r
+ /* Wait until the buffer has space for a new character */\r
+ while (!((BUFF_STATICSIZE - Rx_Buffer.Elements)));\r
+ \r
+ /* Store each character from the endpoint */\r
+ Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
+ }\r
+ \r
+ /* Clear the endpoint buffer */\r
+ Endpoint_ClearCurrentBank();\r
+ }\r
+ \r
+ /* Check if Rx buffer contains data */\r
+ if (Rx_Buffer.Elements)\r
+ {\r
+ /* Initiate the transmission of the buffer contents if USART idle */\r
+ if (!(Transmitting))\r
+ {\r
+ Transmitting = true;\r
+ Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\r
+ }\r
+ }\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)\r
+ {\r
+ /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
+ while (!(Endpoint_ReadWriteAllowed()));\r
+ \r
+ /* Check before sending the data if the endpoint is completely full */\r
+ bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
+ \r
+ /* Write the transmission buffer contents to the received data endpoint */\r
+ while (Tx_Buffer.Elements && (Endpoint_BytesInEndpoint() < CDC_TXRX_EPSIZE))\r
+ Endpoint_Write_Byte(Buffer_GetElement(&Tx_Buffer));\r
+ \r
+ /* Send the data */\r
+ Endpoint_ClearCurrentBank();\r
+\r
+ /* If a full endpoint was sent, we need to send an empty packet afterwards to terminate the transfer */\r
+ if (IsFull)\r
+ {\r
+ /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
+ while (!(Endpoint_ReadWriteAllowed()));\r
+\r
+ /* Send an empty packet to terminate the transfer */\r
+ Endpoint_ClearCurrentBank();\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
+/** ISR to handle the USART transmit complete interrupt, fired each time the USART has sent a character. This reloads the USART\r
+ * data register with the next byte from the Rx_Buffer circular buffer if a character is available, or stops the transmission if\r
+ * the buffer is currently empty.\r
+ */\r
+ISR(USART1_TX_vect, ISR_BLOCK)\r
+{\r
+ /* Send next character if available */\r
+ if (Rx_Buffer.Elements)\r
+ UDR1 = Buffer_GetElement(&Rx_Buffer);\r
+ else\r
+ Transmitting = false;\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
+ /* Only store received characters if the USB interface is connected */\r
+ if (USB_IsConnected)\r
+ {\r
+ /* Character received, store it into the buffer */\r
+ Buffer_StoreElement(&Tx_Buffer, UDR1);\r
+ }\r
+}\r
+\r
+/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
+ * log to a serial port, or anything else that is suitable for status updates.\r
+ *\r
+ * \param CurrentStatus Current status of the system, from the USBtoSerial_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\r
+{\r
+ uint8_t LEDMask = LEDS_NO_LEDS;\r
+ \r
+ /* Set the LED mask to the appropriate LED mask based on the given status code */\r
+ switch (CurrentStatus)\r
+ {\r
+ case Status_USBNotReady:\r
+ LEDMask = (LEDS_LED1);\r
+ break;\r
+ case Status_USBEnumerating:\r
+ LEDMask = (LEDS_LED1 | LEDS_LED2);\r
+ break;\r
+ case Status_USBReady:\r
+ LEDMask = (LEDS_LED2 | LEDS_LED4);\r
+ break;\r
+ }\r
+ \r
+ /* Set the board LEDs to the new LED mask */\r
+ LEDs_SetAllLEDs(LEDMask);\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 (LineCoding.ParityType == Parity_Odd)\r
+ ConfigMask = ((1 << UPM11) | (1 << UPM10));\r
+ else if (LineCoding.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 (LineCoding.CharFormat == TwoStopBits)\r
+ ConfigMask |= (1 << USBS1);\r
+\r
+ /* Determine data size - 5, 6, 7, or 8 bits are supported */\r
+ if (LineCoding.DataBits == 6)\r
+ ConfigMask |= (1 << UCSZ10);\r
+ else if (LineCoding.DataBits == 7)\r
+ ConfigMask |= (1 << UCSZ11);\r
+ else if (LineCoding.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 << TXCIE1) | (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)LineCoding.BaudRateBPS);\r
+}\r
projects / pub / lufa.git / blobdiff