/** @file\r
USB Mouse Driver that manages USB mouse and produces Simple Pointer Protocol.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. 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
#include "UsbMouse.h"\r
\r
-EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding = {\r
+EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding = {\r
USBMouseDriverBindingSupported,\r
USBMouseDriverBindingStart,\r
USBMouseDriverBindingStop,\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingEntryPoint (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
- EFI_STATUS Status;\r
+ EFI_STATUS Status;\r
\r
Status = EfiLibInstallDriverBindingComponentName2 (\r
ImageHandle,\r
return EFI_SUCCESS;\r
}\r
\r
-\r
/**\r
Check whether USB mouse driver supports this device.\r
\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
+ EFI_STATUS Status;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
\r
Status = gBS->OpenProtocol (\r
Controller,\r
&gEfiUsbIoProtocolGuid,\r
- (VOID **) &UsbIo,\r
+ (VOID **)&UsbIo,\r
This->DriverBindingHandle,\r
Controller,\r
EFI_OPEN_PROTOCOL_BY_DRIVER\r
}\r
\r
gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
\r
return Status;\r
}\r
\r
-\r
/**\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 Simple Pointer Protocol, and submits Asynchronous Interrupt\r
Transfer to manage the USB mouse device.\r
\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
{\r
- EFI_STATUS Status;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- USB_MOUSE_DEV *UsbMouseDevice;\r
- UINT8 EndpointNumber;\r
- EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
- UINT8 Index;\r
- UINT8 EndpointAddr;\r
- UINT8 PollingInterval;\r
- UINT8 PacketSize;\r
- BOOLEAN Found;\r
-\r
+ EFI_STATUS Status;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ USB_MOUSE_DEV *UsbMouseDevice;\r
+ UINT8 EndpointNumber;\r
+ EFI_USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;\r
+ UINT8 Index;\r
+ UINT8 EndpointAddr;\r
+ UINT8 PollingInterval;\r
+ UINT8 PacketSize;\r
+ BOOLEAN Found;\r
+ EFI_TPL OldTpl;\r
+\r
+ OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
//\r
// Open USB I/O Protocol\r
//\r
Status = gBS->OpenProtocol (\r
Controller,\r
&gEfiUsbIoProtocolGuid,\r
- (VOID **) &UsbIo,\r
+ (VOID **)&UsbIo,\r
This->DriverBindingHandle,\r
Controller,\r
EFI_OPEN_PROTOCOL_BY_DRIVER\r
);\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ goto ErrorExit1;\r
}\r
\r
UsbMouseDevice = AllocateZeroPool (sizeof (USB_MOUSE_DEV));\r
Status = gBS->OpenProtocol (\r
Controller,\r
&gEfiDevicePathProtocolGuid,\r
- (VOID **) &UsbMouseDevice->DevicePath,\r
+ (VOID **)&UsbMouseDevice->DevicePath,\r
This->DriverBindingHandle,\r
Controller,\r
EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
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
+ UsbMouseDevice->DevicePath\r
+ );\r
+\r
//\r
// Get interface & endpoint descriptor\r
//\r
EndpointNumber = UsbMouseDevice->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
&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
//\r
// We only care interrupt endpoint here\r
//\r
- CopyMem(&UsbMouseDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof(EndpointDescriptor));\r
+ CopyMem (&UsbMouseDevice->IntEndpointDescriptor, &EndpointDescriptor, sizeof (EndpointDescriptor));\r
Found = TRUE;\r
break;\r
}\r
\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
+ UsbMouseDevice->DevicePath\r
+ );\r
+\r
Status = InitializeUsbMouseDevice (UsbMouseDevice);\r
if (EFI_ERROR (Status)) {\r
//\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueMouseInterfaceError),\r
+ (EFI_PERIPHERAL_MOUSE | EFI_P_EC_INTERFACE_ERROR),\r
UsbMouseDevice->DevicePath\r
);\r
\r
//\r
// Initialize and install EFI Simple Pointer Protocol.\r
//\r
- UsbMouseDevice->SimplePointerProtocol.GetState = GetMouseState;\r
- UsbMouseDevice->SimplePointerProtocol.Reset = UsbMouseReset;\r
- UsbMouseDevice->SimplePointerProtocol.Mode = &UsbMouseDevice->Mode;\r
+ UsbMouseDevice->SimplePointerProtocol.GetState = GetMouseState;\r
+ UsbMouseDevice->SimplePointerProtocol.Reset = UsbMouseReset;\r
+ UsbMouseDevice->SimplePointerProtocol.Mode = &UsbMouseDevice->Mode;\r
\r
Status = gBS->CreateEvent (\r
EVT_NOTIFY_WAIT,\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueMouseEnable),\r
+ (EFI_PERIPHERAL_MOUSE | EFI_P_PC_ENABLE),\r
UsbMouseDevice->DevicePath\r
);\r
\r
//\r
EndpointAddr = UsbMouseDevice->IntEndpointDescriptor.EndpointAddress;\r
PollingInterval = UsbMouseDevice->IntEndpointDescriptor.Interval;\r
- PacketSize = (UINT8) (UsbMouseDevice->IntEndpointDescriptor.MaxPacketSize);\r
+ PacketSize = (UINT8)(UsbMouseDevice->IntEndpointDescriptor.MaxPacketSize);\r
\r
Status = UsbIo->UsbAsyncInterruptTransfer (\r
UsbIo,\r
);\r
goto ErrorExit;\r
}\r
- \r
+\r
UsbMouseDevice->ControllerNameTable = NULL;\r
AddUnicodeString2 (\r
"eng",\r
FALSE\r
);\r
\r
+ gBS->RestoreTPL (OldTpl);\r
+\r
return EFI_SUCCESS;\r
\r
-//\r
-// Error handler\r
-//\r
+ //\r
+ // Error handler\r
+ //\r
ErrorExit:\r
if (EFI_ERROR (Status)) {\r
gBS->CloseProtocol (\r
- Controller,\r
- &gEfiUsbIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
+ Controller,\r
+ &gEfiUsbIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
\r
if (UsbMouseDevice != NULL) {\r
if ((UsbMouseDevice->SimplePointerProtocol).WaitForInput != NULL) {\r
}\r
}\r
\r
+ErrorExit1:\r
+ gBS->RestoreTPL (OldTpl);\r
return Status;\r
}\r
\r
-\r
/**\r
Stop the USB mouse device handled by this driver.\r
\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN UINTN NumberOfChildren,\r
+ IN EFI_HANDLE *ChildHandleBuffer\r
)\r
{\r
- EFI_STATUS Status;\r
- USB_MOUSE_DEV *UsbMouseDevice;\r
- EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
+ EFI_STATUS Status;\r
+ USB_MOUSE_DEV *UsbMouseDevice;\r
+ EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
\r
Status = gBS->OpenProtocol (\r
Controller,\r
&gEfiSimplePointerProtocolGuid,\r
- (VOID **) &SimplePointerProtocol,\r
+ (VOID **)&SimplePointerProtocol,\r
This->DriverBindingHandle,\r
Controller,\r
EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueMouseDisable),\r
+ (EFI_PERIPHERAL_MOUSE | EFI_P_PC_DISABLE),\r
UsbMouseDevice->DevicePath\r
);\r
\r
FreePool (UsbMouseDevice);\r
\r
return EFI_SUCCESS;\r
-\r
}\r
\r
-\r
/**\r
Uses USB I/O to check whether the device is a USB mouse device.\r
\r
**/\r
BOOLEAN\r
IsUsbMouse (\r
- IN EFI_USB_IO_PROTOCOL *UsbIo\r
+ IN EFI_USB_IO_PROTOCOL *UsbIo\r
)\r
{\r
EFI_STATUS Status;\r
if ((InterfaceDescriptor.InterfaceClass == CLASS_HID) &&\r
(InterfaceDescriptor.InterfaceSubClass == SUBCLASS_BOOT) &&\r
(InterfaceDescriptor.InterfaceProtocol == PROTOCOL_MOUSE)\r
- ) {\r
+ )\r
+ {\r
return TRUE;\r
}\r
\r
return FALSE;\r
}\r
\r
-\r
/**\r
Initialize the USB mouse device.\r
\r
**/\r
EFI_STATUS\r
InitializeUsbMouseDevice (\r
- IN OUT USB_MOUSE_DEV *UsbMouseDev\r
+ IN OUT USB_MOUSE_DEV *UsbMouseDev\r
)\r
{\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- UINT8 Protocol;\r
- EFI_STATUS Status;\r
- EFI_USB_HID_DESCRIPTOR MouseHidDesc;\r
- UINT8 *ReportDesc;\r
- UINT8 ReportId;\r
- UINT8 Duration;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ UINT8 Protocol;\r
+ EFI_STATUS Status;\r
+ EFI_USB_HID_DESCRIPTOR *MouseHidDesc;\r
+ UINT8 *ReportDesc;\r
+ EFI_USB_CONFIG_DESCRIPTOR ConfigDesc;\r
+ VOID *Buf;\r
+ UINT32 TransferResult;\r
+ UINT16 Total;\r
+ USB_DESC_HEAD *Head;\r
+ BOOLEAN Start;\r
\r
UsbIo = UsbMouseDev->UsbIo;\r
\r
//\r
- // Get HID descriptor\r
+ // Get the current configuration descriptor. Note that it doesn't include other descriptors.\r
+ //\r
+ Status = UsbIo->UsbGetConfigDescriptor (\r
+ UsbIo,\r
+ &ConfigDesc\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // By issuing Get_Descriptor(Configuration) request with total length, we get the Configuration descriptor,\r
+ // all Interface descriptors, all Endpoint descriptors, and the HID descriptor for each interface.\r
//\r
- Status = UsbGetHidDescriptor (\r
+ Buf = AllocateZeroPool (ConfigDesc.TotalLength);\r
+ if (Buf == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ Status = UsbGetDescriptor (\r
UsbIo,\r
- UsbMouseDev->InterfaceDescriptor.InterfaceNumber,\r
- &MouseHidDesc\r
+ (UINT16)((USB_DESC_TYPE_CONFIG << 8) | (ConfigDesc.ConfigurationValue - 1)),\r
+ 0,\r
+ ConfigDesc.TotalLength,\r
+ Buf,\r
+ &TransferResult\r
);\r
if (EFI_ERROR (Status)) {\r
+ FreePool (Buf);\r
return Status;\r
}\r
\r
+ Total = 0;\r
+ Start = FALSE;\r
+ Head = (USB_DESC_HEAD *)Buf;\r
+ MouseHidDesc = NULL;\r
+\r
+ //\r
+ // Get HID descriptor from the receipt of Get_Descriptor(Configuration) request.\r
+ // This algorithm is based on the fact that the HID descriptor shall be interleaved\r
+ // between the interface and endpoint descriptors for HID interfaces.\r
+ //\r
+ while (Total < ConfigDesc.TotalLength) {\r
+ if (Head->Type == USB_DESC_TYPE_INTERFACE) {\r
+ if ((((USB_INTERFACE_DESCRIPTOR *)Head)->InterfaceNumber == UsbMouseDev->InterfaceDescriptor.InterfaceNumber) &&\r
+ (((USB_INTERFACE_DESCRIPTOR *)Head)->AlternateSetting == UsbMouseDev->InterfaceDescriptor.AlternateSetting))\r
+ {\r
+ Start = TRUE;\r
+ }\r
+ }\r
+\r
+ if (Start && (Head->Type == USB_DESC_TYPE_ENDPOINT)) {\r
+ break;\r
+ }\r
+\r
+ if (Start && (Head->Type == USB_DESC_TYPE_HID)) {\r
+ MouseHidDesc = (EFI_USB_HID_DESCRIPTOR *)Head;\r
+ break;\r
+ }\r
+\r
+ Total = Total + (UINT16)Head->Len;\r
+ Head = (USB_DESC_HEAD *)((UINT8 *)Buf + Total);\r
+ }\r
+\r
+ if (MouseHidDesc == NULL) {\r
+ FreePool (Buf);\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
//\r
// Get report descriptor\r
//\r
- if (MouseHidDesc.HidClassDesc[0].DescriptorType != USB_DESC_TYPE_REPORT) {\r
+ if (MouseHidDesc->HidClassDesc[0].DescriptorType != USB_DESC_TYPE_REPORT) {\r
+ FreePool (Buf);\r
return EFI_UNSUPPORTED;\r
}\r
\r
- ReportDesc = AllocateZeroPool (MouseHidDesc.HidClassDesc[0].DescriptorLength);\r
+ ReportDesc = AllocateZeroPool (MouseHidDesc->HidClassDesc[0].DescriptorLength);\r
ASSERT (ReportDesc != NULL);\r
\r
Status = UsbGetReportDescriptor (\r
UsbIo,\r
UsbMouseDev->InterfaceDescriptor.InterfaceNumber,\r
- MouseHidDesc.HidClassDesc[0].DescriptorLength,\r
+ MouseHidDesc->HidClassDesc[0].DescriptorLength,\r
ReportDesc\r
);\r
\r
if (EFI_ERROR (Status)) {\r
+ FreePool (Buf);\r
FreePool (ReportDesc);\r
return Status;\r
}\r
Status = ParseMouseReportDescriptor (\r
UsbMouseDev,\r
ReportDesc,\r
- MouseHidDesc.HidClassDesc[0].DescriptorLength\r
+ MouseHidDesc->HidClassDesc[0].DescriptorLength\r
);\r
\r
if (EFI_ERROR (Status)) {\r
+ FreePool (Buf);\r
FreePool (ReportDesc);\r
return Status;\r
}\r
if (UsbMouseDev->NumberOfButtons >= 1) {\r
UsbMouseDev->Mode.LeftButton = TRUE;\r
}\r
+\r
if (UsbMouseDev->NumberOfButtons > 1) {\r
UsbMouseDev->Mode.RightButton = TRUE;\r
}\r
+\r
UsbMouseDev->Mode.ResolutionX = 8;\r
UsbMouseDev->Mode.ResolutionY = 8;\r
UsbMouseDev->Mode.ResolutionZ = 0;\r
if (Protocol != BOOT_PROTOCOL) {\r
Status = UsbSetProtocolRequest (\r
UsbIo,\r
- 0,\r
+ UsbMouseDev->InterfaceDescriptor.InterfaceNumber,\r
BOOT_PROTOCOL\r
);\r
\r
if (EFI_ERROR (Status)) {\r
+ FreePool (Buf);\r
FreePool (ReportDesc);\r
return Status;\r
}\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
- UsbMouseDev->InterfaceDescriptor.InterfaceNumber,\r
- ReportId,\r
- Duration\r
- );\r
-\r
+ FreePool (Buf);\r
FreePool (ReportDesc);\r
\r
//\r
return EFI_SUCCESS;\r
}\r
\r
-\r
/**\r
Handler function for USB mouse's asynchronous interrupt transfer.\r
\r
EFI_STATUS\r
EFIAPI\r
OnMouseInterruptComplete (\r
- IN VOID *Data,\r
- IN UINTN DataLength,\r
- IN VOID *Context,\r
- IN UINT32 Result\r
+ IN VOID *Data,\r
+ IN UINTN DataLength,\r
+ IN VOID *Context,\r
+ IN UINT32 Result\r
)\r
{\r
- USB_MOUSE_DEV *UsbMouseDevice;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
- UINT8 EndpointAddr;\r
- UINT32 UsbResult;\r
+ USB_MOUSE_DEV *UsbMouseDevice;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
+ UINT8 EndpointAddr;\r
+ UINT32 UsbResult;\r
\r
- UsbMouseDevice = (USB_MOUSE_DEV *) Context;\r
- UsbIo = UsbMouseDevice->UsbIo;\r
+ UsbMouseDevice = (USB_MOUSE_DEV *)Context;\r
+ UsbIo = UsbMouseDevice->UsbIo;\r
\r
if (Result != EFI_USB_NOERROR) {\r
//\r
//\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
- PcdGet32 (PcdStatusCodeValueMouseInputError),\r
+ (EFI_PERIPHERAL_MOUSE | EFI_P_EC_INPUT_ERROR),\r
UsbMouseDevice->DevicePath\r
);\r
\r
\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
//\r
// If no error and no data, just return EFI_SUCCESS.\r
//\r
- if (DataLength == 0 || Data == NULL) {\r
+ if ((DataLength == 0) || (Data == NULL)) {\r
return EFI_SUCCESS;\r
}\r
\r
- UsbMouseDevice->StateChanged = TRUE;\r
-\r
//\r
// Check mouse Data\r
// USB HID Specification specifies following data format:\r
// 2 0 to 7 Y displacement\r
// 3 to n 0 to 7 Device specific (optional)\r
//\r
- UsbMouseDevice->State.LeftButton = (BOOLEAN) ((*(UINT8 *) Data & BIT0) != 0);\r
- UsbMouseDevice->State.RightButton = (BOOLEAN) ((*(UINT8 *) Data & BIT1) != 0);\r
- UsbMouseDevice->State.RelativeMovementX += *((INT8 *) Data + 1);\r
- UsbMouseDevice->State.RelativeMovementY += *((INT8 *) Data + 2);\r
+ if (DataLength < 3) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ UsbMouseDevice->StateChanged = TRUE;\r
+\r
+ UsbMouseDevice->State.LeftButton = (BOOLEAN)((*(UINT8 *)Data & BIT0) != 0);\r
+ UsbMouseDevice->State.RightButton = (BOOLEAN)((*(UINT8 *)Data & BIT1) != 0);\r
+ UsbMouseDevice->State.RelativeMovementX += *((INT8 *)Data + 1);\r
+ UsbMouseDevice->State.RelativeMovementY += *((INT8 *)Data + 2);\r
\r
if (DataLength > 3) {\r
- UsbMouseDevice->State.RelativeMovementZ += *((INT8 *) Data + 3);\r
+ UsbMouseDevice->State.RelativeMovementZ += *((INT8 *)Data + 3);\r
}\r
\r
return EFI_SUCCESS;\r
\r
/**\r
Retrieves the current state of a pointer device.\r
- \r
- @param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance. \r
+\r
+ @param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.\r
@param MouseState A pointer to the state information on the pointer device.\r
- \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 MouseState is NULL. \r
+ current state.\r
+ @retval EFI_INVALID_PARAMETER MouseState is NULL.\r
\r
**/\r
EFI_STATUS\r
OUT EFI_SIMPLE_POINTER_STATE *MouseState\r
)\r
{\r
- USB_MOUSE_DEV *MouseDev;\r
+ USB_MOUSE_DEV *MouseDev;\r
\r
if (MouseState == NULL) {\r
return EFI_INVALID_PARAMETER;\r
MouseDev->State.RelativeMovementY = 0;\r
MouseDev->State.RelativeMovementZ = 0;\r
\r
- MouseDev->StateChanged = FALSE;\r
+ MouseDev->StateChanged = FALSE;\r
\r
return EFI_SUCCESS;\r
}\r
\r
-\r
-/** \r
+/**\r
Resets the pointer device hardware.\r
- \r
+\r
@param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.\r
@param ExtendedVerification Indicates that the driver may perform a more exhaustive\r
verification operation of the device during reset.\r
- \r
+\r
@retval EFI_SUCCESS The device was reset.\r
@retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset.\r
\r
EFI_STATUS\r
EFIAPI\r
UsbMouseReset (\r
- IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
+ IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
+ IN BOOLEAN ExtendedVerification\r
)\r
{\r
- USB_MOUSE_DEV *UsbMouseDevice;\r
+ USB_MOUSE_DEV *UsbMouseDevice;\r
\r
- UsbMouseDevice = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (This);\r
+ UsbMouseDevice = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (This);\r
\r
REPORT_STATUS_CODE_WITH_DEVICE_PATH (\r
EFI_PROGRESS_CODE,\r
- PcdGet32 (PcdStatusCodeValueMouseReset),\r
+ (EFI_PERIPHERAL_MOUSE | EFI_P_PC_RESET),\r
UsbMouseDevice->DevicePath\r
);\r
\r
return EFI_SUCCESS;\r
}\r
\r
-\r
/**\r
- Event notification function for SIMPLE_POINTER.WaitForInput event.\r
+ Event notification function for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput event.\r
\r
@param Event Event to be signaled when there's input from mouse.\r
@param Context Points to USB_MOUSE_DEV instance.\r
- \r
+\r
**/\r
VOID\r
EFIAPI\r
UsbMouseWaitForInput (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
)\r
{\r
- USB_MOUSE_DEV *UsbMouseDev;\r
+ USB_MOUSE_DEV *UsbMouseDev;\r
\r
- UsbMouseDev = (USB_MOUSE_DEV *) Context;\r
+ UsbMouseDev = (USB_MOUSE_DEV *)Context;\r
\r
//\r
// If there's input from mouse, signal the event.\r
}\r
}\r
\r
-\r
/**\r
Handler for Delayed Recovery event.\r
\r
VOID\r
EFIAPI\r
USBMouseRecoveryHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
)\r
{\r
- USB_MOUSE_DEV *UsbMouseDev;\r
- EFI_USB_IO_PROTOCOL *UsbIo;\r
+ USB_MOUSE_DEV *UsbMouseDev;\r
+ EFI_USB_IO_PROTOCOL *UsbIo;\r
\r
- UsbMouseDev = (USB_MOUSE_DEV *) Context;\r
+ UsbMouseDev = (USB_MOUSE_DEV *)Context;\r
\r
- UsbIo = UsbMouseDev->UsbIo;\r
+ UsbIo = UsbMouseDev->UsbIo;\r
\r
//\r
// Re-submit Asynchronous Interrupt Transfer for recovery.\r
projects / mirror_edk2.git / blobdiff