]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Bus/Usb/UsbMouseAbsolutePointerDxe/UsbMouseAbsolutePointer.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
MdeModulePkg/UsbMouse: Fix few typos
[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseAbsolutePointerDxe / UsbMouseAbsolutePointer.c
... / ...
CommitLineData
1/** @file\r
2 USB Mouse Driver that manages USB mouse and produces Absolute Pointer Protocol.\r
3\r
4Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
5SPDX-License-Identifier: BSD-2-Clause-Patent\r
6\r
7**/\r
8\r
9#include "UsbMouseAbsolutePointer.h"\r
10\r
11EFI_DRIVER_BINDING_PROTOCOL gUsbMouseAbsolutePointerDriverBinding = {\r
12 USBMouseAbsolutePointerDriverBindingSupported,\r
13 USBMouseAbsolutePointerDriverBindingStart,\r
14 USBMouseAbsolutePointerDriverBindingStop,\r
15 0x1,\r
16 NULL,\r
17 NULL\r
18};\r
19\r
20/**\r
21 Entrypoint of USB Mouse Absolute Pointer Driver.\r
22\r
23 This function is the entrypoint of USB Mouse Driver. It installs Driver Binding\r
24 Protocols together with Component Name Protocols.\r
25\r
26 @param ImageHandle The firmware allocated handle for the EFI image.\r
27 @param SystemTable A pointer to the EFI System Table.\r
28\r
29 @retval EFI_SUCCESS The entry point is executed successfully.\r
30\r
31**/\r
32EFI_STATUS\r
33EFIAPI\r
34USBMouseAbsolutePointerDriverBindingEntryPoint (\r
35 IN EFI_HANDLE ImageHandle,\r
36 IN EFI_SYSTEM_TABLE *SystemTable\r
37 )\r
38{\r
39 EFI_STATUS Status;\r
40\r
41 Status = EfiLibInstallDriverBindingComponentName2 (\r
42 ImageHandle,\r
43 SystemTable,\r
44 &gUsbMouseAbsolutePointerDriverBinding,\r
45 ImageHandle,\r
46 &gUsbMouseAbsolutePointerComponentName,\r
47 &gUsbMouseAbsolutePointerComponentName2\r
48 );\r
49 ASSERT_EFI_ERROR (Status);\r
50\r
51 return EFI_SUCCESS;\r
52}\r
53\r
54\r
55/**\r
56 Check whether USB Mouse Absolute Pointer Driver supports this device.\r
57\r
58 @param This The driver binding protocol.\r
59 @param Controller The controller handle to check.\r
60 @param RemainingDevicePath The remaining device path.\r
61\r
62 @retval EFI_SUCCESS The driver supports this controller.\r
63 @retval other This device isn't supported.\r
64\r
65**/\r
66EFI_STATUS\r
67EFIAPI\r
68USBMouseAbsolutePointerDriverBindingSupported (\r
69 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
70 IN EFI_HANDLE Controller,\r
71 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
72 )\r
73{\r
74 EFI_STATUS Status;\r
75 EFI_USB_IO_PROTOCOL *UsbIo;\r
76\r
77 Status = gBS->OpenProtocol (\r
78 Controller,\r
79 &gEfiUsbIoProtocolGuid,\r
80 (VOID **) &UsbIo,\r
81 This->DriverBindingHandle,\r
82 Controller,\r
83 EFI_OPEN_PROTOCOL_BY_DRIVER\r
84 );\r
85 if (EFI_ERROR (Status)) {\r
86 return Status;\r
87 }\r
88\r
89 //\r
90 // Use the USB I/O Protocol interface to check whether Controller is\r
91 // a mouse device that can be managed by this driver.\r
92 //\r
93 Status = EFI_SUCCESS;\r
94 if (!IsUsbMouse (UsbIo)) {\r
95 Status = EFI_UNSUPPORTED;\r
96 }\r
97\r
98 gBS->CloseProtocol (\r
99 Controller,\r
100 &gEfiUsbIoProtocolGuid,\r
101 This->DriverBindingHandle,\r
102 Controller\r
103 );\r
104\r
105 return Status;\r
106}\r
107\r
108\r
109/**\r
110 Starts the mouse device with this driver.\r
111\r
112 This function consumes USB I/O Protocol, initializes USB mouse device,\r
113 installs Absolute Pointer Protocol, and submits Asynchronous Interrupt\r
114 Transfer to manage the USB mouse device.\r
115\r
116 @param This The driver binding instance.\r
117 @param Controller Handle of device to bind driver to.\r
118 @param RemainingDevicePath Optional parameter use to pick a specific child\r
119 device to start.\r
120\r
121 @retval EFI_SUCCESS This driver supports this device.\r
122 @retval EFI_UNSUPPORTED This driver does not support this device.\r
123 @retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.\r
124 @retval EFI_OUT_OF_RESOURCES Can't allocate memory resources.\r
125 @retval EFI_ALREADY_STARTED This driver has been started.\r
126\r
127**/\r
128EFI_STATUS\r
129EFIAPI\r
130USBMouseAbsolutePointerDriverBindingStart (\r
131 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
132 IN EFI_HANDLE Controller,\r
133 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
134 )\r
135{\r
136 EFI_STATUS Status;\r
137 EFI_USB_IO_PROTOCOL *UsbIo;\r
138 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDevice;\r
139 UINT8 EndpointNumber;\r
140 EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
141 UINT8 Index;\r
142 UINT8 EndpointAddr;\r
143 UINT8 PollingInterval;\r
144 UINT8 PacketSize;\r
145 BOOLEAN Found;\r
146 EFI_TPL OldTpl;\r
147\r
148 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
149 //\r
150 // Open USB I/O Protocol\r
151 //\r
152 Status = gBS->OpenProtocol (\r
153 Controller,\r
154 &gEfiUsbIoProtocolGuid,\r
155 (VOID **) &UsbIo,\r
156 This->DriverBindingHandle,\r
157 Controller,\r
158 EFI_OPEN_PROTOCOL_BY_DRIVER\r
159 );\r
160 if (EFI_ERROR (Status)) {\r
161 goto ErrorExit1;\r
162 }\r
163\r
164 UsbMouseAbsolutePointerDevice = AllocateZeroPool (sizeof (USB_MOUSE_ABSOLUTE_POINTER_DEV));\r
165 ASSERT (UsbMouseAbsolutePointerDevice != NULL);\r
166\r
167 UsbMouseAbsolutePointerDevice->UsbIo = UsbIo;\r
168 UsbMouseAbsolutePointerDevice->Signature = USB_MOUSE_ABSOLUTE_POINTER_DEV_SIGNATURE;\r
169\r
170 //\r
171 // Get the Device Path Protocol on Controller's handle\r
172 //\r
173 Status = gBS->OpenProtocol (\r
174 Controller,\r
175 &gEfiDevicePathProtocolGuid,\r
176 (VOID **) &UsbMouseAbsolutePointerDevice->DevicePath,\r
177 This->DriverBindingHandle,\r
178 Controller,\r
179 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
180 );\r
181\r
182 if (EFI_ERROR (Status)) {\r
183 goto ErrorExit;\r
184 }\r
185\r
186 //\r
187 // Report Status Code here since USB mouse will be detected next.\r
188 //\r
189 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
190 EFI_PROGRESS_CODE,\r
191 (EFI_PERIPHERAL_MOUSE | EFI_P_PC_PRESENCE_DETECT),\r
192 UsbMouseAbsolutePointerDevice->DevicePath\r
193 );\r
194\r
195 //\r
196 // Get interface & endpoint descriptor\r
197 //\r
198 UsbIo->UsbGetInterfaceDescriptor (\r
199 UsbIo,\r
200 &UsbMouseAbsolutePointerDevice->InterfaceDescriptor\r
201 );\r
202\r
203 EndpointNumber = UsbMouseAbsolutePointerDevice->InterfaceDescriptor.NumEndpoints;\r
204\r
205 //\r
206 // Traverse endpoints to find interrupt endpoint IN\r
207 //\r
208 Found = FALSE;\r
209 for (Index = 0; Index < EndpointNumber; Index++) {\r
210 UsbIo->UsbGetEndpointDescriptor (\r
211 UsbIo,\r
212 Index,\r
213 &EndpointDescriptor\r
214 );\r
215\r
216 if (((EndpointDescriptor.Attributes & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT) &&\r
217 ((EndpointDescriptor.EndpointAddress & USB_ENDPOINT_DIR_IN) != 0)) {\r
218 //\r
219 // We only care interrupt endpoint here\r
220 //\r
221 CopyMem (&UsbMouseAbsolutePointerDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));\r
222 Found = TRUE;\r
223 break;\r
224 }\r
225 }\r
226\r
227 if (!Found) {\r
228 //\r
229 // Report Status Code to indicate that there is no USB mouse\r
230 //\r
231 REPORT_STATUS_CODE (\r
232 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
233 (EFI_PERIPHERAL_MOUSE | EFI_P_EC_NOT_DETECTED)\r
234 );\r
235 //\r
236 // No interrupt endpoint found, then return unsupported.\r
237 //\r
238 Status = EFI_UNSUPPORTED;\r
239 goto ErrorExit;\r
240 }\r
241\r
242 //\r
243 // Report Status Code here since USB mouse has be detected.\r
244 //\r
245 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
246 EFI_PROGRESS_CODE,\r
247 (EFI_PERIPHERAL_MOUSE | EFI_P_PC_DETECTED),\r
248 UsbMouseAbsolutePointerDevice->DevicePath\r
249 );\r
250\r
251 Status = InitializeUsbMouseDevice (UsbMouseAbsolutePointerDevice);\r
252 if (EFI_ERROR (Status)) {\r
253 //\r
254 // Fail to initialize USB mouse device.\r
255 //\r
256 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
257 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
258 (EFI_PERIPHERAL_MOUSE | EFI_P_EC_INTERFACE_ERROR),\r
259 UsbMouseAbsolutePointerDevice->DevicePath\r
260 );\r
261\r
262 goto ErrorExit;\r
263 }\r
264\r
265 //\r
266 // Initialize and install EFI Absolute Pointer Protocol.\r
267 //\r
268 UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.GetState = GetMouseAbsolutePointerState;\r
269 UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Reset = UsbMouseAbsolutePointerReset;\r
270 UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Mode = &UsbMouseAbsolutePointerDevice->Mode;\r
271\r
272 Status = gBS->CreateEvent (\r
273 EVT_NOTIFY_WAIT,\r
274 TPL_NOTIFY,\r
275 UsbMouseAbsolutePointerWaitForInput,\r
276 UsbMouseAbsolutePointerDevice,\r
277 &((UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol).WaitForInput)\r
278 );\r
279 if (EFI_ERROR (Status)) {\r
280 goto ErrorExit;\r
281 }\r
282\r
283 Status = gBS->InstallProtocolInterface (\r
284 &Controller,\r
285 &gEfiAbsolutePointerProtocolGuid,\r
286 EFI_NATIVE_INTERFACE,\r
287 &UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol\r
288 );\r
289\r
290 if (EFI_ERROR (Status)) {\r
291 goto ErrorExit;\r
292 }\r
293\r
294 //\r
295 // The next step would be submitting Asynchronous Interrupt Transfer on this mouse device.\r
296 // After that we will be able to get key data from it. Thus this is deemed as\r
297 // the enable action of the mouse, so report status code accordingly.\r
298 //\r
299 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
300 EFI_PROGRESS_CODE,\r
301 (EFI_PERIPHERAL_MOUSE | EFI_P_PC_ENABLE),\r
302 UsbMouseAbsolutePointerDevice->DevicePath\r
303 );\r
304\r
305 //\r
306 // Submit Asynchronous Interrupt Transfer to manage this device.\r
307 //\r
308 EndpointAddr = UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.EndpointAddress;\r
309 PollingInterval = UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.Interval;\r
310 PacketSize = (UINT8) (UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.MaxPacketSize);\r
311\r
312 Status = UsbIo->UsbAsyncInterruptTransfer (\r
313 UsbIo,\r
314 EndpointAddr,\r
315 TRUE,\r
316 PollingInterval,\r
317 PacketSize,\r
318 OnMouseInterruptComplete,\r
319 UsbMouseAbsolutePointerDevice\r
320 );\r
321\r
322 if (EFI_ERROR (Status)) {\r
323 //\r
324 // If submit error, uninstall that interface\r
325 //\r
326 gBS->UninstallProtocolInterface (\r
327 Controller,\r
328 &gEfiAbsolutePointerProtocolGuid,\r
329 &UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol\r
330 );\r
331 goto ErrorExit;\r
332 }\r
333\r
334 UsbMouseAbsolutePointerDevice->ControllerNameTable = NULL;\r
335 AddUnicodeString2 (\r
336 "eng",\r
337 gUsbMouseAbsolutePointerComponentName.SupportedLanguages,\r
338 &UsbMouseAbsolutePointerDevice->ControllerNameTable,\r
339 L"Generic Usb Mouse Absolute Pointer",\r
340 TRUE\r
341 );\r
342 AddUnicodeString2 (\r
343 "en",\r
344 gUsbMouseAbsolutePointerComponentName2.SupportedLanguages,\r
345 &UsbMouseAbsolutePointerDevice->ControllerNameTable,\r
346 L"Generic Usb Mouse Absolute Pointer",\r
347 FALSE\r
348 );\r
349\r
350 gBS->RestoreTPL (OldTpl);\r
351 return EFI_SUCCESS;\r
352\r
353//\r
354// Error handler\r
355//\r
356ErrorExit:\r
357 if (EFI_ERROR (Status)) {\r
358 gBS->CloseProtocol (\r
359 Controller,\r
360 &gEfiUsbIoProtocolGuid,\r
361 This->DriverBindingHandle,\r
362 Controller\r
363 );\r
364\r
365 if (UsbMouseAbsolutePointerDevice != NULL) {\r
366 if ((UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol).WaitForInput != NULL) {\r
367 gBS->CloseEvent ((UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol).WaitForInput);\r
368 }\r
369\r
370 FreePool (UsbMouseAbsolutePointerDevice);\r
371 UsbMouseAbsolutePointerDevice = NULL;\r
372 }\r
373 }\r
374\r
375ErrorExit1:\r
376 gBS->RestoreTPL (OldTpl);\r
377\r
378 return Status;\r
379}\r
380\r
381\r
382/**\r
383 Stop the USB mouse device handled by this driver.\r
384\r
385 @param This The driver binding protocol.\r
386 @param Controller The controller to release.\r
387 @param NumberOfChildren The number of handles in ChildHandleBuffer.\r
388 @param ChildHandleBuffer The array of child handle.\r
389\r
390 @retval EFI_SUCCESS The device was stopped.\r
391 @retval EFI_UNSUPPORTED Absolute Pointer Protocol is not installed on Controller.\r
392 @retval Others Fail to uninstall protocols attached on the device.\r
393\r
394**/\r
395EFI_STATUS\r
396EFIAPI\r
397USBMouseAbsolutePointerDriverBindingStop (\r
398 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
399 IN EFI_HANDLE Controller,\r
400 IN UINTN NumberOfChildren,\r
401 IN EFI_HANDLE *ChildHandleBuffer\r
402 )\r
403{\r
404 EFI_STATUS Status;\r
405 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDevice;\r
406 EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointerProtocol;\r
407 EFI_USB_IO_PROTOCOL *UsbIo;\r
408\r
409 Status = gBS->OpenProtocol (\r
410 Controller,\r
411 &gEfiAbsolutePointerProtocolGuid,\r
412 (VOID **) &AbsolutePointerProtocol,\r
413 This->DriverBindingHandle,\r
414 Controller,\r
415 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
416 );\r
417\r
418 if (EFI_ERROR (Status)) {\r
419 return EFI_UNSUPPORTED;\r
420 }\r
421\r
422 UsbMouseAbsolutePointerDevice = USB_MOUSE_ABSOLUTE_POINTER_DEV_FROM_MOUSE_PROTOCOL (AbsolutePointerProtocol);\r
423\r
424 UsbIo = UsbMouseAbsolutePointerDevice->UsbIo;\r
425\r
426 //\r
427 // The key data input from this device will be disabled.\r
428 //\r
429 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
430 EFI_PROGRESS_CODE,\r
431 (EFI_PERIPHERAL_MOUSE | EFI_P_PC_DISABLE),\r
432 UsbMouseAbsolutePointerDevice->DevicePath\r
433 );\r
434\r
435 //\r
436 // Delete the Asynchronous Interrupt Transfer from this device\r
437 //\r
438 UsbIo->UsbAsyncInterruptTransfer (\r
439 UsbIo,\r
440 UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.EndpointAddress,\r
441 FALSE,\r
442 UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.Interval,\r
443 0,\r
444 NULL,\r
445 NULL\r
446 );\r
447\r
448 Status = gBS->UninstallProtocolInterface (\r
449 Controller,\r
450 &gEfiAbsolutePointerProtocolGuid,\r
451 &UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol\r
452 );\r
453 if (EFI_ERROR (Status)) {\r
454 return Status;\r
455 }\r
456\r
457 gBS->CloseProtocol (\r
458 Controller,\r
459 &gEfiUsbIoProtocolGuid,\r
460 This->DriverBindingHandle,\r
461 Controller\r
462 );\r
463\r
464 //\r
465 // Free all resources.\r
466 //\r
467 gBS->CloseEvent (UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.WaitForInput);\r
468\r
469 if (UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent != NULL) {\r
470 gBS->CloseEvent (UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent);\r
471 UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent = NULL;\r
472 }\r
473\r
474 if (UsbMouseAbsolutePointerDevice->ControllerNameTable != NULL) {\r
475 FreeUnicodeStringTable (UsbMouseAbsolutePointerDevice->ControllerNameTable);\r
476 }\r
477\r
478 FreePool (UsbMouseAbsolutePointerDevice);\r
479\r
480 return EFI_SUCCESS;\r
481\r
482}\r
483\r
484\r
485/**\r
486 Uses USB I/O to check whether the device is a USB mouse device.\r
487\r
488 @param UsbIo Pointer to a USB I/O protocol instance.\r
489\r
490 @retval TRUE Device is a USB mouse device.\r
491 @retval FALSE Device is a not USB mouse device.\r
492\r
493**/\r
494BOOLEAN\r
495IsUsbMouse (\r
496 IN EFI_USB_IO_PROTOCOL *UsbIo\r
497 )\r
498{\r
499 EFI_STATUS Status;\r
500 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r
501\r
502 //\r
503 // Get the default interface descriptor\r
504 //\r
505 Status = UsbIo->UsbGetInterfaceDescriptor (\r
506 UsbIo,\r
507 &InterfaceDescriptor\r
508 );\r
509\r
510 if (EFI_ERROR (Status)) {\r
511 return FALSE;\r
512 }\r
513\r
514 if ((InterfaceDescriptor.InterfaceClass == CLASS_HID) &&\r
515 (InterfaceDescriptor.InterfaceSubClass == SUBCLASS_BOOT) &&\r
516 (InterfaceDescriptor.InterfaceProtocol == PROTOCOL_MOUSE)\r
517 ) {\r
518 return TRUE;\r
519 }\r
520\r
521 return FALSE;\r
522}\r
523\r
524\r
525/**\r
526 Initialize the USB mouse device.\r
527\r
528 This function retrieves and parses HID report descriptor, and\r
529 initializes state of USB_MOUSE_ABSOLUTE_POINTER_DEV. Then it sets indefinite idle\r
530 rate for the device. Finally it creates event for delayed recovery,\r
531 which deals with device error.\r
532\r
533 @param UsbMouseAbsolutePointerDev Device instance to be initialized.\r
534\r
535 @retval EFI_SUCCESS USB mouse device successfully initialized.\r
536 @retval EFI_UNSUPPORTED HID descriptor type is not report descriptor.\r
537 @retval Other USB mouse device was not initialized successfully.\r
538\r
539**/\r
540EFI_STATUS\r
541InitializeUsbMouseDevice (\r
542 IN USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDev\r
543 )\r
544{\r
545 EFI_USB_IO_PROTOCOL *UsbIo;\r
546 UINT8 Protocol;\r
547 EFI_STATUS Status;\r
548 EFI_USB_HID_DESCRIPTOR *MouseHidDesc;\r
549 UINT8 *ReportDesc;\r
550 EFI_USB_CONFIG_DESCRIPTOR ConfigDesc;\r
551 VOID *Buf;\r
552 UINT32 TransferResult;\r
553 UINT16 Total;\r
554 USB_DESC_HEAD *Head;\r
555 BOOLEAN Start;\r
556\r
557 UsbIo = UsbMouseAbsolutePointerDev->UsbIo;\r
558\r
559 //\r
560 // Get the current configuration descriptor. Note that it doesn't include other descriptors.\r
561 //\r
562 Status = UsbIo->UsbGetConfigDescriptor (\r
563 UsbIo,\r
564 &ConfigDesc\r
565 );\r
566 if (EFI_ERROR (Status)) {\r
567 return Status;\r
568 }\r
569\r
570 //\r
571 // By issuing Get_Descriptor(Configuration) request with total length, we get the Configuration descriptor,\r
572 // all Interface descriptors, all Endpoint descriptors, and the HID descriptor for each interface.\r
573 //\r
574 Buf = AllocateZeroPool (ConfigDesc.TotalLength);\r
575 if (Buf == NULL) {\r
576 return EFI_OUT_OF_RESOURCES;\r
577 }\r
578\r
579 Status = UsbGetDescriptor (\r
580 UsbIo,\r
581 (UINT16)((USB_DESC_TYPE_CONFIG << 8) | (ConfigDesc.ConfigurationValue - 1)),\r
582 0,\r
583 ConfigDesc.TotalLength,\r
584 Buf,\r
585 &TransferResult\r
586 );\r
587 if (EFI_ERROR (Status)) {\r
588 FreePool (Buf);\r
589 return Status;\r
590 }\r
591\r
592 Total = 0;\r
593 Start = FALSE;\r
594 Head = (USB_DESC_HEAD *)Buf;\r
595 MouseHidDesc = NULL;\r
596\r
597 //\r
598 // Get HID descriptor from the receipt of Get_Descriptor(Configuration) request.\r
599 // This algorithm is based on the fact that the HID descriptor shall be interleaved\r
600 // between the interface and endpoint descriptors for HID interfaces.\r
601 //\r
602 while (Total < ConfigDesc.TotalLength) {\r
603 if (Head->Type == USB_DESC_TYPE_INTERFACE) {\r
604 if ((((USB_INTERFACE_DESCRIPTOR *)Head)->InterfaceNumber == UsbMouseAbsolutePointerDev->InterfaceDescriptor.InterfaceNumber) &&\r
605 (((USB_INTERFACE_DESCRIPTOR *)Head)->AlternateSetting == UsbMouseAbsolutePointerDev->InterfaceDescriptor.AlternateSetting)) {\r
606 Start = TRUE;\r
607 }\r
608 }\r
609 if (Start && (Head->Type == USB_DESC_TYPE_ENDPOINT)) {\r
610 break;\r
611 }\r
612 if (Start && (Head->Type == USB_DESC_TYPE_HID)) {\r
613 MouseHidDesc = (EFI_USB_HID_DESCRIPTOR *)Head;\r
614 break;\r
615 }\r
616 Total = Total + (UINT16)Head->Len;\r
617 Head = (USB_DESC_HEAD*)((UINT8 *)Buf + Total);\r
618 }\r
619\r
620 if (MouseHidDesc == NULL) {\r
621 FreePool (Buf);\r
622 return EFI_UNSUPPORTED;\r
623 }\r
624\r
625 //\r
626 // Get report descriptor\r
627 //\r
628 if (MouseHidDesc->HidClassDesc[0].DescriptorType != USB_DESC_TYPE_REPORT) {\r
629 FreePool (Buf);\r
630 return EFI_UNSUPPORTED;\r
631 }\r
632\r
633 ReportDesc = AllocateZeroPool (MouseHidDesc->HidClassDesc[0].DescriptorLength);\r
634 ASSERT (ReportDesc != NULL);\r
635\r
636 Status = UsbGetReportDescriptor (\r
637 UsbIo,\r
638 UsbMouseAbsolutePointerDev->InterfaceDescriptor.InterfaceNumber,\r
639 MouseHidDesc->HidClassDesc[0].DescriptorLength,\r
640 ReportDesc\r
641 );\r
642\r
643 if (EFI_ERROR (Status)) {\r
644 FreePool (Buf);\r
645 FreePool (ReportDesc);\r
646 return Status;\r
647 }\r
648\r
649 //\r
650 // Parse report descriptor\r
651 //\r
652 Status = ParseMouseReportDescriptor (\r
653 UsbMouseAbsolutePointerDev,\r
654 ReportDesc,\r
655 MouseHidDesc->HidClassDesc[0].DescriptorLength\r
656 );\r
657\r
658 if (EFI_ERROR (Status)) {\r
659 FreePool (Buf);\r
660 FreePool (ReportDesc);\r
661 return Status;\r
662 }\r
663\r
664 UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxX = 1024;\r
665 UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxY = 1024;\r
666 UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxZ = 0;\r
667 UsbMouseAbsolutePointerDev->Mode.AbsoluteMinX = 0;\r
668 UsbMouseAbsolutePointerDev->Mode.AbsoluteMinY = 0;\r
669 UsbMouseAbsolutePointerDev->Mode.AbsoluteMinZ = 0;\r
670 UsbMouseAbsolutePointerDev->Mode.Attributes = 0x3;\r
671\r
672 //\r
673 // Let the cursor's starting position is in the center of the screen.\r
674 //\r
675 UsbMouseAbsolutePointerDev->State.CurrentX =\r
676 DivU64x32 (UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxX + UsbMouseAbsolutePointerDev->Mode.AbsoluteMinX, 2);\r
677 UsbMouseAbsolutePointerDev->State.CurrentY =\r
678 DivU64x32 (UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxY + UsbMouseAbsolutePointerDev->Mode.AbsoluteMinY, 2);\r
679\r
680 //\r
681 // Set boot protocol for the USB mouse.\r
682 // This driver only supports boot protocol.\r
683 //\r
684 UsbGetProtocolRequest (\r
685 UsbIo,\r
686 UsbMouseAbsolutePointerDev->InterfaceDescriptor.InterfaceNumber,\r
687 &Protocol\r
688 );\r
689 if (Protocol != BOOT_PROTOCOL) {\r
690 Status = UsbSetProtocolRequest (\r
691 UsbIo,\r
692 UsbMouseAbsolutePointerDev->InterfaceDescriptor.InterfaceNumber,\r
693 BOOT_PROTOCOL\r
694 );\r
695\r
696 if (EFI_ERROR (Status)) {\r
697 FreePool (Buf);\r
698 FreePool (ReportDesc);\r
699 return Status;\r
700 }\r
701 }\r
702\r
703 FreePool (Buf);\r
704 FreePool (ReportDesc);\r
705\r
706 //\r
707 // Create event for delayed recovery, which deals with device error.\r
708 //\r
709 if (UsbMouseAbsolutePointerDev->DelayedRecoveryEvent != NULL) {\r
710 gBS->CloseEvent (UsbMouseAbsolutePointerDev->DelayedRecoveryEvent);\r
711 UsbMouseAbsolutePointerDev->DelayedRecoveryEvent = 0;\r
712 }\r
713\r
714 gBS->CreateEvent (\r
715 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
716 TPL_NOTIFY,\r
717 USBMouseRecoveryHandler,\r
718 UsbMouseAbsolutePointerDev,\r
719 &UsbMouseAbsolutePointerDev->DelayedRecoveryEvent\r
720 );\r
721\r
722 return EFI_SUCCESS;\r
723}\r
724\r
725\r
726/**\r
727 Handler function for USB mouse's asynchronous interrupt transfer.\r
728\r
729 This function is the handler function for USB mouse's asynchronous interrupt transfer\r
730 to manage the mouse. It parses data returned from asynchronous interrupt transfer, and\r
731 get button and movement state.\r
732\r
733 @param Data A pointer to a buffer that is filled with key data which is\r
734 retrieved via asynchronous interrupt transfer.\r
735 @param DataLength Indicates the size of the data buffer.\r
736 @param Context Pointing to USB_KB_DEV instance.\r
737 @param Result Indicates the result of the asynchronous interrupt transfer.\r
738\r
739 @retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.\r
740 @retval EFI_DEVICE_ERROR Hardware error occurs.\r
741\r
742**/\r
743EFI_STATUS\r
744EFIAPI\r
745OnMouseInterruptComplete (\r
746 IN VOID *Data,\r
747 IN UINTN DataLength,\r
748 IN VOID *Context,\r
749 IN UINT32 Result\r
750 )\r
751{\r
752 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDevice;\r
753 EFI_USB_IO_PROTOCOL *UsbIo;\r
754 UINT8 EndpointAddr;\r
755 UINT32 UsbResult;\r
756\r
757 UsbMouseAbsolutePointerDevice = (USB_MOUSE_ABSOLUTE_POINTER_DEV *) Context;\r
758 UsbIo = UsbMouseAbsolutePointerDevice->UsbIo;\r
759\r
760 if (Result != EFI_USB_NOERROR) {\r
761 //\r
762 // Some errors happen during the process\r
763 //\r
764 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
765 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
766 (EFI_PERIPHERAL_MOUSE | EFI_P_EC_INPUT_ERROR),\r
767 UsbMouseAbsolutePointerDevice->DevicePath\r
768 );\r
769\r
770 if ((Result & EFI_USB_ERR_STALL) == EFI_USB_ERR_STALL) {\r
771 EndpointAddr = UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.EndpointAddress;\r
772\r
773 UsbClearEndpointHalt (\r
774 UsbIo,\r
775 EndpointAddr,\r
776 &UsbResult\r
777 );\r
778 }\r
779\r
780 //\r
781 // Delete & Submit this interrupt again\r
782 // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.\r
783 //\r
784 UsbIo->UsbAsyncInterruptTransfer (\r
785 UsbIo,\r
786 UsbMouseAbsolutePointerDevice->IntEndpointDescriptor.EndpointAddress,\r
787 FALSE,\r
788 0,\r
789 0,\r
790 NULL,\r
791 NULL\r
792 );\r
793 //\r
794 // EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.\r
795 //\r
796 gBS->SetTimer (\r
797 UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent,\r
798 TimerRelative,\r
799 EFI_USB_INTERRUPT_DELAY\r
800 );\r
801 return EFI_DEVICE_ERROR;\r
802 }\r
803\r
804 //\r
805 // If no error and no data, just return EFI_SUCCESS.\r
806 //\r
807 if (DataLength == 0 || Data == NULL) {\r
808 return EFI_SUCCESS;\r
809 }\r
810\r
811 //\r
812 // Check mouse Data\r
813 // USB HID Specification specifies following data format:\r
814 // Byte Bits Description\r
815 // 0 0 Button 1\r
816 // 1 Button 2\r
817 // 2 Button 3\r
818 // 4 to 7 Device-specific\r
819 // 1 0 to 7 X displacement\r
820 // 2 0 to 7 Y displacement\r
821 // 3 to n 0 to 7 Device specific (optional)\r
822 //\r
823 if (DataLength < 3) {\r
824 return EFI_DEVICE_ERROR;\r
825 }\r
826\r
827 UsbMouseAbsolutePointerDevice->StateChanged = TRUE;\r
828\r
829 UsbMouseAbsolutePointerDevice->State.ActiveButtons = *(UINT8 *) Data & (BIT0 | BIT1 | BIT2);\r
830\r
831 UsbMouseAbsolutePointerDevice->State.CurrentX =\r
832 MIN (\r
833 MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentX + *((INT8 *) Data + 1),\r
834 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinX),\r
835 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxX\r
836 );\r
837 UsbMouseAbsolutePointerDevice->State.CurrentY =\r
838 MIN (\r
839 MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentY + *((INT8 *) Data + 2),\r
840 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinY),\r
841 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxY\r
842 );\r
843 if (DataLength > 3) {\r
844 UsbMouseAbsolutePointerDevice->State.CurrentZ =\r
845 MIN (\r
846 MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentZ + *((INT8 *) Data + 1),\r
847 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinZ),\r
848 (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxZ\r
849 );\r
850 }\r
851\r
852 return EFI_SUCCESS;\r
853}\r
854\r
855/**\r
856 Retrieves the current state of a pointer device.\r
857\r
858 @param This A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.\r
859 @param MouseState A pointer to the state information on the pointer device.\r
860\r
861 @retval EFI_SUCCESS The state of the pointer device was returned in State.\r
862 @retval EFI_NOT_READY The state of the pointer device has not changed since the last call to\r
863 GetState().\r
864 @retval EFI_DEVICE_ERROR A device error occurred while attempting to retrieve the pointer device's\r
865 current state.\r
866 @retval EFI_INVALID_PARAMETER State is NULL.\r
867\r
868**/\r
869EFI_STATUS\r
870EFIAPI\r
871GetMouseAbsolutePointerState (\r
872 IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
873 OUT EFI_ABSOLUTE_POINTER_STATE *State\r
874 )\r
875{\r
876 USB_MOUSE_ABSOLUTE_POINTER_DEV *MouseAbsolutePointerDev;\r
877\r
878 if (State == NULL) {\r
879 return EFI_INVALID_PARAMETER;\r
880 }\r
881\r
882 MouseAbsolutePointerDev = USB_MOUSE_ABSOLUTE_POINTER_DEV_FROM_MOUSE_PROTOCOL (This);\r
883\r
884 if (!MouseAbsolutePointerDev->StateChanged) {\r
885 return EFI_NOT_READY;\r
886 }\r
887\r
888 //\r
889 // Retrieve mouse state from USB_MOUSE_ABSOLUTE_POINTER_DEV,\r
890 // which was filled by OnMouseInterruptComplete()\r
891 //\r
892 CopyMem (\r
893 State,\r
894 &MouseAbsolutePointerDev->State,\r
895 sizeof (EFI_ABSOLUTE_POINTER_STATE)\r
896 );\r
897\r
898 MouseAbsolutePointerDev->StateChanged = FALSE;\r
899\r
900 return EFI_SUCCESS;\r
901}\r
902\r
903\r
904/**\r
905 Resets the pointer device hardware.\r
906\r
907 @param This A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.\r
908 @param ExtendedVerification Indicates that the driver may perform a more exhaustive\r
909 verification operation of the device during reset.\r
910\r
911 @retval EFI_SUCCESS The device was reset.\r
912 @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset.\r
913\r
914**/\r
915EFI_STATUS\r
916EFIAPI\r
917UsbMouseAbsolutePointerReset (\r
918 IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
919 IN BOOLEAN ExtendedVerification\r
920 )\r
921{\r
922 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDevice;\r
923\r
924 UsbMouseAbsolutePointerDevice = USB_MOUSE_ABSOLUTE_POINTER_DEV_FROM_MOUSE_PROTOCOL (This);\r
925\r
926 REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
927 EFI_PROGRESS_CODE,\r
928 (EFI_PERIPHERAL_MOUSE | EFI_P_PC_RESET),\r
929 UsbMouseAbsolutePointerDevice->DevicePath\r
930 );\r
931\r
932 //\r
933 // Clear mouse state.\r
934 //\r
935 ZeroMem (\r
936 &UsbMouseAbsolutePointerDevice->State,\r
937 sizeof (EFI_ABSOLUTE_POINTER_STATE)\r
938 );\r
939\r
940 //\r
941 // Let the cursor's starting position is in the center of the screen.\r
942 //\r
943 UsbMouseAbsolutePointerDevice->State.CurrentX =\r
944 DivU64x32 (UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxX + UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinX, 2);\r
945 UsbMouseAbsolutePointerDevice->State.CurrentY =\r
946 DivU64x32 (UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxY + UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinY, 2);\r
947\r
948 UsbMouseAbsolutePointerDevice->StateChanged = FALSE;\r
949\r
950 return EFI_SUCCESS;\r
951}\r
952\r
953/**\r
954 Event notification function for EFI_ABSOLUTE_POINTER_PROTOCOL.WaitForInput event.\r
955\r
956 @param Event Event to be signaled when there's input from mouse.\r
957 @param Context Points to USB_MOUSE_ABSOLUTE_POINTER_DEV instance.\r
958\r
959**/\r
960VOID\r
961EFIAPI\r
962UsbMouseAbsolutePointerWaitForInput (\r
963 IN EFI_EVENT Event,\r
964 IN VOID *Context\r
965 )\r
966{\r
967 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDev;\r
968\r
969 UsbMouseAbsolutePointerDev = (USB_MOUSE_ABSOLUTE_POINTER_DEV *) Context;\r
970\r
971 //\r
972 // If there's input from mouse, signal the event.\r
973 //\r
974 if (UsbMouseAbsolutePointerDev->StateChanged) {\r
975 gBS->SignalEvent (Event);\r
976 }\r
977}\r
978\r
979/**\r
980 Handler for Delayed Recovery event.\r
981\r
982 This function is the handler for Delayed Recovery event triggered\r
983 by timer.\r
984 After a device error occurs, the event would be triggered\r
985 with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY\r
986 is defined in USB standard for error handling.\r
987\r
988 @param Event The Delayed Recovery event.\r
989 @param Context Points to the USB_MOUSE_ABSOLUTE_POINTER_DEV instance.\r
990\r
991**/\r
992VOID\r
993EFIAPI\r
994USBMouseRecoveryHandler (\r
995 IN EFI_EVENT Event,\r
996 IN VOID *Context\r
997 )\r
998{\r
999 USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointerDev;\r
1000 EFI_USB_IO_PROTOCOL *UsbIo;\r
1001\r
1002 UsbMouseAbsolutePointerDev = (USB_MOUSE_ABSOLUTE_POINTER_DEV *) Context;\r
1003\r
1004 UsbIo = UsbMouseAbsolutePointerDev->UsbIo;\r
1005\r
1006 //\r
1007 // Re-submit Asynchronous Interrupt Transfer for recovery.\r
1008 //\r
1009 UsbIo->UsbAsyncInterruptTransfer (\r
1010 UsbIo,\r
1011 UsbMouseAbsolutePointerDev->IntEndpointDescriptor.EndpointAddress,\r
1012 TRUE,\r
1013 UsbMouseAbsolutePointerDev->IntEndpointDescriptor.Interval,\r
1014 UsbMouseAbsolutePointerDev->IntEndpointDescriptor.MaxPacketSize,\r
1015 OnMouseInterruptComplete,\r
1016 UsbMouseAbsolutePointerDev\r
1017 );\r
1018}\r
EFI Development Kit II mirror for PVE