/** @file
  Header file for USB Keyboard Driver's Data Structures

;******************************************************************************
;* Copyright (c) 2012 - 2021, Insyde Software Corp. All Rights Reserved.
;*
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
;* transmit, broadcast, present, recite, release, license or otherwise exploit
;* any part of this publication in any form, by any means, without the prior
;* written permission of Insyde Software Corporation.
;*
;******************************************************************************
*/

#ifndef _USB_KB_H
#define _USB_KB_H

#include <Uefi.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>
#include <Library/ReportStatusCodeLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/HiiDbLib.h>
#include <Library/HiiStringLib.h>
#include <Library/HiiConfigAccessLib.h>
#include <Library/HidDescriptorLib.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/DevicePath.h>
#include <Protocol/Ps2Policy.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>
#include <Protocol/UsbCore.h>
#include <Protocol/HiiDatabase.h>
#include <Guid/StatusCodeDataTypeId.h>
#include <Guid/EventGroup.h>
#include <Guid/HiiKeyBoardLayout.h>
#include <Guid/H2OUsbKeyBoardLayout.h>

#define KEYBOARD_TIMER_INTERVAL         200000  // 0.02s

#define MAX_KEY_ALLOWED                 64

#define USBKBD_REPEAT_DELAY             500
#define USBKBD_REPEAT_RATE              32

#define CLASS_HID                       3
#define SUBCLASS_BOOT                   1
#define PROTOCOL_KEYBOARD               1

#define BOOT_PROTOCOL                   0
#define REPORT_PROTOCOL                 1

#define BDA_QUALIFIER_STAT              0x417
#define PAUSE_IN_PROGRESS               ((*(UINT8*)(UINTN)0x418) & 0x08)

#define KEYBOARD_RESET_SIGNATURE        L"CAD"

#define IMAGE_DRIVER_NAME               L"Usb Keyboard Driver"
#define CONTROLLER_DRIVER_NAME          L"Generic Usb Keyboard"

#define USB_KEYBOARD_US_KEY_COUNT                 105
#define USB_KEYBOARD_US_LANGUAGE_STR_LEN          5         // RFC4646 Language Code: "en-US"
#define USB_KEYBOARD_US_DESCRIPTION_STR_LEN       (16 + 1)  // Description: "English Keyboard"
#define USB_KEYBOARD_FRENCH_KEY_COUNT             105
#define USB_KEYBOARD_FRENCH_LANGUAGE_STR_LEN      5         // RFC4646 Language Code: "fr-FR"
#define USB_KEYBOARD_FRENCH_DESCRIPTION_STR_LEN   (15 + 1)  // Description: "French Keyboard"

#pragma pack (1)
typedef struct {
  //
  // EFI_HII_KEYBOARD_LAYOUT
  //
  UINT16                 LayoutLength;
  EFI_GUID               Guid;
  UINT32                 LayoutDescriptorStringOffset;
  UINT8                  DescriptorCount;
  EFI_KEY_DESCRIPTOR     KeyDescriptor[USB_KEYBOARD_US_KEY_COUNT];
  UINT16                 DescriptionCount;
  CHAR16                 Language[USB_KEYBOARD_US_LANGUAGE_STR_LEN];
  CHAR16                 Space;
  CHAR16                 DescriptionString[USB_KEYBOARD_US_DESCRIPTION_STR_LEN];
} USB_KEYBOARD_US_LAYOUT_PACK;

typedef struct {
  //
  // EFI_HII_KEYBOARD_LAYOUT
  //
  UINT16                 LayoutLength;
  EFI_GUID               Guid;
  UINT32                 LayoutDescriptorStringOffset;
  UINT8                  DescriptorCount;
  EFI_KEY_DESCRIPTOR     KeyDescriptor[USB_KEYBOARD_FRENCH_KEY_COUNT];
  UINT16                 DescriptionCount;
  CHAR16                 Language[USB_KEYBOARD_FRENCH_LANGUAGE_STR_LEN];
  CHAR16                 Space;
  CHAR16                 DescriptionString[USB_KEYBOARD_FRENCH_DESCRIPTION_STR_LEN];
} USB_KEYBOARD_FRENCH_LAYOUT_PACK;

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
  //
  USB_KEYBOARD_US_LAYOUT_PACK       USLayout;
  USB_KEYBOARD_FRENCH_LAYOUT_PACK   FrenchLayout;
} USB_KEYBOARD_LAYOUT_PACK_BIN;
#pragma pack()

