1/*++
2
3Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>
4This program and the accompanying materials
5are licensed and made available under the terms and conditions of the BSD License
6which accompanies this distribution.  The full text of the license may be found at
7http://opensource.org/licenses/bsd-license.php
8
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12Module Name:
13
14  SimplePointer.h
15
16Abstract:
17
18  Simple Pointer protocol from the EFI 1.1 specification.
19
20  Abstraction of a very simple pointer device like a mice or tracekballs.
21
22--*/
23
24#ifndef _SIMPLE_POINTER_H_
25#define _SIMPLE_POINTER_H_
26
27#define EFI_SIMPLE_POINTER_PROTOCOL_GUID \
28  { \
29    0x31878c87, 0xb75, 0x11d5, {0x9a, 0x4f, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} \
30  }
31
32EFI_FORWARD_DECLARATION (EFI_SIMPLE_POINTER_PROTOCOL);
33
34//
35// Data structures
36//
37typedef struct {
38  INT32   RelativeMovementX;
39  INT32   RelativeMovementY;
40  INT32   RelativeMovementZ;
41  BOOLEAN LeftButton;
42  BOOLEAN RightButton;
43} EFI_SIMPLE_POINTER_STATE;
44
45typedef struct {
46  UINT64  ResolutionX;
47  UINT64  ResolutionY;
48  UINT64  ResolutionZ;
49  BOOLEAN LeftButton;
50  BOOLEAN RightButton;
51} EFI_SIMPLE_POINTER_MODE;
52
53typedef
54EFI_STATUS
55(EFIAPI *EFI_SIMPLE_POINTER_RESET) (
56  IN EFI_SIMPLE_POINTER_PROTOCOL            * This,
57  IN BOOLEAN                                ExtendedVerification
58  );
59
60typedef
61EFI_STATUS
62(EFIAPI *EFI_SIMPLE_POINTER_GET_STATE) (
63  IN EFI_SIMPLE_POINTER_PROTOCOL          * This,
64  IN OUT EFI_SIMPLE_POINTER_STATE         * State
65  );
66
67struct _EFI_SIMPLE_POINTER_PROTOCOL {
68  EFI_SIMPLE_POINTER_RESET      Reset;
69  EFI_SIMPLE_POINTER_GET_STATE  GetState;
70  EFI_EVENT                     WaitForInput;
71  EFI_SIMPLE_POINTER_MODE       *Mode;
72};
73
74extern EFI_GUID gEfiSimplePointerProtocolGuid;
75
76#endif
77