2 # USB Keyboard Driver that manages USB keyboard and produces Simple Text Input
3 # Protocol and Simple Text Input Ex Protocol.
5 # USB Keyboard Driver consumes USB I/O Protocol and Device Path Protocol, and produces
6 # Simple Text Input Protocol and Simple Text Input Ex Protocol on USB keyboard devices.
7 # It initializes the keyboard layout according to info retrieved from HII database.
8 # If HII cannot provide the info, this module uses its carried default one if PCD allows.
9 # It manages the USB keyboard device via Asynchronous Interrupt Transfer of USB I/O Protocol,
10 # and parses the data according to USB HID documents.
11 # This module refers to following specifications:
12 # 1. Universal Serial Bus HID Firmware Specification, ver 1.11
13 # 2. Universal Serial Bus HID Usage Tables, ver 1.12
14 # 3. UEFI Specification, v2.1
16 # Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
18 # This program and the accompanying materials
19 # are licensed and made available under the terms and conditions of the BSD License
20 # which accompanies this distribution. The full text of the license may be found at
21 # http://opensource.org/licenses/bsd-license.php
23 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
24 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
30 INF_VERSION = 0x00010005
32 FILE_GUID = 2D2E62CF-9ECF-43b7-8219-94E7FC713DFE
33 MODULE_TYPE = UEFI_DRIVER
35 ENTRY_POINT = USBKeyboardDriverBindingEntryPoint
38 # The following information is for reference only and not required by the build tools.
40 # VALID_ARCHITECTURES = IA32 X64 IPF EBC
42 # DRIVER_BINDING = gUsbKeyboardDriverBinding
43 # COMPONENT_NAME = gUsbKeyboardComponentName
44 # COMPONENT_NAME2 = gUsbKeyboardComponentName2
56 MdeModulePkg/MdeModulePkg.dec
61 UefiBootServicesTableLib
63 UefiRuntimeServicesTableLib
73 # Event registered to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
74 # which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
76 gEfiHiiKeyBoardLayoutGuid ## SOMETIME_CONSUMES ## Event
77 gUsbKeyboardLayoutPackageGuid
78 gUsbKeyboardLayoutKeyGuid
81 gEfiUsbIoProtocolGuid ## TO_START
82 gEfiDevicePathProtocolGuid ## TO_START
83 gEfiSimpleTextInProtocolGuid ## BY_START
84 gEfiSimpleTextInputExProtocolGuid ## BY_START
86 # If HII Database Protocol exists, then keyboard layout from HII database is used.
87 # Otherwise, USB keyboard module tries to use its carried default layout.
89 gEfiHiiDatabaseProtocolGuid ## SOMETIMES_CONSUMES (Default value is used if it's absent.)
92 gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver ## SOMETIME_CONSUMES (Checked when no layout is provided by HII.)
96 # # Periodic timer event for generation of repeat key
98 # EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
100 # # Periodic timer event for delayed recovery, which deals with device error.
102 # EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
104 # # Event for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey
106 # EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
108 # # Event for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx
110 # EVENT_TYPE_NOTIFY_WAIT ## PRODUCES