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,5 @@
## @file
#
# Component Description File For EhciDxe Module.
#
# EhciDxe driver is responsible for managing the behavior of EHCI controller.
# The EhciDxe driver is responsible for managing the behavior of EHCI controller.
# It implements the interfaces of monitoring the status of all ports and transferring
# Control, Bulk, Interrupt and Isochronous requests to Usb2.0 device.
#
@@ -11,7 +8,7 @@
# This way avoids the control transfer on a shared port between EHCI and companion host
# controller when UHCI gets attached earlier than EHCI and a USB 2.0 device inserts.
#
# Copyright (c) 2006 - 2012, 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
@@ -27,6 +24,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = EhciDxe
MODULE_UNI_FILE = EhciDxe.uni
FILE_GUID = BDFE430E-8F2A-4db0-9991-6F856594777E
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -64,7 +62,7 @@
MdeModulePkg/MdeModulePkg.dec
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport ## SOMETIME_CONSUMES (enable/disable usb legacy support.)
gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport ## CONSUMES
[LibraryClasses]
MemoryAllocationLib
@@ -78,15 +76,15 @@
ReportStatusCodeLib
[Guids]
gEfiEventExitBootServicesGuid ## PRODUCES ## Event
gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event
[Protocols]
gEfiPciIoProtocolGuid ## TO_START
gEfiUsb2HcProtocolGuid ## BY_START
# [Event]
# ##
# # Periodic timer event for checking the result of interrupt transfer execution.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
EhciDxeExtra.uni

View File

@@ -1,8 +1,10 @@
## @file
# Component description file for EhcPeim PEIM to produce gPeiUsb2HostControllerPpiGuid
# based on gPeiUsbControllerPpiGuid which is used to enable recovery function from USB Drivers.
# The EhcPeim driver is responsible for managing EHCI host controller at PEI phase.
#
# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
# It produces gPeiUsb2HostControllerPpiGuid based on gPeiUsbControllerPpiGuid
# which is used to enable recovery function from USB Drivers.
#
# Copyright (c) 2010 - 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 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = EhciPei
MODULE_UNI_FILE = EhciPei.uni
FILE_GUID = BAB4F20F-0981-4b5f-A047-6EF83BEEAB3C
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -56,11 +59,12 @@
[Ppis]
gPeiUsb2HostControllerPpiGuid # PPI ALWAYS_PRODUCED
gPeiUsbControllerPpiGuid # PPI ALWAYS_CONSUMED
gPeiUsb2HostControllerPpiGuid ## PRODUCES
gPeiUsbControllerPpiGuid ## CONSUMES
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gPeiUsbControllerPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
EhciPeiExtra.uni

View File

@@ -1,10 +1,10 @@
## @file
# PEIM to produce gEfiPeiVirtualBlockIoPpiGuid PPI for ATA controllers in the platform.
# This PPI canl be consumed by PEIM which produce gEfiPeiDeviceRecoveryModulePpiGuid
# This PPI can be consumed by PEIM which produce gEfiPeiDeviceRecoveryModulePpiGuid
# for Atapi CD ROM device.
#
# This module discovers CDROM devices in Legacy and native mode and installs block IO ppis for them.
# Copyright (c) 2006 - 2012, 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
@@ -20,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IdeBusPei
MODULE_UNI_FILE = IdeBusPei.uni
FILE_GUID = B7A5041A-78BA-49e3-B73B-54C757811FB6
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -54,14 +55,14 @@
PcdLib
[Ppis]
gPeiAtaControllerPpiGuid # PPI ALWAYS_CONSUMED
gEfiPeiVirtualBlockIoPpiGuid # PPI ALWAYS_PRODUCED
gPeiAtaControllerPpiGuid ## CONSUMES
gEfiPeiVirtualBlockIoPpiGuid ## PRODUCES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdSataSpinUpDelayInSecForRecoveryPath
gEfiMdeModulePkgTokenSpaceGuid.PcdSataSpinUpDelayInSecForRecoveryPath ## CONSUMES
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid AND gPeiAtaControllerPpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
IdeBusPeiExtra.uni

View File

@@ -4,7 +4,7 @@
# Installs EFI PCI Incompatible Device Support protocol and includes one incompatile
# pci devices list template.
#
# Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2009 - 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
@@ -19,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IncompatiblePciDeviceSupport
MODULE_UNI_FILE = IncompatiblePciDeviceSupport.uni
FILE_GUID = AD70855E-0CC5-4abf-8979-BE762A949EA3
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -43,7 +44,10 @@
DebugLib
[Protocols]
gEfiIncompatiblePciDeviceSupportProtocolGuid ## PRODUCEDS
gEfiIncompatiblePciDeviceSupportProtocolGuid ## PRODUCES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
IncompatiblePciDeviceSupportExtra.uni

