CDC.c 14.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

#include "../../HighLevel/USBMode.h"
#if defined(USB_CAN_BE_HOST)

#define  INCLUDE_FROM_CDC_CLASS_HOST_C
#include "CDC.h"

37
uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
38
                                void* ConfigDescriptorData)
39
{
40
	uint8_t FoundEndpoints = 0;
41

42
43
	memset(&CDCInterfaceInfo->State, 0x00, sizeof(CDCInterfaceInfo->State));

44
	if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
45
	  return CDC_ENUMERROR_InvalidConfigDescriptor;
46
47
48
49
	
	if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
	                              DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
	{
50
		return CDC_ENUMERROR_NoCDCInterfaceFound;
51
	}
52
	
53
	CDCInterfaceInfo->State.ControlInterfaceNumber = DESCRIPTOR_CAST(ConfigDescriptorData, USB_Descriptor_Interface_t).InterfaceNumber;
54

55
	while (FoundEndpoints != (CDC_FOUND_NOTIFICATION_IN | CDC_FOUND_DATAPIPE_IN | CDC_FOUND_DATAPIPE_OUT))
56
57
	{
		if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
58
		                              DComp_CDC_Host_NextCDCInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
59
		{
60
			if (FoundEndpoints & CDC_FOUND_NOTIFICATION_IN)
61
62
63
64
			{
				if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, 
				                              DComp_CDC_Host_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)
				{
65
					return CDC_ENUMERROR_NoCDCInterfaceFound;
66
67
68
69
70
71
				}
			}
			else
			{
				FoundEndpoints = 0;

72
				Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
73
				Pipe_DisablePipe();
74
				Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);
75
				Pipe_DisablePipe();
76
				Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
77
78
79
80
81
				Pipe_DisablePipe();
			
				if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
				                              DComp_CDC_Host_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)
				{
82
					return CDC_ENUMERROR_NoCDCInterfaceFound;
83
84
85
86
				}
			}

			if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
87
			                              DComp_CDC_Host_NextCDCInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
88
			{
89
				return CDC_ENUMERROR_EndpointsNotFound;
90
91
92
93
94
95
96
97
			}
		}
		
		USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);

		if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)
		{
			if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
98
			{
99
				Pipe_ConfigurePipe(CDCInterfaceInfo->Config.NotificationPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
100
101
								   EndpointData->EndpointAddress, EndpointData->EndpointSize,
								   CDCInterfaceInfo->Config.NotificationPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
102
				CDCInterfaceInfo->State.NotificationPipeSize = EndpointData->EndpointSize;
103
104
105

				Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);
				
106
				FoundEndpoints |= CDC_FOUND_NOTIFICATION_IN;
107
108
109
110
111
112
			}
		}
		else
		{
			if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
			{
113
114
				if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
				{
115
					CDCInterfaceInfo->State.BidirectionalDataEndpoints = true;
116
117
118
					Pipe_DisablePipe();
				}

119
				Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,
120
121
				                   EndpointData->EndpointAddress, EndpointData->EndpointSize, 
				                   CDCInterfaceInfo->Config.DataINPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
122
				CDCInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
123

124
				FoundEndpoints |= CDC_FOUND_DATAPIPE_IN;
125
126
127
			}
			else
			{
128
129
				if (Pipe_IsEndpointBound(EndpointData->EndpointAddress))
				{
130
					CDCInterfaceInfo->State.BidirectionalDataEndpoints = true;
131
132
133
134
135
136
137
138
				}
				else
				{
					Pipe_ConfigurePipe(CDCInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,
					                   EndpointData->EndpointAddress, EndpointData->EndpointSize, 
					                   CDCInterfaceInfo->Config.DataOUTPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
				}
				
139
				CDCInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
140
				
141
				FoundEndpoints |= CDC_FOUND_DATAPIPE_OUT;
142
143
144
145
			}
		}
	}

146
147
	CDCInterfaceInfo->State.ControlLineStates.HostToDevice = (CDC_CONTROL_LINE_OUT_RTS | CDC_CONTROL_LINE_OUT_DTR);
	CDCInterfaceInfo->State.ControlLineStates.DeviceToHost = (CDC_CONTROL_LINE_IN_DCD  | CDC_CONTROL_LINE_IN_DSR);
148
	CDCInterfaceInfo->State.IsActive = true;
149
	return CDC_ENUMERROR_NoError;
150
151
}

