Blame view

LUFA/Drivers/USB/Class/Host/HIDClassHost.c 12.4 KB
c9b6255a   dmohamed   ajout de la bibli...
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2017.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  
    Permission to use, copy, modify, distribute, and sell this
    software and its documentation for any purpose is hereby granted
    without fee, 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 disclaims 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.
  */
  
  #define  __INCLUDE_FROM_USB_DRIVER
  #include "../../Core/USBMode.h"
  
  #if defined(USB_CAN_BE_HOST)
  
  #define  __INCLUDE_FROM_HID_DRIVER
  #define  __INCLUDE_FROM_HID_HOST_C
  #include "HIDClassHost.h"
  
  uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                  uint16_t ConfigDescriptorSize,
                                  void* ConfigDescriptorData)
  {
  	USB_Descriptor_Endpoint_t*  DataINEndpoint  = NULL;
  	USB_Descriptor_Endpoint_t*  DataOUTEndpoint = NULL;
  	USB_Descriptor_Interface_t* HIDInterface    = NULL;
  	USB_HID_Descriptor_HID_t*   HIDDescriptor   = NULL;
  
  	memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));
  
  	if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  	  return HID_ENUMERROR_InvalidConfigDescriptor;
  
  	while (!(DataINEndpoint) || !(DataOUTEndpoint))
  	{
  		if (!(HIDInterface) ||
  		    USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  		                              DCOMP_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  		{
  			if (DataINEndpoint)
  			  break;
  
  			do
  			{
  				if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  				                              DCOMP_HID_Host_NextHIDInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  				{
  					return HID_ENUMERROR_NoCompatibleInterfaceFound;
  				}
  
  				HIDInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
  			} while (HIDInterfaceInfo->Config.HIDInterfaceProtocol &&
  					 (HIDInterface->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol));
  
  			if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  			                              DCOMP_HID_Host_NextHIDDescriptor) != DESCRIPTOR_SEARCH_COMP_Found)
  			{
  				return HID_ENUMERROR_NoCompatibleInterfaceFound;
  			}
  
  			HIDDescriptor = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_HID_Descriptor_HID_t);
  
  			DataINEndpoint  = NULL;
  			DataOUTEndpoint = NULL;
  
  			continue;
  		}
  
  		USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
  
  		if ((EndpointData->EndpointAddress & ENDPOINT_DIR_MASK) == ENDPOINT_DIR_IN)
  		  DataINEndpoint  = EndpointData;
  		else
  		  DataOUTEndpoint = EndpointData;
  	}
  
  	HIDInterfaceInfo->Config.DataINPipe.Size  = le16_to_cpu(DataINEndpoint->EndpointSize);
  	HIDInterfaceInfo->Config.DataINPipe.EndpointAddress = DataINEndpoint->EndpointAddress;
  	HIDInterfaceInfo->Config.DataINPipe.Type  = EP_TYPE_INTERRUPT;
  
  	if (!(Pipe_ConfigurePipeTable(&HIDInterfaceInfo->Config.DataINPipe, 1)))
  	  return HID_ENUMERROR_PipeConfigurationFailed;
  
  	if (DataOUTEndpoint)
  	{
  		HIDInterfaceInfo->Config.DataOUTPipe.Size = le16_to_cpu(DataOUTEndpoint->EndpointSize);
  		HIDInterfaceInfo->Config.DataOUTPipe.EndpointAddress = DataOUTEndpoint->EndpointAddress;
  		HIDInterfaceInfo->Config.DataOUTPipe.Type = EP_TYPE_INTERRUPT;
  
  		if (!(Pipe_ConfigurePipeTable(&HIDInterfaceInfo->Config.DataOUTPipe, 1)))
  		  return HID_ENUMERROR_PipeConfigurationFailed;
  	}
  
  	HIDInterfaceInfo->State.InterfaceNumber      = HIDInterface->InterfaceNumber;
  	HIDInterfaceInfo->State.HIDReportSize        = LE16_TO_CPU(HIDDescriptor->HIDReportLength);
  	HIDInterfaceInfo->State.SupportsBootProtocol = (HIDInterface->SubClass != HID_CSCP_NonBootProtocol);
  	HIDInterfaceInfo->State.LargestReportSize    = 8;
  	HIDInterfaceInfo->State.IsActive             = true;
  
  	return HID_ENUMERROR_NoError;
  }
  
  static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor)
  {
  	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
  
  	if (Header->Type == DTYPE_Interface)
  	{
  		USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
  
  		if (Interface->Class == HID_CSCP_HIDClass)
  		  return DESCRIPTOR_SEARCH_Found;
  	}
  
  	return DESCRIPTOR_SEARCH_NotFound;
  }
  
  static uint8_t DCOMP_HID_Host_NextHIDDescriptor(void* const CurrentDescriptor)
  {
  	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
  
  	if (Header->Type == HID_DTYPE_HID)
  	  return DESCRIPTOR_SEARCH_Found;
  	else if (Header->Type == DTYPE_Interface)
  	  return DESCRIPTOR_SEARCH_Fail;
  	else
  	  return DESCRIPTOR_SEARCH_NotFound;
  }
  
  static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor)
  {
  	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
  
  	if (Header->Type == DTYPE_Endpoint)
  	{
  		USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
  
  		if (!(Pipe_IsEndpointBound(Endpoint->EndpointAddress)))
  		  return DESCRIPTOR_SEARCH_Found;
  	}
  	else if (Header->Type == DTYPE_Interface)
  	{
  		return DESCRIPTOR_SEARCH_Fail;
  	}
  
  	return DESCRIPTOR_SEARCH_NotFound;
  }
  
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
  uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                     const uint8_t ReportID,
                                     void* Buffer)
  {
  	USB_ControlRequest = (USB_Request_Header_t)
  	{
  		.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
  		.bRequest      = HID_REQ_SetReport,
  		.wValue        = ((HID_REPORT_ITEM_In + 1) << 8) | ReportID,
  		.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  		.wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, HID_REPORT_ITEM_In),
  	};
  
  	Pipe_SelectPipe(PIPE_CONTROLPIPE);
  
  	return USB_Host_SendControlRequest(Buffer);
  }
  #endif
  
  uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                 void* Buffer)
  {
  	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
  	  return PIPE_READYWAIT_DeviceDisconnected;
  
  	uint8_t ErrorCode;
  
  	Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipe.Address);
  	Pipe_Unfreeze();
  
  	uint16_t ReportSize;
  	uint8_t* BufferPos = Buffer;
  
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
  	if (!(HIDInterfaceInfo->State.UsingBootProtocol))
  	{
  		uint8_t ReportID = 0;
  
  		if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)
  		{
  			ReportID = Pipe_Read_8();
  			*(BufferPos++) = ReportID;
  		}
  
  		ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, HID_REPORT_ITEM_In);
  	}
  	else
  #endif
  	{
  		ReportSize = Pipe_BytesInPipe();
  	}
  
  	if ((ErrorCode = Pipe_Read_Stream_LE(BufferPos, ReportSize, NULL)) != PIPE_RWSTREAM_NoError)
  	  return ErrorCode;
  
  	Pipe_ClearIN();
  	Pipe_Freeze();
  
  	return PIPE_RWSTREAM_NoError;
  }
  
  uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                  const uint8_t ReportID,
  #endif
                                  const uint8_t ReportType,
                                  void* Buffer,
                                  const uint16_t ReportSize)
  {
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
  	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
  	  return PIPE_RWSTREAM_NoError;
  
  	if (HIDInterfaceInfo->State.DeviceUsesOUTPipe && (ReportType == HID_REPORT_ITEM_Out))
  	{
  		uint8_t ErrorCode;
  
  		Pipe_SelectPipe(HIDInterfaceInfo->Config.DataOUTPipe.Address);
  		Pipe_Unfreeze();
  
  		if (ReportID)
  		  Pipe_Write_Stream_LE(&ReportID, sizeof(ReportID), NULL);
  
  		if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NULL)) != PIPE_RWSTREAM_NoError)
  		  return ErrorCode;
  
  		Pipe_ClearOUT();
  		Pipe_Freeze();
  
  		return PIPE_RWSTREAM_NoError;
  	}
  	else
  #endif
  	{
  		USB_ControlRequest = (USB_Request_Header_t)
  		{
  			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
  			.bRequest      = HID_REQ_SetReport,
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
  			.wValue        = ((ReportType + 1) << 8) | ReportID,
  #else
  			.wValue        = ((ReportType + 1) << 8),
  #endif
  			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  			.wLength       = ReportSize,
  		};
  
  		Pipe_SelectPipe(PIPE_CONTROLPIPE);
  
  		return USB_Host_SendControlRequest(Buffer);
  	}
  }
  
  bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
  {
  	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
  	  return false;
  
  	bool ReportReceived;
  
  	Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipe.Address);
  	Pipe_Unfreeze();
  
  	ReportReceived = Pipe_IsINReceived();
  
  	Pipe_Freeze();
  
  	return ReportReceived;
  }
  
  uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
  {
  	uint8_t ErrorCode;
  
  	if (!(HIDInterfaceInfo->State.SupportsBootProtocol))
  	  return HID_ERROR_LOGICAL;
  
  	USB_ControlRequest = (USB_Request_Header_t)
  		{
  			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
  			.bRequest      = HID_REQ_SetProtocol,
  			.wValue        = 0,
  			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  			.wLength       = 0,
  		};
  
  	Pipe_SelectPipe(PIPE_CONTROLPIPE);
  
  	if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
  	  return ErrorCode;
  
  	HIDInterfaceInfo->State.LargestReportSize = 8;
  	HIDInterfaceInfo->State.UsingBootProtocol = true;
  
  	return HOST_SENDCONTROL_Successful;
  }
  
  uint8_t HID_Host_SetIdlePeriod(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
                                 const uint16_t MS)
  {
  	USB_ControlRequest = (USB_Request_Header_t)
  		{
  			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
  			.bRequest      = HID_REQ_SetIdle,
  			.wValue        = ((MS << 6) & 0xFF00),
  			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  			.wLength       = 0,
  		};
  
  	Pipe_SelectPipe(PIPE_CONTROLPIPE);
  
  	return USB_Host_SendControlRequest(NULL);
  }
  
  #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
  uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
  {
  	uint8_t ErrorCode;
  
  	uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];
  
  	USB_ControlRequest = (USB_Request_Header_t)
  		{
  			.bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
  			.bRequest      = REQ_GetDescriptor,
  			.wValue        = (HID_DTYPE_Report << 8),
  			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  			.wLength       = HIDInterfaceInfo->State.HIDReportSize,
  		};
  
  	Pipe_SelectPipe(PIPE_CONTROLPIPE);
  
  	if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)
  	  return ErrorCode;
  
  	if (HIDInterfaceInfo->State.UsingBootProtocol)
  	{
  		USB_ControlRequest = (USB_Request_Header_t)
  			{
  				.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
  				.bRequest      = HID_REQ_SetProtocol,
  				.wValue        = 1,
  				.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
  				.wLength       = 0,
  			};
  
  		if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
  		  return ErrorCode;
  
  		HIDInterfaceInfo->State.UsingBootProtocol = false;
  	}
  
  	if (HIDInterfaceInfo->Config.HIDParserData == NULL)
  	  return HID_ERROR_LOGICAL;
  
  	if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,
  	                                      HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)
  	{
  		return HID_ERROR_LOGICAL | ErrorCode;
  	}
  
  	uint16_t LargestReportSizeBits = HIDInterfaceInfo->Config.HIDParserData->LargestReportSizeBits;
  	HIDInterfaceInfo->State.LargestReportSize = (LargestReportSizeBits >> 3) + ((LargestReportSizeBits & 0x07) != 0);
  
  	return 0;
  }
  #endif
  
  #endif