#include <Uefi.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>
#include <Protocol/HiiDatabase.h>
#include <Protocol/UsbIo.h>
#include <Protocol/DevicePath.h>
#include <Guid/HiiKeyBoardLayout.h>
#include <Guid/UsbKeyBoardLayout.h>
#include <Library/DebugLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>
#include <Library/UefiUsbLib.h>
#include <Library/HiiLib.h>
#include <IndustryStandard/Usb.h>

Data Structures
struct	USB_KEY

struct	USB_SIMPLE_QUEUE

struct	_KEYBOARD_CONSOLE_IN_EX_NOTIFY

struct	USB_NS_KEY

struct	USB_KB_DEV

struct	LED_MAP

Macros
#define	KEYBOARD_TIMER_INTERVAL 200000

#define	MAX_KEY_ALLOWED 32

#define	HZ 1000 * 1000 * 10

#define	USBKBD_REPEAT_DELAY ((HZ) / 2)

#define	USBKBD_REPEAT_RATE ((HZ) / 50)

#define	CLASS_HID 3

#define	SUBCLASS_BOOT 1

#define	PROTOCOL_KEYBOARD 1

#define	BOOT_PROTOCOL 0

#define	REPORT_PROTOCOL 1

#define	USB_KB_DEV_SIGNATURE SIGNATURE_32 ('u', 'k', 'b', 'd')

#define	USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('u', 'k', 'b', 'x')

#define	USB_NS_KEY_SIGNATURE SIGNATURE_32 ('u', 'n', 's', 'k')

#define	USB_NS_KEY_FORM_FROM_LINK(a) CR (a, USB_NS_KEY, Link, USB_NS_KEY_SIGNATURE)

#define	USB_KB_DEV_FROM_THIS(a) CR(a, USB_KB_DEV, SimpleInput, USB_KB_DEV_SIGNATURE)

#define	TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS(a) CR(a, USB_KB_DEV, SimpleInputEx, USB_KB_DEV_SIGNATURE)

#define	NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE 0x62

#define	NUMBER_OF_VALID_USB_KEYCODE 0x6A

#define	USBKBD_VALID_KEYCODE(Key) ((UINT8) (Key) > 3)

Typedefs
typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY	KEYBOARD_CONSOLE_IN_EX_NOTIFY

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

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

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

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

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

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

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

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

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

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