typedef struct {
  UINT8 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 {
  UINTN                                 Signature;
  EFI_HANDLE                            NotifyHandle;
  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_SIMPLE_TEXT_INPUT_PROTOCOL        SimpleInput;
  EFI_USB_IO_PROTOCOL                   *UsbIo;
  EFI_USB_INTERFACE_DESCRIPTOR          InterfaceDescriptor;
  EFI_USB_ENDPOINT_DESCRIPTOR           IntEndpointDescriptor;
  REPORT_GROUP                          ReportGroup;
  USB_SIMPLE_QUEUE                      UsbKeyQueue;
  USB_SIMPLE_QUEUE                      EfiKeyQueue;
  USB_SIMPLE_QUEUE                      EfiKeyQueueForNotify;
  UINT8                                 CtrlOn;
  UINT8                                 AltOn;
  UINT8                                 ShiftOn;
  UINT8                                 NumLockOn;
  UINT8                                 CapsOn;
  UINT8                                 ScrollOn;
  UINT8                                 CurKeyChar;

  EFI_EVENT                             TimerEvent;

  UINT8                                 RepeatKey;
  UINT8                                 LastKeyCodeArray[8];
  EFI_UNICODE_STRING_TABLE              *ControllerNameTable;
  EFI_HANDLE                            RepeatPollingHandle;
  EFI_HANDLE                            RecoveryPollingHandle;
  BOOLEAN                               LedSupported;
  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL     SimpleInputEx;
  UINT8                                 LeftCtrlOn;
  UINT8                                 LeftAltOn;
  UINT8                                 LeftShiftOn;
  UINT8                                 LeftLogoOn;
  UINT8                                 RightCtrlOn;
  UINT8                                 RightAltOn;
  UINT8                                 RightShiftOn;
  UINT8                                 RightLogoOn;  
  UINT8                                 MenuKeyOn;
  UINT8                                 SysReqOn;
  UINT8                                 AltGrOn;
  UINT8                                 CircumflexAccentOn;
  UINT8                                 CircumflexAccentShiftedOn;
  UINT8                                 GraveAccentOn;
  UINT8                                 TildeOn;
  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;
  EFI_EVENT                             KeyboardLayoutEvent;
  EFI_GUID                              CurrentLayoutGuid;
} USB_KB_DEV;

#define USB_KB_DEV_BUFFER_SIZE          (sizeof(USB_KB_DEV) + ((MAX_KEY_ALLOWED + 1) * (sizeof(USB_KEY) + sizeof(EFI_KEY_DATA) + sizeof(EFI_KEY_DATA))))

typedef struct {
  EFI_HANDLE                            Handle;
  UINT8                                 UsbHidDevicePath[sizeof(USB_DEVICE_PATH) + sizeof(USB_CLASS_DEVICE_PATH) + END_DEVICE_PATH_LENGTH];
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL        SimpleInput;
  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL     SimpleInputEx;
} FAKE_DEV;


//
// Global Variables
//
extern USB_KEYBOARD_LAYOUT_PACK_BIN     mUsbKeyboardLayoutBin;
extern EFI_DRIVER_BINDING_PROTOCOL      gUsbKeyboardDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL      gUsbKeyboardComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL     gUsbKeyboardComponentName2;
extern EFI_USB_CORE_PROTOCOL            *mUsbCore;
extern BOOLEAN                          mInSmram;

VOID
KbdReportStatusCode (
  IN USB_KB_DEV                *UsbKeyboardDevice,
  IN EFI_STATUS_CODE_TYPE      CodeType,
  IN EFI_STATUS_CODE_VALUE     Value
  );

#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 MOD_CONTROL_L           0x01
#define MOD_CONTROL_R           0x10
#define MOD_SHIFT_L             0x02
#define MOD_SHIFT_R             0x20
#define MOD_ALT_L               0x04
#define MOD_ALT_R               0x40
#define MOD_WIN_L               0x08
#define MOD_WIN_R               0x80

typedef struct {
  UINT8 Mask;
  UINT8 Key;
} KB_MODIFIER;

#define USB_KEYCODE_MAX_MAKE      0x7E
#define USBKBD_VALID_KEYCODE(key) ((UINT8) (key) > 3)
//
// 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

typedef struct {
  UINT8 NumLock : 1;
  UINT8 CapsLock : 1;
  UINT8 ScrollLock : 1;
  UINT8 Resrvd : 5;
} LED_MAP;

typedef struct {
  UINT8 RightShift : 1;
  UINT8 LeftShift : 1;
  UINT8 Ctrl : 1;
  UINT8 Alt : 1;
  UINT8 ScrollLock : 1;
  UINT8 NumLock : 1;
  UINT8 CapsLock : 1;
  UINT8 Insert : 1;
} QUALIFIER_STAT;

/**
  Timer handler to convert the key from USB.

  @param  Event                    Indicates the event that invoke this function.
  @param  Context                  Indicates the calling context.
**/
VOID
EFIAPI
USBKeyboardTimerHandler (
  IN  EFI_EVENT                 Event,
  IN  VOID                      *Context
  );

/**
  Process key notify.

  @param  Event                 Indicates the event that invoke this function.
  @param  Context               Indicates the calling context.
**/
VOID
EFIAPI
KeyNotifyProcessHandler (
  IN  EFI_EVENT                 Event,
  IN  VOID                      *Context
  );

#endif