MdePkg/Include/Protocol/SimplePointer.h File Reference


Data Structures

struct  EFI_SIMPLE_POINTER_STATE
struct  EFI_SIMPLE_POINTER_MODE
struct  _EFI_SIMPLE_POINTER_PROTOCOL

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)
typedef EFI_STATUS(EFIAPIEFI_SIMPLE_POINTER_GET_STATE )(IN EFI_SIMPLE_POINTER_PROTOCOL *This, IN 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 - 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.


Define Documentation

#define EFI_SIMPLE_POINTER_PROTOCOL_GUID

Value:

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


Typedef Documentation

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.

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.


Variable Documentation


Generated on Thu Sep 24 23:14:20 2015 for MdePkg[ALL] by  doxygen 1.5.7.1