View File

@@ -1,10 +1,10 @@
## @file
# Component Description File For NVM Express Host Controller Module.
# NVM Express Host Controller Module.
#
# NvmExpressDxe driver is used to manage non-volatile memory subsystem which follows
# NVM Express specification.
#
# Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2013 - 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
@@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = NvmExpressDxe
MODULE_UNI_FILE = NvmExpressDxe.uni
FILE_GUID = 5BE3BDF4-53CF-46a3-A6A9-73C34A6E5EE3
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -62,7 +63,16 @@
[Protocols]
gEfiPciIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
## BY_START
## TO_START
gEfiDevicePathProtocolGuid
gEfiBlockIoProtocolGuid ## BY_START
gEfiDiskInfoProtocolGuid ## BY_START
gEfiDriverSupportedEfiVersionProtocolGuid ## BY_START
gEfiDriverSupportedEfiVersionProtocolGuid ## PRODUCES
# [Event]
# EVENT_TYPE_RELATIVE_TIMER ## SOMETIMES_CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
NvmExpressDxeExtra.uni

View File

@@ -1,11 +1,8 @@
## @file
# Component description file for PciBus module.
# The PCI bus driver will probe all PCI devices and allocate MMIO and IO space for these devices.
# Please use PCD feature flag PcdPciBusHotplugDeviceSupport to enable hot plug supporting.
#
# PCI bus driver. This module will probe all PCI devices and allocate MMIO and IO
# space for these devices. Please use PCD feature flag PcdPciBusHotplugDeviceSupport to enable
# hot plug supporting.
#
# Copyright (c) 2006 - 2013, 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 = PciBusDxe
MODULE_UNI_FILE = PciBusDxe.uni
FILE_GUID = 93B80004-9FB3-11d4-9A3A-0090273FC14D
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -83,37 +81,32 @@
PeCoffLib
[Protocols]
gEfiPciHotPlugRequestProtocolGuid ## BY_START
gEfiPciHotPlugRequestProtocolGuid ## SOMETIMES_PRODUCES
gEfiPciIoProtocolGuid ## BY_START
gEfiDevicePathProtocolGuid ## BY_START
gEfiBusSpecificDriverOverrideProtocolGuid ## BY_START
gEfiLoadedImageProtocolGuid ## CONSUMED
gEfiDecompressProtocolGuid ## CONSUMED
gEfiPciHotPlugInitProtocolGuid ## CONSUMED
gEfiPciHostBridgeResourceAllocationProtocolGuid ## CONSUMED
gEfiPciPlatformProtocolGuid ## CONSUMED
gEfiPciOverrideProtocolGuid ## CONSUMED
gEfiPciEnumerationCompleteProtocolGuid ## CONSUMED
gEfiPciRootBridgeIoProtocolGuid ## CONSUMED
gEfiIncompatiblePciDeviceSupportProtocolGuid ## CONSUMED
gEfiLoadFile2ProtocolGuid ## CONSUMED
gEfiLoadedImageProtocolGuid ## SOMETIMES_CONSUMES
gEfiDecompressProtocolGuid ## SOMETIMES_CONSUMES
gEfiPciHotPlugInitProtocolGuid ## SOMETIMES_CONSUMES
gEfiPciHostBridgeResourceAllocationProtocolGuid ## TO_START
gEfiPciPlatformProtocolGuid ## SOMETIMES_CONSUMES
gEfiPciOverrideProtocolGuid ## SOMETIMES_CONSUMES
gEfiPciEnumerationCompleteProtocolGuid ## PRODUCES
gEfiPciRootBridgeIoProtocolGuid ## TO_START
gEfiIncompatiblePciDeviceSupportProtocolGuid ## SOMETIMES_CONSUMES
gEfiLoadFile2ProtocolGuid ## SOMETIMES_PRODUCES
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdPciBusHotplugDeviceSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdPciBridgeIoAlignmentProbe
gEfiMdeModulePkgTokenSpaceGuid.PcdUnalignedPciIoEnable
gEfiMdeModulePkgTokenSpaceGuid.PcdPciBusHotplugDeviceSupport ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdPciBridgeIoAlignmentProbe ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdUnalignedPciIoEnable ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdSrIovSystemPageSize
gEfiMdeModulePkgTokenSpaceGuid.PcdSrIovSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdAriSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdMrIovSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration
gEfiMdeModulePkgTokenSpaceGuid.PcdSrIovSystemPageSize ## SOMETIMES_CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdSrIovSupport ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAriSupport ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdMrIovSupport ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration ## SOMETIMES_CONSUMES
# [Event]
# ##
# # Notify event set by CreateEventForHpc () for PCI Hot Plug controller.
# #
# EVT_NOTIFY_SIGNAL ## PRODUCES
#
#
[UserExtensions.TianoCore."ExtraFiles"]
PciBusDxeExtra.uni

