Minor documentation cleanups.
[pub/USBasp.git] / Demos / Host / LowLevel / RNDISEthernetHost / RNDISEthernetHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all 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 RNDISEthernetHost demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
35 */
36
37 #include "RNDISEthernetHost.h"
38
39 /** Main program entry point. This routine configures the hardware required by the application, then
40 * enters a loop to run the application tasks in sequence.
41 */
42 int main(void)
43 {
44 SetupHardware();
45
46 puts_P(PSTR(ESC_FG_CYAN "RNDIS Host Demo running.\r\n" ESC_FG_WHITE));
47
48 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
49 sei();
50
51 for (;;)
52 {
53 RNDIS_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_Host_DeviceAttached(void)
78 {
79 puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
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_Host_DeviceUnattached(void)
87 {
88 puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
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_Host_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_Host_HostError(const uint8_t ErrorCode)
102 {
103 USB_ShutDown();
104
105 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
106 " -- Error Code %d\r\n" ESC_FG_WHITE), 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_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
116 {
117 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
118 " -- Error Code %d\r\n"
119 " -- Sub Error Code %d\r\n"
120 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
121
122 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
123 }
124
125 void PrintIncomingPackets(void)
126 {
127 uint8_t ErrorCode;
128
129 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
130
131 uint16_t PacketLength;
132 if ((ErrorCode = RNDIS_GetPacketLength(&PacketLength)) != HOST_SENDCONTROL_Successful)
133 {
134 printf_P(PSTR(ESC_FG_RED "Packet Reception Error.\r\n"
135 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
136 return;
137 }
138
139 if (!(PacketLength))
140 return;
141
142 Pipe_Unfreeze();
143
144 printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
145
146 if (PacketLength > 1024)
147 {
148 puts_P(PSTR(ESC_FG_RED "Packet too large.\r\n" ESC_FG_WHITE));
149 Pipe_Discard_Stream(PacketLength);
150 }
151 else
152 {
153 uint8_t PacketBuffer[PacketLength];
154
155 Pipe_Read_Stream_LE(&PacketBuffer, PacketLength);
156
157 for (uint16_t i = 0; i < PacketLength; i++)
158 printf("%02x ", PacketBuffer[i]);
159 }
160
161 Pipe_ClearIN();
162 Pipe_Freeze();
163
164 printf("\r\n\r\n");
165
166 LEDs_SetAllLEDs(LEDMASK_USB_READY);
167 }
168
169 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
170 * data received from the attached RNDIS device and print it to the serial port.
171 */
172 void RNDIS_Host_Task(void)
173 {
174 uint8_t ErrorCode;
175
176 switch (USB_HostState)
177 {
178 case HOST_STATE_Addressed:
179 puts_P(PSTR("Getting Config Data.\r\n"));
180
181 /* Get and process the configuration descriptor data */
182 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
183 {
184 if (ErrorCode == ControlError)
185 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
186 else
187 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
188
189 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
190
191 /* Indicate error via status LEDs */
192 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
193
194 /* Wait until USB device disconnected */
195 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
196 break;
197 }
198
199 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
200 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
201 {
202 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
203 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
204
205 /* Indicate error via status LEDs */
206 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
207
208 /* Wait until USB device disconnected */
209 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
210 break;
211 }
212
213 uint16_t DeviceMaxPacketSize;
214 if ((ErrorCode = RNDIS_InitializeDevice(1024, &DeviceMaxPacketSize)) != HOST_SENDCONTROL_Successful)
215 {
216 printf_P(PSTR(ESC_FG_RED "Error Initializing Device.\r\n"
217 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
218
219 /* Indicate error via status LEDs */
220 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
221
222 /* Wait until USB device disconnected */
223 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
224 break;
225 }
226
227 printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), DeviceMaxPacketSize);
228
229 /* We set the default filter to only receive packets we would be interested in */
230 uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
231 if ((ErrorCode = RNDIS_SetRNDISProperty(OID_GEN_CURRENT_PACKET_FILTER,
232 &PacketFilter, sizeof(PacketFilter))) != HOST_SENDCONTROL_Successful)
233 {
234 printf_P(PSTR(ESC_FG_RED "Error Setting Device Packet Filter.\r\n"
235 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
236
237 /* Indicate error via status LEDs */
238 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
239
240 /* Wait until USB device disconnected */
241 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
242 break;
243 }
244
245 uint32_t VendorID;
246 if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_VENDOR_ID,
247 &VendorID, sizeof(VendorID))) != HOST_SENDCONTROL_Successful)
248 {
249 printf_P(PSTR(ESC_FG_RED "Error Getting Vendor ID.\r\n"
250 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
251
252 /* Indicate error via status LEDs */
253 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
254
255 /* Wait until USB device disconnected */
256 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
257 break;
258 }
259
260 printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
261
262 puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
263
264 USB_HostState = HOST_STATE_Configured;
265 break;
266 case HOST_STATE_Configured:
267 PrintIncomingPackets();
268
269 break;
270 }
271 }
272