UsbMouse.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
USB Mouse Driver that manages USB mouse and produces Simple Pointer Protocol.
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "UsbMouse.h"
0xa,
NULL,
};
/**
Entrypoint of USB Mouse Driver.
This function is the entrypoint of USB Mouse Driver. It installs Driver Binding
Protocols together with Component Name Protocols.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
**/
)
{
);
return EFI_SUCCESS;
}
/**
Check whether USB mouse driver supports this device.
@param This The USB mouse driver binding protocol.
@param Controller The controller handle to check.
@param RemainingDevicePath The remaining device path.
@retval EFI_SUCCESS The driver supports this controller.
@retval other This device isn't supported.
**/
)
{
);
return Status;
}
//
// Use the USB I/O Protocol interface to check whether Controller is
// a mouse device that can be managed by this driver.
//
if (!IsUsbMouse (UsbIo)) {
}
gBS->CloseProtocol (
);
return Status;
}
/**
Starts the mouse device with this driver.
This function consumes USB I/O Portocol, intializes USB mouse device,
installs Simple Pointer Protocol, and submits Asynchronous Interrupt
Transfer to manage the USB mouse device.
@param This The USB mouse driver binding instance.
@param Controller Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_UNSUPPORTED This driver does not support this device.
@retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.
@retval EFI_OUT_OF_RESOURCES Can't allocate memory resources.
@retval EFI_ALREADY_STARTED This driver has been started.
**/
)
{
//
// Open USB I/O Protocol
//
);
goto ErrorExit1;
}
//
// Get the Device Path Protocol on Controller's handle
//
);
goto ErrorExit;
}
//
// Get interface & endpoint descriptor
//
);
//
// Traverse endpoints to find interrupt endpoint
//
);
//
// We only care interrupt endpoint here
//
break;
}
}
if (!Found) {
//
// No interrupt endpoint found, then return unsupported.
//
goto ErrorExit;
}
//
// Fail to initialize USB mouse device.
//
);
goto ErrorExit;
}
//
// Initialize and install EFI Simple Pointer Protocol.
//
);
goto ErrorExit;
}
);
goto ErrorExit;
}
//
// The next step would be submitting Asynchronous Interrupt Transfer on this mouse device.
// After that we will be able to get key data from it. Thus this is deemed as
// the enable action of the mouse, so report status code accordingly.
//
);
//
// Submit Asynchronous Interrupt Transfer to manage this device.
//
TRUE,
);
//
// If submit error, uninstall that interface
//
);
goto ErrorExit;
}
"eng",
L"Generic Usb Mouse",
);
"en",
L"Generic Usb Mouse",
);
return EFI_SUCCESS;
//
// Error handler
//
gBS->CloseProtocol (
);
if (UsbMouseDevice != NULL) {
}
}
}
return Status;
}
/**
Stop the USB mouse device handled by this driver.
@param This The USB mouse driver binding protocol.
@param Controller The controller to release.
@param NumberOfChildren The number of handles in ChildHandleBuffer.
@param ChildHandleBuffer The array of child handle.
@retval EFI_SUCCESS The device was stopped.
@retval EFI_UNSUPPORTED Simple Pointer Protocol is not installed on Controller.
@retval Others Fail to uninstall protocols attached on the device.
**/
)
{
(VOID **) &SimplePointerProtocol,
);
return EFI_UNSUPPORTED;
}
//
// The key data input from this device will be disabled.
//
);
//
// Delete the Asynchronous Interrupt Transfer from this device
//
0,
NULL,
);
);
return Status;
}
gBS->CloseProtocol (
);
//
// Free all resources.
//
}
}
return EFI_SUCCESS;
}
/**
Uses USB I/O to check whether the device is a USB mouse device.
@param UsbIo Pointer to a USB I/O protocol instance.
@retval TRUE Device is a USB mouse device.
@retval FALSE Device is a not USB mouse device.
**/
)
{
//
// Get the default interface descriptor
//
);
return FALSE;
}
) {
return TRUE;
}
return FALSE;
}
/**
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.
@param UsbMouseDev Device instance to be initialized.
@retval EFI_SUCCESS USB mouse device successfully initialized..
@retval EFI_UNSUPPORTED HID descriptor type is not report descriptor.
@retval Other USB mouse device was not initialized successfully.
**/
)
{
//
// Get HID descriptor
//
);
return Status;
}
//
// Get report descriptor
//
return EFI_UNSUPPORTED;
}
);
return Status;
}
//
// Parse report descriptor
//
);
return Status;
}
//
// Check the presence of left and right buttons,
// and initialize fields of EFI_SIMPLE_POINTER_MODE.
//
}
}
//
// Set boot protocol for the USB mouse.
// This driver only supports boot protocol.
//
);
if (Protocol != BOOT_PROTOCOL) {
);
return Status;
}
}
//
// ReportId is zero, which means the idle rate applies to all input reports.
//
ReportId = 0;
//
// Duration is zero, which means the duration is infinite.
// so the endpoint will inhibit reporting forever,
// and only reporting when a change is detected in the report data.
//
Duration = 0;
);
//
// Create event for delayed recovery, which deals with device error.
//
}
gBS->CreateEvent (
);
return EFI_SUCCESS;
}
/**
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.
@param Data A pointer to a buffer that is filled with key data which is
retrieved via asynchronous interrupt transfer.
@param DataLength Indicates the size of the data buffer.
@param Context Pointing to USB_KB_DEV instance.
@param Result Indicates the result of the asynchronous interrupt transfer.
@retval EFI_SUCCESS Asynchronous interrupt transfer is handled successfully.
@retval EFI_DEVICE_ERROR Hardware error occurs.
**/
)
{
if (Result != EFI_USB_NOERROR) {
//
// Some errors happen during the process
//
);
);
}
//
// Delete & Submit this interrupt again
// Handler of DelayedRecoveryEvent triggered by timer will re-submit the interrupt.
//
0,
0,
NULL,
);
//
// EFI_USB_INTERRUPT_DELAY is defined in USB standard for error handling.
//
);
return EFI_DEVICE_ERROR;
}
//
// If no error and no data, just return EFI_SUCCESS.
//
return EFI_SUCCESS;
}
//
// Check mouse Data
// USB HID Specification specifies following data format:
// Byte Bits Description
// 0 0 Button 1
// 1 Button 2
// 2 Button 3
// 4 to 7 Device-specific
// 1 0 to 7 X displacement
// 2 0 to 7 Y displacement
// 3 to n 0 to 7 Device specific (optional)
//
if (DataLength > 3) {
}
return EFI_SUCCESS;
}
/**
Retrieves the current state of a pointer device.
@param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
@param MouseState A pointer to the state information on the pointer device.
@retval EFI_SUCCESS The state of the pointer device was returned in State.
@retval EFI_NOT_READY The state of the pointer device has not changed since the last call to
GetState().
@retval EFI_DEVICE_ERROR A device error occurred while attempting to retrieve the pointer device's
current state.
@retval EFI_INVALID_PARAMETER MouseState is NULL.
**/
)
{
if (MouseState == NULL) {
return EFI_INVALID_PARAMETER;
}
if (!MouseDev->StateChanged) {
return EFI_NOT_READY;
}
//
// Retrieve mouse state from USB_MOUSE_DEV, which was filled by OnMouseInterruptComplete()
//
CopyMem (
sizeof (EFI_SIMPLE_POINTER_STATE)
);
//
// Clear previous move state
//
return EFI_SUCCESS;
}
/**
Resets the pointer device hardware.
@param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
@param ExtendedVerification Indicates that the driver may perform a more exhaustive
verification operation of the device during reset.
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset.
**/
)
{
);
//
// Clear mouse state.
//
ZeroMem (
sizeof (EFI_SIMPLE_POINTER_STATE)
);
return EFI_SUCCESS;
}
/**
Event notification function for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput event.
@param Event Event to be signaled when there's input from mouse.
@param Context Points to USB_MOUSE_DEV instance.
**/
)
{
//
// If there's input from mouse, signal the event.
//
if (UsbMouseDev->StateChanged) {
}
}
/**
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.
@param Event The Delayed Recovery event.
@param Context Points to the USB_MOUSE_DEV instance.
**/
)
{
//
// Re-submit Asynchronous Interrupt Transfer for recovery.
//
TRUE,
);
}