#include "UsbMouse.h"

Functions
EFI_STATUS EFIAPI	USBMouseDriverBindingEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS EFIAPI	USBMouseDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	USBMouseDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	USBMouseDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

BOOLEAN	IsUsbMouse (IN EFI_USB_IO_PROTOCOL *UsbIo)

EFI_STATUS	InitializeUsbMouseDevice (IN OUT USB_MOUSE_DEV *UsbMouseDev)

EFI_STATUS EFIAPI	OnMouseInterruptComplete (IN VOID Data, IN UINTN DataLength, IN VOID Context, IN UINT32 Result)

EFI_STATUS EFIAPI	GetMouseState (IN EFI_SIMPLE_POINTER_PROTOCOL This, OUT EFI_SIMPLE_POINTER_STATE MouseState)

EFI_STATUS EFIAPI	UsbMouseReset (IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

VOID EFIAPI	UsbMouseWaitForInput (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	USBMouseRecoveryHandler (IN EFI_EVENT Event, IN VOID *Context)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gUsbMouseDriverBinding

Detailed Description

USB Mouse Driver that manages USB mouse and produces Simple Pointer Protocol.

Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UsbMouse.c.

Function Documentation

◆ GetMouseState()

EFI_STATUS EFIAPI GetMouseState	(	IN EFI_SIMPLE_POINTER_PROTOCOL *	This,
		OUT EFI_SIMPLE_POINTER_STATE *	MouseState
	)

Retrieves the current state of a pointer device.

Parameters

This	A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
MouseState	A pointer to the state information on the pointer device.

Return values

EFI_SUCCESS	The state of the pointer device was returned in State.
EFI_NOT_READY	The state of the pointer device has not changed since the last call to GetState().
EFI_DEVICE_ERROR	A device error occurred while attempting to retrieve the pointer device's current state.
EFI_INVALID_PARAMETER	MouseState is NULL.

Definition at line 856 of file UsbMouse.c.

◆ InitializeUsbMouseDevice()

EFI_STATUS InitializeUsbMouseDevice ( IN OUT USB_MOUSE_DEV * UsbMouseDev )

Initialize the USB mouse device.

This function retrieves and parses HID report descriptor, and initializes state of USB_MOUSE_DEV. Then it sets indefinite idle rate for the device. Finally it creates event for delayed recovery, which deals with device error.

Parameters

UsbMouseDev Device instance to be initialized.

Return values

EFI_SUCCESS	USB mouse device successfully initialized..
EFI_UNSUPPORTED	HID descriptor type is not report descriptor.
Other	USB mouse device was not initialized successfully.

Definition at line 537 of file UsbMouse.c.

◆ IsUsbMouse()

BOOLEAN IsUsbMouse ( IN EFI_USB_IO_PROTOCOL * UsbIo )

Uses USB I/O to check whether the device is a USB mouse device.

Parameters

UsbIo Pointer to a USB I/O protocol instance.

Return values

TRUE	Device is a USB mouse device.
FALSE	Device is a not USB mouse device.

Definition at line 491 of file UsbMouse.c.

◆ OnMouseInterruptComplete()

EFI_STATUS EFIAPI OnMouseInterruptComplete	(	IN VOID *	Data,
		IN UINTN	DataLength,
		IN VOID *	Context,
		IN UINT32	Result
	)

Handler function for USB mouse's asynchronous interrupt transfer.

This function is the handler function for USB mouse's asynchronous interrupt transfer to manage the mouse. It parses data returned from asynchronous interrupt transfer, and get button and movement state.

Parameters

Data	A pointer to a buffer that is filled with key data which is retrieved via asynchronous interrupt transfer.
DataLength	Indicates the size of the data buffer.
Context	Pointing to USB_KB_DEV instance.
Result	Indicates the result of the asynchronous interrupt transfer.

Return values

EFI_SUCCESS	Asynchronous interrupt transfer is handled successfully.
EFI_DEVICE_ERROR	Hardware error occurs.

Definition at line 744 of file UsbMouse.c.

◆ USBMouseDriverBindingEntryPoint()

EFI_STATUS EFIAPI USBMouseDriverBindingEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Entrypoint of USB Mouse Driver.

This function is the entrypoint of USB Mouse Driver. It installs Driver Binding Protocols together with Component Name Protocols.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The entry point is executed successfully.

Definition at line 34 of file UsbMouse.c.

◆ USBMouseDriverBindingStart()

EFI_STATUS EFIAPI USBMouseDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starts the mouse device with this driver.

This function consumes USB I/O Protocol, initializes USB mouse device, installs Simple Pointer Protocol, and submits Asynchronous Interrupt Transfer to manage the USB mouse device.

Parameters

This	The USB mouse driver binding instance.
Controller	Handle of device to bind driver to.
RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver supports this device.
EFI_UNSUPPORTED	This driver does not support this device.
EFI_DEVICE_ERROR	This driver cannot be started due to device Error.
EFI_OUT_OF_RESOURCES	Can't allocate memory resources.
EFI_ALREADY_STARTED	This driver has been started.

Definition at line 128 of file UsbMouse.c.

◆ USBMouseDriverBindingStop()

EFI_STATUS EFIAPI USBMouseDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stop the USB mouse device handled by this driver.

Parameters

This	The USB mouse driver binding protocol.
Controller	The controller to release.
NumberOfChildren	The number of handles in ChildHandleBuffer.
ChildHandleBuffer	The array of child handle.

Return values

EFI_SUCCESS	The device was stopped.
EFI_UNSUPPORTED	Simple Pointer Protocol is not installed on Controller.
Others	Fail to uninstall protocols attached on the device.

Definition at line 395 of file UsbMouse.c.

◆ USBMouseDriverBindingSupported()

EFI_STATUS EFIAPI USBMouseDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Check whether USB mouse driver supports this device.

Parameters

This	The USB mouse driver binding protocol.
Controller	The controller handle to check.
RemainingDevicePath	The remaining device path.

Return values

EFI_SUCCESS	The driver supports this controller.
other	This device isn't supported.

Definition at line 67 of file UsbMouse.c.

◆ USBMouseRecoveryHandler()

VOID EFIAPI USBMouseRecoveryHandler	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Handler for Delayed Recovery event.

This function is the handler for Delayed Recovery event triggered by timer. After a device error occurs, the event would be triggered with interval of EFI_USB_INTERRUPT_DELAY. EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.

Parameters

Event	The Delayed Recovery event.
Context	Points to the USB_MOUSE_DEV instance.

Definition at line 975 of file UsbMouse.c.

◆ UsbMouseReset()

EFI_STATUS EFIAPI UsbMouseReset	(	IN EFI_SIMPLE_POINTER_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Resets the pointer device hardware.

Parameters

This	A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
ExtendedVerification	Indicates that the driver may perform a more exhaustive verification operation of the device during reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning correctly and could not be reset.

Definition at line 907 of file UsbMouse.c.

◆ UsbMouseWaitForInput()

VOID EFIAPI UsbMouseWaitForInput	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event notification function for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput event.

Parameters

Event	Event to be signaled when there's input from mouse.
Context	Points to USB_MOUSE_DEV instance.

Definition at line 943 of file UsbMouse.c.

Variable Documentation

◆ gUsbMouseDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUsbMouseDriverBinding

Initial value:

= {
  USBMouseDriverBindingSupported,
  USBMouseDriverBindingStart,
  USBMouseDriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 11 of file UsbMouse.c.

Functions

Variables

Detailed Description

Function Documentation

◆ GetMouseState()

◆ InitializeUsbMouseDevice()

◆ IsUsbMouse()

◆ OnMouseInterruptComplete()

◆ USBMouseDriverBindingEntryPoint()

◆ USBMouseDriverBindingStart()

◆ USBMouseDriverBindingStop()

◆ USBMouseDriverBindingSupported()

◆ USBMouseRecoveryHandler()

◆ UsbMouseReset()

◆ UsbMouseWaitForInput()

Variable Documentation

◆ gUsbMouseDriverBinding