]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec\r | |
3 | and the standard requests defined in Usb 1.1 spec.\r | |
4 | \r | |
5 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r | |
6 | All rights reserved. This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | \r | |
17 | #ifndef __USB_DXE_LIB_H__\r | |
18 | #define __USB_DXE_LIB_H__\r | |
19 | \r | |
20 | #include <Protocol/UsbIo.h>\r | |
21 | #include <IndustryStandard/Usb.h>\r | |
22 | \r | |
23 | ///\r | |
24 | /// define the timeout time as 3ms\r | |
25 | ///\r | |
26 | #define TIMEOUT_VALUE 3 * 1000\r | |
27 | \r | |
28 | /**\r | |
29 | Get the descriptor of the specified USB HID interface.\r | |
30 | \r | |
31 | Submit a USB get HID descriptor request for the USB device specified by UsbIo\r | |
32 | and Interface and return the HID descriptor in HidDescriptor.\r | |
33 | If UsbIo is NULL, then ASSERT().\r | |
34 | If HidDescriptor is NULL, then ASSERT().\r | |
35 | \r | |
36 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
37 | @param Interface The index of the HID interface on the USB target.\r | |
38 | @param HidDescriptor Pointer to the USB HID descriptor that was retrieved from\r | |
39 | the specified USB target and interface. Type EFI_USB_HID_DESCRIPTOR\r | |
40 | is defined in the MDE Package Industry Standard include file Usb.h.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The request executed successfully.\r | |
43 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
44 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
45 | \r | |
46 | **/\r | |
47 | EFI_STATUS\r | |
48 | EFIAPI\r | |
49 | UsbGetHidDescriptor (\r | |
50 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
51 | IN UINT8 Interface,\r | |
52 | OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor\r | |
53 | );\r | |
54 | \r | |
55 | \r | |
56 | /**\r | |
57 | Get the report descriptor of the specified USB HID interface.\r | |
58 | \r | |
59 | Submit a USB get HID report descriptor request for the USB device specified by\r | |
60 | UsbIo and Interface and return the report descriptor in DescriptorBuffer.\r | |
61 | If UsbIo is NULL, then ASSERT().\r | |
62 | If DescriptorBuffer is NULL, then ASSERT().\r | |
63 | \r | |
64 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
65 | @param Interface The index of the report interface on the USB target.\r | |
66 | @param DescriptorLength The size, in bytes, of DescriptorBuffer.\r | |
67 | @param DescriptorBuffer A pointer to the buffer to store the report class descriptor.\r | |
68 | \r | |
69 | @retval EFI_SUCCESS The request executed successfully.\r | |
70 | @retval EFI_OUT_OF_RESOURCES The request could not be completed because the\r | |
71 | buffer specified by DescriptorLength and DescriptorBuffer\r | |
72 | is not large enough to hold the result of the request.\r | |
73 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
74 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
75 | \r | |
76 | **/\r | |
77 | EFI_STATUS\r | |
78 | EFIAPI\r | |
79 | UsbGetReportDescriptor (\r | |
80 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
81 | IN UINT8 Interface,\r | |
82 | IN UINT16 DescriptorLength,\r | |
83 | OUT UINT8 *DescriptorBuffer\r | |
84 | );\r | |
85 | \r | |
86 | /**\r | |
87 | Get the HID protocol of the specified USB HID interface.\r | |
88 | \r | |
89 | Submit a USB get HID protocol request for the USB device specified by UsbIo\r | |
90 | and Interface and return the protocol retrieved in Protocol.\r | |
91 | If UsbIo is NULL, then ASSERT().\r | |
92 | If Protocol is NULL, then ASSERT().\r | |
93 | \r | |
94 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
95 | @param Interface The index of the report interface on the USB target.\r | |
96 | @param Protocol A pointer to the protocol for the specified USB target.\r | |
97 | \r | |
98 | @retval EFI_SUCCESS The request executed successfully.\r | |
99 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
100 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
101 | \r | |
102 | **/\r | |
103 | EFI_STATUS\r | |
104 | EFIAPI\r | |
105 | UsbGetProtocolRequest (\r | |
106 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
107 | IN UINT8 Interface,\r | |
108 | OUT UINT8 *Protocol\r | |
109 | );\r | |
110 | \r | |
111 | /**\r | |
112 | Set the HID protocol of the specified USB HID interface.\r | |
113 | \r | |
114 | Submit a USB set HID protocol request for the USB device specified by UsbIo\r | |
115 | and Interface and set the protocol to the value specified by Protocol.\r | |
116 | If UsbIo is NULL, then ASSERT().\r | |
117 | \r | |
118 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
119 | @param Interface The index of the report interface on the USB target.\r | |
120 | @param Protocol The protocol value to set for the specified USB target.\r | |
121 | \r | |
122 | @retval EFI_SUCCESS The request executed successfully.\r | |
123 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
124 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
125 | \r | |
126 | **/\r | |
127 | EFI_STATUS\r | |
128 | EFIAPI\r | |
129 | UsbSetProtocolRequest (\r | |
130 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
131 | IN UINT8 Interface,\r | |
132 | IN UINT8 Protocol\r | |
133 | );\r | |
134 | \r | |
135 | /**\r | |
136 | Set the idle rate of the specified USB HID report.\r | |
137 | \r | |
138 | Submit a USB set HID report idle request for the USB device specified by UsbIo,\r | |
139 | Interface, and ReportId, and set the idle rate to the value specified by Duration.\r | |
140 | If UsbIo is NULL, then ASSERT().\r | |
141 | \r | |
142 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
143 | @param Interface The index of the report interface on the USB target.\r | |
144 | @param ReportId The identifier of the report to retrieve.\r | |
145 | @param Duration The idle rate to set for the specified USB target.\r | |
146 | \r | |
147 | @retval EFI_SUCCESS The request executed successfully.\r | |
148 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
149 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
150 | \r | |
151 | **/\r | |
152 | EFI_STATUS\r | |
153 | EFIAPI\r | |
154 | UsbSetIdleRequest (\r | |
155 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
156 | IN UINT8 Interface,\r | |
157 | IN UINT8 ReportId,\r | |
158 | IN UINT8 Duration\r | |
159 | );\r | |
160 | \r | |
161 | /**\r | |
162 | Get the idle rate of the specified USB HID report.\r | |
163 | \r | |
164 | Submit a USB get HID report idle request for the USB device specified by UsbIo,\r | |
165 | Interface, and ReportId, and return the ide rate in Duration.\r | |
166 | If UsbIo is NULL, then ASSERT().\r | |
167 | If Duration is NULL, then ASSERT().\r | |
168 | \r | |
169 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
170 | @param Interface The index of the report interface on the USB target.\r | |
171 | @param ReportId The identifier of the report to retrieve.\r | |
172 | @param Duration A pointer to the idle rate retrieved from the specified USB target.\r | |
173 | \r | |
174 | @retval EFI_SUCCESS The request executed successfully.\r | |
175 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
176 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
177 | \r | |
178 | **/\r | |
179 | EFI_STATUS\r | |
180 | EFIAPI\r | |
181 | UsbGetIdleRequest (\r | |
182 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
183 | IN UINT8 Interface,\r | |
184 | IN UINT8 ReportId,\r | |
185 | OUT UINT8 *Duration\r | |
186 | );\r | |
187 | \r | |
188 | /**\r | |
189 | Set the report descriptor of the specified USB HID interface.\r | |
190 | \r | |
191 | Submit a USB set HID report request for the USB device specified by UsbIo,\r | |
192 | Interface, ReportId, and ReportType, and set the report descriptor using the\r | |
193 | buffer specified by ReportLength and Report.\r | |
194 | If UsbIo is NULL, then ASSERT().\r | |
195 | If Report is NULL, then ASSERT().\r | |
196 | \r | |
197 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
198 | @param Interface The index of the report interface on the USB target.\r | |
199 | @param ReportId The identifier of the report to retrieve.\r | |
200 | @param ReportType The type of report to retrieve.\r | |
201 | @param ReportLength The size, in bytes, of Report.\r | |
202 | @param Report A pointer to the report descriptor buffer to set.\r | |
203 | \r | |
204 | @retval EFI_SUCCESS The request executed successfully.\r | |
205 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
206 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
207 | \r | |
208 | **/\r | |
209 | EFI_STATUS\r | |
210 | EFIAPI\r | |
211 | UsbSetReportRequest (\r | |
212 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
213 | IN UINT8 Interface,\r | |
214 | IN UINT8 ReportId,\r | |
215 | IN UINT8 ReportType,\r | |
216 | IN UINT16 ReportLen,\r | |
217 | IN UINT8 *Report\r | |
218 | );\r | |
219 | \r | |
220 | /**\r | |
221 | Get the report descriptor of the specified USB HID interface.\r | |
222 | \r | |
223 | Submit a USB get HID report request for the USB device specified by UsbIo,\r | |
224 | Interface, ReportId, and ReportType, and return the report in the buffer\r | |
225 | specified by Report.\r | |
226 | If UsbIo is NULL, then ASSERT().\r | |
227 | If Report is NULL, then ASSERT().\r | |
228 | \r | |
229 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
230 | @param Interface The index of the report interface on the USB target.\r | |
231 | @param ReportId The identifier of the report to retrieve.\r | |
232 | @param ReportType The type of report to retrieve.\r | |
233 | @param ReportLength The size, in bytes, of Report.\r | |
234 | @param Report A pointer to the buffer to store the report descriptor.\r | |
235 | \r | |
236 | @retval EFI_SUCCESS The request executed successfully.\r | |
237 | @retval EFI_OUT_OF_RESOURCES The request could not be completed because the\r | |
238 | buffer specifed by ReportLength and Report is not\r | |
239 | large enough to hold the result of the request.\r | |
240 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
241 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
242 | \r | |
243 | **/\r | |
244 | EFI_STATUS\r | |
245 | EFIAPI\r | |
246 | UsbGetReportRequest (\r | |
247 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
248 | IN UINT8 Interface,\r | |
249 | IN UINT8 ReportId,\r | |
250 | IN UINT8 ReportType,\r | |
251 | IN UINT16 ReportLen,\r | |
252 | OUT UINT8 *Report\r | |
253 | );\r | |
254 | \r | |
255 | /**\r | |
256 | Get the descriptor of the specified USB device.\r | |
257 | \r | |
258 | Submit a USB get descriptor request for the USB device specified by UsbIo, Value,\r | |
259 | and Index, and return the descriptor in the buffer specified by Descriptor.\r | |
260 | The status of the transfer is returned in Status.\r | |
261 | If UsbIo is NULL, then ASSERT().\r | |
262 | If Descriptor is NULL, then ASSERT().\r | |
263 | If Status is NULL, then ASSERT().\r | |
264 | \r | |
265 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
266 | @param Value The device request value.\r | |
267 | @param Index The device request index.\r | |
268 | @param DescriptorLength The size, in bytes, of Descriptor.\r | |
269 | @param Descriptor A pointer to the descriptor buffer to get.\r | |
270 | @param Status A pointer to the status of the transfer.\r | |
271 | \r | |
272 | @retval EFI_SUCCESS The request executed successfully.\r | |
273 | @retval EFI_OUT_OF_RESOURCES The request could not be completed because the\r | |
274 | buffer specifed by DescriptorLength and Descriptor\r | |
275 | is not large enough to hold the result of the request.\r | |
276 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
277 | @retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer\r | |
278 | status is returned in Status.\r | |
279 | \r | |
280 | **/\r | |
281 | EFI_STATUS\r | |
282 | EFIAPI\r | |
283 | UsbGetDescriptor (\r | |
284 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
285 | IN UINT16 Value,\r | |
286 | IN UINT16 Index,\r | |
287 | IN UINT16 DescriptorLength,\r | |
288 | OUT VOID *Descriptor,\r | |
289 | OUT UINT32 *Status\r | |
290 | );\r | |
291 | \r | |
292 | /**\r | |
293 | Set the descriptor of the specified USB device.\r | |
294 | \r | |
295 | Submit a USB set descriptor request for the USB device specified by UsbIo,\r | |
296 | Value, and Index, and set the descriptor using the buffer specified by DesriptorLength\r | |
297 | and Descriptor. The status of the transfer is returned in Status.\r | |
298 | If UsbIo is NULL, then ASSERT().\r | |
299 | If Descriptor is NULL, then ASSERT().\r | |
300 | If Status is NULL, then ASSERT().\r | |
301 | \r | |
302 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
303 | @param Value The device request value.\r | |
304 | @param Index The device request index.\r | |
305 | @param DescriptorLength The size, in bytes, of Descriptor.\r | |
306 | @param Descriptor A pointer to the descriptor buffer to set.\r | |
307 | @param Status A pointer to the status of the transfer.\r | |
308 | \r | |
309 | @retval EFI_SUCCESS The request executed successfully.\r | |
310 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
311 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
312 | The transfer status is returned in Status.\r | |
313 | \r | |
314 | **/\r | |
315 | EFI_STATUS\r | |
316 | EFIAPI\r | |
317 | UsbSetDescriptor (\r | |
318 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
319 | IN UINT16 Value,\r | |
320 | IN UINT16 Index,\r | |
321 | IN UINT16 DescriptorLength,\r | |
322 | IN VOID *Descriptor,\r | |
323 | OUT UINT32 *Status\r | |
324 | );\r | |
325 | \r | |
326 | /**\r | |
327 | Get the interface setting of the specified USB device.\r | |
328 | \r | |
329 | Submit a USB get interface request for the USB device specified by UsbIo,\r | |
330 | and Interface, and place the result in the buffer specified by AlternateSetting.\r | |
331 | The status of the transfer is returned in Status.\r | |
332 | If UsbIo is NULL, then ASSERT().\r | |
333 | If AlternateSetting is NULL, then ASSERT().\r | |
334 | If Status is NULL, then ASSERT().\r | |
335 | \r | |
336 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
337 | @param Interface The interface index value.\r | |
338 | @param AlternateSetting A pointer to the alternate setting to be retrieved.\r | |
339 | @param Status A pointer to the status of the transfer.\r | |
340 | \r | |
341 | @retval EFI_SUCCESS The request executed successfully.\r | |
342 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
343 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
344 | The transfer status is returned in Status.\r | |
345 | \r | |
346 | **/\r | |
347 | EFI_STATUS\r | |
348 | EFIAPI\r | |
349 | UsbGetInterface (\r | |
350 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
351 | IN UINT16 Interface,\r | |
352 | OUT UINT16 *AlternateSetting,\r | |
353 | OUT UINT32 *Status\r | |
354 | );\r | |
355 | \r | |
356 | /**\r | |
357 | Set the interface setting of the specified USB device.\r | |
358 | \r | |
359 | Submit a USB set interface request for the USB device specified by UsbIo, and\r | |
360 | Interface, and set the alternate setting to the value specified by AlternateSetting.\r | |
361 | The status of the transfer is returned in Status.\r | |
362 | If UsbIo is NULL, then ASSERT().\r | |
363 | If Status is NULL, then ASSERT().\r | |
364 | \r | |
365 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
366 | @param Interface The interface index value.\r | |
367 | @param AlternateSetting The alternate setting to be set.\r | |
368 | @param Status A pointer to the status of the transfer.\r | |
369 | \r | |
370 | @retval EFI_SUCCESS The request executed successfully.\r | |
371 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
372 | @retval EFI_SUCCESS The request failed due to a device error.\r | |
373 | The transfer status is returned in Status.\r | |
374 | \r | |
375 | **/\r | |
376 | EFI_STATUS\r | |
377 | EFIAPI\r | |
378 | UsbSetInterface (\r | |
379 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
380 | IN UINT16 Interface,\r | |
381 | IN UINT16 AlternateSetting,\r | |
382 | OUT UINT32 *Status\r | |
383 | );\r | |
384 | \r | |
385 | /**\r | |
386 | Get the device configuration.\r | |
387 | \r | |
388 | Submit a USB get configuration request for the USB device specified by UsbIo\r | |
389 | and place the result in the buffer specified by ConfigurationValue. The status\r | |
390 | of the transfer is returned in Status.\r | |
391 | If UsbIo is NULL, then ASSERT().\r | |
392 | If ConfigurationValue is NULL, then ASSERT().\r | |
393 | If Status is NULL, then ASSERT().\r | |
394 | \r | |
395 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
396 | @param ConfigurationValue A pointer to the device configuration to be retrieved.\r | |
397 | @param Status A pointer to the status of the transfer.\r | |
398 | \r | |
399 | @retval EFI_SUCCESS The request executed successfully.\r | |
400 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
401 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
402 | The transfer status is returned in Status.\r | |
403 | \r | |
404 | **/\r | |
405 | EFI_STATUS\r | |
406 | EFIAPI\r | |
407 | UsbGetConfiguration (\r | |
408 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
409 | OUT UINT16 *ConfigurationValue,\r | |
410 | OUT UINT32 *Status\r | |
411 | );\r | |
412 | \r | |
413 | /**\r | |
414 | Set the device configuration.\r | |
415 | \r | |
416 | Submit a USB set configuration request for the USB device specified by UsbIo\r | |
417 | and set the device configuration to the value specified by ConfigurationValue.\r | |
418 | The status of the transfer is returned in Status.\r | |
419 | If UsbIo is NULL, then ASSERT().\r | |
420 | If Status is NULL, then ASSERT().\r | |
421 | \r | |
422 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
423 | @param ConfigurationValue The device configuration value to be set.\r | |
424 | @param Status A pointer to the status of the transfer.\r | |
425 | \r | |
426 | @retval EFI_SUCCESS The request executed successfully.\r | |
427 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
428 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
429 | The transfer status is returned in Status.\r | |
430 | \r | |
431 | **/\r | |
432 | EFI_STATUS\r | |
433 | EFIAPI\r | |
434 | UsbSetConfiguration (\r | |
435 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
436 | IN UINT16 ConfigurationValue,\r | |
437 | OUT UINT32 *Status\r | |
438 | );\r | |
439 | \r | |
440 | /**\r | |
441 | Set the specified feature of the specified device.\r | |
442 | \r | |
443 | Submit a USB set device feature request for the USB device specified by UsbIo,\r | |
444 | Recipient, and Target to the value specified by Value. The status of the\r | |
445 | transfer is returned in Status.\r | |
446 | If UsbIo is NULL, then ASSERT().\r | |
447 | If Status is NULL, then ASSERT().\r | |
448 | \r | |
449 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
450 | @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).\r | |
451 | Type USB_TYPES_DEFINITION is defined in the MDE Package Industry\r | |
452 | Standard include file Usb.h.\r | |
453 | @param Value The value of the feature to be set.\r | |
454 | @param Target The index of the device to be set.\r | |
455 | @param Status A pointer to the status of the transfer.\r | |
456 | \r | |
457 | @retval EFI_SUCCESS The request executed successfully.\r | |
458 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
459 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
460 | The transfer status is returned in Status.\r | |
461 | \r | |
462 | **/\r | |
463 | EFI_STATUS\r | |
464 | EFIAPI\r | |
465 | UsbSetFeature (\r | |
466 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
467 | IN USB_TYPES_DEFINITION Recipient,\r | |
468 | IN UINT16 Value,\r | |
469 | IN UINT16 Target,\r | |
470 | OUT UINT32 *Status\r | |
471 | );\r | |
472 | \r | |
473 | /**\r | |
474 | Clear the specified feature of the specified device.\r | |
475 | \r | |
476 | Submit a USB clear device feature request for the USB device specified by UsbIo,\r | |
477 | Recipient, and Target to the value specified by Value. The status of the transfer\r | |
478 | is returned in Status.\r | |
479 | If UsbIo is NULL, then ASSERT().\r | |
480 | If Status is NULL, then ASSERT().\r | |
481 | \r | |
482 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
483 | @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).\r | |
484 | Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard\r | |
485 | include file Usb.h.\r | |
486 | @param Value The value of the feature to be cleared.\r | |
487 | @param Target The index of the device to be cleared.\r | |
488 | @param Status A pointer to the status of the transfer.\r | |
489 | \r | |
490 | @retval EFI_SUCCESS The request executed successfully.\r | |
491 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
492 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
493 | The transfer status is returned in Status.\r | |
494 | \r | |
495 | **/\r | |
496 | EFI_STATUS\r | |
497 | EFIAPI\r | |
498 | UsbClearFeature (\r | |
499 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
500 | IN USB_TYPES_DEFINITION Recipient,\r | |
501 | IN UINT16 Value,\r | |
502 | IN UINT16 Target,\r | |
503 | OUT UINT32 *Status\r | |
504 | );\r | |
505 | \r | |
506 | /**\r | |
507 | Get the status of the specified device.\r | |
508 | \r | |
509 | Submit a USB device get status request for the USB device specified by UsbIo,\r | |
510 | Recipient, and Target and place the result in the buffer specified by DeviceStatus.\r | |
511 | The status of the transfer is returned in Status.\r | |
512 | If UsbIo is NULL, then ASSERT().\r | |
513 | If DeviceStatus is NULL, then ASSERT().\r | |
514 | If Status is NULL, then ASSERT().\r | |
515 | \r | |
516 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
517 | @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).\r | |
518 | Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard\r | |
519 | include file Usb.h.\r | |
520 | @param Target The index of the device to be get the status of.\r | |
521 | @param DeviceStatus A pointer to the device status to be retrieved.\r | |
522 | @param Status A pointer to the status of the transfer.\r | |
523 | \r | |
524 | @retval EFI_SUCCESS The request executed successfully.\r | |
525 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
526 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
527 | The transfer status is returned in Status.\r | |
528 | \r | |
529 | **/\r | |
530 | EFI_STATUS\r | |
531 | EFIAPI\r | |
532 | UsbGetStatus (\r | |
533 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
534 | IN USB_TYPES_DEFINITION Recipient,\r | |
535 | IN UINT16 Target,\r | |
536 | OUT UINT16 *DeviceStatus,\r | |
537 | OUT UINT32 *Status\r | |
538 | );\r | |
539 | \r | |
540 | /**\r | |
541 | Clear halt feature of the specified usb endpoint.\r | |
542 | \r | |
543 | Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.\r | |
544 | If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.\r | |
545 | If the endpoint descriptor is found, then clear the halt feature of this USB endpoint.\r | |
546 | The status of the transfer is returned in Status.\r | |
547 | If UsbIo is NULL, then ASSERT().\r | |
548 | If Status is NULL, then ASSERT().\r | |
549 | \r | |
550 | @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.\r | |
551 | @param Endpoint The endpoint address.\r | |
552 | @param Status A pointer to the status of the transfer.\r | |
553 | \r | |
554 | @retval EFI_SUCCESS The request executed successfully.\r | |
555 | @retval EFI_TIMEOUT A timeout occurred executing the request.\r | |
556 | @retval EFI_DEVICE_ERROR The request failed due to a device error.\r | |
557 | The transfer status is returned in Status.\r | |
558 | @retval EFI_NOT_FOUND The specified USB endpoint descriptor can not be found\r | |
559 | \r | |
560 | **/\r | |
561 | EFI_STATUS\r | |
562 | EFIAPI\r | |
563 | UsbClearEndpointHalt (\r | |
564 | IN EFI_USB_IO_PROTOCOL *UsbIo,\r | |
565 | IN UINT8 Endpoint,\r | |
566 | OUT UINT32 *Status\r | |
567 | );\r | |
568 | \r | |
569 | #endif\r |