diff options
Diffstat (limited to 'MdePkg/Include/Protocol/SimplePointer.h')
-rw-r--r-- | MdePkg/Include/Protocol/SimplePointer.h | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h index 5ea6c05b7c..ff168b8d7b 100644 --- a/MdePkg/Include/Protocol/SimplePointer.h +++ b/MdePkg/Include/Protocol/SimplePointer.h @@ -3,14 +3,14 @@ Abstraction of a very simple pointer device like a mouse or trackball.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
- 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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+ 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.
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -78,17 +78,17 @@ typedef struct { BOOLEAN RightButton;
} EFI_SIMPLE_POINTER_MODE;
-/**
+/**
Resets the pointer device hardware.
-
+
@param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL
- instance.
+ instance.
@param ExtendedVerification Indicates that the driver may perform a more exhaustive
- verification operation of the device during reset.
-
+ verification operation of the device during reset.
+
@retval EFI_SUCCESS The device was reset.
- @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset.
-
+ @retval EFI_DEVICE_ERROR The device is not functioning correctly and could not be reset.
+
**/
typedef
EFI_STATUS
@@ -97,19 +97,19 @@ EFI_STATUS IN BOOLEAN ExtendedVerification
);
-/**
+/**
Retrieves the current state of a pointer device.
-
+
@param This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL
- instance.
+ instance.
@param State A pointer to the state information on the pointer device.
-
+
@retval EFI_SUCCESS The state of the pointer device was returned in State.
@retval EFI_NOT_READY The state of the pointer device has not changed since the last call to
- GetState().
+ GetState().
@retval EFI_DEVICE_ERROR A device error occurred while attempting to retrieve the pointer device's
- current state.
-
+ current state.
+
**/
typedef
EFI_STATUS
@@ -119,10 +119,10 @@ EFI_STATUS );
///
-/// 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. The services include the ability to reset the
-/// pointer device, retrieve get the state of the pointer device, and
+/// 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. The services include the ability to reset the
+/// pointer device, retrieve get the state of the pointer device, and
/// retrieve the capabilities of the pointer device.
///
struct _EFI_SIMPLE_POINTER_PROTOCOL {
|