]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Bus/Usb/UsbMouseAbsolutePointerDxe/UsbMouseAbsolutePointer.c
MdeModulePkg/UsbMouse: Fix few typos
[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseAbsolutePointerDxe / UsbMouseAbsolutePointer.c
index 3540cd4a0fcec7a5881b4ba77d04180da5e2e936..926e03f9cb920617637c9f874e0427052b13ba00 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
   USB Mouse Driver that manages USB mouse and produces Absolute Pointer Protocol.\r
 \r
-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -91,7 +85,7 @@ USBMouseAbsolutePointerDriverBindingSupported (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  \r
+\r
   //\r
   // Use the USB I/O Protocol interface to check whether Controller is\r
   // a mouse device that can be managed by this driver.\r
@@ -100,14 +94,14 @@ USBMouseAbsolutePointerDriverBindingSupported (
   if (!IsUsbMouse (UsbIo)) {\r
     Status = EFI_UNSUPPORTED;\r
   }\r
-  \r
+\r
   gBS->CloseProtocol (\r
         Controller,\r
         &gEfiUsbIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
-        \r
+\r
   return Status;\r
 }\r
 \r
@@ -115,7 +109,7 @@ USBMouseAbsolutePointerDriverBindingSupported (
 /**\r
   Starts the mouse device with this driver.\r
 \r
-  This function consumes USB I/O Portocol, intializes USB mouse device,\r
+  This function consumes USB I/O Protocol, initializes USB mouse device,\r
   installs Absolute Pointer Protocol, and submits Asynchronous Interrupt\r
   Transfer to manage the USB mouse device.\r
 \r
@@ -161,12 +155,12 @@ USBMouseAbsolutePointerDriverBindingStart (
                   (VOID **) &UsbIo,\r
                   This->DriverBindingHandle,\r
                   Controller,\r
-                  EFI_OPEN_PROTOCOL_BY_DRIVER                  \r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                   );\r
   if (EFI_ERROR (Status)) {\r
     goto ErrorExit1;\r
   }\r
-  \r
+\r
   UsbMouseAbsolutePointerDevice = AllocateZeroPool (sizeof (USB_MOUSE_ABSOLUTE_POINTER_DEV));\r
   ASSERT (UsbMouseAbsolutePointerDevice != NULL);\r
 \r
@@ -188,6 +182,16 @@ USBMouseAbsolutePointerDriverBindingStart (
   if (EFI_ERROR (Status)) {\r
     goto ErrorExit;\r
   }\r
+\r
+  //\r
+  // Report Status Code here since USB mouse will be detected next.\r
+  //\r
+  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
+    EFI_PROGRESS_CODE,\r
+    (EFI_PERIPHERAL_MOUSE | EFI_P_PC_PRESENCE_DETECT),\r
+    UsbMouseAbsolutePointerDevice->DevicePath\r
+    );\r
+\r
   //\r
   // Get interface & endpoint descriptor\r
   //\r
@@ -199,7 +203,7 @@ USBMouseAbsolutePointerDriverBindingStart (
   EndpointNumber = UsbMouseAbsolutePointerDevice->InterfaceDescriptor.NumEndpoints;\r
 \r
   //\r
-  // Traverse endpoints to find interrupt endpoint\r
+  // Traverse endpoints to find interrupt endpoint IN\r
   //\r
   Found = FALSE;\r
   for (Index = 0; Index < EndpointNumber; Index++) {\r
@@ -209,7 +213,8 @@ USBMouseAbsolutePointerDriverBindingStart (
              &EndpointDescriptor\r
              );\r
 \r
-    if ((EndpointDescriptor.Attributes & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT) {\r
+    if (((EndpointDescriptor.Attributes & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT) &&\r
+        ((EndpointDescriptor.EndpointAddress & USB_ENDPOINT_DIR_IN) != 0)) {\r
       //\r
       // We only care interrupt endpoint here\r
       //\r
@@ -221,12 +226,28 @@ USBMouseAbsolutePointerDriverBindingStart (
 \r
   if (!Found) {\r
     //\r
+    // Report Status Code to indicate that there is no USB mouse\r
+    //\r
+    REPORT_STATUS_CODE (\r
+      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+      (EFI_PERIPHERAL_MOUSE | EFI_P_EC_NOT_DETECTED)\r
+      );\r
+    //\r
     // No interrupt endpoint found, then return unsupported.\r
     //\r
     Status = EFI_UNSUPPORTED;\r
     goto ErrorExit;\r
   }\r
 \r
+  //\r
+  // Report Status Code here since USB mouse has be detected.\r
+  //\r
+  REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
+    EFI_PROGRESS_CODE,\r
+    (EFI_PERIPHERAL_MOUSE | EFI_P_PC_DETECTED),\r
+    UsbMouseAbsolutePointerDevice->DevicePath\r
+    );\r
+\r
   Status = InitializeUsbMouseDevice (UsbMouseAbsolutePointerDevice);\r
   if (EFI_ERROR (Status)) {\r
     //\r
@@ -245,8 +266,8 @@ USBMouseAbsolutePointerDriverBindingStart (
   // Initialize and install EFI Absolute Pointer Protocol.\r
   //\r
   UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.GetState = GetMouseAbsolutePointerState;\r
-  UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Reset   = UsbMouseAbsolutePointerReset;\r
-  UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Mode    = &UsbMouseAbsolutePointerDevice->Mode;\r
+  UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Reset    = UsbMouseAbsolutePointerReset;\r
+  UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.Mode    = &UsbMouseAbsolutePointerDevice->Mode;\r
 \r
   Status = gBS->CreateEvent (\r
                   EVT_NOTIFY_WAIT,\r
@@ -444,7 +465,7 @@ USBMouseAbsolutePointerDriverBindingStop (
   // Free all resources.\r
   //\r
   gBS->CloseEvent (UsbMouseAbsolutePointerDevice->AbsolutePointerProtocol.WaitForInput);\r
-  \r
+\r
   if (UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent != NULL) {\r
     gBS->CloseEvent (UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent);\r
     UsbMouseAbsolutePointerDevice->DelayedRecoveryEvent = NULL;\r
@@ -526,8 +547,6 @@ InitializeUsbMouseDevice (
   EFI_STATUS                Status;\r
   EFI_USB_HID_DESCRIPTOR    *MouseHidDesc;\r
   UINT8                     *ReportDesc;\r
-  UINT8                     ReportId;\r
-  UINT8                     Duration;\r
   EFI_USB_CONFIG_DESCRIPTOR ConfigDesc;\r
   VOID                      *Buf;\r
   UINT32                    TransferResult;\r
@@ -572,7 +591,7 @@ InitializeUsbMouseDevice (
 \r
   Total = 0;\r
   Start = FALSE;\r
-  Head  = (USB_DESC_HEAD *)Buf;  \r
+  Head  = (USB_DESC_HEAD *)Buf;\r
   MouseHidDesc = NULL;\r
 \r
   //\r
@@ -587,15 +606,15 @@ InitializeUsbMouseDevice (
         Start = TRUE;\r
       }\r
     }\r
-    if ((Start == TRUE) && (Head->Type == USB_DESC_TYPE_ENDPOINT)) {\r
+    if (Start && (Head->Type == USB_DESC_TYPE_ENDPOINT)) {\r
       break;\r
     }\r
-    if ((Start == TRUE) && (Head->Type == USB_DESC_TYPE_HID)) {\r
+    if (Start && (Head->Type == USB_DESC_TYPE_HID)) {\r
       MouseHidDesc = (EFI_USB_HID_DESCRIPTOR *)Head;\r
       break;\r
     }\r
-    Total += (UINT16)Head->Len;\r
-    Head   = (USB_DESC_HEAD*)((UINT8 *)Buf + Total);\r
+    Total = Total + (UINT16)Head->Len;\r
+    Head  = (USB_DESC_HEAD*)((UINT8 *)Buf + Total);\r
   }\r
 \r
   if (MouseHidDesc == NULL) {\r
@@ -649,7 +668,15 @@ InitializeUsbMouseDevice (
   UsbMouseAbsolutePointerDev->Mode.AbsoluteMinY = 0;\r
   UsbMouseAbsolutePointerDev->Mode.AbsoluteMinZ = 0;\r
   UsbMouseAbsolutePointerDev->Mode.Attributes   = 0x3;\r
-  \r
+\r
+  //\r
+  // Let the cursor's starting position is in the center of the screen.\r
+  //\r
+  UsbMouseAbsolutePointerDev->State.CurrentX =\r
+    DivU64x32 (UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxX + UsbMouseAbsolutePointerDev->Mode.AbsoluteMinX, 2);\r
+  UsbMouseAbsolutePointerDev->State.CurrentY =\r
+    DivU64x32 (UsbMouseAbsolutePointerDev->Mode.AbsoluteMaxY + UsbMouseAbsolutePointerDev->Mode.AbsoluteMinY, 2);\r
+\r
   //\r
   // Set boot protocol for the USB mouse.\r
   // This driver only supports boot protocol.\r
@@ -673,23 +700,6 @@ InitializeUsbMouseDevice (
     }\r
   }\r
 \r
-  //\r
-  // ReportId is zero, which means the idle rate applies to all input reports.\r
-  //\r
-  ReportId = 0;\r
-  //\r
-  // Duration is zero, which means the duration is infinite.\r
-  // so the endpoint will inhibit reporting forever,\r
-  // and only reporting when a change is detected in the report data.\r
-  //\r
-  Duration = 0;\r
-  UsbSetIdleRequest (\r
-    UsbIo,\r
-    UsbMouseAbsolutePointerDev->InterfaceDescriptor.InterfaceNumber,\r
-    ReportId,\r
-    Duration\r
-    );\r
-\r
   FreePool (Buf);\r
   FreePool (ReportDesc);\r
 \r
@@ -769,7 +779,7 @@ OnMouseInterruptComplete (
 \r
     //\r
     // Delete & Submit this interrupt again\r
-    // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt. \r
+    // Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.\r
     //\r
     UsbIo->UsbAsyncInterruptTransfer (\r
              UsbIo,\r
@@ -798,8 +808,6 @@ OnMouseInterruptComplete (
     return EFI_SUCCESS;\r
   }\r
 \r
-  UsbMouseAbsolutePointerDevice->StateChanged = TRUE;\r
-\r
   //\r
   // Check mouse Data\r
   // USB HID Specification specifies following data format:\r
@@ -812,13 +820,34 @@ OnMouseInterruptComplete (
   // 2       0 to 7  Y displacement\r
   // 3 to n  0 to 7  Device specific (optional)\r
   //\r
-  UsbMouseAbsolutePointerDevice->State.CurrentX += *((INT8 *) Data + 1);\r
-  UsbMouseAbsolutePointerDevice->State.CurrentY += *((INT8 *) Data + 2);\r
-  \r
+  if (DataLength < 3) {\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
+\r
+  UsbMouseAbsolutePointerDevice->StateChanged = TRUE;\r
+\r
+  UsbMouseAbsolutePointerDevice->State.ActiveButtons = *(UINT8 *) Data & (BIT0 | BIT1 | BIT2);\r
+\r
+  UsbMouseAbsolutePointerDevice->State.CurrentX =\r
+    MIN (\r
+      MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentX + *((INT8 *) Data + 1),\r
+           (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinX),\r
+      (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxX\r
+      );\r
+  UsbMouseAbsolutePointerDevice->State.CurrentY =\r
+    MIN (\r
+      MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentY + *((INT8 *) Data + 2),\r
+           (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinY),\r
+      (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxY\r
+      );\r
   if (DataLength > 3) {\r
-    UsbMouseAbsolutePointerDevice->State.CurrentZ += *((INT8 *) Data + 3);\r
+    UsbMouseAbsolutePointerDevice->State.CurrentZ =\r
+      MIN (\r
+        MAX ((INT64) UsbMouseAbsolutePointerDevice->State.CurrentZ + *((INT8 *) Data + 1),\r
+             (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinZ),\r
+        (INT64) UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxZ\r
+        );\r
   }\r
-  UsbMouseAbsolutePointerDevice->State.ActiveButtons = *(UINT8 *) Data & (BIT0 | BIT1);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -826,15 +855,15 @@ OnMouseInterruptComplete (
 /**\r
   Retrieves the current state of a pointer device.\r
 \r
-  @param  This                  A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.                                   \r
+  @param  This                  A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.\r
   @param  MouseState            A pointer to the state information on the pointer device.\r
 \r
   @retval EFI_SUCCESS           The state of the pointer device was returned in State.\r
   @retval EFI_NOT_READY         The state of the pointer device has not changed since the last call to\r
-                                GetState().                                                           \r
+                                GetState().\r
   @retval EFI_DEVICE_ERROR      A device error occurred while attempting to retrieve the pointer device's\r
-                                current state.                                                           \r
-  @retval EFI_INVALID_PARAMETER State is NULL.                                                           \r
+                                current state.\r
+  @retval EFI_INVALID_PARAMETER State is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -866,14 +895,6 @@ GetMouseAbsolutePointerState (
     sizeof (EFI_ABSOLUTE_POINTER_STATE)\r
     );\r
 \r
-  //\r
-  // Clear previous move state\r
-  //\r
-  MouseAbsolutePointerDev->State.CurrentX      = 0;\r
-  MouseAbsolutePointerDev->State.CurrentY      = 0;\r
-  MouseAbsolutePointerDev->State.CurrentZ      = 0;\r
-  MouseAbsolutePointerDev->State.ActiveButtons = 0;\r
-\r
   MouseAbsolutePointerDev->StateChanged = FALSE;\r
 \r
   return EFI_SUCCESS;\r
@@ -915,6 +936,15 @@ UsbMouseAbsolutePointerReset (
     &UsbMouseAbsolutePointerDevice->State,\r
     sizeof (EFI_ABSOLUTE_POINTER_STATE)\r
     );\r
+\r
+  //\r
+  // Let the cursor's starting position is in the center of the screen.\r
+  //\r
+  UsbMouseAbsolutePointerDevice->State.CurrentX =\r
+    DivU64x32 (UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxX + UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinX, 2);\r
+  UsbMouseAbsolutePointerDevice->State.CurrentY =\r
+    DivU64x32 (UsbMouseAbsolutePointerDevice->Mode.AbsoluteMaxY + UsbMouseAbsolutePointerDevice->Mode.AbsoluteMinY, 2);\r
+\r
   UsbMouseAbsolutePointerDevice->StateChanged = FALSE;\r
 \r
   return EFI_SUCCESS;\r