Remove extra #includes where possible to make build more efficient

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseAbsolutePointerDxe / Ps2MouseAbsolutePointer.h

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h
index 8f6c43591ac4a2383a10cff0f74cf75c5ff99b1b..1713041e8f1e8cfc0c0f06243020a48d200eb878 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   A Ps2MouseAbsolutePointer driver header file\r
   \r
 Copyright (c) 2006 - 2007, Intel Corporation\r
@@ -12,11 +12,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _PS2MOUSEABSOLUTEPOINTER_H\r
-#define _PS2MOUSEABSOLUTEPOINTER_H\r
+#ifndef __PS2MOUSEABSOLUTEPOINTER_H__\r
+#define __PS2MOUSEABSOLUTEPOINTER_H__\r
 \r
-#include <PiDxe.h>\r
-#include <Framework/StatusCode.h>\r
+#include <FrameworkDxe.h>\r
 \r
 #include <Protocol/AbsolutePointer.h>\r
 #include <Protocol/IsaIo.h>\r
@@ -41,33 +40,33 @@ extern EFI_COMPONENT_NAME2_PROTOCOL  gPs2MouseAbsolutePointerComponentName2;
 // PS/2 mouse sample rate\r
 //\r
 typedef enum {\r
-  SSR_10,\r
-  SSR_20,\r
-  SSR_40,\r
-  SSR_60,\r
-  SSR_80,\r
-  SSR_100,\r
-  SSR_200,\r
-  MAX_SR\r
+  SampleRate10,\r
+  SampleRate20,\r
+  SampleRate40,\r
+  SampleRate60,\r
+  SampleRate80,\r
+  SampleRate100,\r
+  SampleRate200,\r
+  MaxSampleRate\r
 } MOUSE_SR;\r
 \r
 //\r
 // PS/2 mouse resolution\r
 //\r
 typedef enum {\r
-  CMR1,\r
-  CMR2,\r
-  CMR4,\r
-  CMR8,\r
-  MAX_CMR\r
+  MouseResolution1,\r
+  MouseResolution2,\r
+  MouseResolution4,\r
+  MouseResolution8,\r
+  MaxResolution\r
 } MOUSE_RE;\r
 \r
 //\r
 // PS/2 mouse scaling\r
 //\r
 typedef enum {\r
-  SF1,\r
-  SF2\r
+  Scaling1,\r
+  Scaling2\r
 } MOUSE_SF;\r
 \r
 //\r
