KeyBoard.h

Go to the documentation of this file.

 
#ifndef _EFI_KEYBOARD_H_
#define _EFI_KEYBOARD_H_
 
#include "EfiKey.h"
 
#define USB_KEYBOARD_KEY_COUNT  105
 
#define USB_KEYBOARD_LANGUAGE_STR_LEN     5         // RFC4646 Language Code: "en-US"
#define USB_KEYBOARD_DESCRIPTION_STR_LEN  (16 + 1)  // Description: "English Keyboard"
 
#pragma pack (1)
typedef struct {
  //
  // This 4-bytes total array length is required by PreparePackageList()
  //
  UINT32                    Length;
 
  //
  // Keyboard Layout package definition
  //
  EFI_HII_PACKAGE_HEADER    PackageHeader;
  UINT16                    LayoutCount;
 
  //
  // EFI_HII_KEYBOARD_LAYOUT
  //
  UINT16                    LayoutLength;
  EFI_GUID                  Guid;
  UINT32                    LayoutDescriptorStringOffset;
  UINT8                     DescriptorCount;
  EFI_KEY_DESCRIPTOR        KeyDescriptor[USB_KEYBOARD_KEY_COUNT];
  UINT16                    DescriptionCount;
  CHAR16                    Language[USB_KEYBOARD_LANGUAGE_STR_LEN];
  CHAR16                    Space;
  CHAR16                    DescriptionString[USB_KEYBOARD_DESCRIPTION_STR_LEN];
} USB_KEYBOARD_LAYOUT_PACK_BIN;
#pragma pack()
 
BOOLEAN
IsUSBKeyboard (
  IN  EFI_USB_IO_PROTOCOL  *UsbIo
  );
 
EFI_STATUS
InitUSBKeyboard (
  IN OUT USB_KB_DEV  *UsbKeyboardDevice
  );
 
EFI_STATUS
InitKeyboardLayout (
  OUT USB_KB_DEV  *UsbKeyboardDevice
  );
 
VOID
ReleaseKeyboardLayoutResources (
  IN OUT USB_KB_DEV  *UsbKeyboardDevice
  );
 
EFI_STATUS
EFIAPI
KeyboardHandler (
  IN  VOID    *Data,
  IN  UINTN   DataLength,
  IN  VOID    *Context,
  IN  UINT32  Result
  );
 
VOID
EFIAPI
USBKeyboardRecoveryHandler (
  IN    EFI_EVENT  Event,
  IN    VOID       *Context
  );
 
EFI_STATUS
USBParseKey (
  IN OUT  USB_KB_DEV  *UsbKeyboardDevice,
  OUT     UINT8       *KeyCode
  );
 
EFI_STATUS
UsbKeyCodeToEfiInputKey (
  IN  USB_KB_DEV    *UsbKeyboardDevice,
  IN  UINT8         KeyCode,
  OUT EFI_KEY_DATA  *KeyData
  );
 
VOID
InitQueue (
  IN OUT  USB_SIMPLE_QUEUE  *Queue,
  IN      UINTN             ItemSize
  );
 
VOID
DestroyQueue (
  IN OUT USB_SIMPLE_QUEUE  *Queue
  );
 
BOOLEAN
IsQueueEmpty (
  IN  USB_SIMPLE_QUEUE  *Queue
  );
 
BOOLEAN
IsQueueFull (
  IN  USB_SIMPLE_QUEUE  *Queue
  );
 
VOID
Enqueue (
  IN OUT  USB_SIMPLE_QUEUE  *Queue,
  IN      VOID              *Item,
  IN      UINTN             ItemSize
  );
 
EFI_STATUS
Dequeue (
  IN OUT  USB_SIMPLE_QUEUE  *Queue,
  OUT  VOID                 *Item,
  IN      UINTN             ItemSize
  );
 
VOID
EFIAPI
USBKeyboardRepeatHandler (
  IN    EFI_EVENT  Event,
  IN    VOID       *Context
  );
 
VOID
SetKeyLED (
  IN  USB_KB_DEV  *UsbKeyboardDevice
  );
 
VOID
InitializeKeyState (
  IN  USB_KB_DEV     *UsbKeyboardDevice,
  OUT EFI_KEY_STATE  *KeyState
  );
 
#endif