View File

@@ -1,12 +1,9 @@
## @file
#
# Component Description File For UhciDxe Module.
#
# UhciDxe driver is responsible for managing the behavior of UHCI controller.
# The UhciDxe driver is responsible for managing the behavior of UHCI controller.
# It implements the interfaces of monitoring the status of all ports and transferring
# Control, Bulk, Interrupt and Isochronous requests to Usb1.x device
#
# Copyright (c) 2006 - 2012, 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
@@ -22,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UhciDxe
MODULE_UNI_FILE = UhciDxe.uni
FILE_GUID = 2FB92EFA-2EE0-4bae-9EB6-7464125E1EF7
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -60,7 +58,7 @@
MdeModulePkg/MdeModulePkg.dec
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport ## SOMETIME_CONSUMES (enable/disable usb legacy support.)
gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport ## CONSUMES
[LibraryClasses]
MemoryAllocationLib
@@ -74,15 +72,15 @@
ReportStatusCodeLib
[Guids]
gEfiEventExitBootServicesGuid ## PRODUCES ## Event
gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event
[Protocols]
gEfiPciIoProtocolGuid ## TO_START
gEfiUsb2HcProtocolGuid ## BY_START
# [Event]
# ##
# # Periodic timer event for checking the result of interrupt transfer execution.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
UhciDxeExtra.uni

View File

@@ -1,9 +1,10 @@
## @file
# Component description file for UhcPeim PEIM to produce gPeiUsbHostControllerPpiGuid based on gPeiUsbControllerPpiGuid
# which is used to enable recovery function from USB Drivers.
# The UhcPeim driver is responsible for managing the behavior of UHCI controller at PEI phase.
#
# Usb Host Controller PEIM to support recovery from USB device.
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# It produces gPeiUsbHostControllerPpiGuid based on gPeiUsbControllerPpiGuid which is used
# to enable recovery function from USB Drivers.
#
# 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
@@ -19,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = UhciPei
MODULE_UNI_FILE = UhciPei.uni
FILE_GUID = C463CEAC-FC57-4f36-88B7-356C750C3BCA
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -51,11 +53,12 @@
[Ppis]
gPeiUsbHostControllerPpiGuid # PPI ALWAYS_PRODUCED
gPeiUsbControllerPpiGuid # PPI ALWAYS_CONSUMED
gPeiUsbHostControllerPpiGuid ## PRODUCES
gPeiUsbControllerPpiGuid ## CONSUMES
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gPeiUsbControllerPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
UhciPeiExtra.uni

View File

@@ -1,12 +1,9 @@
## @file
#
# Component Description File For XhciDxe Module.
#
# XhciDxe driver is responsible for managing the behavior of XHCI controller.
# The XhciDxe driver is responsible for managing the behavior of XHCI controller.
# It implements the interfaces of monitoring the status of all ports and transferring
# Control, Bulk, Interrupt and Isochronous requests to those attached usb LS/FS/HS/SS devices.
#
# Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2011 - 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
@@ -22,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = XhciDxe
MODULE_UNI_FILE = XhciDxe.uni
FILE_GUID = B7F50E91-A759-412c-ADE4-DCD03E7F7C28
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -64,15 +62,15 @@
ReportStatusCodeLib
[Guids]
gEfiEventExitBootServicesGuid ## PRODUCES ## Event
gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event
[Protocols]
gEfiPciIoProtocolGuid ## TO_START
gEfiUsb2HcProtocolGuid ## BY_START
# [Event]
# ##
# # Periodic timer event for checking the result of interrupt transfer execution.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
XhciDxeExtra.uni

View File

@@ -1,6 +1,8 @@
## @file
# Component description file for XhcPeim PEIM to produce gPeiUsb2HostControllerPpiGuid
# based on gPeiUsbControllerPpiGuid which is used to enable recovery function from USB Drivers.
# The XhcPeim driver is responsible for managing the behavior of XHCI controller at PEI phase.
#
# It produces gPeiUsb2HostControllerPpiGuid based on gPeiUsbControllerPpiGuid
# which is used to enable recovery function from USB Drivers.
#
# Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
#
@@ -18,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = XhciPei
MODULE_UNI_FILE = XhciPei.uni
FILE_GUID = 65E5746E-9C14-467d-B5B3-932A66D59F79
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -57,3 +60,5 @@
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gPeiUsbControllerPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
XhciPeiExtra.uni