UefiCpuPkg: 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: Gao, Liming <liming.gao@intel.com>
Reviewed-by: Michael Kinney <michael.d.kinney@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15933 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Gao, Liming 2014-08-28 05:09:12 +00:00 committed by lgao4
parent ed395cfecd
commit e48e07424a
17 changed files with 95 additions and 66 deletions

View File

@ -1,8 +1,7 @@
## @file
# Simple CPU driver installs CPU Architecture Protocol.
#
# Component description file for simple CPU driver
#
# Copyright (c) 2008 - 2013, 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
@ -16,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = CpuDxe
MODULE_UNI_FILE = CpuDxe.uni
FILE_GUID = 1A1E4886-9517-440e-9FDE-3BE44CEE2136
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -58,12 +58,14 @@
X64/CpuAsm.S | GCC
[Protocols]
gEfiCpuArchProtocolGuid
gEfiCpuArchProtocolGuid ## PRODUCES
[Guids]
gIdleLoopEventGuid ## CONSUMES ## GUID
gEfiVectorHandoffTableGuid ## CONSUMES ## Configuration Table
gIdleLoopEventGuid ## CONSUMES ## Event
gEfiVectorHandoffTableGuid ## SOMETIMES_CONSUMES ## SystemTable
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
CpuDxeExtra.uni

View File

@ -1,9 +1,7 @@
## @file
# Produces the CPU I/O 2 Protocol.
# Produces the CPU I/O 2 Protocol by using the services of the I/O Library.
#
# This DXE driver produces of the CPU I/O 2 Protocol, as introduced by PI 1.2.
#
# Copyright (c) 2009 - 2011, 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
# which accompanies this distribution. The full text of the license may be found at
@ -17,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = CpuIo2Dxe
MODULE_UNI_FILE = CpuIo2Dxe.uni
FILE_GUID = A19B1FE7-C1BC-49F8-875F-54A5D542443F
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -47,3 +46,6 @@
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
CpuIo2DxeExtra.uni

View File

@ -1,7 +1,7 @@
## @file
# Module that produces the SMM CPU I/O 2 Protocol using the services of the I/O Library
# Produces the SMM CPU I/O 2 Protocol by using the services of the I/O Library.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@ -14,6 +14,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = CpuIo2Smm
MODULE_UNI_FILE = CpuIo2Smm.uni
FILE_GUID = A47EE2D8-F60E-42fd-8E58-7BD65EE4C29B
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
@ -42,7 +43,10 @@
BaseMemoryLib
[Protocols]
gEfiSmmCpuIo2ProtocolGuid # PROTOCOL ALWAYS_CONSUMED
gEfiSmmCpuIo2ProtocolGuid ## PRODUCES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
CpuIo2SmmExtra.uni

View File

@ -1,9 +1,7 @@
## @file
# Produces the CPU I/O PPI.
# Produces the CPU I/O PPI by using the services of the I/O Library.
#
# This PEIM produces of the CPU I/O PPI.
#
# Copyright (c) 2009 - 2011, 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
# which accompanies this distribution. The full text of the license may be found at
@ -17,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = CpuIoPei
MODULE_UNI_FILE = CpuIoPei.uni
FILE_GUID = AE265864-CF5D-41a8-913D-71C155E76442
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@ -43,7 +42,10 @@
PeiServicesLib
[Ppis]
gEfiPeiCpuIoPpiInstalledGuid # PPI ALWAYS_PRODUCED
gEfiPeiCpuIoPpiInstalledGuid ## PRODUCES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
CpuIoPeiExtra.uni

View File

@ -1,8 +1,9 @@
## @file
# This library defines some routines that are generic for IA32 family CPU
# to be UEFI specification compliant.
# This library defines some routines that are generic for IA32 family CPU.
#
# Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
# The library routines are UEFI specification compliant.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@ -16,6 +17,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BaseUefiCpuLib
MODULE_UNI_FILE = BaseUefiCpuLib.uni
FILE_GUID = 34C24FD7-7A90-45c2-89FD-946473D9CE98
MODULE_TYPE = BASE
VERSION_STRING = 1.0

View File

@ -1,7 +1,8 @@
## @file
# Component description file for CPU Local APIC Library.
# The Local Apic library supports xAPIC mode only.
#
# This library instance supports xAPIC mode only.
# Note: Local APIC library assumes local APIC is enabled. It does not handle cases
# where local APIC is disabled.
#
# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
@ -17,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BaseXApicLib
MODULE_UNI_FILE = BaseXApicLib.uni
FILE_GUID = D87CA0A8-1AC2-439b-90F8-EF4A2AC88DAF
MODULE_TYPE = BASE
VERSION_STRING = 1.0
@ -42,4 +44,4 @@
IoLib
[Pcd]
gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds
gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds ## SOMETIME_CONSUMES

