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

diff --git a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
index c5e3e6173d28633c0805529a5e77ee316e2b4363..e3c68904429f8411c4c5d3f94ea827e9c0313358 100644 (file)
--- a/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
+++ b/IntelFrameworkPkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.inf
@@ -1,9 +1,7 @@
 ## @file\r
-# Component description file for Cpu Io Dxe Io Library.\r
+# I/O Library implementation that uses the CPU I/O Protocol for I/O and MMIO operations.\r
 #\r
-# I/O Library implementation that uses the CPU I/O Protocol for I/O\r
-#  and MMIO operations.\r
-# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -18,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DxeIoLibCpuIo\r
+  MODULE_UNI_FILE                = DxeIoLibCpuIo.uni\r
   FILE_GUID                      = e94cd42a-3aad-4ea0-9b09-945891c60ccd\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -46,7 +45,8 @@
   UefiBootServicesTableLib\r
 \r
 [Protocols]\r
-  gEfiCpuIoProtocolGuid                         # PROTOCOL ALWAYS_CONSUMED\r
+  gEfiCpuIoProtocolGuid                         ## CONSUMES\r
 \r
 [Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER]\r
-  gEfiCpuIoProtocolGuid
\ No newline at end of file
+  gEfiCpuIoProtocolGuid\r
+\r

diff --git a/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf b/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf
index a9d031d9eca8de8ae17209bd08175f36689280c8..9a5b523ea0dba0d7eb0f6ae1df1e9e6456c1a4c3 100644 (file)
--- a/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf
+++ b/IntelFrameworkPkg/Library/DxeSmmDriverEntryPoint/DxeSmmDriverEntryPoint.inf
@@ -1,8 +1,9 @@
 ## @file\r
-# SMM driver entry point library\r
+# Framework SMM driver entry point library.\r
 #\r
-# Register driver in SMRAM and wrapper driver library constructors and entry point\r
-# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+# Register driver in SMRAM and wrapper driver's library constructors and entry point.\r
+#\r
+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -17,6 +18,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DxeSmmDriverEntryPoint\r
+  MODULE_UNI_FILE                = DxeSmmDriverEntryPoint.uni\r
   FILE_GUID                      = 79C5C7B7-1083-42a6-AD15-2A4E7C4274D7\r
   MODULE_TYPE                    = DXE_SMM_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -44,11 +46,10 @@
   DevicePathLib\r
 \r
 [Protocols]\r
-  gEfiLoadedImageProtocolGuid                   # PROTOCOL ALWAYS_CONSUMED\r
-  gEfiSmmBaseProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
-  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
+  gEfiLoadedImageProtocolGuid                   ## CONSUMES\r
+  gEfiSmmBaseProtocolGuid                       ## CONSUMES\r
+  gEfiDevicePathProtocolGuid                    ## CONSUMES\r
   \r
 [Depex]\r
   gEfiSmmBaseProtocolGuid\r
 \r
-\r

diff --git a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf
index cb4841b69668f35ba6a80d33378f2cc1b573202d..7057ef6e264c18f55bbaaf698fe6a2452e0cd1d8 100644 (file)
--- a/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf
+++ b/IntelFrameworkPkg/Library/FrameworkUefiLib/FrameworkUefiLib.inf
@@ -1,13 +1,11 @@
 ## @file\r
-#  Component description file for the entry point to a EFIDXE Drivers\r
-#\r
 #  Library to abstract Framework extensions that conflict with UEFI 2.0 Specification.\r
-#  Help Port Framework/Tinao code that has conflicts with UEFI 2.0 by hiding the oldconflicts \r
-#  with library functions and supporting implementations of the old (EDK/EFI 1.10) and new \r
-#  (EDK II/UEFI 2.0) way. This module is a DXE driver as it contains DXE enum extensions for \r
-#  EFI event services.\r
 #\r
-#  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  This library is helpful to port Framework/Tinao code that has conflicts with UEFI 2.0. \r
+#  It hides the old conflicts with library functions and supporting implementations of\r
+#  the old (EDK/EFI 1.10) and new (EDK II/UEFI 2.0) way.\r
+#\r
+#  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -22,6 +20,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = FrameworkUefiLib\r
+  MODULE_UNI_FILE                = FrameworkUefiLib.uni\r
   FILE_GUID                      = B2F0D71A-A39F-4094-854B-0C6BA6910CCE\r
   MODULE_TYPE                    = UEFI_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -54,30 +53,30 @@
   DevicePathLib\r
   \r
 [Guids]\r
-  gEfiEventReadyToBootGuid                      # ALWAYS_CONSUMED\r
-  gEfiEventLegacyBootGuid                       # ALWAYS_CONSUMED\r
+  gEfiEventReadyToBootGuid                      ## SOMETIMES_CONSUMES  ## Event\r
+  gEfiEventLegacyBootGuid                       ## SOMETIMES_CONSUMES  ## Event\r
 \r
 [Protocols]\r
