MdeModulePkg: INF/DEC file updates to EDK II packages

1. Usage information in INF file comment blocks are either incomplete or incorrect.  
This includes usage information for Protocols/PPIs/GUIDs/PCDs/HOBs/Events/BootModes.  
The syntax for usage information in comment blocks is defined in the EDK II Module Information (INF) Specification

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Zeng, Star <star.zeng@intel.com>
Reviewed-by: Gao, Liming <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15962 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Zeng, Star
2014-08-28 06:34:06 +00:00
committed by lgao4
parent f7acc87241
commit 6036e94dc9
149 changed files with 1838 additions and 1221 deletions

View File

@@ -1,8 +1,7 @@
## @file
# Component description file for UsbBotPei module.
# The Usb mass storage device Peim driver is used to support recovery from USB device.
#
# Usb mass storage device Peim driver to support recovery from USB device.
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions
@@ -18,6 +17,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbBotPei
MODULE_UNI_FILE = UsbBotPei.uni
FILE_GUID = 8401A046-6F70-4505-8471-7015B40355E3
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -53,13 +53,16 @@
PcdLib
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdUsbTransferTimeoutValue
gEfiMdePkgTokenSpaceGuid.PcdUsbTransferTimeoutValue ## CONSUMES
[Ppis]
gEfiPeiVirtualBlockIoPpiGuid # PPI ALWAYS_PRODUCED
gPeiUsbIoPpiGuid # PPI ALWAYS_CONSUMED
gEfiPeiVirtualBlockIoPpiGuid ## PRODUCES
## CONSUMES
## NOTIFY
gPeiUsbIoPpiGuid
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gPeiUsbIoPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
UsbBotPeiExtra.uni

View File

@@ -1,10 +1,7 @@
## @file
#
# Component Description File For UsbBus Dxe Module.
# The Usb Bus Dxe driver is used to enumerate and manage all attached usb devices.
#
# Usb Bus Dxe driver is used to enumerate and manage all attached usb devices.
#
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@@ -20,6 +17,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbBusDxe
MODULE_UNI_FILE = UsbBusDxe.uni
FILE_GUID = 240612B7-A063-11d4-9A3A-0090273FC14D
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -66,14 +64,16 @@
[Protocols]
gEfiUsbIoProtocolGuid ## BY_START
gEfiDevicePathProtocolGuid ## BY_START
## TO_START
## BY_START
gEfiDevicePathProtocolGuid
gEfiUsb2HcProtocolGuid ## TO_START
gEfiUsbHcProtocolGuid ## TO_START
# [Event]
# ##
# # Periodic timer event for monitoring attach/detach event in port and enumerate attached usb devices.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
#
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UsbBusDxeExtra.uni

View File

@@ -1,8 +1,7 @@
## @file
# Component description file for UsbPeim module.
# The Usb Bus Peim driver is used to support recovery from usb device.
#
# Usb Bus Peim driver to support recovery from usb device.
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions
@@ -18,6 +17,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbBusPei
MODULE_UNI_FILE = UsbBusPei.uni
FILE_GUID = 8401A045-6F70-4505-8471-7015B40355E3
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -53,14 +53,15 @@
PcdLib
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdUsbTransferTimeoutValue
gEfiMdePkgTokenSpaceGuid.PcdUsbTransferTimeoutValue ## CONSUMES
[Ppis]
gPeiUsbIoPpiGuid # PPI ALWAYS_PRODUCED
gPeiUsbHostControllerPpiGuid # PPI ALWAYS_CONSUMED
gPeiUsb2HostControllerPpiGuid # PPI ALWAYS_CONSUMED
gPeiUsbIoPpiGuid ## PRODUCES
gPeiUsbHostControllerPpiGuid ## SOMETIMES_CONSUMES
gPeiUsb2HostControllerPpiGuid ## SOMETIMES_CONSUMES
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid AND gPeiUsb2HostControllerPpiGuid OR gPeiUsbHostControllerPpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
UsbBusPeiExtra.uni

View File

