SimplePointer.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_SIMPLE_POINTER_STATE
struct	EFI_SIMPLE_POINTER_MODE
struct	_EFI_SIMPLE_POINTER_PROTOCOL

Macros
#define	EFI_SIMPLE_POINTER_PROTOCOL_GUID

Typedefs
typedef struct _EFI_SIMPLE_POINTER_PROTOCOL	EFI_SIMPLE_POINTER_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_SIMPLE_POINTER_RESET) (IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
typedef EFI_STATUS(EFIAPI *	EFI_SIMPLE_POINTER_GET_STATE) (IN EFI_SIMPLE_POINTER_PROTOCOL *This, OUT EFI_SIMPLE_POINTER_STATE *State)

Variables
EFI_GUID	gEfiSimplePointerProtocolGuid

Detailed Description

Simple Pointer protocol from the UEFI 2.0 specification.

Abstraction of a very simple pointer device like a mouse or trackball.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SimplePointer.h.

Macro Definition Documentation

EFI_SIMPLE_POINTER_PROTOCOL_GUID

#define EFI_SIMPLE_POINTER_PROTOCOL_GUID

Value:

  { \
    0x31878c87, 0xb75, 0x11d5, {0x9a, 0x4f, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

Definition at line 14 of file SimplePointer.h.

Typedef Documentation

EFI_SIMPLE_POINTER_GET_STATE

typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_POINTER_GET_STATE) (IN EFI_SIMPLE_POINTER_PROTOCOL *This, OUT EFI_SIMPLE_POINTER_STATE *State)

Retrieves the current state of a pointer device.

Parameters

This	A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
State	A pointer to the state information on the pointer device.

Return values

EFI_SUCCESS	The state of the pointer device was returned in State.
EFI_NOT_READY	The state of the pointer device has not changed since the last call to GetState().
EFI_DEVICE_ERROR	A device error occurred while attempting to retrieve the pointer device's current state.

Definition at line 109 of file SimplePointer.h.

EFI_SIMPLE_POINTER_PROTOCOL

typedef struct _EFI_SIMPLE_POINTER_PROTOCOL EFI_SIMPLE_POINTER_PROTOCOL

Definition at line 19 of file SimplePointer.h.

EFI_SIMPLE_POINTER_RESET

typedef EFI_STATUS(EFIAPI * EFI_SIMPLE_POINTER_RESET) (IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

Resets the pointer device hardware.

Parameters

This	A pointer to the EFI_SIMPLE_POINTER_PROTOCOL instance.
ExtendedVerification	Indicates that the driver may perform a more exhaustive verification operation of the device during reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning correctly and could not be reset.

Definition at line 88 of file SimplePointer.h.