152
static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor)
153
154
155
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	{
156
157
158
159
160
161
		USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
		                                                                USB_Descriptor_Interface_t);
	
		if ((CurrentInterface->Class    == CDC_CONTROL_CLASS)    &&
		    (CurrentInterface->SubClass == CDC_CONTROL_SUBCLASS) &&
			(CurrentInterface->Protocol == CDC_CONTROL_PROTOCOL))
162
163
164
165
166
167
168
169
		{
			return DESCRIPTOR_SEARCH_Found;
		}
	}
	
	return DESCRIPTOR_SEARCH_NotFound;
}

170
static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor)
171
172
173
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	{
174
175
176
177
178
179
		USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
		                                                                USB_Descriptor_Interface_t);
	
		if ((CurrentInterface->Class    == CDC_DATA_CLASS)    &&
		    (CurrentInterface->SubClass == CDC_DATA_SUBCLASS) &&
			(CurrentInterface->Protocol == CDC_DATA_PROTOCOL))
180
181
182
183
184
185
186
187
		{
			return DESCRIPTOR_SEARCH_Found;
		}
	}
	
	return DESCRIPTOR_SEARCH_NotFound;
}

188
static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor)
189
190
191
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
	{
192
		USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
193
		                                                              USB_Descriptor_Endpoint_t);
194
195
	
		uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
196
	
197
		if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))
198
199
200
		{
			return DESCRIPTOR_SEARCH_Found;
		}
201
202
203
204
205
206
207
208
209
	}
	else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	{
		return DESCRIPTOR_SEARCH_Fail;
	}

	return DESCRIPTOR_SEARCH_NotFound;
}

210
void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
211
{
212
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
213
214
	  return;
	
215
216
	Pipe_SelectPipe(CDCInterfaceInfo->Config.NotificationPipeNumber);
	Pipe_SetPipeToken(PIPE_TOKEN_IN);
217
218
219
220
221
	Pipe_Unfreeze();

	if (Pipe_IsINReceived())
	{
		USB_Request_Header_t Notification;
222
		Pipe_Read_Stream_LE(&Notification, sizeof(USB_Request_Header_t), NO_STREAM_CALLBACK);
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
		
		if ((Notification.bRequest      == NOTIF_SerialState) &&
		    (Notification.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)))
		{
			Pipe_Read_Stream_LE(&CDCInterfaceInfo->State.ControlLineStates.DeviceToHost,
			                    sizeof(CDCInterfaceInfo->State.ControlLineStates.DeviceToHost),
			                    NO_STREAM_CALLBACK);
			
		}

		Pipe_ClearIN();

		EVENT_CDC_Host_ControLineStateChanged(CDCInterfaceInfo);
	}
	
	Pipe_Freeze();
239
240
}

241
uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
242
243
244
245
{
	USB_ControlRequest = (USB_Request_Header_t)
	{
		.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
246
		.bRequest      = REQ_SetLineEncoding,
247
248
249
250
251
252
253
254
255
256
		.wValue        = 0,
		.wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
		.wLength       = sizeof(CDCInterfaceInfo->State.LineEncoding),
	};

	Pipe_SelectPipe(PIPE_CONTROLPIPE);
	
	return USB_Host_SendControlRequest(&CDCInterfaceInfo->State.LineEncoding);
}

257
uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
{
	USB_ControlRequest = (USB_Request_Header_t)
	{
		.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
		.bRequest      = REQ_SetControlLineState,
		.wValue        = CDCInterfaceInfo->State.ControlLineStates.HostToDevice,
		.wIndex        = CDCInterfaceInfo->State.ControlInterfaceNumber,
		.wLength       = 0,
	};

	Pipe_SelectPipe(PIPE_CONTROLPIPE);
	
	return USB_Host_SendControlRequest(NULL);
}

273
uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)
274
{
275
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
276
	  return PIPE_READYWAIT_DeviceDisconnected;
277

278
279
	uint8_t ErrorCode;

280
281
282
	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
283
		Pipe_SetPipeToken(PIPE_TOKEN_OUT);
284
285
286
287
288
289
	}
	else
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);	
	}

290
	Pipe_Unfreeze();
291
	ErrorCode = Pipe_Write_Stream_LE(Data, Length, NO_STREAM_CALLBACK);
292
	Pipe_Freeze();
293
294
295

	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	  Pipe_SetPipeToken(PIPE_TOKEN_IN);
296
297
	
	return ErrorCode;
298
299
}

300
uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data)
301
{
302
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
303
	  return PIPE_READYWAIT_DeviceDisconnected;
304
	  
305
	uint8_t ErrorCode;
306

307
308
309
	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
310
		Pipe_SetPipeToken(PIPE_TOKEN_OUT);
311
312
313
314
315
316
	}
	else
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);	
	}
	
