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 <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@15925 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Gao, Liming 2014-08-28 03:19:58 +00:00 committed by lgao4
parent f4260465a8
commit f15d2c8fed
5 changed files with 51 additions and 54 deletions

View File

@ -1,9 +1,7 @@
## @file ## @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 # Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# and MMIO operations.
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# #
# This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
@ -18,6 +16,7 @@
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = DxeIoLibCpuIo BASE_NAME = DxeIoLibCpuIo
MODULE_UNI_FILE = DxeIoLibCpuIo.uni
FILE_GUID = e94cd42a-3aad-4ea0-9b09-945891c60ccd FILE_GUID = e94cd42a-3aad-4ea0-9b09-945891c60ccd
MODULE_TYPE = DXE_DRIVER MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0 VERSION_STRING = 1.0
@ -46,7 +45,8 @@
UefiBootServicesTableLib UefiBootServicesTableLib
[Protocols] [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] [Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER]
gEfiCpuIoProtocolGuid gEfiCpuIoProtocolGuid

View File

@ -1,8 +1,9 @@
## @file ## @file
# SMM driver entry point library # Framework SMM driver entry point library.
# #
# Register driver in SMRAM and wrapper driver library constructors and entry point # Register driver in SMRAM and wrapper driver's library constructors and entry point.
# 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 # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
@ -17,6 +18,7 @@
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = DxeSmmDriverEntryPoint BASE_NAME = DxeSmmDriverEntryPoint
MODULE_UNI_FILE = DxeSmmDriverEntryPoint.uni
FILE_GUID = 79C5C7B7-1083-42a6-AD15-2A4E7C4274D7 FILE_GUID = 79C5C7B7-1083-42a6-AD15-2A4E7C4274D7
MODULE_TYPE = DXE_SMM_DRIVER MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0 VERSION_STRING = 1.0
@ -44,11 +46,10 @@
DevicePathLib DevicePathLib
[Protocols] [Protocols]
gEfiLoadedImageProtocolGuid # PROTOCOL ALWAYS_CONSUMED gEfiLoadedImageProtocolGuid ## CONSUMES
gEfiSmmBaseProtocolGuid # PROTOCOL ALWAYS_CONSUMED gEfiSmmBaseProtocolGuid ## CONSUMES
gEfiDevicePathProtocolGuid # PROTOCOL ALWAYS_CONSUMED gEfiDevicePathProtocolGuid ## CONSUMES
[Depex] [Depex]
gEfiSmmBaseProtocolGuid gEfiSmmBaseProtocolGuid

View File

@ -1,13 +1,11 @@
## @file ## @file
# Component description file for the entry point to a EFIDXE Drivers
#
# Library to abstract Framework extensions that conflict with UEFI 2.0 Specification. # 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.<BR> # 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.<BR>
# #
# This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
@ -22,6 +20,7 @@
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = FrameworkUefiLib BASE_NAME = FrameworkUefiLib
MODULE_UNI_FILE = FrameworkUefiLib.uni
FILE_GUID = B2F0D71A-A39F-4094-854B-0C6BA6910CCE FILE_GUID = B2F0D71A-A39F-4094-854B-0C6BA6910CCE
MODULE_TYPE = UEFI_DRIVER MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0 VERSION_STRING = 1.0
@ -54,30 +53,30 @@
DevicePathLib DevicePathLib
[Guids] [Guids]
gEfiEventReadyToBootGuid # ALWAYS_CONSUMED gEfiEventReadyToBootGuid ## SOMETIMES_CONSUMES ## Event
gEfiEventLegacyBootGuid # ALWAYS_CONSUMED gEfiEventLegacyBootGuid ## SOMETIMES_CONSUMES ## Event
[Protocols] [Protocols]
gEfiDriverBindingProtocolGuid # ALWAYS_CONSUMED gEfiDriverBindingProtocolGuid ## SOMETIMES_PRODUCES
gEfiSimpleTextOutProtocolGuid # ALWAYS_CONSUMED gEfiSimpleTextOutProtocolGuid ## SOMETIMES_CONSUMES
gEfiGraphicsOutputProtocolGuid # ALWAYS_CONSUMED gEfiGraphicsOutputProtocolGuid ## SOMETIMES_CONSUMES
gEfiHiiFontProtocolGuid # ALWAYS_CONSUMED gEfiHiiFontProtocolGuid ## SOMETIMES_CONSUMES
gEfiComponentNameProtocolGuid # SOMETIMES_CONSUMED gEfiComponentNameProtocolGuid ## SOMETIMES_PRODUCES
gEfiComponentName2ProtocolGuid # SOMETIMES_CONSUMED gEfiComponentName2ProtocolGuid ## SOMETIMES_PRODUCES
gEfiDriverConfigurationProtocolGuid # SOMETIMES_CONSUMED gEfiDriverConfigurationProtocolGuid ## SOMETIMES_PRODUCES
gEfiDriverConfiguration2ProtocolGuid # SOMETIMES_CONSUMED gEfiDriverConfiguration2ProtocolGuid ## SOMETIMES_PRODUCES
gEfiDriverDiagnosticsProtocolGuid # SOMETIMES_CONSUMED gEfiDriverDiagnosticsProtocolGuid ## SOMETIMES_PRODUCES
gEfiDriverDiagnostics2ProtocolGuid # SOMETIMES_CONSUMED gEfiDriverDiagnostics2ProtocolGuid ## SOMETIMES_PRODUCES
gEfiUgaDrawProtocolGuid # SOMETIMES_CONSUMED gEfiUgaDrawProtocolGuid ## SOMETIMES_CONSUMES
[Pcd] [Pcd]
gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize ## SOMETIMES_CONSUMES
[FeaturePcd] [FeaturePcd]
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## CONSUMES

