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,7 +1,7 @@
## @file
# Sample ACPI Platform Driver
#
# Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2008 - 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
# which accompanies this distribution. The full text of the license may be found at
@@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = AcpiPlatform
MODULE_UNI_FILE = AcpiPlatform.uni
FILE_GUID = cb933912-df8f-4305-b1f9-7b44fa11395c
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -43,11 +44,13 @@
UefiDriverEntryPoint
[Protocols]
gEfiAcpiTableProtocolGuid # PROTOCOL ALWAYS_CONSUMED
gEfiAcpiTableProtocolGuid ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile ## CONSUMES
[Depex]
gEfiAcpiTableProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
AcpiPlatformExtra.uni

View File

@@ -1,7 +1,7 @@
## @file
# ACPI Table Protocol Driver
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = AcpiTableDxe
MODULE_UNI_FILE = AcpiTableDxe.uni
FILE_GUID = 9622E42C-8E38-4a08-9E8F-54F784652F6B
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -54,24 +55,28 @@
PcdLib
[Guids]
gEfiAcpi10TableGuid # ALWAYS_CONSUMED
gEfiAcpiTableGuid
gEfiAcpi10TableGuid ## PRODUCES ## SystemTable
gEfiAcpiTableGuid ## PRODUCES ## SystemTable
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdInstallAcpiSdtProtocol
gEfiMdeModulePkgTokenSpaceGuid.PcdInstallAcpiSdtProtocol ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision ## CONSUMES
[Protocols]
gEfiAcpiTableProtocolGuid # PROTOCOL ALWAYS_PRODUCED
gEfiAcpiSdtProtocolGuid # PROTOCOL ALWAYS_PRODUCED
gEfiDxeSmmReadyToLockProtocolGuid # PROTOCOL ALWAYS_CONSUMED
gEfiAcpiTableProtocolGuid ## PRODUCES
gEfiAcpiSdtProtocolGuid ## PRODUCES
## NOTIFY
## SOMETIMES_CONSUMES
gEfiDxeSmmReadyToLockProtocolGuid
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
AcpiTableDxeExtra.uni

View File

@@ -1,7 +1,7 @@
## @file
# This module install ACPI Boot Graphics Resource Table (BGRT).
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BootGraphicsResourceTableDxe
MODULE_UNI_FILE = BootGraphicsResourceTableDxe.uni
FILE_GUID = B8E62775-BB0A-43f0-A843-5BE8B14F8CCD
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -44,15 +45,18 @@
PcdLib
[Protocols]
gEfiAcpiTableProtocolGuid ## SOMETIMES_CONSUMES
gEfiBootLogoProtocolGuid ## SOMETIMES_CONSUMES
gEfiAcpiTableProtocolGuid ## CONSUMES
gEfiBootLogoProtocolGuid ## PRODUCES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision ## CONSUMES
[Guids]
gEfiEventReadyToBootGuid ## CONSUMES
gEfiEventReadyToBootGuid ## CONSUMES ## Event
[UserExtensions.TianoCore."ExtraFiles"]
BootGraphicsResourceTableDxeExtra.uni

View File

@@ -4,7 +4,7 @@
# This is a standalone Boot Script Executor. Standalone means it does not
# depends on any PEI or DXE service.
#
# 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
@@ -19,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BootScriptExecutorDxe
MODULE_UNI_FILE = BootScriptExecutorDxe.uni
FILE_GUID = FA20568B-548B-4b2b-81EF-1BA08D4A3CEC
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -50,19 +51,14 @@
MdeModulePkg/MdeModulePkg.dec
[LibraryClasses]
TimerLib
PcdLib
BaseMemoryLib
SmbusLib
UefiDriverEntryPoint
BaseLib
PciLib
IoLib
S3BootScriptLib
PeCoffLib
DxeServicesLib
UefiBootServicesTableLib
UefiRuntimeServicesTableLib
CacheMaintenanceLib
UefiLib
DebugAgentLib
@@ -70,20 +66,22 @@
CpuExceptionHandlerLib
[Guids]
gEfiBootScriptExecutorVariableGuid
gEfiBootScriptExecutorContextGuid
gPerformanceProtocolGuid
gEfiEventExitBootServicesGuid
gEfiBootScriptExecutorVariableGuid ## PRODUCES ## UNDEFINED # SaveLockBox
gEfiBootScriptExecutorContextGuid ## PRODUCES ## UNDEFINED # SaveLockBox
[Protocols]
## NOTIFY
## CONSUMES
gEfiDxeSmmReadyToLockProtocolGuid
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode
gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdUse1GPageTable
gEfiMdeModulePkgTokenSpaceGuid.PcdUse1GPageTable ## SOMETIMES_CONSUMES
[Depex]
gEfiLockBoxProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
BootScriptExecutorDxeExtra.uni