View File

@ -1,8 +1,8 @@
## @file
# Component description file for CPU Local APIC Library.
# The Local Apic library supports x2APIC capable processors which have xAPIC and x2APIC modes.
#
# This library instance supports x2APIC capable processors
# which have xAPIC and x2APIC modes.
# Note: Local APIC library assumes local APIC is enabled. It does not handle cases
# where local APIC is disabled.
#
# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BaseXApicX2ApicLib
MODULE_UNI_FILE = BaseXApicX2ApicLib.uni
FILE_GUID = 967B6E05-F10D-4c10-8BF7-365291CA143F
MODULE_TYPE = BASE
VERSION_STRING = 1.0
@ -43,5 +44,5 @@
IoLib
[Pcd]
gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds
gUefiCpuPkgTokenSpaceGuid.PcdCpuInitIpiDelayInMicroSeconds ## SOMETIME_CONSUMES

View File

@ -1,9 +1,7 @@
## @file
# Component description file for DXE CPU Exception Handler Library instance.
# CPU Exception Handler library instance for DXE modules.
#
# This library instance supports DXE module only.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@ -17,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = DxeCpuExceptionHandlerLib
MODULE_UNI_FILE = DxeCpuExceptionHandlerLib.uni
FILE_GUID = B6E9835A-EDCF-4748-98A8-27D3C722E02D
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0

View File

@ -1,9 +1,7 @@
## @file
# Component description file for SEC/PEI CPU Exception Handler Library instance
# CPU Exception Handler library instance for SEC/PEI modules.
#
# This library instance supports SEC/PEI module only.
#
# Copyright (c) 2012 - 2013, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2012 - 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
@ -17,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = SecPeiCpuExceptionHandlerLib
MODULE_UNI_FILE = SecPeiCpuExceptionHandlerLib.uni
FILE_GUID = CA4BBC99-DFC6-4234-B553-8B6586B7B113
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@ -56,6 +55,3 @@
PrintLib
LocalApicLib
PeCoffGetEntryPointLib
[Ppis]
gEfiVectorHandoffInfoPpiGuid

View File

@ -1,9 +1,7 @@
## @file
# Component description file for SMM CPU Exception Handler Library instance.
# CPU Exception Handler library instance for SMM modules.
#
# This library instance supports SMM module only.
#
# 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
# which accompanies this distribution. The full text of the license may be found at
@ -17,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = SmmCpuExceptionHandlerLib
MODULE_UNI_FILE = SmmCpuExceptionHandlerLib.uni
FILE_GUID = 8D2C439B-3981-42ff-9CE5-1B50ECA502D6
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
@ -60,5 +59,3 @@
PeCoffGetEntryPointLib
DebugLib
[Ppis]
gEfiVectorHandoffInfoPpiGuid

View File

@ -1,5 +1,5 @@
## @file
# MTRR library provides API for MTRR operation
# MTRR library provides APIs for MTRR operation.
#
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = MtrrLib
MODULE_UNI_FILE = MtrrLib.uni
FILE_GUID = 6826b408-f4f3-47ee-917f-af7047f9d937
MODULE_TYPE = BASE
VERSION_STRING = 1.0

View File

@ -13,7 +13,7 @@
# This library differs with the SecPeiDxeTimerLibCpu library in the MdePkg in
# that it uses the local APIC library so that it supports x2APIC mode.
#
# Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
# 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 of the BSD License
@ -28,6 +28,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = SecPeiDxeTimerLibUefiCpu
MODULE_UNI_FILE = SecPeiDxeTimerLibUefiCpu.uni
FILE_GUID = 4FFF2014-2086-4ee6-9B58-886D1967861C
MODULE_TYPE = BASE
VERSION_STRING = 1.0
@ -62,5 +63,5 @@
[Pcd.IA32, Pcd.X64]
gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## SOMETIME_CONSUMES

View File

@ -1,6 +1,8 @@
## @file
# Reset Vector
#
# This VTF requires build time fixups in order to find the SEC entry point.
#
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
@ -18,6 +20,7 @@
FILE_GUID = 1BA0062E-C779-4582-8566-336AE8F78F09
MODULE_TYPE = SEC
VERSION_STRING = 1.1
MODULE_UNI_FILE = ResetVector.uni
#
# The following information is for reference only and not required by the build tools.
@ -30,3 +33,6 @@
[Packages]
MdePkg/MdePkg.dec
[UserExtensions.TianoCore."ExtraFiles"]
ResetVectorExtra.uni

