More Doxygen fixes - ensure no undocumented function parameters.
[pub/USBasp.git] / Demos / Host / LowLevel / CDCHost / CDCHost.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 CDCHost demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "CDCHost.h"
38
39 /** Main program entry point. This routine configures the hardware required by the application, then
40 * starts the scheduler to run the application tasks.
41 */
42 int main(void)
43 {
44 SetupHardware();
45
46 puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
47 "CDC Host Demo running.\r\n" ESC_INVERSE_OFF));
48
49 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
50
51 for (;;)
52 {
53 CDC_Host_Task();
54 USB_USBTask();
55 }
56 }
57
58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
59 void SetupHardware(void)
60 {
61 /* Disable watchdog if enabled by bootloader/fuses */
62 MCUSR &= ~(1 << WDRF);
63 wdt_disable();
64
65 /* Disable clock division */
66 clock_prescale_set(clock_div_1);
67
68 /* Hardware Initialization */
69 SerialStream_Init(9600, false);
70 LEDs_Init();
71 USB_Init();
72 }
73
74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
75 * starts the library USB task to begin the enumeration and USB management process.
76 */
77 void EVENT_USB_DeviceAttached(void)
78 {
79 puts_P(PSTR("Device Attached.\r\n"));
80 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
81 }
82
83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
84 * stops the library USB task management process.
85 */
86 void EVENT_USB_DeviceUnattached(void)
87 {
88 puts_P(PSTR("\r\nDevice Unattached.\r\n"));
89 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
90 }
91
92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
93 * enumerated by the host and is now ready to be used by the application.
94 */
95 void EVENT_USB_DeviceEnumerationComplete(void)
96 {
97 LEDs_SetAllLEDs(LEDMASK_USB_READY);
98 }
99
100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
101 void EVENT_USB_HostError(const uint8_t ErrorCode)
102 {
103 USB_ShutDown();
104
105 puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
106 printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
107
108 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
109 for(;;);
110 }
111
112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
113 * enumerating an attached USB device.
114 */
115 void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
116 {
117 puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
118 printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
119 printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
120 printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
121
122 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
123 }
124
125 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
126 * data received from the attached CDC device and print it to the serial port.
127 */
128 void CDC_Host_Task(void)
129 {
130 uint8_t ErrorCode;
131
132 switch (USB_HostState)
133 {
134 case HOST_STATE_Addressed:
135 /* Standard request to set the device configuration to configuration 1 */
136 USB_ControlRequest = (USB_Request_Header_t)
137 {
138 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
139 .bRequest = REQ_SetConfiguration,
140 .wValue = 1,
141 .wIndex = 0,
142 .wLength = 0,
143 };
144
145 /* Select the control pipe for the request transfer */
146 Pipe_SelectPipe(PIPE_CONTROLPIPE);
147
148 /* Send the request, display error and wait for device detach if request fails */
149 if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
150 {
151 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
152 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
153
154 /* Indicate error via status LEDs */
155 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
156
157 /* Wait until USB device disconnected */
158 while (USB_IsConnected);
159 break;
160 }
161
162 USB_HostState = HOST_STATE_Configured;
163 break;
164 case HOST_STATE_Configured:
165 puts_P(PSTR("Getting Config Data.\r\n"));
166
167 /* Get and process the configuration descriptor data */
168 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
169 {
170 if (ErrorCode == ControlError)
171 puts_P(PSTR("Control Error (Get Configuration).\r\n"));
172 else
173 puts_P(PSTR("Invalid Device.\r\n"));
174
175 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
176
177 /* Indicate error via status LEDs */
178 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
179
180 /* Wait until USB device disconnected */
181 while (USB_IsConnected);
182 break;
183 }
184
185 puts_P(PSTR("CDC Device Enumerated.\r\n"));
186
187 USB_HostState = HOST_STATE_Ready;
188 break;
189 case HOST_STATE_Ready:
190 /* Select and the data IN pipe */
191 Pipe_SelectPipe(CDC_DATAPIPE_IN);
192
193 /* Check to see if a packet has been received */
194 if (Pipe_IsINReceived())
195 {
196 /* Check if data is in the pipe */
197 if (Pipe_IsReadWriteAllowed())
198 {
199 /* Get the length of the pipe data, and create a new buffer to hold it */
200 uint16_t BufferLength = Pipe_BytesInPipe();
201 uint8_t Buffer[BufferLength];
202
203 /* Read in the pipe data to the temporary buffer */
204 Pipe_Read_Stream_LE(Buffer, BufferLength);
205
206 /* Print out the buffer contents to the USART */
207 for (uint16_t BufferByte = 0; BufferByte < BufferLength; BufferByte++)
208 putchar(Buffer[BufferByte]);
209 }
210
211 /* Clear the pipe after it is read, ready for the next packet */
212 Pipe_ClearIN();
213 }
214
215 /* Select and unfreeze the notification pipe */
216 Pipe_SelectPipe(CDC_NOTIFICATIONPIPE);
217 Pipe_Unfreeze();
218
219 /* Check if a packet has been received */
220 if (Pipe_IsINReceived())
221 {
222 /* Discard the unused event notification */
223 Pipe_ClearIN();
224 }
225
226 /* Freeze notification IN pipe after use */
227 Pipe_Freeze();
228
229 break;
230 }
231 }