#include <Guid/StatusCodeDataTypeId.h>
#include <Protocol/DevicePath.h>
#include <Protocol/PlatformVirtualKeyboard.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/IoLib.h>
#include <Library/PcdLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiLib.h>

Data Structures
struct	_VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY

struct	SIMPLE_QUEUE

struct	SCAN_CODE_QUEUE

struct	VIRTUAL_KEYBOARD_DEV

Macros
#define	CHAR_SCANCODE 0xe0

#define	CHAR_ESC 0x1b

#define	KEYBOARD_TIMEOUT 65536

#define	KEYBOARD_WAITFORVALUE_TIMEOUT 1000000

#define	KEYBOARD_BAT_TIMEOUT 4000000

#define	KEYBOARD_TIMER_INTERVAL 500000

#define	QUEUE_MAX_COUNT 32

#define	KEYBOARD_SCAN_CODE_MAX_COUNT 32

#define	VIRTUAL_KEYBOARD_DEV_SIGNATURE SIGNATURE_32 ('V', 'K', 'B', 'D')

#define	VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('v', 'k', 'c', 'n')

#define	VIRTUAL_KEYBOARD_DEV_FROM_THIS(a) CR (a, VIRTUAL_KEYBOARD_DEV, SimpleTextIn, VIRTUAL_KEYBOARD_DEV_SIGNATURE)

#define	TEXT_INPUT_EX_VIRTUAL_KEYBOARD_DEV_FROM_THIS(a)

Typedefs
typedef struct _VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY	VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY

Functions
EFI_STATUS EFIAPI	VirtualKeyboardDriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	VirtualKeyboardDriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath)

EFI_STATUS EFIAPI	VirtualKeyboardDriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer)

EFI_STATUS EFIAPI	VirtualKeyboardComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN CHAR8 Language, OUT CHAR16 **DriverName)

EFI_STATUS EFIAPI	VirtualKeyboardComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 Language, OUT CHAR16 **ControllerName)