View File

@@ -5,7 +5,7 @@
# for Firmware Basic Boot Performance Record and other boot performance records,
# and install FPDT to ACPI table.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@@ -19,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = FirmwarePerformanceDxe
MODULE_UNI_FILE = FirmwarePerformanceDxe.uni
FILE_GUID = 00160F8D-2B35-4df2-BBE0-B272A8D631F0
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -52,37 +53,39 @@
UefiLib
[Protocols]
gEfiAcpiTableProtocolGuid ## SOMETIMES_CONSUMES
gEfiAcpiTableProtocolGuid ## CONSUMES
gEfiRscHandlerProtocolGuid ## CONSUMES
gEfiSmmCommunicationProtocolGuid ## SOMETIMES_CONSUMES
gEfiVariableArchProtocolGuid ## SOMETIMES_CONSUMES
gEfiLockBoxProtocolGuid ## SOMETIMES_CONSUMES
gEfiVariableArchProtocolGuid ## CONSUMES
gEfiLockBoxProtocolGuid ## CONSUMES
[Guids]
gEfiEventExitBootServicesGuid ## CONSUMES
gEfiEventReadyToBootGuid ## CONSUMES
gEfiEventLegacyBootGuid ## CONSUMES
gEfiAcpiTableGuid ## SOMETIMES_CONSUMES
gEfiAcpi10TableGuid ## SOMETIMES_CONSUMES
gEfiAcpi20TableGuid ## SOMETIMES_CONSUMES
gEfiFirmwarePerformanceGuid ## PRODUCES ## Variable:L"FirmwarePerformance"
gEfiFirmwarePerformanceGuid ## SOMETIMES_CONSUMES ## Hob
gEfiFirmwarePerformanceGuid ## SOMETIMES_CONSUMES ## SmiHandler
gEfiFirmwarePerformanceGuid ## SOMETIMES_CONSUMES ## StatusCode Data
gFirmwarePerformanceS3PointerGuid ## SOMETIMES_PRODUCES # SaveLockBox
gEfiEventExitBootServicesGuid ## CONSUMES ## Event
gEfiEventReadyToBootGuid ## CONSUMES ## Event
gEfiEventLegacyBootGuid ## SOMETIMES_CONSUMES ## Event
## SOMETIMES_CONSUMES ## HOB
## SOMETIMES_CONSUMES ## Variable:L"FirmwarePerformance"
## PRODUCES ## Variable:L"FirmwarePerformance"
## SOMETIMES_CONSUMES ## UNDEFINED # Used to do smm communication
## SOMETIMES_CONSUMES ## UNDEFINED # StatusCode Data
gEfiFirmwarePerformanceGuid
gFirmwarePerformanceS3PointerGuid ## PRODUCES ## UNDEFINED # SaveLockBox
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderLoad
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderStart
gEfiMdeModulePkgTokenSpaceGuid.PcdExtFpdtBootRecordPadSize
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderLoad ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderStart ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdExtFpdtBootRecordPadSize ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision ## CONSUMES
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwarePerformanceDataTableS3Support
gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwarePerformanceDataTableS3Support ## CONSUMES
[Depex]
gEfiRscHandlerProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
FirmwarePerformanceDxeExtra.uni

View File