@@ -105,6 +104,20 @@ typedef struct {
 //\r
 // Function prototypes\r
 //\r
+/**\r
+  Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
+  than contains a IsaIo protocol can be supported.\r
+\r
+  @param  This                Protocol instance pointer.\r
+  @param  ControllerHandle    Handle of device to test\r
+  @param  RemainingDevicePath Optional parameter use to pick a specific child\r
+                              device to start.\r
+\r
+  @retval EFI_SUCCESS         This driver supports this device\r
+  @retval EFI_ALREADY_STARTED This driver is already running on this device\r
+  @retval other               This driver does not support this device\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PS2MouseAbsolutePointerDriverSupported (\r
@@ -113,6 +126,21 @@ PS2MouseAbsolutePointerDriverSupported (
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
   );\r
 \r
+/**\r
+  Start this driver on ControllerHandle by opening a IsaIo\r
+  protocol, creating PS2_MOUSE_ABSOLUTE_POINTER_DEV device and install gEfiAbsolutePointerProtocolGuid\r
+  finnally.\r
+\r
+  @param  This                 Protocol instance pointer.\r
+  @param  ControllerHandle     Handle of device to bind driver to\r
+  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
+                               device to start.\r
+\r
+  @retval EFI_SUCCESS          This driver is added to ControllerHandle\r
+  @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle\r
+  @retval other                This driver does not support this device\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PS2MouseAbsolutePointerDriverStart (\r
@@ -121,6 +149,20 @@ PS2MouseAbsolutePointerDriverStart (
   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  ControllerHandle  Handle of device to stop driver on\r
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
+                            children is zero stop the entire bus driver.\r
+  @param  ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
+  @retval other             This driver was not removed from this device\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PS2MouseAbsolutePointerDriverStop (\r
@@ -153,7 +195,7 @@ PS2MouseAbsolutePointerDriverStop (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r
-                                in RFC 3066 or ISO 639-2 language code format.\r
+                                in RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -218,7 +260,7 @@ Ps2MouseAbsolutePointerComponentNameGetDriverName (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r
-                                RFC 3066 or ISO 639-2 language code format.\r
+                                RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -259,7 +301,17 @@ Ps2MouseAbsolutePointerComponentNameGetControllerName (
   OUT CHAR16                                          **ControllerName\r
   );\r
 \r
+/**\r
+  Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system.\r
+\r
+  @param This                 - Pointer of simple pointer Protocol.\r
+  @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip.\r
 \r
+\r
+  @retval EFI_SUCCESS         - The command byte is written successfully.\r
+  @retval EFI_DEVICE_ERROR    - Errors occurred during reseting keyboard.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 MouseAbsolutePointerReset (\r
@@ -267,6 +319,16 @@ MouseAbsolutePointerReset (
   IN BOOLEAN                        ExtendedVerification\r
   );\r
 \r
+/**\r
+  Get and Clear mouse status.\r
+  \r
+  @param This                 - Pointer of simple pointer Protocol.\r
+  @param State                - Output buffer holding status.\r
+\r
+  @retval EFI_INVALID_PARAMETER Output buffer is invalid.\r
+  @retval EFI_NOT_READY         Mouse is not changed status yet.\r
+  @retval EFI_SUCCESS           Mouse status is changed and get successful.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 MouseAbsolutePointerGetState (\r
@@ -274,6 +336,15 @@ MouseAbsolutePointerGetState (
   IN OUT EFI_ABSOLUTE_POINTER_STATE   *State\r
   );\r
 \r
+/**\r
+\r
+  Event notification function for SIMPLE_POINTER.WaitForInput event.\r
+  Signal the event if there is input from mouse.\r
+\r
+  @param Event    event object\r
+  @param Context  event context\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 MouseAbsolutePointerWaitForInput (\r
@@ -281,6 +352,14 @@ MouseAbsolutePointerWaitForInput (
   IN  VOID                    *Context\r
   );\r
 \r
+/**\r
+  Event notification function for TimerEvent event.\r
+  If mouse device is connected to system, try to get the mouse packet data.\r
+\r
+  @param Event      -  TimerEvent in PS2_MOUSE_DEV\r
+  @param Context    -  Pointer to PS2_MOUSE_DEV structure\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 PollMouseAbsolutePointer (\r
@@ -288,11 +367,30 @@ PollMouseAbsolutePointer (
   IN VOID       *Context\r
   );\r
 \r
+/**\r
+  I/O work flow of in 8042 data.\r
+  \r
+  @param IsaIo   Pointer to instance of EFI_ISA_IO_PROTOCOL\r
+  @param Data    Data value\r
+  \r
+  @retval EFI_SUCCESS Success to excute I/O work flow\r
+  @retval EFI_TIMEOUT Keyboard controller time out.\r
+**/\r
 EFI_STATUS\r
 In8042Data (\r
   IN EFI_ISA_IO_PROTOCOL                  *IsaIo,\r
   IN OUT UINT8                            *Data\r
   );\r
+\r
+/**\r
+  Check whether there is Ps/2 mouse device in system\r
+\r
+  @param MouseAbsolutePointerDev - Absolute Pointer Device Private Data Structure\r
+\r
+  @retval TRUE                - Keyboard in System.\r
+  @retval FALSE               - Keyboard not in System.\r
+\r
+**/\r
 BOOLEAN\r
 CheckMouseAbsolutePointerConnect (\r
   IN  PS2_MOUSE_ABSOLUTE_POINTER_DEV     *MouseAbsolutePointerDev\r