MdeModulePkg/Bus/Usb/UsbKbDxe/UsbKbDxe.inf

   1 #/** @file
   2 # USB Keyboard Driver that manages USB keyboard and produces Simple Text Input
   3 # Protocol and Simple Text Input Ex Protocol.
   4 #
   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
  15 #
  16 # Copyright (c) 2006 - 2008, Intel Corporation.
  17 #
  18 #  All rights reserved. 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
  22 #
  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.
  25 #
  26 #
  27 #**/
  28
  29 [Defines]
  30   INF_VERSION                    = 0x00010005
  31   BASE_NAME                      = UsbKbDxe
  32   FILE_GUID                      = 2D2E62CF-9ECF-43b7-8219-94E7FC713DFE
  33   MODULE_TYPE                    = UEFI_DRIVER
  34   VERSION_STRING                 = 1.0
  35   ENTRY_POINT                    = USBKeyboardDriverBindingEntryPoint
  36
  37 #
  38 # The following information is for reference only and not required by the build tools.
  39 #
  40 #  VALID_ARCHITECTURES           = IA32 X64 IPF EBC
  41 #
  42 #  DRIVER_BINDING                =  gUsbKeyboardDriverBinding
  43 #  COMPONENT_NAME                =  gUsbKeyboardComponentName
  44 #  COMPONENT_NAME2               =  gUsbKeyboardComponentName2
  45 #
  46
  47 [Sources.common]
  48   EfiKey.c
  49   EfiKey.h
  50   KeyBoard.c
  51   ComponentName.c
  52   KeyBoard.h
  53
  54 [Packages]
  55   MdePkg/MdePkg.dec
  56   MdeModulePkg/MdeModulePkg.dec
  57
  58 [LibraryClasses]
  59   MemoryAllocationLib
  60   UefiLib
  61   UefiBootServicesTableLib
  62   UefiDriverEntryPoint
  63   UefiRuntimeServicesTableLib
  64   BaseMemoryLib
  65   ReportStatusCodeLib
  66   DebugLib
  67   PcdLib
  68   UefiUsbLib
  69
  70 [Guids]
  71   ##
  72   # Event registered to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
  73   # which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
  74   #
  75   gEfiHiiKeyBoardLayoutGuid                     ## SOMETIME_CONSUMES  ## Event
  76
  77 [Protocols]
  78   gEfiUsbIoProtocolGuid                         ## TO_START
  79   gEfiDevicePathProtocolGuid                    ## TO_START
  80   gEfiSimpleTextInProtocolGuid                  ## BY_START
  81   gEfiSimpleTextInputExProtocolGuid             ## BY_START
  82   ##
  83   # If HII Database Protocol exists, then keyboard layout from HII database is used.
  84   # Otherwise, USB keyboard module tries to use its carried default layout.
  85   #
  86   gEfiHiiDatabaseProtocolGuid                   ## SOMETIMES_CONSUMES (Default value is used if it's absent.)
  87
  88 [FeaturePcd.common]
  89   gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver ## SOMETIME_CONSUMES (Checked when no layout is provided by HII.)
  90
  91 [FixedPcd]
  92   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardEnable
  93   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardPresenceDetect
  94   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardDisable
  95   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardReset
  96   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardClearBuffer
  97   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardSelfTest
  98   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardInterfaceError
  99   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueKeyboardInputError
 100
 101
 102 # [Event]
 103 #   ##
 104 #   # Periodic timer event for generation of repeat key
 105 #   #
 106 #   EVENT_TYPE_PERIODIC_TIMER                   ## PRODUCES
 107 #   ##
 108 #   # Periodic timer event for delayed recovery, which deals with device error.
 109 #   #
 110 #   EVENT_TYPE_PERIODIC_TIMER                   ## PRODUCES
 111 #   ##
 112 #   # Event for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey
 113 #   #
 114 #   EVENT_TYPE_NOTIFY_WAIT                      ## PRODUCES
 115 #   ##
 116 #   # Event for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx
 117 #   #
 118 #   EVENT_TYPE_NOTIFY_WAIT                      ## PRODUCES
 119 #
 120 #