Added explicit ADC channel masks for the standard set of ADC channels, as the single...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / RNDIS.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 #include "../../HighLevel/USBMode.h"
32 #if defined(USB_CAN_BE_HOST)
33
34 #define INCLUDE_FROM_RNDIS_CLASS_HOST_C
35 #include "RNDIS.h"
36
37 uint8_t RNDIS_Host_ConfigurePipes(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint16_t ConfigDescriptorSize,
38 void* ConfigDescriptorData)
39 {
40 uint8_t FoundEndpoints = 0;
41
42 memset(&RNDISInterfaceInfo->State, 0x00, sizeof(RNDISInterfaceInfo->State));
43
44 if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
45 return RNDIS_ENUMERROR_InvalidConfigDescriptor;
46
47 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
48 DComp_RNDIS_Host_NextRNDISControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
49 {
50 return RNDIS_ENUMERROR_NoRNDISInterfaceFound;
51 }
52
53 RNDISInterfaceInfo->State.ControlInterfaceNumber = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber;
54
55 while (FoundEndpoints != (RNDIS_FOUND_NOTIFICATION_IN | RNDIS_FOUND_DATAPIPE_IN | RNDIS_FOUND_DATAPIPE_OUT))
56 {
57 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
58 DComp_RNDIS_Host_NextRNDISInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
59 {
60 if (FoundEndpoints & RNDIS_FOUND_NOTIFICATION_IN)
61 {
62 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
63 DComp_RNDIS_Host_NextRNDISDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)
64 {
65 return RNDIS_ENUMERROR_NoRNDISInterfaceFound;
66 }
67 }
68 else
69 {
70 FoundEndpoints = 0;
71
72 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataINPipeNumber);
73 Pipe_DisablePipe();
74 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataOUTPipeNumber);
75 Pipe_DisablePipe();
76 Pipe_SelectPipe(RNDISInterfaceInfo->Config.NotificationPipeNumber);
77 Pipe_DisablePipe();
78
79 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
80 DComp_RNDIS_Host_NextRNDISControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
81 {
82 return RNDIS_ENUMERROR_NoRNDISInterfaceFound;
83 }
84 }
85
86 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
87 DComp_RNDIS_Host_NextRNDISInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
88 {
89 return RNDIS_ENUMERROR_EndpointsNotFound;
90 }
91 }
92
93 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
94
95 if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
96 {
97 if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
98 {
99 Pipe_ConfigurePipe(RNDISInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
100 EndpointData->EndpointAddress, EndpointData->EndpointSize,
101 RNDISInterfaceInfo->Config.NotificationPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
102 RNDISInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
103
104 Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
105
106 FoundEndpoints |= RNDIS_FOUND_NOTIFICATION_IN;
107 }
108 }
109 else
110 {
111 if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
112 {
113 if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
114 {
115 RNDISInterfaceInfo->State.BidirectionalDataEndpoints = true;
116 Pipe_DisablePipe();
117 }
118
119 Pipe_ConfigurePipe(RNDISInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
120 EndpointData->EndpointAddress, EndpointData->EndpointSize,
121 RNDISInterfaceInfo->Config.DataINPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
122 RNDISInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
123
124 FoundEndpoints |= RNDIS_FOUND_DATAPIPE_IN;
125 }
126 else
127 {
128 if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
129 {
130 RNDISInterfaceInfo->State.BidirectionalDataEndpoints = true;
131 }
132 else
133 {
134 Pipe_ConfigurePipe(RNDISInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
135 EndpointData->EndpointAddress, EndpointData->EndpointSize,
136 RNDISInterfaceInfo->Config.DataOUTPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
137 }
138
139 RNDISInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
140
141 FoundEndpoints |= RNDIS_FOUND_DATAPIPE_OUT;
142 }
143 }
144 }
145
146 RNDISInterfaceInfo->State.IsActive = true;
147 return RNDIS_ENUMERROR_NoError;
148 }
149
150 static uint8_t DComp_RNDIS_Host_NextRNDISControlInterface(void* const CurrentDescriptor)
151 {
152 if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
153 {
154 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
155 USB_Descriptor_Interface_t);
156
157 if ((CurrentInterface->Class == RNDIS_CONTROL_CLASS) &&
158 (CurrentInterface->SubClass == RNDIS_CONTROL_SUBCLASS) &&
159 (CurrentInterface->Protocol == RNDIS_CONTROL_PROTOCOL))
160 {
161 return DESCRIPTOR_SEARCH_Found;
162 }
163 }
164
165 return DESCRIPTOR_SEARCH_NotFound;
166 }
167
168 static uint8_t DComp_RNDIS_Host_NextRNDISDataInterface(void* const CurrentDescriptor)
169 {
170 if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
171 {
172 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
173 USB_Descriptor_Interface_t);
174
175 if ((CurrentInterface->Class == RNDIS_DATA_CLASS) &&
176 (CurrentInterface->SubClass == RNDIS_DATA_SUBCLASS) &&
177 (CurrentInterface->Protocol == RNDIS_DATA_PROTOCOL))
178 {
179 return DESCRIPTOR_SEARCH_Found;
180 }
181 }
182
183 return DESCRIPTOR_SEARCH_NotFound;
184 }
185
186 static uint8_t DComp_RNDIS_Host_NextRNDISInterfaceEndpoint(void* const CurrentDescriptor)
187 {
188 if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
189 {
190 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
191 USB_Descriptor_Endpoint_t);
192
193 uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
194
195 if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))
196 {
197 return DESCRIPTOR_SEARCH_Found;
198 }
199 }
200 else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
201 {
202 return DESCRIPTOR_SEARCH_Fail;
203 }
204
205 return DESCRIPTOR_SEARCH_NotFound;
206 }
207
208 static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
209 void* Buffer, uint16_t Length)
210 {
211 USB_ControlRequest = (USB_Request_Header_t)
212 {
213 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
214 .bRequest = REQ_SendEncapsulatedCommand,
215 .wValue = 0,
216 .wIndex = RNDISInterfaceInfo->State.ControlInterfaceNumber,
217 .wLength = Length,
218 };
219
220 Pipe_SelectPipe(PIPE_CONTROLPIPE);
221 return USB_Host_SendControlRequest(Buffer);
222 }
223
224 static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,
225 void* Buffer, uint16_t Length)
226 {
227 USB_ControlRequest = (USB_Request_Header_t)
228 {
229 .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
230 .bRequest = REQ_GetEncapsulatedResponse,
231 .wValue = 0,
232 .wIndex = RNDISInterfaceInfo->State.ControlInterfaceNumber,
233 .wLength = Length,
234 };
235
236 Pipe_SelectPipe(PIPE_CONTROLPIPE);
237 return USB_Host_SendControlRequest(Buffer);
238 }
239
240 uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
241 {
242 uint8_t ErrorCode;
243
244 RNDIS_KeepAlive_Message_t KeepAliveMessage;
245 RNDIS_KeepAlive_Complete_t KeepAliveMessageResponse;
246
247 KeepAliveMessage.MessageType = REMOTE_NDIS_KEEPALIVE_MSG;
248 KeepAliveMessage.MessageLength = sizeof(RNDIS_KeepAlive_Message_t);
249 KeepAliveMessage.RequestId = RNDISInterfaceInfo->State.RequestID++;
250
251 if ((ErrorCode = RNDIS_SendEncapsulatedCommand(RNDISInterfaceInfo, &KeepAliveMessage,
252 sizeof(RNDIS_KeepAlive_Message_t))) != HOST_SENDCONTROL_Successful)
253 {
254 return ErrorCode;
255 }
256
257 if ((ErrorCode = RNDIS_GetEncapsulatedResponse(RNDISInterfaceInfo, &KeepAliveMessageResponse,
258 sizeof(RNDIS_KeepAlive_Complete_t))) != HOST_SENDCONTROL_Successful)
259 {
260 return ErrorCode;
261 }
262
263 return HOST_SENDCONTROL_Successful;
264 }
265
266 uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
267 {
268 uint8_t ErrorCode;
269
270 RNDIS_Initialize_Message_t InitMessage;
271 RNDIS_Initialize_Complete_t InitMessageResponse;
272
273 InitMessage.MessageType = REMOTE_NDIS_INITIALIZE_MSG;
274 InitMessage.MessageLength = sizeof(RNDIS_Initialize_Message_t);
275 InitMessage.RequestId = RNDISInterfaceInfo->State.RequestID++;
276
277 InitMessage.MajorVersion = REMOTE_NDIS_VERSION_MAJOR;
278 InitMessage.MinorVersion = REMOTE_NDIS_VERSION_MINOR;
279 InitMessage.MaxTransferSize = RNDISInterfaceInfo->Config.HostMaxPacketSize;
280
281 if ((ErrorCode = RNDIS_SendEncapsulatedCommand(RNDISInterfaceInfo, &InitMessage,
282 sizeof(RNDIS_Initialize_Message_t))) != HOST_SENDCONTROL_Successful)
283 {
284 return ErrorCode;
285 }
286
287 if ((ErrorCode = RNDIS_GetEncapsulatedResponse(RNDISInterfaceInfo, &InitMessageResponse,
288 sizeof(RNDIS_Initialize_Complete_t))) != HOST_SENDCONTROL_Successful)
289 {
290 return ErrorCode;
291 }
292
293 if (InitMessageResponse.Status != REMOTE_NDIS_STATUS_SUCCESS)
294 return RNDIS_COMMAND_FAILED;
295
296 RNDISInterfaceInfo->State.DeviceMaxPacketSize = InitMessageResponse.MaxTransferSize;
297
298 return HOST_SENDCONTROL_Successful;
299 }
300
301 uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer, uint16_t Length)
302 {
303 uint8_t ErrorCode;
304
305 struct
306 {
307 RNDIS_Set_Message_t SetMessage;
308 uint8_t ContigiousBuffer[Length];
309 } SetMessageData;
310
311 RNDIS_Set_Complete_t SetMessageResponse;
312
313 SetMessageData.SetMessage.MessageType = REMOTE_NDIS_SET_MSG;
314 SetMessageData.SetMessage.MessageLength = sizeof(RNDIS_Set_Message_t) + Length;
315 SetMessageData.SetMessage.RequestId = RNDISInterfaceInfo->State.RequestID++;
316
317 SetMessageData.SetMessage.Oid = Oid;
318 SetMessageData.SetMessage.InformationBufferLength = Length;
319 SetMessageData.SetMessage.InformationBufferOffset = (sizeof(RNDIS_Set_Message_t) - sizeof(RNDIS_Message_Header_t));
320 SetMessageData.SetMessage.DeviceVcHandle = 0;
321
322 memcpy(&SetMessageData.ContigiousBuffer, Buffer, Length);
323
324 if ((ErrorCode = RNDIS_SendEncapsulatedCommand(RNDISInterfaceInfo, &SetMessageData,
325 SetMessageData.SetMessage.MessageLength)) != HOST_SENDCONTROL_Successful)
326 {
327 return ErrorCode;
328 }
329
330 if ((ErrorCode = RNDIS_GetEncapsulatedResponse(RNDISInterfaceInfo, &SetMessageResponse,
331 sizeof(RNDIS_Set_Complete_t))) != HOST_SENDCONTROL_Successful)
332 {
333 return ErrorCode;
334 }
335
336 if (SetMessageResponse.Status != REMOTE_NDIS_STATUS_SUCCESS)
337 return RNDIS_COMMAND_FAILED;
338
339 return HOST_SENDCONTROL_Successful;
340 }
341
342 uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, uint32_t Oid, void* Buffer, uint16_t MaxLength)
343 {
344 uint8_t ErrorCode;
345
346 RNDIS_Query_Message_t QueryMessage;
347
348 struct
349 {
350 RNDIS_Query_Complete_t QueryMessageResponse;
351 uint8_t ContigiousBuffer[MaxLength];
352 } QueryMessageResponseData;
353
354 QueryMessage.MessageType = REMOTE_NDIS_QUERY_MSG;
355 QueryMessage.MessageLength = sizeof(RNDIS_Query_Message_t);
356 QueryMessage.RequestId = RNDISInterfaceInfo->State.RequestID++;
357
358 QueryMessage.Oid = Oid;
359 QueryMessage.InformationBufferLength = 0;
360 QueryMessage.InformationBufferOffset = 0;
361 QueryMessage.DeviceVcHandle = 0;
362
363 if ((ErrorCode = RNDIS_SendEncapsulatedCommand(RNDISInterfaceInfo, &QueryMessage,
364 sizeof(RNDIS_Query_Message_t))) != HOST_SENDCONTROL_Successful)
365 {
366 return ErrorCode;
367 }
368
369 if ((ErrorCode = RNDIS_GetEncapsulatedResponse(RNDISInterfaceInfo, &QueryMessageResponseData,
370 sizeof(QueryMessageResponseData))) != HOST_SENDCONTROL_Successful)
371 {
372 return ErrorCode;
373 }
374
375 if (QueryMessageResponseData.QueryMessageResponse.Status != REMOTE_NDIS_STATUS_SUCCESS)
376 return RNDIS_COMMAND_FAILED;
377
378 memcpy(Buffer, &QueryMessageResponseData.ContigiousBuffer, MaxLength);
379
380 return HOST_SENDCONTROL_Successful;
381 }
382
383 bool RNDIS_Host_IsPacketReceived(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo)
384 {
385 bool PacketWaiting;
386
387 if ((USB_HostState != HOST_STATE_Configured) || !(RNDISInterfaceInfo->State.IsActive))
388 return false;
389
390 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataINPipeNumber);
391 Pipe_SetPipeToken(PIPE_TOKEN_IN);
392
393 Pipe_Unfreeze();
394
395 PacketWaiting = Pipe_IsINReceived();
396
397 Pipe_Freeze();
398
399 return PacketWaiting;
400 }
401
402 uint8_t RNDIS_Host_ReadPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t* PacketLength)
403 {
404 uint8_t ErrorCode;
405
406 if ((USB_HostState != HOST_STATE_Configured) || !(RNDISInterfaceInfo->State.IsActive))
407 return PIPE_READYWAIT_DeviceDisconnected;
408
409 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataINPipeNumber);
410 Pipe_SetPipeToken(PIPE_TOKEN_IN);
411 Pipe_Unfreeze();
412
413 if (!(Pipe_IsReadWriteAllowed()))
414 {
415 *PacketLength = 0;
416 Pipe_Freeze();
417 return PIPE_RWSTREAM_NoError;
418 }
419
420 RNDIS_Packet_Message_t DeviceMessage;
421
422 if ((ErrorCode = Pipe_Read_Stream_LE(&DeviceMessage, sizeof(RNDIS_Packet_Message_t),
423 NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
424 {
425 return ErrorCode;
426 }
427
428 *PacketLength = (uint16_t)DeviceMessage.DataLength;
429
430 Pipe_Discard_Stream(DeviceMessage.DataOffset - (sizeof(RNDIS_Packet_Message_t) - sizeof(RNDIS_Message_Header_t)),
431 NO_STREAM_CALLBACK);
432
433 Pipe_Read_Stream_LE(Buffer, *PacketLength, NO_STREAM_CALLBACK);
434 Pipe_ClearIN();
435
436 Pipe_Freeze();
437
438 return PIPE_RWSTREAM_NoError;
439 }
440
441 uint8_t RNDIS_Host_SendPacket(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, void* Buffer, uint16_t PacketLength)
442 {
443 uint8_t ErrorCode;
444
445 if ((USB_HostState != HOST_STATE_Configured) || !(RNDISInterfaceInfo->State.IsActive))
446 return PIPE_READYWAIT_DeviceDisconnected;
447
448 if (RNDISInterfaceInfo->State.BidirectionalDataEndpoints)
449 {
450 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataINPipeNumber);
451 Pipe_SetPipeToken(PIPE_TOKEN_OUT);
452 }
453 else
454 {
455 Pipe_SelectPipe(RNDISInterfaceInfo->Config.DataOUTPipeNumber);
456 }
457
458 Pipe_Unfreeze();
459
460 RNDIS_Packet_Message_t DeviceMessage;
461
462 DeviceMessage.MessageType = REMOTE_NDIS_PACKET_MSG;
463 DeviceMessage.MessageLength = (sizeof(RNDIS_Packet_Message_t) + PacketLength);
464 DeviceMessage.DataOffset = (sizeof(RNDIS_Packet_Message_t) - sizeof(RNDIS_Message_Header_t));
465 DeviceMessage.DataLength = PacketLength;
466
467 if ((ErrorCode = Pipe_Write_Stream_LE(&DeviceMessage, sizeof(RNDIS_Packet_Message_t),
468 NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
469 {
470 return ErrorCode;
471 }
472
473 Pipe_Write_Stream_LE(Buffer, PacketLength, NO_STREAM_CALLBACK);
474 Pipe_ClearOUT();
475
476 Pipe_Freeze();
477
478 if (RNDISInterfaceInfo->State.BidirectionalDataEndpoints)
479 Pipe_SetPipeToken(PIPE_TOKEN_IN);
480
481 return PIPE_RWSTREAM_NoError;
482 }
483
484 #endif