MdeModulePkg: 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: Zeng, Star <star.zeng@intel.com>
Reviewed-by: Gao, Liming <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15962 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 60 insertions, 26 deletions

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
index b44e1e21ac..5649241f71 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
@@ -1,4 +1,6 @@
 ## @file

+# Fault Tolerant Write Dxe Driver.

+#

 # This driver installs Fault Tolerant Write (FTW) protocol, 

 # which provides fault tolerant write capability for block devices.

 # Its implementation depends on the full functionality FVB protocol that support read, write/erase flash access.

@@ -17,6 +19,7 @@
 [Defines]

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = FaultTolerantWriteDxe

+  MODULE_UNI_FILE                = FaultTolerantWriteDxe.uni

   FILE_GUID                      = FE5CEA76-4F72-49e8-986F-2CD899DFFE5D

   MODULE_TYPE                    = DXE_DRIVER

   VERSION_STRING                 = 1.0

@@ -50,23 +53,30 @@
   ReportStatusCodeLib

 

 [Guids]

-  gEdkiiWorkingBlockSignatureGuid               ## CONSUMES ## FV Signature of Working Space Header

+  #

+  # Signature in EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER

+  #

+  ## CONSUMES           ## GUID

+  ## PRODUCES           ## GUID

+  gEdkiiWorkingBlockSignatureGuid

 

 [Protocols]

-  gEfiSwapAddressRangeProtocolGuid     | gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable          ## CONSUMES

-  gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES

+  gEfiSwapAddressRangeProtocolGuid | gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable ## SOMETIMES_CONSUMES

+  ## NOTIFY

+  ## CONSUMES

+  gEfiFirmwareVolumeBlockProtocolGuid

   gEfiFaultTolerantWriteProtocolGuid            ## PRODUCES

 

 [FeaturePcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES

 

 #

 # gBS->CalculateCrc32() is consumed in EntryPoint.

@@ -77,3 +87,5 @@
 [Depex]

   gEfiFirmwareVolumeBlockProtocolGuid AND gEfiRuntimeArchProtocolGuid

 

+[UserExtensions.TianoCore."ExtraFiles"]

+  FaultTolerantWriteDxeExtra.uni

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
index a6fdd98187..105820c17b 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
@@ -1,4 +1,6 @@
 ## @file

+#   Fault Tolerant Write Smm Driver.

+#

 #   This driver installs SMM Fault Tolerant Write (FTW) protocol, which provides fault 

 #   tolerant write capability in SMM environment for block devices. Its implementation 

 #   depends on the full functionality SMM FVB protocol that support read, write/erase 

@@ -18,6 +20,7 @@
 [Defines]

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = SmmFaultTolerantWriteDxe

+  MODULE_UNI_FILE                = SmmFaultTolerantWriteDxe.uni

   FILE_GUID                      = 470CB248-E8AC-473c-BB4F-81069A1FE6FD

   MODULE_TYPE                    = DXE_SMM_DRIVER

   VERSION_STRING                 = 1.0

@@ -53,25 +56,34 @@
   ReportStatusCodeLib

 

 [Guids]

-  gEdkiiWorkingBlockSignatureGuid                  ## CONSUMES ## FV Signature of Working Space Header

+  #

+  # Signature in EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER

+  #

+  ## CONSUMES           ## GUID

+  ## PRODUCES           ## GUID

+  gEdkiiWorkingBlockSignatureGuid

 

 [Protocols]

-  gEfiSmmSwapAddressRangeProtocolGuid     | gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable          ## CONSUMES

-  gEfiSmmFirmwareVolumeBlockProtocolGuid           ## CONSUMES

-  gEfiSmmFaultTolerantWriteProtocolGuid            ## PRODUCES

+  gEfiSmmSwapAddressRangeProtocolGuid | gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable  ## SOMETIMES_CONSUMES

+  ## NOTIFY

+  ## CONSUMES

+  gEfiSmmFirmwareVolumeBlockProtocolGuid

+  ## PRODUCES

+  ## UNDEFINED # SmiHandlerRegister

+  gEfiSmmFaultTolerantWriteProtocolGuid

   gEfiSmmAccess2ProtocolGuid                       ## CONSUMES

   gEfiSmmEndOfDxeProtocolGuid                      ## CONSUMES

 

 [FeaturePcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable    ## CONSUMES

 

 [Pcd]

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64

-  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase    ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64  ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize    ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase      ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64    ## CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize      ## CONSUMES

 

 #

 # gBS->CalculateCrc32() is consumed in EntryPoint.

@@ -82,3 +94,5 @@
 [Depex]

   gEfiSmmFirmwareVolumeBlockProtocolGuid AND gEfiRuntimeArchProtocolGuid

 

+[UserExtensions.TianoCore."ExtraFiles"]

+  SmmFaultTolerantWriteDxeExtra.uni

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmDxe.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmDxe.inf
index a0dda0588b..82dd36c320 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmDxe.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmDxe.inf
@@ -1,11 +1,12 @@
 ## @file

-# This module is the DXE part corresponding to SMM Fault Tolerant Write (FTW) module.

+# This module is the Runtime DXE part corresponding to SMM Fault Tolerant Write (FTW) module.

+#

 # It installs FTW protocol and works with SMM FTW module together.

 # The FTW protocol will not work after End Of Dxe because it will be not safe to expose

 # the related operations in SMM handler in SMM FTW module. You can use the FTW protocol

 # before End Of Dxe or use FaultTolerantWriteDxe module instead if you really want to.

 #

-# Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2011 - 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                      = FaultTolerantWriteSmmDxe

+  MODULE_UNI_FILE                = FaultTolerantWriteSmmDxe.uni

   FILE_GUID                      = 98948C4A-70F2-4035-8E9F-5927493CFC07

   MODULE_TYPE                    = DXE_DRIVER

   VERSION_STRING                 = 1.0

@@ -47,10 +49,16 @@
   UefiDriverEntryPoint

 

 [Protocols]

-  gEfiFaultTolerantWriteProtocolGuid           ## ALWAYS_PRODUCES

-  gEfiSmmCommunicationProtocolGuid

+  gEfiFaultTolerantWriteProtocolGuid            ## PRODUCES

+  gEfiSmmCommunicationProtocolGuid              ## CONSUMES

+  ## NOTIFY

+  ## UNDEFINED # Used to do smm communication

+  ## CONSUMES

   gEfiSmmFaultTolerantWriteProtocolGuid

-  gEfiFirmwareVolumeBlockProtocolGuid

+  gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES

    

 [Depex]

   gEfiSmmCommunicationProtocolGuid

+

+[UserExtensions.TianoCore."ExtraFiles"]

+  FaultTolerantWriteSmmDxeExtra.uni