View File

@ -5,7 +5,7 @@
# This library instance uses EFI_HOB_TYPE_CV defined in Intel framework HOB specification v0.9 # This library instance uses EFI_HOB_TYPE_CV defined in Intel framework HOB specification v0.9
# to implement HobLib BuildCvHob() API. # to implement HobLib BuildCvHob() API.
# #
# 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 # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
@ -20,6 +20,7 @@
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = PeiHobLib BASE_NAME = PeiHobLib
MODULE_UNI_FILE = PeiHobLib.uni
FILE_GUID = B6684612-6F5D-425d-952C-F462792EC00B FILE_GUID = B6684612-6F5D-425d-952C-F462792EC00B
MODULE_TYPE = PEIM MODULE_TYPE = PEIM
VERSION_STRING = 1.0 VERSION_STRING = 1.0
@ -44,18 +45,14 @@
DebugLib DebugLib
[Guids] [Guids]
gEfiHobMemoryAllocStackGuid ## PRODUCES ## HOB gEfiHobMemoryAllocStackGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation StackHob
gEfiHobMemoryAllocBspStoreGuid ## PRODUCES ## HOB gEfiHobMemoryAllocBspStoreGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation BspStoreHob
gEfiHobMemoryAllocModuleGuid ## PRODUCES ## HOB gEfiHobMemoryAllocModuleGuid ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation ModuleHob
# #
# [Hob] # [Hob]
# RESOURCE_DESCRIPTOR ## PRODUCES # MEMORY_ALLOCATION ## SOMETIMES_PRODUCES
# MEMORY_ALLOCATION ## PRODUCES # RESOURCE_DESCRIPTOR ## SOMETIMES_PRODUCES
# GUID_EXTENSION ## CONSUMES # FIRMWARE_VOLUME ## SOMETIMES_PRODUCES
# GUID_EXTENSION ## PRODUCES
# CPU ## PRODUCES
# FV2 ## PRODUCES
# FV ## PRODUCES
# #

View File

@ -1,8 +1,7 @@
## @file ## @file
# Component description file for Pei Smbus Library.
#
# SMBUS library that layers on top of the SMBUS PPI. # SMBUS library that layers on top of the SMBUS PPI.
# 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 # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # are licensed and made available under the terms and conditions of the BSD License
@ -17,6 +16,7 @@
[Defines] [Defines]
INF_VERSION = 0x00010005 INF_VERSION = 0x00010005
BASE_NAME = PeiSmbusLibSmbusPpi BASE_NAME = PeiSmbusLibSmbusPpi
MODULE_UNI_FILE = PeiSmbusLibSmbusPpi.uni
FILE_GUID = 51C4C059-67F0-4e3c-9A55-FF42A8291C8C FILE_GUID = 51C4C059-67F0-4e3c-9A55-FF42A8291C8C
MODULE_TYPE = PEIM MODULE_TYPE = PEIM
VERSION_STRING = 1.0 VERSION_STRING = 1.0
@ -47,7 +47,7 @@
PeiServicesTablePointerLib PeiServicesTablePointerLib
[Ppis] [Ppis]
gEfiPeiSmbusPpiGuid # PPI ALWAYS_CONSUMED gEfiPeiSmbusPpiGuid ## CONSUMES
[Depex] [Depex]
gEfiPeiSmbusPpiGuid gEfiPeiSmbusPpiGuid