]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h
ShellPkg: acpiview: Make '-h' option not require a parameter
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseAbsolutePointerDxe / Ps2MouseAbsolutePointer.h
index 7a111f37f3d16290680ba3523040c37b7c5d2f85..e7aa1715ae6ba94a8fe90813418273321d94c76e 100644 (file)
@@ -1,22 +1,15 @@
 /** @file\r
   A Ps2MouseAbsolutePointer driver header file\r
-  \r
-Copyright (c) 2006 - 2007, 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) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
 #ifndef __PS2MOUSEABSOLUTEPOINTER_H__\r
 #define __PS2MOUSEABSOLUTEPOINTER_H__\r
 \r
-#include <PiDxe.h>\r
-#include <Framework/StatusCode.h>\r
+#include <Uefi.h>\r
 \r
 #include <Protocol/AbsolutePointer.h>\r
 #include <Protocol/IsaIo.h>\r
@@ -29,6 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/ReportStatusCodeLib.h>\r
+#include <Library/PcdLib.h>\r
 \r
 //\r
 // Global Variables\r
@@ -41,33 +35,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
@@ -151,7 +145,7 @@ PS2MouseAbsolutePointerDriverStart (
   );\r
 \r
 /**\r
-  Stop this driver on ControllerHandle. Support stoping any child handles\r
+  Stop this driver on ControllerHandle. Support stopping any child handles\r
   created by this driver.\r
 \r
   @param  This              Protocol instance pointer.\r
@@ -275,7 +269,7 @@ Ps2MouseAbsolutePointerComponentNameGetDriverName (
                                 driver specified by This was returned in\r
                                 DriverName.\r
 \r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
@@ -303,14 +297,14 @@ Ps2MouseAbsolutePointerComponentNameGetControllerName (
   );\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
+  Reset the Mouse and do BAT test for it, if ExtendedVerification is TRUE and there is a mouse device connected 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
+  @retval EFI_DEVICE_ERROR    - Errors occurred during resetting keyboard.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -322,7 +316,7 @@ MouseAbsolutePointerReset (
 \r
 /**\r
   Get and Clear mouse status.\r
-  \r
+\r
   @param This                 - Pointer of simple pointer Protocol.\r
   @param State                - Output buffer holding status.\r
 \r
@@ -370,11 +364,11 @@ PollMouseAbsolutePointer (
 \r
 /**\r
   I/O work flow of in 8042 data.\r
-  \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
+\r
+  @retval EFI_SUCCESS Success to execute I/O work flow\r
   @retval EFI_TIMEOUT Keyboard controller time out.\r
 **/\r
 EFI_STATUS\r