View File

@ -1,7 +1,7 @@
## @file
# Reset Vector binary
#
# 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
@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = ResetVector
MODULE_UNI_FILE = ResetVector.uni
FILE_GUID = 1BA0062E-C779-4582-8566-336AE8F78F09
MODULE_TYPE = SEC
VERSION_STRING = 1.1
@ -31,3 +32,5 @@
[Binaries.X64]
RAW|ResetVector.x64.raw|*
[UserExtensions.TianoCore."ExtraFiles"]
ResetVectorExtra.uni

View File

@ -18,6 +18,7 @@
FILE_GUID = 1BA0062E-C779-4582-8566-336AE8F78F09
MODULE_TYPE = SEC
VERSION_STRING = 1.1
MODULE_UNI_FILE = ResetVector.uni
#
# The following information is for reference only and not required by the build tools.
@ -30,3 +31,6 @@
[Packages]
MdePkg/MdePkg.dec
[UserExtensions.TianoCore."ExtraFiles"]
ResetVectorExtra.uni

View File

@ -1,5 +1,5 @@
/** @file
This module produces the EFI_PEI_S3_RESUME_PPI.
This module produces the EFI_PEI_S3_RESUME2_PPI.
This module works with StandAloneBootScriptExecutor to S3 resume to OS.
This module will excute the boot script saved during last boot and after that,
control is passed to OS waking up handler.

View File

@ -1,10 +1,11 @@
## @file
# S3 Resume Module:
# S3 Resume Module installs EFI_PEI_S3_RESUME2_PPI.
#
# This module works with StandAloneBootScriptExecutor to S3 resume to OS.
# This module will excute the boot script saved during last boot and after that,
# control is passed to OS waking up handler.
#
# Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
# 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 of the BSD License
@ -19,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = S3Resume2Pei
MODULE_UNI_FILE = S3Resume2Pei.uni
FILE_GUID = 89E549B0-7CFE-449d-9BA3-10D8B2312D71
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@ -66,25 +68,30 @@
PrintLib
[Guids]
gEfiBootScriptExecutorVariableGuid # SOMETIMES_CONSUMED
gEfiBootScriptExecutorContextGuid # SOMETIMES_CONSUMED
gPerformanceProtocolGuid # ALWAYS_CONSUMED L"PerfDataMemAddr"
gEfiAcpiVariableGuid # ALWAYS_CONSUMED Hob: GUID_EXTENSION
gEfiAcpiS3ContextGuid # ALWAYS_CONSUMED
gEfiBootScriptExecutorVariableGuid ## SOMETIMES_CONSUMES ## UNDEFINED # LockBox
gEfiBootScriptExecutorContextGuid ## SOMETIMES_CONSUMES ## UNDEFINED # LockBox
gPerformanceProtocolGuid ## SOMETIMES_CONSUMES ## Variable:L"PerfDataMemAddr"
## SOMETIMES_CONSUMES ## HOB
## SOMETIMES_CONSUMES ## UNDEFINED # LockBox
gEfiAcpiVariableGuid
gEfiAcpiS3ContextGuid ## SOMETIMES_CONSUMES ## UNDEFINED # LockBox
[Ppis]
gEfiPeiReadOnlyVariable2PpiGuid # PPI ALWAYS_CONSUMED
gEfiPeiS3Resume2PpiGuid # PPI ALWAYS_PRODUCED
gPeiSmmAccessPpiGuid # PPI ALWAYS_CONSUMED
gPeiPostScriptTablePpiGuid # PPI ALWAYS_PRODUCED
gEfiEndOfPeiSignalPpiGuid # PPI ALWAYS_PRODUCED
gEfiPeiReadOnlyVariable2PpiGuid ## CONSUMES
gEfiPeiS3Resume2PpiGuid ## PRODUCES
gPeiSmmAccessPpiGuid ## SOMETIMES_CONSUMES
gPeiPostScriptTablePpiGuid ## SOMETIMES_PRODUCES
gEfiEndOfPeiSignalPpiGuid ## SOMETIMES_PRODUCES
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode
gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport
gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdUse1GPageTable
gEfiMdeModulePkgTokenSpaceGuid.PcdUse1GPageTable ## SOMETIMES_CONSUMES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
S3Resume2PeiExtra.uni