-  gEfiDriverBindingProtocolGuid                 # ALWAYS_CONSUMED\r
-  gEfiSimpleTextOutProtocolGuid                 # ALWAYS_CONSUMED\r
-  gEfiGraphicsOutputProtocolGuid                # ALWAYS_CONSUMED\r
-  gEfiHiiFontProtocolGuid                       # ALWAYS_CONSUMED\r
-  gEfiComponentNameProtocolGuid                 # SOMETIMES_CONSUMED\r
-  gEfiComponentName2ProtocolGuid                # SOMETIMES_CONSUMED\r
-  gEfiDriverConfigurationProtocolGuid           # SOMETIMES_CONSUMED\r
-  gEfiDriverConfiguration2ProtocolGuid          # SOMETIMES_CONSUMED\r
-  gEfiDriverDiagnosticsProtocolGuid             # SOMETIMES_CONSUMED\r
-  gEfiDriverDiagnostics2ProtocolGuid            # SOMETIMES_CONSUMED\r
-  gEfiUgaDrawProtocolGuid                       # SOMETIMES_CONSUMED\r
+  gEfiDriverBindingProtocolGuid                 ## SOMETIMES_PRODUCES\r
+  gEfiSimpleTextOutProtocolGuid                 ## SOMETIMES_CONSUMES\r
+  gEfiGraphicsOutputProtocolGuid                ## SOMETIMES_CONSUMES\r
+  gEfiHiiFontProtocolGuid                       ## SOMETIMES_CONSUMES\r
+  gEfiComponentNameProtocolGuid                 ## SOMETIMES_PRODUCES\r
+  gEfiComponentName2ProtocolGuid                ## SOMETIMES_PRODUCES\r
+  gEfiDriverConfigurationProtocolGuid           ## SOMETIMES_PRODUCES\r
+  gEfiDriverConfiguration2ProtocolGuid          ## SOMETIMES_PRODUCES\r
+  gEfiDriverDiagnosticsProtocolGuid             ## SOMETIMES_PRODUCES\r
+  gEfiDriverDiagnostics2ProtocolGuid            ## SOMETIMES_PRODUCES\r
+  gEfiUgaDrawProtocolGuid                       ## SOMETIMES_CONSUMES\r
 \r
 \r
 [Pcd]\r
-  gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize\r
+  gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize ## SOMETIMES_CONSUMES\r
 \r
 [FeaturePcd]\r
-  gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable\r
-  gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable\r
-  gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable\r
-  gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable\r
-  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport\r
+  gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnosticsDisable    ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable        ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdDriverDiagnostics2Disable   ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable       ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport           ## CONSUMES\r
 \r

diff --git a/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf b/IntelFrameworkPkg/Library/PeiHobLibFramework/PeiHobLibFramework.inf
index 9a92df8f961daee110b887feeccb872261df25fe..b10be0068522d360bfc45e7fc4fe5de62b81c3a6 100644 (file)
--- 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\r
 # to implement HobLib BuildCvHob() API. \r
 #\r
-# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -20,6 +20,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PeiHobLib\r
+  MODULE_UNI_FILE                = PeiHobLib.uni\r
   FILE_GUID                      = B6684612-6F5D-425d-952C-F462792EC00B\r
   MODULE_TYPE                    = PEIM\r
   VERSION_STRING                 = 1.0\r
@@ -44,18 +45,14 @@
   DebugLib\r
 \r
 [Guids]\r
-  gEfiHobMemoryAllocStackGuid                   ## PRODUCES ## HOB\r
-  gEfiHobMemoryAllocBspStoreGuid                ## PRODUCES ## HOB\r
-  gEfiHobMemoryAllocModuleGuid                  ## PRODUCES ## HOB\r
+  gEfiHobMemoryAllocStackGuid                   ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation StackHob\r
+  gEfiHobMemoryAllocBspStoreGuid                ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation BspStoreHob\r
+  gEfiHobMemoryAllocModuleGuid                  ## SOMETIMES_PRODUCES ## HOB # MemoryAllocation ModuleHob\r
 \r
 #\r
 # [Hob]\r
-#   RESOURCE_DESCRIPTOR   ## PRODUCES\r
-#   MEMORY_ALLOCATION     ## PRODUCES\r
-#   GUID_EXTENSION        ## CONSUMES\r
-#   GUID_EXTENSION        ## PRODUCES\r
-#   CPU                   ## PRODUCES\r
-#   FV2                   ## PRODUCES\r
-#   FV                    ## PRODUCES\r
+#   MEMORY_ALLOCATION     ## SOMETIMES_PRODUCES\r
+#   RESOURCE_DESCRIPTOR   ## SOMETIMES_PRODUCES\r
+#   FIRMWARE_VOLUME       ## SOMETIMES_PRODUCES\r
 #   \r
 \r

diff --git a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf
index 044c9d1d69edc80b0d3f3a3f2be7a06566118005..d56d4d3fa924a381cbf2f0cc863edfc16b1b448f 100644 (file)
--- a/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf
+++ b/IntelFrameworkPkg/Library/PeiSmbusLibSmbusPpi/PeiSmbusLibSmbusPpi.inf
@@ -1,8 +1,7 @@
 ## @file\r
-# Component description file for Pei Smbus Library.\r
-#\r
 # SMBUS library that layers on top of the SMBUS PPI.\r
-# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#\r
+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -17,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PeiSmbusLibSmbusPpi\r
+  MODULE_UNI_FILE                = PeiSmbusLibSmbusPpi.uni\r
   FILE_GUID                      = 51C4C059-67F0-4e3c-9A55-FF42A8291C8C\r
   MODULE_TYPE                    = PEIM\r
   VERSION_STRING                 = 1.0\r
@@ -47,7 +47,7 @@
   PeiServicesTablePointerLib\r
 \r
 [Ppis]\r
-  gEfiPeiSmbusPpiGuid                           # PPI ALWAYS_CONSUMED\r
+  gEfiPeiSmbusPpiGuid                           ## CONSUMES\r
 \r
 [Depex]\r
   gEfiPeiSmbusPpiGuid\r