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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
/** @file
The library provides USB HID Class standard and specific requests defined
in USB HID Firmware Specification 7 section : Requests.
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "UefiUsbLibInternal.h"
//
// Hid RequestType Bits specifying characteristics of request.
// Valid values are 10100001b (0xa1) or 00100001b (0x21).
// The following description:
// 7 Data transfer direction
// 0 = Host to device
// 1 = Device to host
// 6..5 Type
// 1 = Class
// 4..0 Recipient
// 1 = Interface
//
/**
Get the descriptor of the specified USB HID interface.
Submit a USB get HID descriptor request for the USB device specified by UsbIo
and Interface and return the HID descriptor in HidDescriptor.
If UsbIo is NULL, then ASSERT().
If HidDescriptor is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the HID interface on the USB target.
@param HidDescriptor The pointer to the USB HID descriptor that was retrieved from
the specified USB target and interface. Type EFI_USB_HID_DESCRIPTOR
is defined in the MDE Package Industry Standard include file Usb.h.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetHidDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT(UsbIo != NULL);
ASSERT(HidDescriptor != NULL);
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_HID << 8);
Request.Index = Interface;
Request.Length = (UINT16) sizeof (EFI_USB_HID_DESCRIPTOR);
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataIn,
PcdGet32 (PcdUsbTransferTimeoutValue),
HidDescriptor,
sizeof (EFI_USB_HID_DESCRIPTOR),
&Status
);
return Result;
}
/**
Get the report descriptor of the specified USB HID interface.
Submit a USB get HID report descriptor request for the USB device specified by
UsbIo and Interface and return the report descriptor in DescriptorBuffer.
If UsbIo is NULL, then ASSERT().
If DescriptorBuffer is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param DescriptorLength The size, in bytes, of DescriptorBuffer.
@param DescriptorBuffer A pointer to the buffer to store the report class descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specified by DescriptorLength and DescriptorBuffer
is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetReportDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT16 DescriptorLength,
OUT UINT8 *DescriptorBuffer
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
ASSERT (DescriptorBuffer != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_REPORT << 8);
Request.Index = Interface;
Request.Length = DescriptorLength;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataIn,
PcdGet32 (PcdUsbTransferTimeoutValue),
DescriptorBuffer,
DescriptorLength,
&Status
);
return Result;
}
/**
Get the HID protocol of the specified USB HID interface.
Submit a USB get HID protocol request for the USB device specified by UsbIo
and Interface and return the protocol retrieved in Protocol.
If UsbIo is NULL, then ASSERT().
If Protocol is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param Protocol A pointer to the protocol for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetProtocolRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
OUT UINT8 *Protocol
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
ASSERT (Protocol != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_GET_REQ_TYPE;
Request.Request = EFI_USB_GET_PROTOCOL_REQUEST;
Request.Value = 0;
Request.Index = Interface;
Request.Length = 1;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataIn,
PcdGet32 (PcdUsbTransferTimeoutValue),
Protocol,
sizeof (UINT8),
&Status
);
return Result;
}
/**
Set the HID protocol of the specified USB HID interface.
Submit a USB set HID protocol request for the USB device specified by UsbIo
and Interface and set the protocol to the value specified by Protocol.
If UsbIo is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param Protocol The protocol value to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbSetProtocolRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT8 Protocol
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_SET_REQ_TYPE;
Request.Request = EFI_USB_SET_PROTOCOL_REQUEST;
Request.Value = Protocol;
Request.Index = Interface;
Request.Length = 0;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbNoData,
PcdGet32 (PcdUsbTransferTimeoutValue),
NULL,
0,
&Status
);
return Result;
}
/**
Set the idle rate of the specified USB HID report.
Submit a USB set HID report idle request for the USB device specified by UsbIo,
Interface, and ReportId, and set the idle rate to the value specified by Duration.
If UsbIo is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration The idle rate to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbSetIdleRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT8 ReportId,
IN UINT8 Duration
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_SET_REQ_TYPE;
Request.Request = EFI_USB_SET_IDLE_REQUEST;
Request.Value = (UINT16) ((Duration << 8) | ReportId);
Request.Index = Interface;
Request.Length = 0;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbNoData,
PcdGet32 (PcdUsbTransferTimeoutValue),
NULL,
0,
&Status
);
return Result;
}
/**
Get the idle rate of the specified USB HID report.
Submit a USB get HID report idle request for the USB device specified by UsbIo,
Interface, and ReportId, and return the ide rate in Duration.
If UsbIo is NULL, then ASSERT().
If Duration is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration A pointer to the idle rate retrieved from the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetIdleRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT8 ReportId,
OUT UINT8 *Duration
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
ASSERT (Duration != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_GET_REQ_TYPE;
Request.Request = EFI_USB_GET_IDLE_REQUEST;
Request.Value = ReportId;
Request.Index = Interface;
Request.Length = 1;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataIn,
PcdGet32 (PcdUsbTransferTimeoutValue),
Duration,
1,
&Status
);
return Result;
}
/**
Set the report descriptor of the specified USB HID interface.
Submit a USB set HID report request for the USB device specified by UsbIo,
Interface, ReportId, and ReportType, and set the report descriptor using the
buffer specified by ReportLength and Report.
If UsbIo is NULL, then ASSERT().
If Report is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param ReportType The type of report to retrieve.
@param ReportLength The size, in bytes, of Report.
@param Report A pointer to the report descriptor buffer to set.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbSetReportRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT8 ReportId,
IN UINT8 ReportType,
IN UINT16 ReportLen,
IN UINT8 *Report
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
ASSERT (Report != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_SET_REQ_TYPE;
Request.Request = EFI_USB_SET_REPORT_REQUEST;
Request.Value = (UINT16) ((ReportType << 8) | ReportId);
Request.Index = Interface;
Request.Length = ReportLen;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataOut,
PcdGet32 (PcdUsbTransferTimeoutValue),
Report,
ReportLen,
&Status
);
return Result;
}
/**
Get the report descriptor of the specified USB HID interface.
Submit a USB get HID report request for the USB device specified by UsbIo,
Interface, ReportId, and ReportType, and return the report in the buffer
specified by Report.
If UsbIo is NULL, then ASSERT().
If Report is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param ReportType The type of report to retrieve.
@param ReportLength The size, in bytes, of Report.
@param Report A pointer to the buffer to store the report descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specified by ReportLength and Report is not
large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/
EFI_STATUS
EFIAPI
UsbGetReportRequest (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Interface,
IN UINT8 ReportId,
IN UINT8 ReportType,
IN UINT16 ReportLen,
OUT UINT8 *Report
)
{
UINT32 Status;
EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request;
ASSERT (UsbIo != NULL);
ASSERT (Report != NULL);
//
// Fill Device request packet
//
Request.RequestType = USB_HID_CLASS_GET_REQ_TYPE;
Request.Request = EFI_USB_GET_REPORT_REQUEST;
Request.Value = (UINT16) ((ReportType << 8) | ReportId);
Request.Index = Interface;
Request.Length = ReportLen;
Result = UsbIo->UsbControlTransfer (
UsbIo,
&Request,
EfiUsbDataIn,
PcdGet32 (PcdUsbTransferTimeoutValue),
Report,
ReportLen,
&Status
);
return Result;
}
|
