#include "VirtualKeyboard.h"

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	Enqueue (IN SIMPLE_QUEUE Queue, IN EFI_KEY_DATA KeyData)

EFI_STATUS	Dequeue (IN SIMPLE_QUEUE Queue, IN EFI_KEY_DATA KeyData)

EFI_STATUS	CheckQueue (IN SIMPLE_QUEUE *Queue)

EFI_STATUS EFIAPI	VirtualKeyboardCheckForKey (IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This)

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)

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	KeyboardReadKeyStrokeWorker (IN VIRTUAL_KEYBOARD_DEV VirtualKeyboardPrivate, OUT EFI_KEY_DATA KeyData)

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)

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)

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

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

EFI_STATUS EFIAPI	InitializeVirtualKeyboard (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gVirtualKeyboardDriverBinding

Detailed Description

VirtualKeyboard driver

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

Definition in file VirtualKeyboard.c.

Function Documentation

◆ CheckQueue()

EFI_STATUS CheckQueue ( IN SIMPLE_QUEUE * Queue )

Check whether the queue is empty.

Parameters

Queue The queue to be checked.

Return values

EFI_NOT_READY	The queue is empty.
EFI_SUCCESS	The queue is not empty.

Definition at line 366 of file VirtualKeyboard.c.

◆ Dequeue()

EFI_STATUS Dequeue	(	IN SIMPLE_QUEUE *	Queue,
		IN EFI_KEY_DATA *	KeyData
	)

Dequeue the key.

Parameters

Queue	The queue to be dequeued.
KeyData	The key data to be dequeued.

Return values

EFI_NOT_READY	The queue is empty.
EFI_SUCCESS	Successfully dequeued the key data.

Definition at line 341 of file VirtualKeyboard.c.

◆ Enqueue()

EFI_STATUS Enqueue	(	IN SIMPLE_QUEUE *	Queue,
		IN EFI_KEY_DATA *	KeyData
	)

Enqueue the key.

Parameters

Queue	The queue to be enqueued.
KeyData	The key data to be enqueued.

Return values

EFI_NOT_READY	The queue is full.
EFI_SUCCESS	Successfully enqueued the key data.

Definition at line 315 of file VirtualKeyboard.c.

◆ InitializeVirtualKeyboard()

EFI_STATUS EFIAPI InitializeVirtualKeyboard	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The user Entry Point for module VirtualKeyboard. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 1143 of file VirtualKeyboard.c.

◆ IsKeyRegistered()

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

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.

Definition at line 448 of file VirtualKeyboard.c.

◆ KeyboardReadKeyStrokeWorker()

EFI_STATUS KeyboardReadKeyStrokeWorker	(	IN VIRTUAL_KEYBOARD_DEV *	VirtualKeyboardPrivate,
		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

VirtualKeyboardPrivate	Virtualkeyboard driver private structure.
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.

Definition at line 646 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.

◆ VirtualKeyboardCheckForKey()

EFI_STATUS EFIAPI VirtualKeyboardCheckForKey ( IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL * This )

Check key buffer to get the key stroke status.

Parameters

This	Pointer of the protocol EFI_SIMPLE_TEXT_IN_PROTOCOL.

Return values

EFI_SUCCESS	A key is being pressed now.
Other	No key is now pressed.

Definition at line 388 of file VirtualKeyboard.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 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
	)

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
	)

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

◆ gVirtualKeyboardDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gVirtualKeyboardDriverBinding

Initial value:

= {
  VirtualKeyboardDriverBindingSupported,
  VirtualKeyboardDriverBindingStart,
  VirtualKeyboardDriverBindingStop,
  0x10,
  NULL,
  NULL
}

Definition at line 16 of file VirtualKeyboard.c.

Functions

Variables

Detailed Description

Function Documentation

◆ CheckQueue()

◆ Dequeue()

◆ Enqueue()

◆ InitializeVirtualKeyboard()

◆ IsKeyRegistered()

◆ KeyboardReadKeyStrokeWorker()

◆ KeyNotifyProcessHandler()

◆ VirtualKeyboardCheckForKey()

◆ VirtualKeyboardDriverBindingStart()

◆ VirtualKeyboardDriverBindingStop()

◆ VirtualKeyboardDriverBindingSupported()

◆ VirtualKeyboardFreeNotifyList()

◆ VirtualKeyboardReadKeyStroke()

◆ VirtualKeyboardReadKeyStrokeEx()

◆ VirtualKeyboardRegisterKeyNotify()

◆ VirtualKeyboardReset()

◆ VirtualKeyboardResetEx()

◆ VirtualKeyboardSetState()

◆ VirtualKeyboardTimerHandler()

◆ VirtualKeyboardUnregisterKeyNotify()

◆ VirtualKeyboardWaitForKey()

◆ VirtualKeyboardWaitForKeyEx()

Variable Documentation

◆ gVirtualKeyboardDriverBinding