Minor documentation improvements.
[pub/USBasp.git] / Demos / Host / LowLevel / RNDISEthernetHost / RNDISEthernetHost.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2013.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2013 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 disclaims 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 GlobalInterruptEnable();
50
51 for (;;)
52 {
53 RNDISHost_Task();
54
55 USB_USBTask();
56 }
57 }
58
59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
60 void SetupHardware(void)
61 {
62 /* Disable watchdog if enabled by bootloader/fuses */
63 MCUSR &= ~(1 << WDRF);
64 wdt_disable();
65
66 /* Disable clock division */
67 clock_prescale_set(clock_div_1);
68
69 /* Hardware Initialization */
70 Serial_Init(9600, false);
71 LEDs_Init();
72 USB_Init();
73
74 /* Create a stdio stream for the serial port for stdin and stdout */
75 Serial_CreateStream(NULL);
76 }
77
78 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
79 * starts the library USB task to begin the enumeration and USB management process.
80 */
81 void EVENT_USB_Host_DeviceAttached(void)
82 {
83 puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
84 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
85 }
86
87 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
88 * stops the library USB task management process.
89 */
90 void EVENT_USB_Host_DeviceUnattached(void)
91 {
92 puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
93 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
94 }
95
96 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
97 * enumerated by the host and is now ready to be used by the application.
98 */
99 void EVENT_USB_Host_DeviceEnumerationComplete(void)
100 {
101 puts_P(PSTR("Getting Config Data.\r\n"));
102
103 uint8_t ErrorCode;
104
105 /* Get and process the configuration descriptor data */
106 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
107 {
108 if (ErrorCode == ControlError)
109 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
110 else
111 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
112
113 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
114
115 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
116 return;
117 }
118
119 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
120 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
121 {
122 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
123 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
124
125 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
126 return;
127 }
128
129 uint16_t DeviceMaxPacketSize;
130 if ((ErrorCode = RNDIS_InitializeDevice(1024, &DeviceMaxPacketSize)) != HOST_SENDCONTROL_Successful)
131 {
132 printf_P(PSTR(ESC_FG_RED "Error Initializing Device.\r\n"
133 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
134
135 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
136 USB_Host_SetDeviceConfiguration(0);
137 return;
138 }
139
140 printf_P(PSTR("Device Max Transfer Size: %lu bytes.\r\n"), DeviceMaxPacketSize);
141
142 /* We set the default filter to only receive packets we would be interested in */
143 uint32_t PacketFilter = (REMOTE_NDIS_PACKET_DIRECTED | REMOTE_NDIS_PACKET_BROADCAST | REMOTE_NDIS_PACKET_ALL_MULTICAST);
144 if ((ErrorCode = RNDIS_SetRNDISProperty(OID_GEN_CURRENT_PACKET_FILTER,
145 &PacketFilter, sizeof(PacketFilter))) != HOST_SENDCONTROL_Successful)
146 {
147 printf_P(PSTR(ESC_FG_RED "Error Setting Device Packet Filter.\r\n"
148 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
149
150 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
151 USB_Host_SetDeviceConfiguration(0);
152 return;
153 }
154
155 uint32_t VendorID;
156 if ((ErrorCode = RNDIS_QueryRNDISProperty(OID_GEN_VENDOR_ID,
157 &VendorID, sizeof(VendorID))) != HOST_SENDCONTROL_Successful)
158 {
159 printf_P(PSTR(ESC_FG_RED "Error Getting Vendor ID.\r\n"
160 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
161
162 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
163 USB_Host_SetDeviceConfiguration(0);
164 return;
165 }
166
167 printf_P(PSTR("Device Vendor ID: 0x%08lX\r\n"), VendorID);
168
169 puts_P(PSTR("RNDIS Device Enumerated.\r\n"));
170 LEDs_SetAllLEDs(LEDMASK_USB_READY);
171 }
172
173 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
174 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
175 {
176 USB_Disable();
177
178 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
179 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
180
181 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
182 for(;;);
183 }
184
185 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
186 * enumerating an attached USB device.
187 */
188 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
189 const uint8_t SubErrorCode)
190 {
191 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
192 " -- Error Code %d\r\n"
193 " -- Sub Error Code %d\r\n"
194 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
195
196 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
197 }
198
199 /** Task to read in data received from the attached RNDIS device and print it to the serial port.
200 */
201 void RNDISHost_Task(void)
202 {
203 if (USB_HostState != HOST_STATE_Configured)
204 return;
205
206 uint8_t ErrorCode;
207
208 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
209
210 uint16_t PacketLength;
211 if ((ErrorCode = RNDIS_GetPacketLength(&PacketLength)) != HOST_SENDCONTROL_Successful)
212 {
213 printf_P(PSTR(ESC_FG_RED "Packet Reception Error.\r\n"
214 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
215 return;
216 }
217
218 if (!(PacketLength))
219 return;
220
221 Pipe_Unfreeze();
222
223 printf_P(PSTR("***PACKET (Size %d)***\r\n"), PacketLength);
224
225 if (PacketLength > 1024)
226 {
227 puts_P(PSTR(ESC_FG_RED "Packet too large.\r\n" ESC_FG_WHITE));
228 Pipe_Discard_Stream(PacketLength, NULL);
229 }
230 else
231 {
232 uint8_t PacketBuffer[PacketLength];
233
234 Pipe_Read_Stream_LE(&PacketBuffer, PacketLength, NULL);
235
236 for (uint16_t i = 0; i < PacketLength; i++)
237 printf("0x%02x ", PacketBuffer[i]);
238 }
239
240 Pipe_ClearIN();
241 Pipe_Freeze();
242
243 printf("\r\n\r\n");
244
245 LEDs_SetAllLEDs(LEDMASK_USB_READY);
246 }
247