Doxygen corrections to fix Doxygen warnings in some demos.
[pub/USBasp.git] / Demos / Device / ClassDriver / USBtoSerial / USBtoSerial.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 *
33 * Main source file for the USBtoSerial demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "USBtoSerial.h"
38
39 /** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
40 RingBuff_t Rx_Buffer;
41
42 /** Circular buffer to hold data from the serial port before it is sent to the host. */
43 RingBuff_t Tx_Buffer;
44
45 /** LUFA CDC Class driver interface configuration and state information. This structure is
46 * passed to all CDC Class driver functions, so that multiple instances of the same class
47 * within a device can be differentiated from one another.
48 */
49 USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =
50 {
51 .ControlInterfaceNumber = 0,
52
53 .DataINEndpointNumber = CDC_TX_EPNUM,
54 .DataINEndpointSize = CDC_TXRX_EPSIZE,
55
56 .DataOUTEndpointNumber = CDC_RX_EPNUM,
57 .DataOUTEndpointSize = CDC_TXRX_EPSIZE,
58
59 .NotificationEndpointNumber = CDC_NOTIFICATION_EPNUM,
60 .NotificationEndpointSize = CDC_NOTIFICATION_EPSIZE,
61 };
62
63 /** Main program entry point. This routine contains the overall program flow, including initial
64 * setup of all components and the main program loop.
65 */
66 int main(void)
67 {
68 SetupHardware();
69
70 Buffer_Initialize(&Rx_Buffer);
71 Buffer_Initialize(&Tx_Buffer);
72
73 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
74
75 for (;;)
76 {
77 /* Read bytes from the USB OUT endpoint into the USART transmit buffer */
78 for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
79 {
80 if (!(BUFF_STATICSIZE - Rx_Buffer.Elements))
81 break;
82
83 Buffer_StoreElement(&Rx_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
84 }
85
86 /* Read bytes from the USART receive buffer into the USB IN endpoint */
87 if (Tx_Buffer.Elements)
88 CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&Tx_Buffer));
89
90 /* Read bytes from the USART transmit buffer into the USART */
91 if (Rx_Buffer.Elements)
92 Serial_TxByte(Buffer_GetElement(&Rx_Buffer));
93
94 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
95 USB_USBTask();
96 }
97 }
98
99 /** Configures the board hardware and chip peripherals for the demo's functionality. */
100 void SetupHardware(void)
101 {
102 /* Disable watchdog if enabled by bootloader/fuses */
103 MCUSR &= ~(1 << WDRF);
104 wdt_disable();
105
106 /* Disable clock division */
107 clock_prescale_set(clock_div_1);
108
109 /* Hardware Initialization */
110 Joystick_Init();
111 LEDs_Init();
112 USB_Init();
113 }
114
115 /** Event handler for the library USB Connection event. */
116 void EVENT_USB_Connect(void)
117 {
118 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
119 }
120
121 /** Event handler for the library USB Disconnection event. */
122 void EVENT_USB_Disconnect(void)
123 {
124 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
125 }
126
127 /** Event handler for the library USB Configuration Changed event. */
128 void EVENT_USB_ConfigurationChanged(void)
129 {
130 LEDs_SetAllLEDs(LEDMASK_USB_READY);
131
132 if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
133 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
134 }
135
136 /** Event handler for the library USB Unhandled Control Packet event. */
137 void EVENT_USB_UnhandledControlPacket(void)
138 {
139 CDC_Device_ProcessControlPacket(&VirtualSerial_CDC_Interface);
140 }
141
142 /** ISR to manage the reception of data from the serial port, placing received bytes into a circular buffer
143 * for later transmission to the host.
144 */
145 ISR(USART1_RX_vect, ISR_BLOCK)
146 {
147 if (USB_IsConnected)
148 Buffer_StoreElement(&Tx_Buffer, UDR1);
149 }
150
151 /** Event handler for the CDC Class driver Line Encoding Changed event.
152 *
153 * \param CDCInterfaceInfo Pointer to the CDC class interface configuration structure being referenced
154 */
155 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)
156 {
157 uint8_t ConfigMask = 0;
158
159 if (CDCInterfaceInfo->LineEncoding.ParityType == CDC_PARITY_Odd)
160 ConfigMask = ((1 << UPM11) | (1 << UPM10));
161 else if (CDCInterfaceInfo->LineEncoding.ParityType == CDC_PARITY_Even)
162 ConfigMask = (1 << UPM11);
163
164 if (CDCInterfaceInfo->LineEncoding.CharFormat == CDC_LINEENCODING_TwoStopBits)
165 ConfigMask |= (1 << USBS1);
166
167 if (CDCInterfaceInfo->LineEncoding.DataBits == 6)
168 ConfigMask |= (1 << UCSZ10);
169 else if (CDCInterfaceInfo->LineEncoding.DataBits == 7)
170 ConfigMask |= (1 << UCSZ11);
171 else if (CDCInterfaceInfo->LineEncoding.DataBits == 8)
172 ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));
173
174 UCSR1A = (1 << U2X1);
175 UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));
176 UCSR1C = ConfigMask;
177 UBRR1 = SERIAL_2X_UBBRVAL((uint16_t)CDCInterfaceInfo->LineEncoding.BaudRateBPS);
178 }