317
318
319
320
321
	Pipe_Unfreeze();
	
	if (!(Pipe_IsReadWriteAllowed()))
	{
		Pipe_ClearOUT();
322
323
324

		if ((ErrorCode = Pipe_WaitUntilReady()) != PIPE_READYWAIT_NoError)
		  return ErrorCode;
325
326
327
328
	}

	Pipe_Write_Byte(Data);	
	Pipe_Freeze();
329
330
331

	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	  Pipe_SetPipeToken(PIPE_TOKEN_IN);
332
	
333
	return PIPE_READYWAIT_NoError;
334
335
}

336
uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
337
338
339
{
	uint16_t BytesInPipe = 0;

340
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
341
	  return 0;
342
	
343
344
	Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
	Pipe_SetPipeToken(PIPE_TOKEN_IN);
345
346
347
348
349
350
351
352
353
354
355
	Pipe_Unfreeze();

	if (Pipe_IsINReceived() && !(Pipe_BytesInPipe()))
	  Pipe_ClearIN();
	
	BytesInPipe = Pipe_BytesInPipe();
	Pipe_Freeze();
	
	return BytesInPipe;
}

356
uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
357
358
359
{
	uint8_t ReceivedByte = 0;

360
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
361
	  return 0;
362
	  
363
364
	Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
	Pipe_SetPipeToken(PIPE_TOKEN_IN);
365
366
367
368
369
370
371
372
373
374
375
376
	Pipe_Unfreeze();

	ReceivedByte = Pipe_Read_Byte();
	
	if (!(Pipe_BytesInPipe()))
	  Pipe_ClearIN();
	
	Pipe_Freeze();
	
	return ReceivedByte;
}

377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
{
	if ((USB_HostState != HOST_STATE_Configured) || !(CDCInterfaceInfo->State.IsActive))
	  return PIPE_READYWAIT_DeviceDisconnected;
	  
	uint8_t ErrorCode;

	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataINPipeNumber);
		Pipe_SetPipeToken(PIPE_TOKEN_OUT);
	}
	else
	{
		Pipe_SelectPipe(CDCInterfaceInfo->Config.DataOUTPipeNumber);	
	}
	
	Pipe_Unfreeze();
	
	if (!(Pipe_BytesInPipe()))
	  return PIPE_READYWAIT_NoError;

	bool BankFull = !(Pipe_IsReadWriteAllowed());

	Pipe_ClearOUT();

	if (BankFull)
	{
		if ((ErrorCode = Pipe_WaitUntilReady()) != PIPE_READYWAIT_NoError)
		  return ErrorCode;

		Pipe_ClearOUT();
	}

	Pipe_Freeze();

	if (CDCInterfaceInfo->State.BidirectionalDataEndpoints)
	  Pipe_SetPipeToken(PIPE_TOKEN_IN);
	
	return PIPE_READYWAIT_NoError;
}

419
420
421
422
423
424
void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream)
{
	*Stream = (FILE)FDEV_SETUP_STREAM(CDC_Host_putchar, CDC_Host_getchar, _FDEV_SETUP_RW);
	fdev_set_udata(Stream, CDCInterfaceInfo);
}

425
426
427
428
429
430
void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream)
{
	*Stream = (FILE)FDEV_SETUP_STREAM(CDC_Host_putchar, CDC_Host_getchar_Blocking, _FDEV_SETUP_RW);
	fdev_set_udata(Stream, CDCInterfaceInfo);
}

431
432
static int CDC_Host_putchar(char c, FILE* Stream)
{
433
	return CDC_Host_SendByte((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream), c) ? _FDEV_ERR : 0;
434
435
436
437
438
}

static int CDC_Host_getchar(FILE* Stream)
{
	if (!(CDC_Host_BytesReceived((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream))))
439
	  return _FDEV_EOF;
440
441
442
443

	return CDC_Host_ReceiveByte((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream));
}

444
445
446
447
448
449
450
451
452
453
454
static int CDC_Host_getchar_Blocking(FILE* Stream)
{
	while (!(CDC_Host_BytesReceived((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream))))
	{
		CDC_Host_USBTask((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream));
		USB_USBTask();
	}

	return CDC_Host_ReceiveByte((USB_ClassInfo_CDC_Host_t*)fdev_get_udata(Stream));
}

455
void CDC_Host_Event_Stub(void)
456
457
458
459
460
{

}

#endif