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

Simple Pointer protocol from the UEFI 2.0 specification. More...

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
 The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer device that can use used as an input device from an application written to this specification. More...

Defines

#define EFI_SIMPLE_POINTER_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SIMPLE_POINTER_PROTOCOL 
EFI_SIMPLE_POINTER_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_SIMPLE_POINTER_RESET )(IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN BOOLEAN ExtendedVerification)
 Resets the pointer device hardware.
typedef EFI_STATUS(EFIAPIEFI_SIMPLE_POINTER_GET_STATE )(IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN OUT EFI_SIMPLE_POINTER_STATE *State)
 Retrieves the current state of a pointer device.

Functions

 FILE_LICENCE (BSD3)

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 - 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.

Definition in file SimplePointer.h.


Define Documentation

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

Definition at line 22 of file SimplePointer.h.


Typedef Documentation

Definition at line 27 of file SimplePointer.h.

Resets the pointer device hardware.

Parameters:
ThisA pointer to the EFI_SIMPLE_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 97 of file SimplePointer.h.

Retrieves the current state of a pointer device.

Parameters:
ThisA pointer to the EFI_SIMPLE_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 118 of file SimplePointer.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation