EfiKey.h

Go to the documentation of this file.

 
#ifndef _EFI_USB_KB_H_
#define _EFI_USB_KB_H_
 
#include <Uefi.h>
 
#include <IndustryStandard/AppleHid.h>
 
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>
#include <Protocol/UsbIo.h>
#include <Protocol/DevicePath.h>
#include <Protocol/AppleKeyMapDatabase.h>
#include <Protocol/ApplePlatformInfoDatabase.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 <IndustryStandard/Usb.h>
 
#define KEYBOARD_TIMER_INTERVAL  200000         // 0.02s
 
#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
 
typedef struct {
  BOOLEAN    Down;
  UINT8      KeyCode;
} USB_KEY;
 
typedef struct {
  VOID     *Buffer[MAX_KEY_ALLOWED + 1];
  UINTN    Head;
  UINTN    Tail;
  UINTN    ItemSize;
} USB_SIMPLE_QUEUE;
 
#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')
 
typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {
  UINTN                      Signature;
  EFI_KEY_DATA               KeyData;
  EFI_KEY_NOTIFY_FUNCTION    KeyNotificationFn;
  LIST_ENTRY                 NotifyEntry;
} KEYBOARD_CONSOLE_IN_EX_NOTIFY;
 
#define USB_NS_KEY_SIGNATURE  SIGNATURE_32 ('u', 'n', 's', 'k')
 
typedef struct {
  UINTN                 Signature;
  LIST_ENTRY            Link;
 
  //
  // The number of EFI_NS_KEY_MODIFIER children definitions
  //
  UINTN                 KeyCount;
 
  //
  // NsKey[0] : Non-spacing key
  // NsKey[1] ~ NsKey[KeyCount] : Physical keys
  //
  EFI_KEY_DESCRIPTOR    *NsKey;
} USB_NS_KEY;
 
#define USB_NS_KEY_FORM_FROM_LINK(a)  CR (a, USB_NS_KEY, Link, USB_NS_KEY_SIGNATURE)
 
typedef struct {
  UINTN                                Signature;
  EFI_HANDLE                           ControllerHandle;
  EFI_DEVICE_PATH_PROTOCOL             *DevicePath;
  EFI_EVENT                            DelayedRecoveryEvent;
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL       SimpleInput;
  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL    SimpleInputEx;
  EFI_USB_IO_PROTOCOL                  *UsbIo;
 
  EFI_USB_INTERFACE_DESCRIPTOR         InterfaceDescriptor;
  EFI_USB_ENDPOINT_DESCRIPTOR          IntEndpointDescriptor;
 
  USB_SIMPLE_QUEUE                     UsbKeyQueue;
  USB_SIMPLE_QUEUE                     EfiKeyQueue;
  USB_SIMPLE_QUEUE                     EfiKeyQueueForNotify;
  BOOLEAN                              CtrlOn;
  BOOLEAN                              AltOn;
  BOOLEAN                              ShiftOn;
  BOOLEAN                              NumLockOn;
  BOOLEAN                              CapsOn;
  BOOLEAN                              ScrollOn;
  UINT8                                LastKeyCodeArray[8];
  UINT8                                CurKeyCode;
 
  EFI_EVENT                            TimerEvent;
 
  UINT8                                RepeatKey;
  EFI_EVENT                            RepeatTimer;
 
  EFI_UNICODE_STRING_TABLE             *ControllerNameTable;
 
  BOOLEAN                              LeftCtrlOn;
  BOOLEAN                              LeftAltOn;
  BOOLEAN                              LeftShiftOn;
  BOOLEAN                              LeftLogoOn;
  BOOLEAN                              RightCtrlOn;
  BOOLEAN                              RightAltOn;
  BOOLEAN                              RightShiftOn;
  BOOLEAN                              RightLogoOn;
  BOOLEAN                              MenuKeyOn;
  BOOLEAN                              SysReqOn;
  BOOLEAN                              AltGrOn;
 
  BOOLEAN                              IsSupportPartialKey;
 
  EFI_KEY_STATE                        KeyState;
  //
  // Notification function list
  //
  LIST_ENTRY                           NotifyList;
  EFI_EVENT                            KeyNotifyProcessEvent;
 
  //
  // Non-spacing key list
  //
  LIST_ENTRY                           NsKeyList;
  USB_NS_KEY                           *CurrentNsKey;
  EFI_KEY_DESCRIPTOR                   *KeyConvertionTable;
 
  APPLE_KEY_MAP_DATABASE_PROTOCOL      *KeyMapDb;
  UINTN                                KeyMapDbIndex;
 
  EFI_EVENT                            KeyMapInstallNotifyEvent;
  VOID                                 *KeyMapInstallRegistration;
 
  EFI_EVENT                            ExitBootServicesEvent;
} USB_KB_DEV;
 
//
// Global Variables
//
extern EFI_DRIVER_BINDING_PROTOCOL   gUsbKeyboardDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL   gUsbKeyboardComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gUsbKeyboardComponentName2;
 
#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)
 
//
// According to Universal Serial Bus HID Usage Tables document ver 1.12,
// a Boot Keyboard should support the keycode range from 0x0 to 0x65 and 0xE0 to 0xE7.
// 0xE0 to 0xE7 are for modifier keys, and 0x0 to 0x3 are reserved for typical
// keyboard status or keyboard errors.
// So the number of valid non-modifier USB keycodes is 0x62, and the number of
// valid keycodes is 0x6A.
//
#define NUMBER_OF_VALID_NON_MODIFIER_USB_KEYCODE  0x62
#define NUMBER_OF_VALID_USB_KEYCODE               0x6A
//
// 0x0 to 0x3 are reserved for typical keyboard status or keyboard errors.
//
#define USBKBD_VALID_KEYCODE(Key)  ((UINT8) (Key) > 3)
 
typedef struct {
  UINT8    NumLock    : 1;
  UINT8    CapsLock   : 1;
  UINT8    ScrollLock : 1;
  UINT8    Resrvd     : 5;
} LED_MAP;
 
//
// Functions of Driver Binding Protocol
//
 
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 Component Name Functions
//
 
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
  );
 
//
// Functions of Simple Text Input Protocol
//
 
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
  );
 
//
// Simple Text Input Ex protocol functions
//
 
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
USBKeyboardExitBootServices (
  IN  EFI_EVENT  Event,
  IN  VOID       *Context
  );
 
VOID
EFIAPI
KeyNotifyProcessHandler (
  IN  EFI_EVENT  Event,
  IN  VOID       *Context
  );
 
#endif