@@ -1,13 +1,14 @@
## @file
# This module updates S3 Resume Performance Record in ACPI Firmware Performance
# Data Table in S3 resume boot mode. In normal boot mode, this module consumes
# SecPerformance PPI produced by SEC phase and build Hob to convey the SEC
# performance data to DXE phase.
# Firmware Performance Pei Module.
#
# In S3 resume boot mode, it updates S3 Resume Performance Record in ACPI Firmware Performance Data Table.
# In normal boot mode, it consumes SecPerformance PPI produced by SEC phase
# and build Hob to convey the SEC performance data to DXE phase.
#
# This module register report status code listener to collect performance data
# for S3 Resume Performance Record on S3 resume boot path.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@@ -21,6 +22,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = FirmwarePerformancePei
MODULE_UNI_FILE = FirmwarePerformancePei.uni
FILE_GUID = ADF01BF6-47D6-495d-B95B-687777807214
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@@ -52,14 +54,23 @@
[Ppis]
gEfiPeiRscHandlerPpiGuid ## CONSUMES
gPeiSecPerformancePpiGuid ## CONSUMES
gPeiSecPerformancePpiGuid ## SOMETIMES_CONSUMES
[Guids]
gEfiFirmwarePerformanceGuid ## CONSUMES
gFirmwarePerformanceS3PointerGuid ## CONSUMES
## SOMETIMES_CONSUMES ## UNDEFINED # RestoreLockBox
## SOMETIMES_PRODUCES ## HOB
## SOMETIMES_CONSUMES ## Variable:L"FirmwarePerformance"
gEfiFirmwarePerformanceGuid
gFirmwarePerformanceS3PointerGuid ## SOMETIMES_CONSUMES ## UNDEFINED # RestoreLockBox
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwarePerformanceDataTableS3Support
gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwarePerformanceDataTableS3Support ## CONSUMES
[Depex]
gEfiPeiMasterBootModePpiGuid AND gEfiPeiRscHandlerPpiGuid
# [BootMode]
# S3_RESUME ## SOMETIMES_CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
FirmwarePerformancePeiExtra.uni

View File

@@ -4,7 +4,7 @@
# This module registers report status code listener to collect performance data
# for SMM boot performance records and S3 Suspend Performance Record.
#
# Copyright (c) 2011 - 2012, 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
# which accompanies this distribution. The full text of the license may be found at
@@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = FirmwarePerformanceSmm
MODULE_UNI_FILE = FirmwarePerformanceSmm.uni
FILE_GUID = 044310AB-77FD-402a-AF1A-87D4120E7329
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
@@ -55,13 +56,17 @@
gEfiSmmAccess2ProtocolGuid ## CONSUMES
[Guids]
gEfiFirmwarePerformanceGuid ## CONSUMES ## LockBox
gEfiFirmwarePerformanceGuid ## PRODUCES ## SmiHandler
gEfiFirmwarePerformanceGuid ## SOMETIMES_CONSUMES ## StatusCode Data
## SOMETIMES_PRODUCES ## UNDEFINED # SaveLockBox
## PRODUCES ## UNDEFINED # SmiHandlerRegister
## SOMETIMES_CONSUMES ## UNDEFINED # StatusCode Data
gEfiFirmwarePerformanceGuid
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeS3SuspendStart
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeS3SuspendEnd
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeS3SuspendStart ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeS3SuspendEnd ## CONSUMES
[Depex]
gEfiSmmRscHandlerProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
FirmwarePerformanceSmmExtra.uni

View File

@@ -1,7 +1,9 @@
## @file
# Component description file for ScriptSave module.
# S3 Boot Script Save State driver.
#
# Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
# It will install S3 Save State protocol to store or record various IO operations to be replayed during an S3 resume.
#
# 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
@@ -16,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = S3SaveStateDxe
MODULE_UNI_FILE = S3SaveStateDxe.uni
FILE_GUID = BDCE85BB-FBAA-4f4e-9264-501A2C249581
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@@ -38,19 +41,19 @@
MdeModulePkg/MdeModulePkg.dec
[LibraryClasses]
UefiRuntimeServicesTableLib
UefiBootServicesTableLib
MemoryAllocationLib
UefiDriverEntryPoint
BaseMemoryLib
DebugLib
BaseLib
S3BootScriptLib
[Protocols]
gEfiS3SaveStateProtocolGuid # PROTOCOL ALWAYS_PRODUCED
gEfiS3SaveStateProtocolGuid ## PRODUCES
[Depex]
TRUE
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
S3SaveStateDxeExtra.uni

View File

@@ -1,9 +1,9 @@
## @file
# Component description file for ScriptSave Lite module.
# S3 SMM Boot Script Save State driver.
#
# This is an implementation of the Boot Script Save protocol.
# It will install S3 SMM Save State protocol to store or record various IO operations to be replayed during an S3 resume.
#
# 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
@@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = SmmS3SaveState
MODULE_UNI_FILE = SmmS3SaveState.uni
FILE_GUID = 2D59F041-53A4-40d0-A6CD-844DC0DFEF17
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
@@ -44,13 +45,14 @@
SmmServicesTableLib
UefiDriverEntryPoint
BaseMemoryLib
DebugLib
BaseLib
S3BootScriptLib
[Protocols]
gEfiS3SmmSaveStateProtocolGuid # PROTOCOL ALWAYS_PRODUCED
gEfiS3SmmSaveStateProtocolGuid ## PRODUCES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
SmmS3SaveStateExtra.uni