@@ -1,6 +1,5 @@
## @file
# USB Keyboard Driver that manages USB keyboard and produces Simple Text Input
# Protocol and Simple Text Input Ex Protocol.
# USB Keyboard Driver that manages USB keyboard and produces Simple Text Input(Ex) Protocol.
#
# USB Keyboard Driver consumes USB I/O Protocol and Device Path Protocol, and produces
# Simple Text Input Protocol and Simple Text Input Ex Protocol on USB keyboard devices.
@@ -13,7 +12,7 @@
# 2. Universal Serial Bus HID Usage Tables, ver 1.12
# 3. UEFI Specification, v2.1
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@@ -29,6 +28,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbKbDxe
MODULE_UNI_FILE = UsbKbDxe.uni
FILE_GUID = 2D2E62CF-9ECF-43b7-8219-94E7FC713DFE
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -69,44 +69,31 @@
HiiLib
[Guids]
##
#
# Event registered to EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID group,
# which will be triggered by EFI_HII_DATABASE_PROTOCOL.SetKeyboardLayout().
#
gEfiHiiKeyBoardLayoutGuid ## SOMETIME_CONSUMES ## Event
gUsbKeyboardLayoutPackageGuid
gUsbKeyboardLayoutKeyGuid
gEfiHiiKeyBoardLayoutGuid ## SOMETIMES_CONSUMES ## Event
gUsbKeyboardLayoutPackageGuid ## SOMETIMES_CONSUMES ## HII
gUsbKeyboardLayoutKeyGuid ## SOMETIMES_PRODUCES ## UNDEFINED
[Protocols]
gEfiUsbIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
gEfiSimpleTextInProtocolGuid ## BY_START
gEfiSimpleTextInputExProtocolGuid ## BY_START
##
#
# If HII Database Protocol exists, then keyboard layout from HII database is used.
# Otherwise, USB keyboard module tries to use its carried default layout.
#
gEfiHiiDatabaseProtocolGuid ## SOMETIMES_CONSUMES (Default value is used if it's absent.)
gEfiHiiDatabaseProtocolGuid ## SOMETIMES_CONSUMES
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver ## SOMETIME_CONSUMES (Checked when no layout is provided by HII.)
gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver ## CONSUMES
# [Event]
# ##
# # Periodic timer event for generation of repeat key
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# ##
# # Periodic timer event for delayed recovery, which deals with device error.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# ##
# # Event for EFI_SIMPLE_TEXT_INPUT_PROTOCOL.WaitForKey
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
# ##
# # Event for EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
#
# EVENT_TYPE_RELATIVE_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UsbKbDxeExtra.uni

View File

@@ -1,6 +1,5 @@
## @file
# USB Mass Storage Driver that manages USB mass storage devices and
# produces Block I/O Protocol.
# USB Mass Storage Driver that manages USB mass storage devices and produces Block I/O Protocol.
#
# The USB mass storage class is specified in two layers: the bottom layer
# is the transportation protocol. The top layer is the command set.
@@ -14,7 +13,7 @@
# 3. USB Mass Storage Class Bulk-Only Transport, Revision 1.0.
# 4. UEFI Specification, v2.1
#
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@@ -30,6 +29,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbMassStorageDxe
MODULE_UNI_FILE = UsbMassStorageDxe.uni
FILE_GUID = 9FB4B4A7-42C0-4bcd-8540-9BCC6711F83E
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -78,3 +78,10 @@
gEfiDevicePathProtocolGuid ## TO_START
gEfiBlockIoProtocolGuid ## BY_START
gEfiDiskInfoProtocolGuid ## BY_START
# [Event]
# EVENT_TYPE_RELATIVE_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UsbMassStorageDxeExtra.uni

View File

@@ -9,7 +9,7 @@
# 1. Universal Serial Bus HID Firmware Specification, ver 1.11
# 2. UEFI Specification, v2.1
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@@ -25,6 +25,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbMouseAbsolutePointerDxe
MODULE_UNI_FILE = UsbMouseAbsolutePointerDxe.uni
FILE_GUID = 4EA43463-747C-46eb-97FB-B0E5C5F05306
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -64,14 +65,8 @@
gEfiAbsolutePointerProtocolGuid ## BY_START
# [Event]
# ##
# # Periodic timer event for delayed recovery, which deals with device error.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# ##
# # Event for EFI_ABSOLUTE_POINTER_PROTOCOL.WaitForInput
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
#
# EVENT_TYPE_RELATIVE_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UsbMouseAbsolutePointerDxeExtra.uni

View File

@@ -9,7 +9,7 @@
# 1. Universal Serial Bus HID Firmware Specification, ver 1.11
# 2. UEFI Specification, v2.1
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@@ -25,6 +25,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UsbMouseDxe
MODULE_UNI_FILE = UsbMouseDxe.uni
FILE_GUID = 2D2E62AA-9ECF-43b7-8219-94E7FC713DFE
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -64,14 +65,8 @@
gEfiSimplePointerProtocolGuid ## BY_START
# [Event]
# ##
# # Periodic timer event for delayed recovery, which deals with device error.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# ##
# # Event for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
#
# EVENT_TYPE_RELATIVE_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UsbMouseDxeExtra.uni