diff options
Diffstat (limited to 'src/include/ipxe/efi/Protocol/AbsolutePointer.h')
| -rw-r--r-- | src/include/ipxe/efi/Protocol/AbsolutePointer.h | 79 |
1 files changed, 33 insertions, 46 deletions
diff --git a/src/include/ipxe/efi/Protocol/AbsolutePointer.h b/src/include/ipxe/efi/Protocol/AbsolutePointer.h index b20ca05..48810f9 100644 --- a/src/include/ipxe/efi/Protocol/AbsolutePointer.h +++ b/src/include/ipxe/efi/Protocol/AbsolutePointer.h @@ -2,34 +2,27 @@ The file provides services that allow information about an absolute pointer device to be retrieved. - Copyright (c) 2006 - 2012, 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 - http://opensource.org/licenses/bsd-license.php + Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> + SPDX-License-Identifier: BSD-2-Clause-Patent - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + @par Revision Reference: + This Protocol was introduced in UEFI Specification 2.3. **/ #ifndef __ABSOLUTE_POINTER_H__ #define __ABSOLUTE_POINTER_H__ -FILE_LICENCE ( BSD3 ); - +FILE_LICENCE ( BSD2_PATENT ); #define EFI_ABSOLUTE_POINTER_PROTOCOL_GUID \ { 0x8D59D32B, 0xC655, 0x4AE9, { 0x9B, 0x15, 0xF2, 0x59, 0x04, 0x99, 0x2A, 0x43 } } - typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL; - -//******************************************************* +// ******************************************************* // EFI_ABSOLUTE_POINTER_MODE -//******************************************************* - +// ******************************************************* /** The following data values in the EFI_ABSOLUTE_POINTER_MODE @@ -37,31 +30,30 @@ typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL; interface functions. **/ typedef struct { - UINT64 AbsoluteMinX; ///< The Absolute Minimum of the device on the x-axis - UINT64 AbsoluteMinY; ///< The Absolute Minimum of the device on the y axis. - UINT64 AbsoluteMinZ; ///< The Absolute Minimum of the device on the z-axis - UINT64 AbsoluteMaxX; ///< The Absolute Maximum of the device on the x-axis. If 0, and the - ///< AbsoluteMinX is 0, then the pointer device does not support a xaxis - UINT64 AbsoluteMaxY; ///< The Absolute Maximum of the device on the y -axis. If 0, and the - ///< AbsoluteMinX is 0, then the pointer device does not support a yaxis. - UINT64 AbsoluteMaxZ; ///< The Absolute Maximum of the device on the z-axis. If 0 , and the - ///< AbsoluteMinX is 0, then the pointer device does not support a zaxis - UINT32 Attributes; ///< The following bits are set as needed (or'd together) to indicate the - ///< capabilities of the device supported. The remaining bits are undefined - ///< and should be 0 + UINT64 AbsoluteMinX; ///< The Absolute Minimum of the device on the x-axis + UINT64 AbsoluteMinY; ///< The Absolute Minimum of the device on the y axis. + UINT64 AbsoluteMinZ; ///< The Absolute Minimum of the device on the z-axis + UINT64 AbsoluteMaxX; ///< The Absolute Maximum of the device on the x-axis. If 0, and the + ///< AbsoluteMinX is 0, then the pointer device does not support a xaxis + UINT64 AbsoluteMaxY; ///< The Absolute Maximum of the device on the y -axis. If 0, and the + ///< AbsoluteMinX is 0, then the pointer device does not support a yaxis. + UINT64 AbsoluteMaxZ; ///< The Absolute Maximum of the device on the z-axis. If 0 , and the + ///< AbsoluteMinX is 0, then the pointer device does not support a zaxis + UINT32 Attributes; ///< The following bits are set as needed (or'd together) to indicate the + ///< capabilities of the device supported. The remaining bits are undefined + ///< and should be 0 } EFI_ABSOLUTE_POINTER_MODE; /// /// If set, indicates this device supports an alternate button input. /// -#define EFI_ABSP_SupportsAltActive 0x00000001 +#define EFI_ABSP_SupportsAltActive 0x00000001 /// /// If set, indicates this device returns pressure data in parameter CurrentZ. /// #define EFI_ABSP_SupportsPressureAsZ 0x00000002 - /** This function resets the pointer device hardware. As part of initialization process, the firmware/device will make a quick @@ -92,7 +84,7 @@ EFI_STATUS (EFIAPI *EFI_ABSOLUTE_POINTER_RESET)( IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification -); + ); /// /// This bit is set if the touch sensor is active. @@ -102,8 +94,7 @@ EFI_STATUS /// /// This bit is set if the alt sensor, such as pen-side button, is active /// -#define EFI_ABS_AltActive 0x00000002 - +#define EFI_ABS_AltActive 0x00000002 /** Definition of EFI_ABSOLUTE_POINTER_STATE. @@ -115,7 +106,7 @@ typedef struct { /// both 0, then this pointer device does not support an x-axis, and this field /// must be ignored. /// - UINT64 CurrentX; + UINT64 CurrentX; /// /// The unsigned position of the activation on the y axis. If the AboluteMinY @@ -123,7 +114,7 @@ typedef struct { /// both 0, then this pointer device does not support an y-axis, and this field /// must be ignored. /// - UINT64 CurrentY; + UINT64 CurrentY; /// /// The unsigned position of the activation on the z axis, or the pressure @@ -131,13 +122,13 @@ typedef struct { /// EFI_ABSOLUTE_POINTER_MODE structure are both 0, then this pointer device /// does not support an z-axis, and this field must be ignored. /// - UINT64 CurrentZ; + UINT64 CurrentZ; /// /// Bits are set to 1 in this structure item to indicate that device buttons are /// active. /// - UINT32 ActiveButtons; + UINT32 ActiveButtons; } EFI_ABSOLUTE_POINTER_STATE; /** @@ -174,9 +165,8 @@ typedef EFI_STATUS (EFIAPI *EFI_ABSOLUTE_POINTER_GET_STATE)( IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, - IN OUT EFI_ABSOLUTE_POINTER_STATE *State -); - + OUT EFI_ABSOLUTE_POINTER_STATE *State + ); /// /// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services @@ -187,21 +177,18 @@ EFI_STATUS /// device. The service also provides certain data items describing the device. /// struct _EFI_ABSOLUTE_POINTER_PROTOCOL { - EFI_ABSOLUTE_POINTER_RESET Reset; - EFI_ABSOLUTE_POINTER_GET_STATE GetState; + EFI_ABSOLUTE_POINTER_RESET Reset; + EFI_ABSOLUTE_POINTER_GET_STATE GetState; /// /// Event to use with WaitForEvent() to wait for input from the pointer device. /// - EFI_EVENT WaitForInput; + EFI_EVENT WaitForInput; /// /// Pointer to EFI_ABSOLUTE_POINTER_MODE data. /// - EFI_ABSOLUTE_POINTER_MODE *Mode; + EFI_ABSOLUTE_POINTER_MODE *Mode; }; - -extern EFI_GUID gEfiAbsolutePointerProtocolGuid; - +extern EFI_GUID gEfiAbsolutePointerProtocolGuid; #endif - |