iPXE
Data Structures | Defines | Typedefs | Functions | Variables
AbsolutePointer.h File Reference

The file provides services that allow information about an absolute pointer device to be retrieved. More...

Go to the source code of this file.

Data Structures

struct  EFI_ABSOLUTE_POINTER_MODE
 The following data values in the EFI_ABSOLUTE_POINTER_MODE interface are read-only and are changed by using the appropriate interface functions. More...
struct  EFI_ABSOLUTE_POINTER_STATE
 Definition of EFI_ABSOLUTE_POINTER_STATE. More...
struct  _EFI_ABSOLUTE_POINTER_PROTOCOL
 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. More...

Defines

#define EFI_ABSOLUTE_POINTER_PROTOCOL_GUID   { 0x8D59D32B, 0xC655, 0x4AE9, { 0x9B, 0x15, 0xF2, 0x59, 0x04, 0x99, 0x2A, 0x43 } }
#define EFI_ABSP_SupportsAltActive   0x00000001
 If set, indicates this device supports an alternate button input.
#define EFI_ABSP_SupportsPressureAsZ   0x00000002
 If set, indicates this device returns pressure data in parameter CurrentZ.
#define EFI_ABSP_TouchActive   0x00000001
 This bit is set if the touch sensor is active.
#define EFI_ABS_AltActive   0x00000002
 This bit is set if the alt sensor, such as pen-side button, is active.

Typedefs

typedef struct
_EFI_ABSOLUTE_POINTER_PROTOCOL 
EFI_ABSOLUTE_POINTER_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_ABSOLUTE_POINTER_RESET )(IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
 This function resets the pointer device hardware.
typedef EFI_STATUS(EFIAPIEFI_ABSOLUTE_POINTER_GET_STATE )(IN EFI_ABSOLUTE_POINTER_PROTOCOL *This, IN OUT EFI_ABSOLUTE_POINTER_STATE *State)
 The GetState() function retrieves the current state of a pointer device.

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiAbsolutePointerProtocolGuid

Detailed Description

The file provides services that allow information about an absolute pointer device to be retrieved.

Copyright (c) 2006 - 2012, 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.

Definition in file AbsolutePointer.h.


Define Documentation

#define EFI_ABSOLUTE_POINTER_PROTOCOL_GUID   { 0x8D59D32B, 0xC655, 0x4AE9, { 0x9B, 0x15, 0xF2, 0x59, 0x04, 0x99, 0x2A, 0x43 } }

Definition at line 22 of file AbsolutePointer.h.

#define EFI_ABSP_SupportsAltActive   0x00000001

If set, indicates this device supports an alternate button input.

Definition at line 57 of file AbsolutePointer.h.

#define EFI_ABSP_SupportsPressureAsZ   0x00000002

If set, indicates this device returns pressure data in parameter CurrentZ.

Definition at line 62 of file AbsolutePointer.h.

#define EFI_ABSP_TouchActive   0x00000001

This bit is set if the touch sensor is active.

Definition at line 100 of file AbsolutePointer.h.

#define EFI_ABS_AltActive   0x00000002

This bit is set if the alt sensor, such as pen-side button, is active.

Definition at line 105 of file AbsolutePointer.h.


Typedef Documentation

Definition at line 26 of file AbsolutePointer.h.

This function resets the pointer device hardware.

As part of initialization process, the firmware/device will make a quick but reasonable attempt to verify that the device is functioning. If the ExtendedVerification flag is TRUE the firmware may take an extended amount of time to verify the device is operating on reset. Otherwise the reset operation is to occur as quickly as possible. The hardware verification process is not defined by this specification and is left up to the platform firmware or driver to implement.

Parameters:
ThisA pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.
ExtendedVerificationIndicates that the driver may perform a more exhaustive verification operation of the device during reset.
Return values:
EFI_SUCCESSThe device was reset.
EFI_DEVICE_ERRORThe device is not functioning correctly and could not be reset.

Definition at line 92 of file AbsolutePointer.h.

The GetState() function retrieves the current state of a pointer device.

This includes information on the active state associated with the pointer device and the current position of the axes associated with the pointer device. If the state of the pointer device has not changed since the last call to GetState(), then EFI_NOT_READY is returned. If the state of the pointer device has changed since the last call to GetState(), then the state information is placed in State, and EFI_SUCCESS is returned. If a device error occurs while attempting to retrieve the state information, then EFI_DEVICE_ERROR is returned.

Parameters:
ThisA pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL instance.
StateA pointer to the state information on the pointer device.
Return values:
EFI_SUCCESSThe state of the pointer device was returned in State.
EFI_NOT_READYThe state of the pointer device has not changed since the last call to GetState().
EFI_DEVICE_ERRORA device error occurred while attempting to retrieve the pointer device's current state.

Definition at line 175 of file AbsolutePointer.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation