X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkModulePkg%2FBus%2FIsa%2FPs2MouseAbsolutePointerDxe%2FPs2MouseAbsolutePointer.h;h=e7aa1715ae6ba94a8fe90813418273321d94c76e;hb=4286eb22f4aec33b90574b998a31f8bd34dd4f47;hp=7a111f37f3d16290680ba3523040c37b7c5d2f85;hpb=18a73eb727e697f15891ccad55507ae3d8c37461;p=mirror_edk2.git diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h index 7a111f37f3..e7aa1715ae 100644 --- a/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h +++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2MouseAbsolutePointerDxe/Ps2MouseAbsolutePointer.h @@ -1,22 +1,15 @@ /** @file A Ps2MouseAbsolutePointer driver header file - -Copyright (c) 2006 - 2007, Intel Corporation -All rights reserved. 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 -http://opensource.org/licenses/bsd-license.php -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent **/ #ifndef __PS2MOUSEABSOLUTEPOINTER_H__ #define __PS2MOUSEABSOLUTEPOINTER_H__ -#include -#include +#include #include #include @@ -29,6 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include #include #include +#include // // Global Variables @@ -41,33 +35,33 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gPs2MouseAbsolutePointerComponentName2; // PS/2 mouse sample rate // typedef enum { - SSR_10, - SSR_20, - SSR_40, - SSR_60, - SSR_80, - SSR_100, - SSR_200, - MAX_SR + SampleRate10, + SampleRate20, + SampleRate40, + SampleRate60, + SampleRate80, + SampleRate100, + SampleRate200, + MaxSampleRate } MOUSE_SR; // // PS/2 mouse resolution // typedef enum { - CMR1, - CMR2, - CMR4, - CMR8, - MAX_CMR + MouseResolution1, + MouseResolution2, + MouseResolution4, + MouseResolution8, + MaxResolution } MOUSE_RE; // // PS/2 mouse scaling // typedef enum { - SF1, - SF2 + Scaling1, + Scaling2 } MOUSE_SF; // @@ -151,7 +145,7 @@ PS2MouseAbsolutePointerDriverStart ( ); /** - Stop this driver on ControllerHandle. Support stoping any child handles + Stop this driver on ControllerHandle. Support stopping any child handles created by this driver. @param This Protocol instance pointer. @@ -275,7 +269,7 @@ Ps2MouseAbsolutePointerComponentNameGetDriverName ( driver specified by This was returned in DriverName. - @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE. @@ -303,14 +297,14 @@ Ps2MouseAbsolutePointerComponentNameGetControllerName ( ); /** - Reset the Mouse and do BAT test for it, if ExtendedVerification isTRUE and there is a mouse device connectted to system. + Reset the Mouse and do BAT test for it, if ExtendedVerification is TRUE and there is a mouse device connected to system. @param This - Pointer of simple pointer Protocol. @param ExtendedVerification - Whether configure mouse parameters. True: do; FALSE: skip. @retval EFI_SUCCESS - The command byte is written successfully. - @retval EFI_DEVICE_ERROR - Errors occurred during reseting keyboard. + @retval EFI_DEVICE_ERROR - Errors occurred during resetting keyboard. **/ EFI_STATUS @@ -322,7 +316,7 @@ MouseAbsolutePointerReset ( /** Get and Clear mouse status. - + @param This - Pointer of simple pointer Protocol. @param State - Output buffer holding status. @@ -370,11 +364,11 @@ PollMouseAbsolutePointer ( /** I/O work flow of in 8042 data. - + @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL @param Data Data value - - @retval EFI_SUCCESS Success to excute I/O work flow + + @retval EFI_SUCCESS Success to execute I/O work flow @retval EFI_TIMEOUT Keyboard controller time out. **/ EFI_STATUS