MdeModulePkg/Bus/Usb/UsbKbDxe/UsbKbDxe.inf

   1 ## @file
   2 # USB Keyboard Driver that manages USB keyboard and produces Simple Text Input(Ex) Protocol.
   3 #
   4 # USB Keyboard Driver consumes USB I/O Protocol and Device Path Protocol, and produces
   5 # Simple Text Input Protocol and Simple Text Input Ex Protocol on USB keyboard devices.
   6 # It initializes the keyboard layout according to info retrieved from HII database.
   7 # If HII cannot provide the info, this module uses its carried default one if PCD allows.
   8 # It manages the USB keyboard device via Asynchronous Interrupt Transfer of USB I/O Protocol,
   9 # and parses the data according to USB HID documents.
  10 # This module refers to following specifications:
  11 # 1. Universal Serial Bus HID Firmware Specification, ver 1.11
  12 # 2. Universal Serial Bus HID Usage Tables, ver 1.12
  13 # 3. UEFI Specification, v2.1
  14 #
  15 # Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  16 #
  17 #  SPDX-License-Identifier: BSD-2-Clause-Patent
  18 #
  19 #
  20 ##
  21
  22 [Defines]
  23   INF_VERSION                    = 0x00010005
  24   BASE_NAME                      = UsbKbDxe
  25   MODULE_UNI_FILE                = UsbKbDxe.uni
  26   FILE_GUID                      = 2D2E62CF-9ECF-43b7-8219-94E7FC713DFE
  27   MODULE_TYPE                    = UEFI_DRIVER
  28   VERSION_STRING                 = 1.0
  29   ENTRY_POINT                    = USBKeyboardDriverBindingEntryPoint
  30
  31 #
  32 # The following information is for reference only and not required by the build tools.
  33 #
  34 #  VALID_ARCHITECTURES           = IA32 X64 EBC ARM AARCH64
  35 #
  36 #  DRIVER_BINDING                =  gUsbKeyboardDriverBinding
  37 #  COMPONENT_NAME                =  gUsbKeyboardComponentName
  38 #  COMPONENT_NAME2               =  gUsbKeyboardComponentName2
  39 #
  40
  41 [Sources]
  42   EfiKey.c
  43   EfiKey.h
  44   KeyBoard.c
  45   ComponentName.c
  46   KeyBoard.h
  47
  48 [Packages]
  49   MdePkg/MdePkg.dec
  50   MdeModulePkg/MdeModulePkg.dec
  51
  52 [LibraryClasses]
  53   MemoryAllocationLib
  54   UefiLib
  55   UefiBootServicesTableLib
  56   UefiDriverEntryPoint
  57   UefiRuntimeServicesTableLib
  58   BaseMemoryLib
  59   ReportStatusCodeLib
  60   DebugLib
  61   PcdLib
  62   UefiUsbLib
  63   HiiLib
  64
  65 [Guids]
  66   #
  67   # Event registered to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
  68   # which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
  69   #
  70   gEfiHiiKeyBoardLayoutGuid                     ## SOMETIMES_CONSUMES ## Event
  71   gUsbKeyboardLayoutPackageGuid                 ## SOMETIMES_CONSUMES ## HII
  72   gUsbKeyboardLayoutKeyGuid                     ## SOMETIMES_PRODUCES ## UNDEFINED
  73
  74 [Protocols]
  75   gEfiUsbIoProtocolGuid                         ## TO_START
  76   gEfiDevicePathProtocolGuid                    ## TO_START
  77   gEfiSimpleTextInProtocolGuid                  ## BY_START
  78   gEfiSimpleTextInputExProtocolGuid             ## BY_START
  79   #
  80   # If HII Database Protocol exists, then keyboard layout from HII database is used.
  81   # Otherwise, USB keyboard module tries to use its carried default layout.
  82   #
  83   gEfiHiiDatabaseProtocolGuid                   ## SOMETIMES_CONSUMES
  84
  85 [FeaturePcd]
  86   gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver ## CONSUMES
  87
  88 # [Event]
  89 # EVENT_TYPE_RELATIVE_TIMER        ## CONSUMES
  90 #
  91
  92 [UserExtensions.TianoCore."ExtraFiles"]
  93   UsbKbDxeExtra.uni