EFI_STATUS EFIAPI	USBKeyboardRegisterKeyNotify (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	USBKeyboardUnregisterKeyNotify (IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL This, IN VOID NotificationHandle)

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

EFI_STATUS	KbdFreeNotifyList (IN OUT LIST_ENTRY *NotifyList)

BOOLEAN	IsKeyRegistered (IN EFI_KEY_DATA RegsiteredData, IN EFI_KEY_DATA InputData)

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

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

Variables
EFI_DRIVER_BINDING_PROTOCOL	gUsbKeyboardDriverBinding

EFI_COMPONENT_NAME_PROTOCOL	gUsbKeyboardComponentName

EFI_COMPONENT_NAME2_PROTOCOL	gUsbKeyboardComponentName2

Detailed Description

Header file for USB Keyboard Driver's Data Structures.

Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EfiKey.h.

Macro Definition Documentation

◆ BOOT_PROTOCOL

#define BOOT_PROTOCOL 0

Definition at line 49 of file EfiKey.h.

◆ CLASS_HID

#define CLASS_HID 3

Definition at line 45 of file EfiKey.h.

◆ HZ

#define HZ 1000 * 1000 * 10

Definition at line 41 of file EfiKey.h.

◆ KEYBOARD_TIMER_INTERVAL

#define KEYBOARD_TIMER_INTERVAL 200000

Definition at line 37 of file EfiKey.h.

◆ MAX_KEY_ALLOWED

#define MAX_KEY_ALLOWED 32

Definition at line 39 of file EfiKey.h.

◆ NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE

#define NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE 0x62

Definition at line 178 of file EfiKey.h.

◆ NUMBER_OF_VALID_USB_KEYCODE

#define NUMBER_OF_VALID_USB_KEYCODE 0x6A

Definition at line 179 of file EfiKey.h.

◆ PROTOCOL_KEYBOARD

#define PROTOCOL_KEYBOARD 1

Definition at line 47 of file EfiKey.h.

◆ REPORT_PROTOCOL

#define REPORT_PROTOCOL 1

Definition at line 50 of file EfiKey.h.

◆ SUBCLASS_BOOT

#define SUBCLASS_BOOT 1

Definition at line 46 of file EfiKey.h.

◆ TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS

#define TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS ( a ) CR(a, USB_KB_DEV, SimpleInputEx, USB_KB_DEV_SIGNATURE)

Definition at line 167 of file EfiKey.h.

◆ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE

#define USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('u', 'k', 'b', 'x')

Definition at line 65 of file EfiKey.h.

◆ USB_KB_DEV_FROM_THIS

#define USB_KB_DEV_FROM_THIS ( a ) CR(a, USB_KB_DEV, SimpleInput, USB_KB_DEV_SIGNATURE)

Definition at line 165 of file EfiKey.h.

◆ USB_KB_DEV_SIGNATURE

#define USB_KB_DEV_SIGNATURE SIGNATURE_32 ('u', 'k', 'b', 'd')

Definition at line 64 of file EfiKey.h.

◆ USB_NS_KEY_FORM_FROM_LINK

#define USB_NS_KEY_FORM_FROM_LINK ( a ) CR (a, USB_NS_KEY, Link, USB_NS_KEY_SIGNATURE)

Definition at line 92 of file EfiKey.h.

◆ USB_NS_KEY_SIGNATURE

#define USB_NS_KEY_SIGNATURE SIGNATURE_32 ('u', 'n', 's', 'k')

Definition at line 74 of file EfiKey.h.

◆ USBKBD_REPEAT_DELAY

#define USBKBD_REPEAT_DELAY ((HZ) / 2)

Definition at line 42 of file EfiKey.h.

◆ USBKBD_REPEAT_RATE

#define USBKBD_REPEAT_RATE ((HZ) / 50)

Definition at line 43 of file EfiKey.h.

◆ USBKBD_VALID_KEYCODE

#define USBKBD_VALID_KEYCODE ( Key ) ((UINT8) (Key) > 3)

Definition at line 183 of file EfiKey.h.

Function Documentation

◆ IsKeyRegistered()

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

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 match a registered key.

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.

◆ KbdFreeNotifyList()

EFI_STATUS KbdFreeNotifyList ( IN OUT LIST_ENTRY * NotifyList )

Free keyboard notify list.

Parameters

NotifyList The keyboard notify list to free.

Return values

EFI_SUCCESS	Free the notify list successfully.
EFI_INVALID_PARAMETER	NotifyList is NULL.

Free the waiting key notify list.

Parameters

ListHead Pointer to list head

Return values

EFI_INVALID_PARAMETER	ListHead is NULL
EFI_SUCCESS	Success to free NotifyList

Definition at line 618 of file Ps2Keyboard.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.

◆ UsbKeyboardComponentNameGetControllerName()

EFI_STATUS EFIAPI UsbKeyboardComponentNameGetControllerName	(	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	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle	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	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	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	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 not a valid EFI_HANDLE.
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.

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	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
ControllerHandle	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	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	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	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 145 of file ComponentName.c.

◆ UsbKeyboardComponentNameGetDriverName()

EFI_STATUS EFIAPI UsbKeyboardComponentNameGetDriverName	(	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	A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance.
Language	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	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 70 of file ComponentName.c.

◆ USBKeyboardDriverBindingStart()

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

Starts the keyboard device with this driver.

This function produces Simple Text Input Protocol and Simple Text Input Ex Protocol, initializes the keyboard device, and submit Asynchronous Interrupt Transfer to manage this keyboard device.

Parameters

This	The USB keyboard 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 usb keyboard driver.
EFI_UNSUPPORTED	No interrupt endpoint can be found.
Other	This controller cannot be started.

Definition at line 135 of file EfiKey.c.

◆ USBKeyboardDriverBindingStop()

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

Stop the USB keyboard device handled by this driver.

Parameters

This	The USB keyboard 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_UNSUPPORTED	Simple Text In Protocol or Simple Text In Ex Protocol is not installed on Controller.
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 483 of file EfiKey.c.

◆ USBKeyboardDriverBindingSupported()

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

Check whether USB keyboard driver supports this device.

Parameters

This	The USB keyboard driver 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 72 of file EfiKey.c.

◆ USBKeyboardReadKeyStroke()

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

Reads the next keystroke from the input device.

Parameters

This	The EFI_SIMPLE_TEXT_INPUT_PROTOCOL instance.
Key	A pointer to a buffer that is filled in with the keystroke information 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_UNSUPPORTED	The device does not support the ability to read keystroke data.

Definition at line 700 of file EfiKey.c.

◆ USBKeyboardReadKeyStrokeEx()

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

Reads the next keystroke from the input device.

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 984 of file EfiKey.c.

◆ USBKeyboardRegisterKeyNotify()

EFI_STATUS EFIAPI USBKeyboardRegisterKeyNotify	(	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 for the key that was pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState are 0, then any incomplete keystroke will trigger a notification of the KeyNotificationFunction.
KeyNotificationFunction	Points to the function to be called when the key sequence is typed specified by KeyData. This notification function should be called at <=TPL_CALLBACK.
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 or KeyNotificationFunction is NULL.

Definition at line 1088 of file EfiKey.c.

◆ USBKeyboardReset()

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

Reset the input device and optionally run diagnostics

There are 2 types of reset for USB keyboard. For non-exhaustive reset, only keyboard buffer is cleared. For exhaustive reset, in addition to clearance of keyboard buffer, the hardware status is also re-initialized.

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 637 of file EfiKey.c.

◆ USBKeyboardResetEx()

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

Resets the input device hardware.

The Reset() function resets the input device hardware. As part of initialization process, the firmware/device will make a quick but reasonable attempt to verify that the device is functioning. If the ExtendedVerification flag is TRUE the firmware may take an extended amount of time to verify the device is operating on reset. Otherwise the reset operation is to occur as quickly as possible. The hardware verification process is not defined by this specification and is left up to the platform firmware or driver to implement.

Parameters

This	A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.
ExtendedVerification	Indicates that the driver may perform a more exhaustive verification operation of the device during reset.

Return values

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

Definition at line 946 of file EfiKey.c.

◆ USBKeyboardSetState()

EFI_STATUS EFIAPI USBKeyboardSetState	(	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 appropriately.
EFI_DEVICE_ERROR	The device is not functioning correctly and could not have the setting adjusted.
EFI_UNSUPPORTED	The device does not support the ability to have its state set.
EFI_INVALID_PARAMETER	KeyToggleState is NULL.

Definition at line 1016 of file EfiKey.c.

◆ USBKeyboardTimerHandler()

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

Timer handler to convert the key from USB.

Parameters

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

Definition at line 810 of file EfiKey.c.

◆ USBKeyboardUnregisterKeyNotify()

EFI_STATUS EFIAPI USBKeyboardUnregisterKeyNotify	(	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
EFI_NOT_FOUND	Cannot find the matching entry in database.

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 1160 of file EfiKey.c.

◆ USBKeyboardWaitForKey()

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

Event notification function registered for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey.

Parameters

Event	Event to be signaled when a key is pressed.
Context	Points to USB_KB_DEV instance.

Definition at line 756 of file EfiKey.c.

Variable Documentation

◆ gUsbKeyboardComponentName

EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName

extern

Definition at line 14 of file ComponentName.c.

◆ gUsbKeyboardComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gUsbKeyboardComponentName2

extern

Definition at line 23 of file ComponentName.c.

◆ gUsbKeyboardDriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding

extern

Definition at line 16 of file EfiKey.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BOOT_PROTOCOL

◆ CLASS_HID

◆ HZ

◆ KEYBOARD_TIMER_INTERVAL

◆ MAX_KEY_ALLOWED

◆ NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE

◆ NUMBER_OF_VALID_USB_KEYCODE

◆ PROTOCOL_KEYBOARD

◆ REPORT_PROTOCOL

◆ SUBCLASS_BOOT

◆ TEXT_INPUT_EX_USB_KB_DEV_FROM_THIS

◆ USB_KB_CONSOLE_IN_EX_NOTIFY_SIGNATURE

◆ USB_KB_DEV_FROM_THIS

◆ USB_KB_DEV_SIGNATURE

◆ USB_NS_KEY_FORM_FROM_LINK

◆ USB_NS_KEY_SIGNATURE

◆ USBKBD_REPEAT_DELAY

◆ USBKBD_REPEAT_RATE

◆ USBKBD_VALID_KEYCODE

Function Documentation

◆ IsKeyRegistered()

◆ KbdFreeNotifyList()

◆ KeyNotifyProcessHandler()

◆ UsbKeyboardComponentNameGetControllerName()

◆ UsbKeyboardComponentNameGetDriverName()

◆ USBKeyboardDriverBindingStart()

◆ USBKeyboardDriverBindingStop()

◆ USBKeyboardDriverBindingSupported()

◆ USBKeyboardReadKeyStroke()

◆ USBKeyboardReadKeyStrokeEx()

◆ USBKeyboardRegisterKeyNotify()

◆ USBKeyboardReset()

◆ USBKeyboardResetEx()

◆ USBKeyboardSetState()

◆ USBKeyboardTimerHandler()

◆ USBKeyboardUnregisterKeyNotify()

◆ USBKeyboardWaitForKey()

Variable Documentation

◆ gUsbKeyboardComponentName

◆ gUsbKeyboardComponentName2

◆ gUsbKeyboardDriverBinding