mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-27 07:34:06 +02:00
1. Add Partial Keystroke Support definition in SimpleTextInputEx.h See the Uefi2.3.1a chapter 11.2
Signed-off-by: qianouyang Reviewed-by: niruiyu vanjeff git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12493 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
ec2b081a9c
commit
e791cf4449
@ -1,18 +1,18 @@
|
|||||||
/** @file
|
/** @file
|
||||||
Simple Text Input Ex protocol from the UEFI 2.0 specification.
|
Simple Text Input Ex protocol from the UEFI 2.0 specification.
|
||||||
|
|
||||||
This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
|
This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL
|
||||||
which exposes much more state and modifier information from the input device,
|
which exposes much more state and modifier information from the input device,
|
||||||
also allows one to register a notification for a particular keystroke.
|
also allows one to register a notification for a particular keystroke.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
http://opensource.org/licenses/bsd-license.php
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
||||||
@ -47,7 +47,7 @@ typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTO
|
|||||||
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The device was reset.
|
@retval EFI_SUCCESS The device was reset.
|
||||||
|
|
||||||
@retval EFI_DEVICE_ERROR The device is not functioning
|
@retval EFI_DEVICE_ERROR The device is not functioning
|
||||||
correctly and could not be reset.
|
correctly and could not be reset.
|
||||||
|
|
||||||
@ -113,16 +113,17 @@ typedef struct {
|
|||||||
#define EFI_MENU_KEY_PRESSED 0x00000100
|
#define EFI_MENU_KEY_PRESSED 0x00000100
|
||||||
#define EFI_SYS_REQ_PRESSED 0x00000200
|
#define EFI_SYS_REQ_PRESSED 0x00000200
|
||||||
|
|
||||||
//
|
//
|
||||||
// Toggle state
|
// Toggle state
|
||||||
//
|
//
|
||||||
#define EFI_TOGGLE_STATE_VALID 0x80
|
#define EFI_TOGGLE_STATE_VALID 0x80
|
||||||
|
#define EFI_KEY_STATE_EXPOSED 0x40
|
||||||
#define EFI_SCROLL_LOCK_ACTIVE 0x01
|
#define EFI_SCROLL_LOCK_ACTIVE 0x01
|
||||||
#define EFI_NUM_LOCK_ACTIVE 0x02
|
#define EFI_NUM_LOCK_ACTIVE 0x02
|
||||||
#define EFI_CAPS_LOCK_ACTIVE 0x04
|
#define EFI_CAPS_LOCK_ACTIVE 0x04
|
||||||
|
|
||||||
//
|
//
|
||||||
// EFI Scan codes
|
// EFI Scan codes
|
||||||
//
|
//
|
||||||
#define SCAN_F11 0x0015
|
#define SCAN_F11 0x0015
|
||||||
#define SCAN_F12 0x0016
|
#define SCAN_F12 0x0016
|
||||||
@ -181,17 +182,17 @@ typedef struct {
|
|||||||
state information, and in those cases the high order bit in the
|
state information, and in those cases the high order bit in the
|
||||||
respective Toggle and Shift state fields should not be active.
|
respective Toggle and Shift state fields should not be active.
|
||||||
|
|
||||||
|
|
||||||
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
||||||
|
|
||||||
@param KeyData A pointer to a buffer that is filled in with
|
@param KeyData A pointer to a buffer that is filled in with
|
||||||
the keystroke state data for the key that was
|
the keystroke state data for the key that was
|
||||||
pressed.
|
pressed.
|
||||||
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The keystroke information was
|
@retval EFI_SUCCESS The keystroke information was
|
||||||
returned.
|
returned.
|
||||||
|
|
||||||
@retval EFI_NOT_READY There was no keystroke data available.
|
@retval EFI_NOT_READY There was no keystroke data available.
|
||||||
EFI_DEVICE_ERROR The keystroke
|
EFI_DEVICE_ERROR The keystroke
|
||||||
information was not returned due to
|
information was not returned due to
|
||||||
@ -209,13 +210,13 @@ EFI_STATUS
|
|||||||
/**
|
/**
|
||||||
The SetState() function allows the input device hardware to
|
The SetState() function allows the input device hardware to
|
||||||
have state settings adjusted.
|
have state settings adjusted.
|
||||||
|
|
||||||
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
||||||
|
|
||||||
@param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to
|
@param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to
|
||||||
set the state for the input device.
|
set the state for the input device.
|
||||||
|
|
||||||
|
|
||||||
@retval EFI_SUCCESS The device state was set appropriately.
|
@retval EFI_SUCCESS The device state was set appropriately.
|
||||||
|
|
||||||
@retval EFI_DEVICE_ERROR The device is not functioning
|
@retval EFI_DEVICE_ERROR The device is not functioning
|
||||||
@ -245,21 +246,21 @@ EFI_STATUS
|
|||||||
/**
|
/**
|
||||||
The RegisterKeystrokeNotify() function registers a function
|
The RegisterKeystrokeNotify() function registers a function
|
||||||
which will be called when a specified keystroke will occur.
|
which will be called when a specified keystroke will occur.
|
||||||
|
|
||||||
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
||||||
|
|
||||||
@param KeyData A pointer to a buffer that is filled in with
|
@param KeyData A pointer to a buffer that is filled in with
|
||||||
the keystroke information for the key that was
|
the keystroke information for the key that was
|
||||||
pressed.
|
pressed.
|
||||||
|
|
||||||
@param KeyNotificationFunction Points to the function to be
|
@param KeyNotificationFunction Points to the function to be
|
||||||
called when the key sequence
|
called when the key sequence
|
||||||
is typed specified by KeyData.
|
is typed specified by KeyData.
|
||||||
|
|
||||||
|
|
||||||
@param NotifyHandle Points to the unique handle assigned to
|
@param NotifyHandle Points to the unique handle assigned to
|
||||||
the registered notification.
|
the registered notification.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The device state was set
|
@retval EFI_SUCCESS The device state was set
|
||||||
appropriately.
|
appropriately.
|
||||||
|
|
||||||
@ -279,14 +280,14 @@ EFI_STATUS
|
|||||||
/**
|
/**
|
||||||
The UnregisterKeystrokeNotify() function removes the
|
The UnregisterKeystrokeNotify() function removes the
|
||||||
notification which was previously registered.
|
notification which was previously registered.
|
||||||
|
|
||||||
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
|
||||||
|
|
||||||
@param NotificationHandle The handle of the notification
|
@param NotificationHandle The handle of the notification
|
||||||
function being unregistered.
|
function being unregistered.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The device state was set appropriately.
|
@retval EFI_SUCCESS The device state was set appropriately.
|
||||||
|
|
||||||
@retval EFI_INVALID_PARAMETER The NotificationHandle is
|
@retval EFI_INVALID_PARAMETER The NotificationHandle is
|
||||||
invalid.
|
invalid.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user