/** @file\r
\r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+ Usb Mouse Driver Binding and Implement SIMPLE_POINTER_PROTOCOL 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
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
\r
- Module Name:\r
-\r
- UsbMouse.c\r
-\r
- Abstract:\r
-\r
-\r
**/\r
\r
#include "UsbMouse.h"\r
#include "UsbMouse.h"\r
#include "MouseHid.h"\r
\r
-//\r
-// Prototypes\r
-// Driver model protocol interface\r
-//\r
+/**\r
+ The USB Mouse driver entry pointer.\r
+\r
+ @param ImageHandle The driver image handle.\r
+ @param SystemTable The system table.\r
+\r
+ @return EFI_SUCCESS The component name protocol is installed.\r
+ @return Others Failed to init the usb driver.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingEntryPoint (\r
IN EFI_SYSTEM_TABLE *SystemTable\r
);\r
\r
+/**\r
+ Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
+ that has UsbIoProtocol installed will be supported.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Controller Handle of device to test.\r
+ @param RemainingDevicePath Not used.\r
+\r
+ @retval EFI_SUCCESS This driver supports this device.\r
+ @retval EFI_UNSUPPORTED This driver does not support this device.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingSupported (\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
);\r
\r
+/**\r
+ Starting the Usb Mouse Driver.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Controller Handle of device to test\r
+ @param RemainingDevicePath Not used\r
+\r
+ @retval EFI_SUCCESS This driver supports this device.\r
+ @retval EFI_UNSUPPORTED This driver does not support this device.\r
+ @retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.\r
+ @retval EFI_OUT_OF_RESOURCES Can't allocate memory resources.\r
+ @retval EFI_ALREADY_STARTED Thios driver has been started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingStart (\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
);\r
\r
+/**\r
+ Stop this driver on ControllerHandle. Support stoping any child handles\r
+ created by this driver.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Controller Handle of device to stop driver on.\r
+ @param NumberOfChildren Number of Children in the ChildHandleBuffer.\r
+ @param ChildHandleBuffer List of handles for the children we need to stop.\r
+\r
+ @retval EFI_SUCCESS The controller or children are stopped.\r
+ @retval Other Failed to stop the driver.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingStop (\r
NULL\r
};\r
\r
-//\r
-// helper functions\r
-//\r
-STATIC\r
+/**\r
+ Tell if a Usb Controller is a mouse.\r
+\r
+ @param UsbIo Protocol instance pointer.\r
+\r
+ @retval TRUE It is a mouse.\r
+ @retval FALSE It is not a mouse.\r
+\r
+**/\r
BOOLEAN\r
IsUsbMouse (\r
IN EFI_USB_IO_PROTOCOL *UsbIo\r
);\r
\r
-STATIC\r
+/**\r
+ Initialize the Usb Mouse Device.\r
+\r
+ @param UsbMouseDev Device instance to be initialized.\r
+\r
+ @retval EFI_SUCCESS Success.\r
+ @retval EFI_OUT_OF_RESOURCES Can't allocate memory.\r
+ @retval Other Init error. \r
+\r
+**/\r
EFI_STATUS\r
InitializeUsbMouseDevice (\r
IN USB_MOUSE_DEV *UsbMouseDev\r
);\r
\r
-STATIC\r
+/**\r
+ Event notification function for SIMPLE_POINTER.WaitForInput event\r
+ Signal the event if there is input from mouse.\r
+\r
+ @param Event Wait Event.\r
+ @param Context Passed parameter to event handler.\r
+ \r
+**/\r
VOID\r
EFIAPI\r
UsbMouseWaitForInput (\r
IN VOID *Context\r
);\r
\r
-//\r
-// Mouse interrupt handler\r
-//\r
-STATIC\r
+/**\r
+ It is called whenever there is data received from async interrupt\r
+ transfer.\r
+\r
+ @param Data Data received.\r
+ @param DataLength Length of Data.\r
+ @param Context Passed in context.\r
+ @param Result Async Interrupt Transfer result.\r
+\r
+ @return EFI_SUCCESS Receive data successfully.\r
+ @return EFI_DEVICE_ERROR USB async interrupt transfer fails.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
OnMouseInterruptComplete (\r
IN UINT32 Result\r
);\r
\r
-//\r
-// Mouse Protocol\r
-//\r
-STATIC\r
+/**\r
+ Get the mouse state, see SIMPLE POINTER PROTOCOL.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param MouseState Current mouse state.\r
+\r
+ @return EFI_SUCCESS Get usb mouse status successfully.\r
+ @return EFI_DEVICE_ERROR The parameter is error.\r
+ @return EFI_NOT_READY Mouse status doesn't change.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
GetMouseState (\r
OUT EFI_SIMPLE_POINTER_STATE *MouseState\r
);\r
\r
-STATIC\r
+/**\r
+ Reset the mouse device, see SIMPLE POINTER PROTOCOL.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Ignored here.\r
+\r
+ @return EFI_SUCCESS Reset usb mouse successfully.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
UsbMouseReset (\r
IN BOOLEAN ExtendedVerification\r
);\r
\r
-//\r
-// Driver start here\r
-//\r
+\r
+/**\r
+ The USB Mouse driver entry pointer.\r
+\r
+ @param ImageHandle The driver image handle.\r
+ @param SystemTable The system table.\r
+\r
+ @return EFI_SUCCESS The component name protocol is installed.\r
+ @return Others Failed to init the usb driver.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
USBMouseDriverBindingEntryPoint (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Entry point for EFI drivers.\r
-\r
- Arguments:\r
- ImageHandle - EFI_HANDLE\r
- SystemTable - EFI_SYSTEM_TABLE\r
- Returns:\r
- EFI_SUCCESS\r
- others\r
-\r
---*/\r
{\r
return EfiLibInstallDriverBindingComponentName2 (\r
ImageHandle,\r
\r
/**\r
Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
- that has UsbHcProtocol installed will be supported.\r
+ that has UsbIoProtocol installed will be supported.\r
\r
@param This Protocol instance pointer.\r
@param Controller Handle of device to test\r
- @param RemainingDevicePath Not used\r
+ @param RemainingDevicePath Not used.\r
\r
@retval EFI_SUCCESS This driver supports this device.\r
@retval EFI_UNSUPPORTED This driver does not support this device.\r
\r
\r
/**\r
- Starting the Usb Bus Driver\r
+ Starting the Usb Mouse Driver.\r
\r
@param This Protocol instance pointer.\r
- @param Controller Handle of device to test\r
- @param RemainingDevicePath Not used\r
+ @param Controller Handle of device to test.\r
+ @param RemainingDevicePath Not used.\r
\r
@retval EFI_SUCCESS This driver supports this device.\r
@retval EFI_UNSUPPORTED This driver does not support this device.\r
- @retval EFI_DEVICE_ERROR This driver cannot be started due to device Error\r
- EFI_OUT_OF_RESOURCES- Can't allocate memory\r
- resources\r
- @retval EFI_ALREADY_STARTED Thios driver has been started\r
+ @retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.\r
+ @retval EFI_OUT_OF_RESOURCES Can't allocate memory resources.\r
+ @retval EFI_ALREADY_STARTED Thios driver has been started.\r
\r
**/\r
EFI_STATUS\r
created by this driver.\r
\r
@param This Protocol instance pointer.\r
- @param Controller Handle of device to stop driver on\r
- @param NumberOfChildren Number of Children in the ChildHandleBuffer\r
+ @param Controller Handle of device to stop driver on.\r
+ @param NumberOfChildren Number of Children in the ChildHandleBuffer.\r
@param ChildHandleBuffer List of handles for the children we need to stop.\r
\r
- @return EFI_SUCCESS\r
- @return EFI_DEVICE_ERROR\r
- @return others\r
+ @retval EFI_SUCCESS The controller or children are stopped.\r
+ @retval Other Failed to stop the driver.\r
\r
**/\r
EFI_STATUS\r
\r
gBS->CloseEvent (UsbMouseDevice->SimplePointerProtocol.WaitForInput);\r
\r
- if (UsbMouseDevice->DelayedRecoveryEvent) {\r
+ if (UsbMouseDevice->DelayedRecoveryEvent != NULL) {\r
gBS->CloseEvent (UsbMouseDevice->DelayedRecoveryEvent);\r
UsbMouseDevice->DelayedRecoveryEvent = 0;\r
}\r
gBS->FreePool (UsbMouseDevice->InterfaceDescriptor);\r
gBS->FreePool (UsbMouseDevice->IntEndpointDescriptor);\r
\r
- if (UsbMouseDevice->ControllerNameTable) {\r
+ if (UsbMouseDevice->ControllerNameTable != NULL) {\r
FreeUnicodeStringTable (UsbMouseDevice->ControllerNameTable);\r
}\r
\r
\r
\r
/**\r
- Tell if a Usb Controller is a mouse\r
+ Tell if a Usb Controller is a mouse.\r
\r
@param UsbIo Protocol instance pointer.\r
\r
- @retval TRUE It is a mouse\r
- @retval FALSE It is not a mouse\r
+ @retval TRUE It is a mouse.\r
+ @retval FALSE It is not a mouse.\r
\r
**/\r
BOOLEAN\r
/**\r
Initialize the Usb Mouse Device.\r
\r
- @param UsbMouseDev Device instance to be initialized\r
+ @param UsbMouseDev Device instance to be initialized.\r
\r
- @retval EFI_SUCCESS Success\r
- @retval EFI_DEVICE_ERROR Init error. EFI_OUT_OF_RESOURCES- Can't allocate\r
- memory\r
+ @retval EFI_SUCCESS Success.\r
+ @retval EFI_OUT_OF_RESOURCES Can't allocate memory.\r
+ @retval Other Init error. \r
\r
**/\r
-STATIC\r
EFI_STATUS\r
InitializeUsbMouseDevice (\r
IN USB_MOUSE_DEV *UsbMouseDev\r
\r
gBS->FreePool (ReportDesc);\r
\r
- if (UsbMouseDev->DelayedRecoveryEvent) {\r
+ if (UsbMouseDev->DelayedRecoveryEvent != NULL) {\r
gBS->CloseEvent (UsbMouseDev->DelayedRecoveryEvent);\r
UsbMouseDev->DelayedRecoveryEvent = 0;\r
}\r
transfer.\r
\r
@param Data Data received.\r
- @param DataLength Length of Data\r
- @param Context Passed in context\r
- @param Result Async Interrupt Transfer result\r
+ @param DataLength Length of Data.\r
+ @param Context Passed in context.\r
+ @param Result Async Interrupt Transfer result.\r
\r
- @return EFI_SUCCESS\r
- @return EFI_DEVICE_ERROR\r
+ @return EFI_SUCCESS Receive data successfully.\r
+ @return EFI_DEVICE_ERROR USB async interrupt transfer fails.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
EFIAPI\r
OnMouseInterruptComplete (\r
return EFI_SUCCESS;\r
}\r
\r
-/*\r
-STATIC VOID\r
-PrintMouseState(\r
- IN EFI_MOUSE_STATE *MouseState\r
- )\r
-{\r
- Aprint("(%x: %x, %x)\n",\r
- MouseState->ButtonStates,\r
- MouseState->dx,\r
- MouseState->dy\r
- );\r
-}\r
-*/\r
\r
/**\r
Get the mouse state, see SIMPLE POINTER PROTOCOL.\r
\r
@param This Protocol instance pointer.\r
- @param MouseState Current mouse state\r
+ @param MouseState Current mouse state.\r
\r
- @return EFI_SUCCESS\r
- @return EFI_DEVICE_ERROR\r
- @return EFI_NOT_READY\r
+ @return EFI_SUCCESS Get usb mouse status successfully.\r
+ @return EFI_DEVICE_ERROR The parameter is error.\r
+ @return EFI_NOT_READY Mouse status doesn't change.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
EFIAPI\r
GetMouseState (\r
Reset the mouse device, see SIMPLE POINTER PROTOCOL.\r
\r
@param This Protocol instance pointer.\r
- @param ExtendedVerification Ignored here/\r
+ @param ExtendedVerification Ignored here.\r
\r
- @return EFI_SUCCESS\r
+ @return EFI_SUCCESS Reset usb mouse successfully.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
EFIAPI\r
UsbMouseReset (\r
\r
/**\r
Event notification function for SIMPLE_POINTER.WaitForInput event\r
- Signal the event if there is input from mouse\r
+ Signal the event if there is input from mouse.\r
\r
@param Event Wait Event\r
@param Context Passed parameter to event handler\r
- VOID\r
-\r
+ \r
**/\r
-STATIC\r
VOID\r
EFIAPI\r
UsbMouseWaitForInput (\r
\r
\r
/**\r
- Report Status Code in Usb Bot Driver\r
+ Report Status Code in Usb Bot Driver.\r
\r
@param DevicePath Use this to get Device Path\r
@param CodeType Status Code Type\r
projects / mirror_edk2.git / blobdiff