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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
/** @file
Provides most USB APIs to support the Hid requests defined in USB Hid 1.1 spec
and the standard requests defined in USB 1.1 spec.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __USB_DXE_LIB_H__
#define __USB_DXE_LIB_H__
#include <Protocol/UsbIo.h>
/**
Get the descriptor of the specified USB HID interface.
Submit a UsbGetHidDescriptor() 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 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
);
/**
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
);
/**
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
);
/**
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
);
/**
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
);
/**
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
);
/**
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
);
/**
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
);
/**
Get the descriptor of the specified USB device.
Submit a USB get descriptor request for the USB device specified by UsbIo, Value,
and Index, and return the descriptor in the buffer specified by Descriptor.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Descriptor is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Value The device request value.
@param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to get.
@param Status A pointer to the status of the transfer.
@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 Descriptor
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. The transfer
status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Value,
IN UINT16 Index,
IN UINT16 DescriptorLength,
OUT VOID *Descriptor,
OUT UINT32 *Status
);
/**
Set the descriptor of the specified USB device.
Submit a USB set descriptor request for the USB device specified by UsbIo,
Value, and Index, and set the descriptor using the buffer specified by DesriptorLength
and Descriptor. The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Descriptor is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Value The device request value.
@param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to set.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Value,
IN UINT16 Index,
IN UINT16 DescriptorLength,
IN VOID *Descriptor,
OUT UINT32 *Status
);
/**
Get the interface setting of the specified USB device.
Submit a USB get interface request for the USB device specified by UsbIo,
and Interface, and place the result in the buffer specified by AlternateSetting.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If AlternateSetting is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The interface index value.
@param AlternateSetting A pointer to the alternate setting to be retrieved.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Interface,
OUT UINT16 *AlternateSetting,
OUT UINT32 *Status
);
/**
Set the interface setting of the specified USB device.
Submit a USB set interface request for the USB device specified by UsbIo, and
Interface, and set the alternate setting to the value specified by AlternateSetting.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface The interface index value.
@param AlternateSetting The alternate setting to be set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_SUCCESS The request failed due to a device error.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Interface,
IN UINT16 AlternateSetting,
OUT UINT32 *Status
);
/**
Get the device configuration.
Submit a USB get configuration request for the USB device specified by UsbIo
and place the result in the buffer specified by ConfigurationValue. The status
of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If ConfigurationValue is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param ConfigurationValue A pointer to the device configuration to be retrieved.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo,
OUT UINT16 *ConfigurationValue,
OUT UINT32 *Status
);
/**
Set the device configuration.
Submit a USB set configuration request for the USB device specified by UsbIo
and set the device configuration to the value specified by ConfigurationValue.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param ConfigurationValue The device configuration value to be set.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 ConfigurationValue,
OUT UINT32 *Status
);
/**
Set the specified feature of the specified device.
Submit a USB set device feature request for the USB device specified by UsbIo,
Recipient, and Target to the value specified by Value. The status of the
transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
Type USB_TYPES_DEFINITION is defined in the MDE Package Industry
Standard include file Usb.h.
@param Value The value of the feature to be set.
@param Target The index of the device to be set.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbSetFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value,
IN UINT16 Target,
OUT UINT32 *Status
);
/**
Clear the specified feature of the specified device.
Submit a USB clear device feature request for the USB device specified by UsbIo,
Recipient, and Target to the value specified by Value. The status of the transfer
is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Value The value of the feature to be cleared.
@param Target The index of the device to be cleared.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbClearFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value,
IN UINT16 Target,
OUT UINT32 *Status
);
/**
Get the status of the specified device.
Submit a USB device get status request for the USB device specified by UsbIo,
Recipient, and Target, and place the result in the buffer specified by DeviceStatus.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If DeviceStatus is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Target The index of the device to be get the status of.
@param DeviceStatus A pointer to the device status to be retrieved.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
**/
EFI_STATUS
EFIAPI
UsbGetStatus (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Target,
OUT UINT16 *DeviceStatus,
OUT UINT32 *Status
);
/**
Clear halt feature of the specified usb endpoint.
Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.
If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.
If the endpoint descriptor is found, then clear the halt feature of this USB endpoint.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Endpoint The endpoint address.
@param Status A pointer to the status of the transfer.
@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.
The transfer status is returned in Status.
@retval EFI_NOT_FOUND The specified USB endpoint descriptor can not be found
**/
EFI_STATUS
EFIAPI
UsbClearEndpointHalt (
IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 Endpoint,
OUT UINT32 *Status
);
#endif
|