EFI_STATUS EFIAPI	VirtualKeyboardReset (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	VirtualKeyboardResetEx (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This, IN BOOLEAN ExtendedVerification)

EFI_STATUS EFIAPI	VirtualKeyboardSetState (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL This, IN EFI_KEY_TOGGLE_STATE KeyToggleState)

EFI_STATUS EFIAPI	VirtualKeyboardRegisterKeyNotify (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL This, IN EFI_KEY_DATA KeyData, IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction, OUT VOID **NotifyHandle)

EFI_STATUS EFIAPI	VirtualKeyboardUnregisterKeyNotify (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL This, IN VOID NotificationHandle)

EFI_STATUS	VirtualKeyboardFreeNotifyList (IN OUT LIST_ENTRY *ListHead)

BOOLEAN	IsKeyRegistered (IN EFI_KEY_DATA RegsiteredData, IN EFI_KEY_DATA InputData)

VOID EFIAPI	VirtualKeyboardWaitForKey (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	VirtualKeyboardWaitForKeyEx (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	VirtualKeyboardTimerHandler (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	KeyNotifyProcessHandler (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	VirtualKeyboardReadKeyStroke (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL This, OUT EFI_INPUT_KEY Key)

EFI_STATUS EFIAPI	VirtualKeyboardReadKeyStrokeEx (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL This, OUT EFI_KEY_DATA KeyData)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gVirtualKeyboardDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	gVirtualKeyboardComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gVirtualKeyboardComponentName2

Detailed Description

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file VirtualKeyboard.h.

Macro Definition Documentation

◆ CHAR_ESC

#define CHAR_ESC 0x1b

Definition at line 41 of file VirtualKeyboard.h.

◆ CHAR_SCANCODE

#define CHAR_SCANCODE 0xe0

Definition at line 40 of file VirtualKeyboard.h.

◆ KEYBOARD_BAT_TIMEOUT

#define KEYBOARD_BAT_TIMEOUT 4000000

Definition at line 45 of file VirtualKeyboard.h.

◆ KEYBOARD_SCAN_CODE_MAX_COUNT

#define KEYBOARD_SCAN_CODE_MAX_COUNT 32

Definition at line 50 of file VirtualKeyboard.h.

◆ KEYBOARD_TIMEOUT

#define KEYBOARD_TIMEOUT 65536

Definition at line 43 of file VirtualKeyboard.h.

◆ KEYBOARD_TIMER_INTERVAL

#define KEYBOARD_TIMER_INTERVAL 500000

Definition at line 46 of file VirtualKeyboard.h.

◆ KEYBOARD_WAITFORVALUE_TIMEOUT

#define KEYBOARD_WAITFORVALUE_TIMEOUT 1000000

Definition at line 44 of file VirtualKeyboard.h.

◆ QUEUE_MAX_COUNT

#define QUEUE_MAX_COUNT 32

Definition at line 48 of file VirtualKeyboard.h.

◆ TEXT_INPUT_EX_VIRTUAL_KEYBOARD_DEV_FROM_THIS

#define TEXT_INPUT_EX_VIRTUAL_KEYBOARD_DEV_FROM_THIS ( a )

Value:

  CR (a, \
      VIRTUAL_KEYBOARD_DEV, \
      SimpleTextInputEx, \
      VIRTUAL_KEYBOARD_DEV_SIGNATURE \
      )

Definition at line 99 of file VirtualKeyboard.h.

◆ VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE

#define VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('v', 'k', 'c', 'n')

Definition at line 56 of file VirtualKeyboard.h.

◆ VIRTUAL_KEYBOARD_DEV_FROM_THIS

#define VIRTUAL_KEYBOARD_DEV_FROM_THIS ( a ) CR (a, VIRTUAL_KEYBOARD_DEV, SimpleTextIn, VIRTUAL_KEYBOARD_DEV_SIGNATURE)

Definition at line 98 of file VirtualKeyboard.h.

◆ VIRTUAL_KEYBOARD_DEV_SIGNATURE

#define VIRTUAL_KEYBOARD_DEV_SIGNATURE SIGNATURE_32 ('V', 'K', 'B', 'D')

Definition at line 55 of file VirtualKeyboard.h.

Function Documentation

◆ IsKeyRegistered()

BOOLEAN IsKeyRegistered	(	IN EFI_KEY_DATA *	RegsiteredData,
		IN EFI_KEY_DATA *	InputData
	)

Check if key is registered.

Parameters

RegsiteredData	A pointer to a buffer that is filled in with the keystroke state data for the key that was registered.
InputData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

TRUE	Key be pressed matches a registered key.
FALSE	Match failed.

Judge whether is a registed key

Parameters

RegsiteredData	A pointer to a buffer that is filled in with the keystroke state data for the key that was registered.
InputData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

TRUE	Key be pressed matches a registered key.
FALSE	Match failed.

Judge whether is a registered key

Parameters

RegsiteredData	A pointer to a buffer that is filled in with the keystroke state data for the key that was registered.
InputData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

TRUE	Key be pressed matches a registered key.
FALSE	Match failed.

Check whether the pressed key matches a registered key or not.

Parameters

RegsiteredData	A pointer to keystroke data for the key that was registered.
InputData	A pointer to keystroke data for the key that was pressed.

Return values

TRUE	Key pressed matches a registered key.
FALSE	Key pressed does not matches a registered key.

Test if the key has been registered on input device.

Parameters

RegsiteredData	A pointer to a buffer that is filled in with the keystroke state data for the key that was registered.
InputData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

TRUE	Key be pressed matches a registered key.
FALSE	Match failed.

Check if the key already has been registered.

If both RegsiteredData and InputData is NULL, then ASSERT().

Parameters

RegsiteredData	A pointer to a buffer that is filled in with the keystroke state data for the key that was registered.
InputData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

TRUE	Key be pressed matches a registered key.
FALSE	Match failed.

Definition at line 448 of file VirtualKeyboard.c.

◆ KeyNotifyProcessHandler()

VOID EFIAPI KeyNotifyProcessHandler	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Process key notify.

Parameters

Event	Indicates the event that invoke this function.
Context	Indicates the calling context.

Definition at line 1080 of file VirtualKeyboard.c.

◆ VirtualKeyboardComponentNameGetControllerName()

EFI_STATUS EFIAPI VirtualKeyboardComponentNameGetControllerName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_HANDLE ChildHandle	OPTIONAL,
		IN CHAR8 *	Language,
		OUT CHAR16 **	ControllerName
	)

Retrieves a Unicode string that is the user readable name of the controller that is being managed by a driver.

This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle[in]	The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be returned.
ChildHandle[in]	The handle of the child controller to retrieve the name of. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for a bus drivers that wish to retrieve the name of the bus controller. It will not be NULL for a bus driver that wishes to retrieve the name of a child controller.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
ControllerName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the controller specified by ControllerHandle and ChildHandle in the language specified by Language from the point of view of the driver specified by This.

Return values

EFI_SUCCESS	The Unicode string for the user readable name in the language specified by Language for the driver specified by This was returned in DriverName.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	ChildHandle is not NULL and it is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	ControllerName is NULL.
EFI_UNSUPPORTED	The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 171 of file ComponentName.c.

◆ VirtualKeyboardComponentNameGetDriverName()

EFI_STATUS EFIAPI VirtualKeyboardComponentNameGetDriverName	(	IN EFI_COMPONENT_NAME_PROTOCOL *	This,
		IN CHAR8 *	Language,
		OUT CHAR16 **	DriverName
	)

Retrieves a Unicode string that is the user readable name of the driver.

This function retrieves the user readable name of a driver in the form of a Unicode string. If the driver specified by This has a user readable name in the language specified by Language, then a pointer to the driver name is returned in DriverName, and EFI_SUCCESS is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.

Parameters

This[in]	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
Language[in]	A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name that the caller is requesting, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. Language is specified in RFC 4646 or ISO 639-2 language code format.
DriverName[out]	A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language specified by Language.

Return values

EFI_SUCCESS	The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName.
EFI_INVALID_PARAMETER	Language is NULL.
EFI_INVALID_PARAMETER	DriverName is NULL.
EFI_UNSUPPORTED	The driver specified by This does not support the language specified by Language.

Definition at line 86 of file ComponentName.c.

◆ VirtualKeyboardDriverBindingStart()

EFI_STATUS EFIAPI VirtualKeyboardDriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Starts the device with this driver.

Parameters

This	The driver binding instance.
Controller	Handle of device to bind driver to.
RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	The controller is controlled by the driver.
Other	This controller cannot be started.

Definition at line 86 of file VirtualKeyboard.c.

◆ VirtualKeyboardDriverBindingStop()

EFI_STATUS EFIAPI VirtualKeyboardDriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *	ChildHandleBuffer
	)

Stop the device handled by this driver.

Parameters

This	The driver binding protocol.
Controller	The controller to release.
NumberOfChildren	The number of handles in ChildHandleBuffer.
ChildHandleBuffer	The array of child handle.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.
Others	Fail to uninstall protocols attached on the device.

Definition at line 294 of file VirtualKeyboard.c.

◆ VirtualKeyboardDriverBindingSupported()

EFI_STATUS EFIAPI VirtualKeyboardDriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_DEVICE_PATH_PROTOCOL *	RemainingDevicePath
	)

Check whether the driver supports this device.

Parameters

This	The Udriver binding protocol.
Controller	The controller handle to check.
RemainingDevicePath	The remaining device path.

Return values

EFI_SUCCESS	The driver supports this controller.
other	This device isn't supported.

Definition at line 42 of file VirtualKeyboard.c.

◆ VirtualKeyboardFreeNotifyList()

EFI_STATUS VirtualKeyboardFreeNotifyList ( IN OUT LIST_ENTRY * ListHead )

Free keyboard notify list.

Parameters

ListHead The list head

Return values

EFI_SUCCESS	Free the notify list successfully
EFI_INVALID_PARAMETER	ListHead is invalid.

Definition at line 409 of file VirtualKeyboard.c.

◆ VirtualKeyboardReadKeyStroke()

EFI_STATUS EFIAPI VirtualKeyboardReadKeyStroke	(	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *	This,
		OUT EFI_INPUT_KEY *	Key
	)

Read out the scan code of the key that has just been stroked.

Parameters

This	Pointer of simple text Protocol.
Key	Pointer for store the key that read out.

Return values

EFI_SUCCESS	The key is read out successfully.
other	The key reading failed.
EFI_UNSUPPORTED	The device does not support the ability to read keystroke data.

Definition at line 707 of file VirtualKeyboard.c.

◆ VirtualKeyboardReadKeyStrokeEx()

EFI_STATUS EFIAPI VirtualKeyboardReadKeyStrokeEx	(	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	This,
		OUT EFI_KEY_DATA *	KeyData
	)

Reads the next keystroke from the input device. The WaitForKey Event can be used to test for existence of a keystroke via WaitForEvent () call.

Parameters

This	Protocol instance pointer.
KeyData	A pointer to a buffer that is filled in with the keystroke state data for the key that was pressed.

Return values

EFI_SUCCESS	The keystroke information was returned.
EFI_NOT_READY	There was no keystroke data available.
EFI_DEVICE_ERROR	The keystroke information was not returned due to hardware errors.
EFI_INVALID_PARAMETER	KeyData is NULL.
EFI_UNSUPPORTED	The device does not support the ability to read keystroke data.

Definition at line 761 of file VirtualKeyboard.c.

◆ VirtualKeyboardRegisterKeyNotify()

EFI_STATUS EFIAPI VirtualKeyboardRegisterKeyNotify	(	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	This,
		IN EFI_KEY_DATA *	KeyData,
		IN EFI_KEY_NOTIFY_FUNCTION	KeyNotificationFunction,
		OUT VOID **	NotifyHandle
	)

Register a notification function for a particular keystroke for the input device.

Parameters

This	Protocol instance pointer.
KeyData	A pointer to a buffer that is filled in with the keystroke information data for the key that was pressed.
KeyNotificationFunction	Points to the function to be called when the key sequence is typed specified by KeyData.
NotifyHandle	Points to the unique handle assigned to the registered notification.

Return values

EFI_SUCCESS	The notification function was registered successfully.
EFI_OUT_OF_RESOURCES	Unable to allocate resources for necessary data structures.
EFI_INVALID_PARAMETER	KeyData or NotifyHandle is NULL.

Definition at line 829 of file VirtualKeyboard.c.

◆ VirtualKeyboardReset()

EFI_STATUS EFIAPI VirtualKeyboardReset	(	IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the Keyboard and do BAT test for it, if (ExtendedVerification == TRUE) then do some extra keyboard validations.

Parameters

This	Pointer of simple text Protocol.
ExtendedVerification	Whether perform the extra validation of keyboard. True: perform; FALSE: skip.

Return values

EFI_SUCCESS	The command byte is written successfully.
EFI_DEVICE_ERROR	Errors occurred during resetting keyboard.

Definition at line 558 of file VirtualKeyboard.c.

◆ VirtualKeyboardResetEx()

EFI_STATUS EFIAPI VirtualKeyboardResetEx	(	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	This,
		IN BOOLEAN	ExtendedVerification
	)

Reset the input device and optionally run diagnostics

Parameters

This	Protocol instance pointer.
ExtendedVerification	Driver may perform diagnostics on reset.

Return values

EFI_SUCCESS	The device was reset.
EFI_DEVICE_ERROR	The device is not functioning properly and could not be reset.

Definition at line 603 of file VirtualKeyboard.c.

◆ VirtualKeyboardSetState()

EFI_STATUS EFIAPI VirtualKeyboardSetState	(	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	This,
		IN EFI_KEY_TOGGLE_STATE *	KeyToggleState
	)

Set certain state for the input device.

Parameters

This	Protocol instance pointer.
KeyToggleState	A pointer to the EFI_KEY_TOGGLE_STATE to set the state for the input device.

Return values

EFI_SUCCESS	The device state was set successfully.
EFI_DEVICE_ERROR	The device is not functioning correctly and could not have the setting adjusted.
EFI_UNSUPPORTED	The device does not have the ability to set its state.
EFI_INVALID_PARAMETER	KeyToggleState is NULL.

Definition at line 794 of file VirtualKeyboard.c.

◆ VirtualKeyboardTimerHandler()

VOID EFIAPI VirtualKeyboardTimerHandler	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Timer event handler: read a series of key stroke from 8042 and put them into memory key buffer. It is registered as running under TPL_NOTIFY

Parameters

Event	The timer event
Context	A VIRTUAL_KEYBOARD_DEV pointer

Timer event handler: read a series of scancodes from 8042 and put them into memory scancode buffer. it read as much scancodes to either fill the memory buffer or empty the keyboard buffer. It is registered as running under TPL_NOTIFY

Parameters

Event	The timer event
Context	A KEYBOARD_CONSOLE_IN_DEV pointer

Definition at line 998 of file VirtualKeyboard.c.

◆ VirtualKeyboardUnregisterKeyNotify()

EFI_STATUS EFIAPI VirtualKeyboardUnregisterKeyNotify	(	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *	This,
		IN VOID *	NotificationHandle
	)

Remove a registered notification function from a particular keystroke.

Parameters

This	Protocol instance pointer.
NotificationHandle	The handle of the notification function being unregistered.

Return values

EFI_SUCCESS	The notification function was unregistered successfully.
EFI_INVALID_PARAMETER	The NotificationHandle is invalid.

Definition at line 920 of file VirtualKeyboard.c.

◆ VirtualKeyboardWaitForKey()

VOID EFIAPI VirtualKeyboardWaitForKey	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Waiting on the keyboard event, if there's any key pressed by the user, signal the event

Parameters

Event	The event that be signalled when any key has been struck.
Context	Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_PROTOCOL.

Event notification function for SIMPLE_TEXT_IN.WaitForKey event Signal the event if there is key available

Parameters

Event	the event object
Context	waiting context

Definition at line 491 of file VirtualKeyboard.c.

◆ VirtualKeyboardWaitForKeyEx()

VOID EFIAPI VirtualKeyboardWaitForKeyEx	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Waiting on the keyboard event, if there's any key pressed by the user, signal the event

Parameters

Event	The event that be signalled when any key has been struck.
Context	Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.

Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event. Signal the event if there is key available

Parameters

Event	event object
Context	waiting context

Definition at line 528 of file VirtualKeyboard.c.

Variable Documentation

◆ gVirtualKeyboardComponentName

EFI_COMPONENT_NAME_PROTOCOL gVirtualKeyboardComponentName

extern

Definition at line 15 of file ComponentName.c.

◆ gVirtualKeyboardComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gVirtualKeyboardComponentName2

extern

Definition at line 24 of file ComponentName.c.

◆ gVirtualKeyboardDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gVirtualKeyboardDriverBinding

extern

Definition at line 109 of file VirtualKeyboard.h.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CHAR_ESC

◆ CHAR_SCANCODE

◆ KEYBOARD_BAT_TIMEOUT

◆ KEYBOARD_SCAN_CODE_MAX_COUNT

◆ KEYBOARD_TIMEOUT

◆ KEYBOARD_TIMER_INTERVAL

◆ KEYBOARD_WAITFORVALUE_TIMEOUT

◆ QUEUE_MAX_COUNT

◆ TEXT_INPUT_EX_VIRTUAL_KEYBOARD_DEV_FROM_THIS

◆ VIRTUAL_KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE

◆ VIRTUAL_KEYBOARD_DEV_FROM_THIS

◆ VIRTUAL_KEYBOARD_DEV_SIGNATURE

Function Documentation

◆ IsKeyRegistered()

◆ KeyNotifyProcessHandler()

◆ VirtualKeyboardComponentNameGetControllerName()

◆ VirtualKeyboardComponentNameGetDriverName()

◆ VirtualKeyboardDriverBindingStart()

◆ VirtualKeyboardDriverBindingStop()

◆ VirtualKeyboardDriverBindingSupported()

◆ VirtualKeyboardFreeNotifyList()

◆ VirtualKeyboardReadKeyStroke()

◆ VirtualKeyboardReadKeyStrokeEx()

◆ VirtualKeyboardRegisterKeyNotify()

◆ VirtualKeyboardReset()

◆ VirtualKeyboardResetEx()

◆ VirtualKeyboardSetState()

◆ VirtualKeyboardTimerHandler()

◆ VirtualKeyboardUnregisterKeyNotify()

◆ VirtualKeyboardWaitForKey()

◆ VirtualKeyboardWaitForKeyEx()

Variable Documentation

◆ gVirtualKeyboardComponentName

◆ gVirtualKeyboardComponentName2

◆ gVirtualKeyboardDriverBinding