X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FAbsolutePointer.h;h=ecf476d7c0e2f0b96eda0b0a380ef65913fc69a0;hb=9095d37b8fe5bfc3d02adad6ba7fd7359ebc0107;hp=2b8d94d49fbd5dee54e7013a5d6ded5bf67c1752;hpb=99e8ed219f48b82694424e46c9512d4929d9d54e;p=mirror_edk2.git diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h index 2b8d94d49f..ecf476d7c0 100644 --- a/MdePkg/Include/Protocol/AbsolutePointer.h +++ b/MdePkg/Include/Protocol/AbsolutePointer.h @@ -1,15 +1,15 @@ /** @file - The file provides services that allow information about a + The file provides services that allow information about an absolute pointer device to be retrieved. - - Copyright (c) 2006 - 2008, 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.
+ 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. **/ @@ -33,54 +33,30 @@ typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL; The following data values in the EFI_ABSOLUTE_POINTER_MODE interface are read-only and are changed by using the appropriate interface functions. - - @param AbsoluteMinX The Absolute Minimum of the device on the - x-axis. - - @param AbsoluteMinY The Absolute Minimum of the device on the - y axis. - - @param AbsoluteMinZ The Absolute Minimum of the device on the - z-axis. - - @param 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. - - @param 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. - - @param 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. - - @param 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. - **/ typedef struct { - UINT64 AbsoluteMinX; - UINT64 AbsoluteMinY; - UINT64 AbsoluteMinZ; - UINT64 AbsoluteMaxX; - UINT64 AbsoluteMaxY; - UINT64 AbsoluteMaxZ; - UINT32 Attributes; + 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. -/// +/// If set, indicates this device supports an alternate button input. +/// #define EFI_ABSP_SupportsAltActive 0x00000001 /// /// If set, indicates this device returns pressure data in parameter CurrentZ. -/// +/// #define EFI_ABSP_SupportsPressureAsZ 0x00000002 @@ -104,7 +80,7 @@ typedef struct { device during reset. @retval EFI_SUCCESS The device was reset. - + @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset. @@ -116,57 +92,49 @@ EFI_STATUS IN BOOLEAN ExtendedVerification ); - - - -/** - Definitions of bits within ActiveButtons. - - @param EFI_ABSP_TouchActive This bit is set if the touch - sensor is active. - - @param EFI_ABS_AltActive This bit is set if the alt sensor, - such as pen-side button, is - active. -**/ +/// +/// This bit is set if the touch sensor is active. +/// #define EFI_ABSP_TouchActive 0x00000001 + +/// +/// This bit is set if the alt sensor, such as pen-side button, is active +/// #define EFI_ABS_AltActive 0x00000002 /** Definition of EFI_ABSOLUTE_POINTER_STATE. - - @param CurrentX The unsigned position of the activation on the - x axis If the AboluteMinX and the AboluteMaxX - fields of the EFI_ABSOLUTE_POINTER_MODE - structure are both 0, then this pointer device - does not support an x-axis, and this field - must be ignored. - - @param CurrentY The unsigned position of the activation on the - x axis If the AboluteMinY and the AboluteMaxY - fields of the EFI_ABSOLUTE_POINTER_MODE - structure are both 0, then this pointer device - does not support an y-axis, and this field - must be ignored. - - @param CurrentZ The unsigned position of the activation on the - x axis, or the pressure measurement. If the - AboluteMinZ and the AboluteMaxZ fields of the - EFI_ABSOLUTE_POINTER_MODE structure are - both 0, then this pointer device does not - support an z-axis, and this field must be - ignored. - - @param ActiveButtons Bits are set to 1 in this structure item - to indicate that device buttons are - active. - **/ typedef struct { + /// + /// The unsigned position of the activation on the x axis. If the AboluteMinX + /// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are + /// both 0, then this pointer device does not support an x-axis, and this field + /// must be ignored. + /// UINT64 CurrentX; + + /// + /// The unsigned position of the activation on the y axis. If the AboluteMinY + /// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are + /// both 0, then this pointer device does not support an y-axis, and this field + /// must be ignored. + /// UINT64 CurrentY; + + /// + /// The unsigned position of the activation on the z axis, or the pressure + /// measurement. If the AboluteMinZ and the AboluteMaxZ fields of the + /// 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; + + /// + /// Bits are set to 1 in this structure item to indicate that device buttons are + /// active. + /// UINT32 ActiveButtons; } EFI_ABSOLUTE_POINTER_STATE; @@ -203,36 +171,29 @@ typedef struct { typedef EFI_STATUS (EFIAPI *EFI_ABSOLUTE_POINTER_GET_STATE)( - IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, - IN OUT EFI_ABSOLUTE_POINTER_STATE *State + IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, + IN OUT EFI_ABSOLUTE_POINTER_STATE *State ); -/** - @par Protocol Description: - The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services - for a pointer device that can be used as an input device from an - application written to this specification. The services include - the ability to reset the pointer device, retrieve the state of - the pointer device, and retrieve the capabilities of the pointer - device. In addition certain data items describing the device are - provided. - - - @param Reset Resets the pointer device. - - @param GetState Retrieves the current state of the pointer - device. - - @param WaitForInput Event to use with WaitForEvent() to wait - for input from the pointer device. - @param Mode Pointer to EFI_ABSOLUTE_POINTER_MODE data. - -**/ +/// +/// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services +/// for a pointer device that can be used as an input device from an +/// application written to this specification. The services include +/// the ability to: reset the pointer device, retrieve the state of +/// the pointer device, and retrieve the capabilities of the pointer +/// 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; + /// + /// Event to use with WaitForEvent() to wait for input from the pointer device. + /// EFI_EVENT WaitForInput; + /// + /// Pointer to EFI_ABSOLUTE_POINTER_MODE data. + /// EFI_ABSOLUTE_POINTER_MODE *Mode; };