From f15d2c8fed6c9e29ae1695aa082647883f6a3583 Mon Sep 17 00:00:00 2001 From: "Gao, Liming" Date: Thu, 28 Aug 2014 03:19:58 +0000 Subject: [PATCH] IntelFrameworkPkg: 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@15925 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf | 12 ++--- .../DxeSmmDriverEntryPoint.inf | 15 +++--- .../FrameworkUefiLib/FrameworkUefiLib.inf | 51 +++++++++---------- .../PeiHobLibFramework/PeiHobLibFramework.inf | 19 +++---- .../PeiSmbusLibSmbusPpi.inf | 8 +-- 5 files changed, 51 insertions(+), 54 deletions(-) diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf index c5e3e6173d..e3c6890442 100644 --- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf +++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf @@ -1,9 +1,7 @@ ## @file -# Component description file for Cpu Io Dxe Io Library. +# I/O Library implementation that uses the CPU I/O Protocol for I/O and MMIO operations. # -# I/O Library implementation that uses the CPU I/O Protocol for I/O -# and MMIO operations. -# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
+# Copyright (c) 2006 - 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 @@ -18,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DxeIoLibCpuIo + MODULE_UNI_FILE = DxeIoLibCpuIo.uni FILE_GUID = e94cd42a-3aad-4ea0-9b09-945891c60ccd MODULE_TYPE = DXE_DRIVER VERSION_STRING = 1.0 @@ -46,7 +45,8 @@ UefiBootServicesTableLib [Protocols] - gEfiCpuIoProtocolGuid # PROTOCOL ALWAYS_CONSUMED + gEfiCpuIoProtocolGuid ## CONSUMES [Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER] - gEfiCpuIoProtocolGuid \ No newline at end of file + gEfiCpuIoProtocolGuid + diff --git a/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf b/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf index a9d031d9ec..9a5b523ea0 100644 --- a/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf +++ b/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf @@ -1,8 +1,9 @@ ## @file -# SMM driver entry point library +# Framework SMM driver entry point library. # -# Register driver in SMRAM and wrapper driver library constructors and entry point -# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+# Register driver in SMRAM and wrapper driver's library constructors and entry point. +# +# Copyright (c) 2006 - 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 @@ -17,6 +18,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DxeSmmDriverEntryPoint + MODULE_UNI_FILE = DxeSmmDriverEntryPoint.uni FILE_GUID = 79C5C7B7-1083-42a6-AD15-2A4E7C4274D7 MODULE_TYPE = DXE_SMM_DRIVER VERSION_STRING = 1.0 @@ -44,11 +46,10 @@ DevicePathLib [Protocols] - gEfiLoadedImageProtocolGuid # PROTOCOL ALWAYS_CONSUMED - gEfiSmmBaseProtocolGuid # PROTOCOL ALWAYS_CONSUMED - gEfiDevicePathProtocolGuid # PROTOCOL ALWAYS_CONSUMED + gEfiLoadedImageProtocolGuid ## CONSUMES + gEfiSmmBaseProtocolGuid ## CONSUMES + gEfiDevicePathProtocolGuid ## CONSUMES [Depex] gEfiSmmBaseProtocolGuid - diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf index cb4841b696..7057ef6e26 100644 --- a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf +++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf @@ -1,13 +1,11 @@ ## @file -# Component description file for the entry point to a EFIDXE Drivers -# # Library to abstract Framework extensions that conflict with UEFI 2.0 Specification. -# Help Port Framework/Tinao code that has conflicts with UEFI 2.0 by hiding the oldconflicts -# with library functions and supporting implementations of the old (EDK/EFI 1.10) and new -# (EDK II/UEFI 2.0) way. This module is a DXE driver as it contains DXE enum extensions for -# EFI event services. # -# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+# This library is helpful to port Framework/Tinao code that has conflicts with UEFI 2.0. +# It hides the old conflicts with library functions and supporting implementations of +# the old (EDK/EFI 1.10) and new (EDK II/UEFI 2.0) way. +# +# Copyright (c) 2006 - 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 @@ -22,6 +20,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = FrameworkUefiLib + MODULE_UNI_FILE = FrameworkUefiLib.uni FILE_GUID = B2F0D71A-A39F-4094-854B-0C6BA6910CCE MODULE_TYPE = UEFI_DRIVER VERSION_STRING = 1.0 @@ -54,30 +53,30 @@ DevicePathLib [Guids] - gEfiEventReadyToBootGuid # ALWAYS_CONSUMED - gEfiEventLegacyBootGuid # ALWAYS_CONSUMED + gEfiEventReadyToBootGuid ## SOMETIMES_CONSUMES ## Event + gEfiEventLegacyBootGuid ## SOMETIMES_CONSUMES ## Event [Protocols] - gEfiDriverBindingProtocolGuid # ALWAYS_CONSUMED - gEfiSimpleTextOutProtocolGuid # ALWAYS_CONSUMED - gEfiGraphicsOutputProtocolGuid # ALWAYS_CONSUMED - gEfiHiiFontProtocolGuid # ALWAYS_CONSUMED - gEfiComponentNameProtocolGuid # SOMETIMES_CONSUMED - gEfiComponentName2ProtocolGuid # SOMETIMES_CONSUMED - gEfiDriverConfigurationProtocolGuid # SOMETIMES_CONSUMED - gEfiDriverConfiguration2ProtocolGuid # SOMETIMES_CONSUMED - gEfiDriverDiagnosticsProtocolGuid # SOMETIMES_CONSUMED - gEfiDriverDiagnostics2ProtocolGuid # SOMETIMES_CONSUMED - gEfiUgaDrawProtocolGuid # SOMETIMES_CONSUMED + gEfiDriverBindingProtocolGuid ## SOMETIMES_PRODUCES + gEfiSimpleTextOutProtocolGuid ## SOMETIMES_CONSUMES + gEfiGraphicsOutputProtocolGuid ## SOMETIMES_CONSUMES + gEfiHiiFontProtocolGuid ## SOMETIMES_CONSUMES + gEfiComponentNameProtocolGuid ## SOMETIMES_PRODUCES + gEfiComponentName2ProtocolGuid ## SOMETIMES_PRODUCES + gEfiDriverConfigurationProtocolGuid ## SOMETIMES_PRODUCES + gEfiDriverConfiguration2ProtocolGuid ## SOMETIMES_PRODUCES + gEfiDriverDiagnosticsProtocolGuid ## SOMETIMES_PRODUCES + gEfiDriverDiagnostics2ProtocolGuid ## SOMETIMES_PRODUCES + gEfiUgaDrawProtocolGuid ## SOMETIMES_CONSUMES [Pcd] - gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize + gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize ## SOMETIMES_CONSUMES [FeaturePcd] - gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable - gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable - gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable - gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable - gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport + gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## CONSUMES diff --git a/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf b/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf index 9a92df8f96..b10be00685 100644 --- a/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf +++ b/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf @@ -5,7 +5,7 @@ # This library instance uses EFI_HOB_TYPE_CV defined in Intel framework HOB specification v0.9 # to implement HobLib BuildCvHob() API. # -# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+# Copyright (c) 2006 - 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 @@ -20,6 +20,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = PeiHobLib + MODULE_UNI_FILE = PeiHobLib.uni FILE_GUID = B6684612-6F5D-425d-952C-F462792EC00B MODULE_TYPE = PEIM VERSION_STRING = 1.0 @@ -44,18 +45,14 @@ DebugLib [Guids] - gEfiHobMemoryAllocStackGuid ## PRODUCES ## HOB - gEfiHobMemoryAllocBspStoreGuid ## PRODUCES ## HOB - gEfiHobMemoryAllocModuleGuid ## PRODUCES ## HOB + gEfiHobMemoryAllocStackGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation StackHob + gEfiHobMemoryAllocBspStoreGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation BspStoreHob + gEfiHobMemoryAllocModuleGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation ModuleHob # # [Hob] -# RESOURCE_DESCRIPTOR ## PRODUCES -# MEMORY_ALLOCATION ## PRODUCES -# GUID_EXTENSION ## CONSUMES -# GUID_EXTENSION ## PRODUCES -# CPU ## PRODUCES -# FV2 ## PRODUCES -# FV ## PRODUCES +# MEMORY_ALLOCATION ## SOMETIMES_PRODUCES +# RESOURCE_DESCRIPTOR ## SOMETIMES_PRODUCES +# FIRMWARE_VOLUME ## SOMETIMES_PRODUCES # diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf index 044c9d1d69..d56d4d3fa9 100644 --- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf +++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf @@ -1,8 +1,7 @@ ## @file -# Component description file for Pei Smbus Library. -# # SMBUS library that layers on top of the SMBUS PPI. -# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
+# +# Copyright (c) 2006 - 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 @@ -17,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = PeiSmbusLibSmbusPpi + MODULE_UNI_FILE = PeiSmbusLibSmbusPpi.uni FILE_GUID = 51C4C059-67F0-4e3c-9A55-FF42A8291C8C MODULE_TYPE = PEIM VERSION_STRING = 1.0 @@ -47,7 +47,7 @@ PeiServicesTablePointerLib [Ppis] - gEfiPeiSmbusPpiGuid # PPI ALWAYS_CONSUMED + gEfiPeiSmbusPpiGuid ## CONSUMES [Depex] gEfiPeiSmbusPpiGuid