From e48e07424a72a2bdaa8dfe46198facaca02051d6 Mon Sep 17 00:00:00 2001 From: "Gao, Liming" Date: Thu, 28 Aug 2014 05:09:12 +0000 Subject: 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 Reviewed-by: Michael Kinney git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15933 6f19259b-4bc3-4df7-8a09-765794883524 --- UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf | 8 +++++--- UefiCpuPkg/Library/BaseXApicLib/BaseXApicLib.inf | 8 +++++--- UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf | 9 +++++---- .../CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf | 7 +++---- .../CpuExceptionHandlerLib/SecPeiCpuExceptionHandlerLib.inf | 10 +++------- .../CpuExceptionHandlerLib/SmmCpuExceptionHandlerLib.inf | 11 ++++------- UefiCpuPkg/Library/MtrrLib/MtrrLib.inf | 3 ++- .../SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf | 5 +++-- 8 files changed, 30 insertions(+), 31 deletions(-) (limited to 'UefiCpuPkg/Library') diff --git a/UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf b/UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf index 2bc023fc23..7cf7d8ca80 100644 --- a/UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf +++ b/UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf @@ -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.
+# The library routines are UEFI specification compliant. +# +# Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.
# 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 diff --git a/UefiCpuPkg/Library/BaseXApicLib/BaseXApicLib.inf b/UefiCpuPkg/Library/BaseXApicLib/BaseXApicLib.inf index 4257b157e7..839c311e1e 100644 --- a/UefiCpuPkg/Library/BaseXApicLib/BaseXApicLib.inf +++ b/UefiCpuPkg/Library/BaseXApicLib/BaseXApicLib.inf @@ -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.
# 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 diff --git a/UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf b/UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf index bc6182d80d..cb7a42e072 100644 --- a/UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf +++ b/UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf @@ -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.
# 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 diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf index b8bf4ebd17..0718afee72 100644 --- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf +++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf @@ -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.
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.
# 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 diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuExceptionHandlerLib.inf b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuExceptionHandlerLib.inf index 3d48f76ee0..0530a15024 100644 --- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuExceptionHandlerLib.inf +++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuExceptionHandlerLib.inf @@ -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.
+# Copyright (c) 2012 - 2014, Intel Corporation. All rights reserved.
# 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 diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmCpuExceptionHandlerLib.inf b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmCpuExceptionHandlerLib.inf index 2fe7ac3ca6..582fc8a9cf 100644 --- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmCpuExceptionHandlerLib.inf +++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmCpuExceptionHandlerLib.inf @@ -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.
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.
# 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 @@ -59,6 +58,4 @@ LocalApicLib PeCoffGetEntryPointLib DebugLib - -[Ppis] - gEfiVectorHandoffInfoPpiGuid + diff --git a/UefiCpuPkg/Library/MtrrLib/MtrrLib.inf b/UefiCpuPkg/Library/MtrrLib/MtrrLib.inf index e635752e89..64ec9bd0b0 100644 --- a/UefiCpuPkg/Library/MtrrLib/MtrrLib.inf +++ b/UefiCpuPkg/Library/MtrrLib/MtrrLib.inf @@ -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.
# 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 diff --git a/UefiCpuPkg/Library/SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf b/UefiCpuPkg/Library/SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf index e47b662625..ad54492df8 100644 --- a/UefiCpuPkg/Library/SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf +++ b/UefiCpuPkg/Library/SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf @@ -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.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # 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 -- cgit v1.2.3