Documentation improvements - put driver example code into its own section, fix incorr...
[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.lufa-lib.org
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,
116 const uint8_t SubErrorCode)
117 {
118 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
119 " -- Error Code %d\r\n"
120 " -- Sub Error Code %d\r\n"
121 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
122
123 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
124 }
125
126 void PrintIncomingPackets(void)
127 {
128 uint8_t ErrorCode;
129
130 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
131
132 uint16_t PacketLength;
133 if ((ErrorCode = RNDIS_GetPacketLength(&PacketLength)) != HOST_SENDCONTROL_Successful)
134 {
135 printf_P(PSTR(ESC_FG_RED "Packet Reception Error.\r\n"
136 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
137 return;
138 }
139
140 if (!(PacketLength))
141 return;
142
143 Pipe_Unfreeze();
144
145 printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
146
147 if (PacketLength > 1024)
148 {
149 puts_P(PSTR(ESC_FG_RED "Packet too large.\r\n" ESC_FG_WHITE));
150 Pipe_Discard_Stream(PacketLength);
151 }
152 else
153 {
154 uint8_t PacketBuffer[PacketLength];
155
156 Pipe_Read_Stream_LE(&PacketBuffer, PacketLength);
157
158 for (uint16_t i = 0; i < PacketLength; i++)
159 printf("0x%02x ", PacketBuffer[i]);
160 }
161
162 Pipe_ClearIN();
163 Pipe_Freeze();
164
165 printf("\r\n\r\n");
166
167 LEDs_SetAllLEDs(LEDMASK_USB_READY);
168 }
169
170 /** Task to set the configuration of the attached device after it has been enumerated, and to read in
171 * data received from the attached RNDIS device and print it to the serial port.
172 */
173 void RNDIS_Host_Task(void)
174 {
175 uint8_t ErrorCode;
176
177 switch (USB_HostState)
178 {
179 case HOST_STATE_Addressed:
180 puts_P(PSTR("Getting Config Data.\r\n"));
181
182 /* Get and process the configuration descriptor data */
183 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
184 {
185 if (ErrorCode == ControlError)
186 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
187 else
188 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
189
190 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
191
192 /* Indicate error via status LEDs */
193 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
194
195 /* Wait until USB device disconnected */
196 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
197 break;
198 }
199
200 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
201 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
202 {
203 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
204 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
205
206 /* Indicate error via status LEDs */
207 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
208
209 /* Wait until USB device disconnected */
210 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
211 break;
212 }
213
214 uint16_t DeviceMaxPacketSize;
215 if ((ErrorCode = RNDIS_InitializeDevice(1024, &DeviceMaxPacketSize)) != HOST_SENDCONTROL_Successful)
216 {
217 printf_P(PSTR(ESC_FG_RED "Error Initializing Device.\r\n"
218 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
219
220 /* Indicate error via status LEDs */
221 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
222
223 /* Wait until USB device disconnected */
224 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
225 break;
226 }
227
228 printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), DeviceMaxPacketSize);
229
230 /* We set the default filter to only receive packets we would be interested in */
231 uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
232 if ((ErrorCode = RNDIS_SetRNDISProperty(OID_GEN_CURRENT_PACKET_FILTER,
233 &PacketFilter, sizeof(PacketFilter))) != HOST_SENDCONTROL_Successful)
234 {
235 printf_P(PSTR(ESC_FG_RED "Error Setting Device Packet Filter.\r\n"
236 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
237
238 /* Indicate error via status LEDs */
239 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
240
241 /* Wait until USB device disconnected */
242 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
243 break;
244 }
245
246 uint32_t VendorID;
247 if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_VENDOR_ID,
248 &VendorID, sizeof(VendorID))) != HOST_SENDCONTROL_Successful)
249 {
250 printf_P(PSTR(ESC_FG_RED "Error Getting Vendor ID.\r\n"
251 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
252
253 /* Indicate error via status LEDs */
254 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
255
256 /* Wait until USB device disconnected */
257 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
258 break;
259 }
260
261 printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
262
263 puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
264
265 USB_HostState = HOST_STATE_Configured;
266 break;
267 case HOST_STATE_Configured:
268 PrintIncomingPackets();
269
270 break;
271 }
272 }
273