IntelFrameworkModulePkg: 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@15966 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 98 insertions, 76 deletions

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/BlockIoDxe/BlockIoDxe.inf b/IntelFrameworkModulePkg/Csm/BiosThunk/BlockIoDxe/BlockIoDxe.inf
index 0e02f7eb27..86dd325d23 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/BlockIoDxe/BlockIoDxe.inf
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/BlockIoDxe/BlockIoDxe.inf
@@ -1,7 +1,10 @@
 ## @file

-#  Component description file for BIOS Block IO module.

+# BIOS Block IO module.

 #

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

+# This is the UEFI driver to thunk legacy BIOS int13 interface into UEFI block IO interface.

+# Once connected it installs EfiBlockIoProtocol on top of legacy BIOS int13.

+#

+# Copyright (c) 1999 - 2014, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions

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

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = BlockIoDxe

+  MODULE_UNI_FILE                = BlockIoDxe.uni

   FILE_GUID                      = 4495E47E-42A9-4007-8c17-B6664F909D04

   MODULE_TYPE                    = UEFI_DRIVER

   VERSION_STRING                 = 1.0

@@ -41,18 +45,21 @@
 

 

 [Protocols]

-  gEfiBlockIoProtocolGuid

-  gEfiDevicePathProtocolGuid

-  gEfiPciIoProtocolGuid

-  gEfiLegacyBiosProtocolGuid

+  gEfiBlockIoProtocolGuid    ## BY_START

+  gEfiDevicePathProtocolGuid ## BY_START

+  gEfiDevicePathProtocolGuid ## TO_START

+  gEfiPciIoProtocolGuid      ## TO_START

+  gEfiLegacyBiosProtocolGuid ## TO_START

 

 

 [Guids]

-  gEfiLegacyBiosGuid

-  gBlockIoVendorGuid

+  gEfiLegacyBiosGuid ## PRODUCES            ## UNDEFINED

+  gBlockIoVendorGuid ## SOMETIMES_CONSUMES  ## UNDEFINED

 

 [Packages]

   MdePkg/MdePkg.dec

   IntelFrameworkPkg/IntelFrameworkPkg.dec

   IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec

 

+[UserExtensions.TianoCore."ExtraFiles"]

+  BlockIoDxeExtra.uni

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/KeyboardDxe.inf b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/KeyboardDxe.inf
index ee79f6b607..a453480aa9 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/KeyboardDxe.inf
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/KeyboardDxe.inf
@@ -1,10 +1,10 @@
 ## @file

-# Component description file for BiosKeyboard module.

+# Ps2 Keyboard driver.

 #

-# Ps2 Keyboard driver by using Legacy Bios protocol service and IsaIo protocol service.

-# This dirver uses legacy INT16 to get the key stroke status.

+# Ps2 Keyboard driver by using Legacy Bios protocol service and IsaIo protocol 

+# service. This dirver uses legacy INT16 to get the key stroke status.

 #

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

+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions

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

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = KeyboardDxe

+  MODULE_UNI_FILE                = KeyboardDxe.uni

   FILE_GUID                      = 5479662B-6AE4-49e8-A6BD-6DE4B625811F

   MODULE_TYPE                    = UEFI_DRIVER

   VERSION_STRING                 = 1.0

@@ -60,15 +61,17 @@
   PcdLib

 

 [Protocols]

-  gEfiIsaIoProtocolGuid                         # PROTOCOL TO_START

-  gEfiSimpleTextInProtocolGuid                  # PROTOCOL BY_START

-  gEfiSimpleTextInputExProtocolGuid             # PROTOCOL BY_START

-  gEfiLegacyBiosProtocolGuid                    # PROTOCOL TO_START

-  gEfiPs2PolicyProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED

-  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED

+  gEfiIsaIoProtocolGuid                         ## TO_START

+  gEfiSimpleTextInProtocolGuid                  ## BY_START

+  gEfiSimpleTextInputExProtocolGuid             ## BY_START

+  gEfiLegacyBiosProtocolGuid                    ## CONSUMES

+  gEfiPs2PolicyProtocolGuid                     ## SOMETIMES_CONSUMES

 

 [FeaturePcd]

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification|FALSE

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification|FALSE  ## CONSUMES

 

 [Pcd]

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection
\ No newline at end of file
+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection                  ## SOMETIMES_CONSUMES

+

+[UserExtensions.TianoCore."ExtraFiles"]

+  KeyboardDxeExtra.uni

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/Snp16Dxe/Snp16Dxe.inf b/IntelFrameworkModulePkg/Csm/BiosThunk/Snp16Dxe/Snp16Dxe.inf
index c37c4abb86..2e6b0c532d 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/Snp16Dxe/Snp16Dxe.inf
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/Snp16Dxe/Snp16Dxe.inf
@@ -1,7 +1,9 @@
 ## @file

+# SNP driver On Legacy NIC ROM.

+#

 # Thunk wrapper UEFI driver to produce EFI SNP protocol based on legacy 16 NIC ROM.

 #

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

+# Copyright (c) 1999 - 2014, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions

@@ -16,6 +18,7 @@
 

 [Defines]

   BASE_NAME                            = BiosSnp16

+  MODULE_UNI_FILE                      = BiosSnp16.uni

   FILE_GUID                            = D0CAA91E-2DE4-4b0d-B3DC-09C67E854E34

   MODULE_TYPE                          = UEFI_DRIVER

   INF_VERSION                          = 0x00010005

@@ -52,16 +55,19 @@
   MemoryAllocationLib

 

 [Guids]

-  gEfiEventExitBootServicesGuid

+  gEfiEventExitBootServicesGuid         ##CONSUMES  ##Event

 

 [Protocols]

-  gEfiNetworkInterfaceIdentifierProtocolGuid

-  gEfiDevicePathProtocolGuid

-  gEfiSimpleNetworkProtocolGuid

-  gEfiPciIoProtocolGuid

-  gEfiLegacyBiosProtocolGuid

+  gEfiNetworkInterfaceIdentifierProtocolGuid  ##BY_START

+  gEfiDevicePathProtocolGuid                  ##BY_START

+  gEfiDevicePathProtocolGuid                  ##TO_START

+  gEfiSimpleNetworkProtocolGuid               ##BY_START

+  gEfiPciIoProtocolGuid                       ##TO_START

+  gEfiLegacyBiosProtocolGuid                  ##CONSUMES

 

 [Packages]

   MdePkg/MdePkg.dec

   IntelFrameworkPkg/IntelFrameworkPkg.dec

 

+[UserExtensions.TianoCore."ExtraFiles"]

+  BiosSnp16Extra.uni

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/VideoDxe/VideoDxe.inf b/IntelFrameworkModulePkg/Csm/BiosThunk/VideoDxe/VideoDxe.inf
index 33dad82109..7b1764acfc 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/VideoDxe/VideoDxe.inf
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/VideoDxe/VideoDxe.inf
@@ -4,7 +4,7 @@
 # This driver by using Legacy Bios protocol service to support csm Video

 # and produce Graphics Output Protocol.

 #

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

+# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions

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

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = BiosVideoDxe

+  MODULE_UNI_FILE                = BiosVideoDxe.uni

   FILE_GUID                      = 0B04B2ED-861C-42cd-A22F-C3AAFACCB896

   MODULE_TYPE                    = UEFI_DRIVER

   VERSION_STRING                 = 1.0

@@ -61,22 +62,26 @@
 

 

 [Guids]

-  gEfiLegacyBiosGuid                            # ALWAYS_PRODUCED

-  gEfiEventExitBootServicesGuid

+  gEfiLegacyBiosGuid                            ## PRODUCES  ##GUID # Install Legacy BIOS GUID to mark this driver as a BIOS Thunk Driver

+  gEfiEventExitBootServicesGuid                 ## CONSUMES  ##Event

 

 [Protocols]

-  gEfiVgaMiniPortProtocolGuid                   # PROTOCOL BY_START

-  gEfiEdidDiscoveredProtocolGuid                # PROTOCOL BY_START

-  gEfiGraphicsOutputProtocolGuid                # PROTOCOL BY_START

-  gEfiEdidActiveProtocolGuid                    # PROTOCOL BY_START

-  gEfiLegacyBiosProtocolGuid                    # PROTOCOL TO_START

-  gEfiPciIoProtocolGuid                         # PROTOCOL TO_START

-  gEfiDevicePathProtocolGuid                    # PROTOCOL TO_START

-  gEfiEdidOverrideProtocolGuid                  # PROTOCOL TO_START

+  gEfiVgaMiniPortProtocolGuid                   ## BY_START

+  gEfiEdidDiscoveredProtocolGuid                ## BY_START

+  gEfiGraphicsOutputProtocolGuid                ## BY_START

+  gEfiEdidActiveProtocolGuid                    ## BY_START

+  gEfiLegacyBiosProtocolGuid                    ## CONSUMES

+  gEfiPciIoProtocolGuid                         ## TO_START

+  gEfiDevicePathProtocolGuid                    ## TO_START

+  gEfiDevicePathProtocolGuid                    ## BY_START

+  gEfiEdidOverrideProtocolGuid                  ## SOMETIMES_CONSUMES

 

 [Pcd]

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable

-  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution

-  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution  

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoSetTextVgaModeEnable  ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVbeEnable        ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBiosVideoCheckVgaEnable        ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution                 ## SOMETIMES_CONSUMES

+  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution                   ## SOMETIMES_CONSUMES

+

+[UserExtensions.TianoCore."ExtraFiles"]

+  BiosVideoDxeExtra.uni

diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosDxe.inf b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosDxe.inf
index e3084e601f..f8cc4f3fc4 100644
--- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosDxe.inf
+++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosDxe.inf
@@ -3,7 +3,7 @@
 #

 # This driver installs Legacy Bios Protocol to support CSM module work in EFI system.

 #

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

+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>

 #

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions

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

   INF_VERSION                    = 0x00010005

   BASE_NAME                      = LegacyBiosDxe

+  MODULE_UNI_FILE                = LegacyBiosDxe.uni

   FILE_GUID                      = F122A15C-C10B-4d54-8F48-60F4F06DD1AD

   MODULE_TYPE                    = DXE_DRIVER

   VERSION_STRING                 = 1.0

@@ -102,48 +103,48 @@
 

 

 [Guids]

-  gEfiDiskInfoIdeInterfaceGuid                  # ALWAYS_CONSUMED

-  gEfiSmbiosTableGuid                           # ALWAYS_CONSUMED

-  gEfiLegacyBiosGuid                            # ALWAYS_PRODUCED

+  gEfiDiskInfoIdeInterfaceGuid                  ## SOMETIMES_CONSUMES ##GUID #Used in LegacyBiosBuildIdeData() to assure device is a disk

+  gEfiSmbiosTableGuid                           ## SOMETIMES_CONSUMES ##SystemTable

+  gEfiLegacyBiosGuid                            ## SOMETIMES_CONSUMES ##GUID #Used in LegacyBiosInstallVgaRom() to locate handle buffer

 

 [Guids.IA32]

-  gEfiSmbiosTableGuid                           # ALWAYS_CONSUMED

-  gEfiAcpi20TableGuid                           # ALWAYS_CONSUMED

-  gEfiAcpi10TableGuid                           # ALWAYS_CONSUMED

+  gEfiAcpi20TableGuid                           ## SOMETIMES_CONSUMES ##SystemTable

+  gEfiAcpi10TableGuid                           ## SOMETIMES_CONSUMES ##SystemTable

 

 [Guids.X64]

-  gEfiSmbiosTableGuid                           # ALWAYS_CONSUMED

-  gEfiAcpi20TableGuid                           # ALWAYS_CONSUMED

-  gEfiAcpi10TableGuid                           # ALWAYS_CONSUMED

+  gEfiAcpi20TableGuid                           ## SOMETIMES_CONSUMES ##SystemTable

+  gEfiAcpi10TableGuid                           ## SOMETIMES_CONSUMES ##SystemTable

 

 

 [Protocols]

-  gEfiLoadedImageProtocolGuid                   # PROTOCOL ALWAYS_CONSUMED

-  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED

-  gEfiPciRootBridgeIoProtocolGuid               # PROTOCOL ALWAYS_CONSUMED

-  gEfiCpuArchProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED

-  gEfiTimerArchProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED

-  gEfiIsaIoProtocolGuid                         # PROTOCOL ALWAYS_CONSUMED

-  gEfiBlockIoProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED

-  gEfiPciIoProtocolGuid                         # PROTOCOL ALWAYS_CONSUMED

-  gEfiGenericMemTestProtocolGuid                # PROTOCOL ALWAYS_CONSUMED

-  gEfiDiskInfoProtocolGuid                      # PROTOCOL ALWAYS_CONSUMED

-  gEfiSimpleTextInProtocolGuid                  # PROTOCOL ALWAYS_CONSUMED

-  gEfiLegacy8259ProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED

-  gEfiLegacyBiosPlatformProtocolGuid            # PROTOCOL ALWAYS_CONSUMED

-  gEfiLegacyInterruptProtocolGuid               # PROTOCOL ALWAYS_CONSUMED

-  gEfiLegacyRegion2ProtocolGuid                 # PROTOCOL ALWAYS_CONSUMED

-  gEfiLegacyBiosProtocolGuid                    # PROTOCOL ALWAYS_PRODUCED

+  gEfiLoadedImageProtocolGuid                   ## SOMETIMES_CONSUMES

+  gEfiDevicePathProtocolGuid                    ## SOMETIMES_CONSUMES

+  gEfiPciRootBridgeIoProtocolGuid               ## SOMETIMES_CONSUMES

+  gEfiCpuArchProtocolGuid                       ## CONSUMES

+  gEfiTimerArchProtocolGuid                     ## CONSUMES

+  gEfiIsaIoProtocolGuid                         ## SOMETIMES_CONSUMES

+  gEfiBlockIoProtocolGuid                       ## SOMETIMES_CONSUMES

+  gEfiPciIoProtocolGuid                         ## SOMETIMES_CONSUMES

+  gEfiGenericMemTestProtocolGuid                ## CONSUMES

+  gEfiDiskInfoProtocolGuid                      ## SOMETIMES_CONSUMES

+  gEfiSimpleTextInProtocolGuid                  ## SOMETIMES_CONSUMES

+  gEfiLegacy8259ProtocolGuid                    ## CONSUMES

+  gEfiLegacyBiosPlatformProtocolGuid            ## CONSUMES

+  gEfiLegacyInterruptProtocolGuid               ## CONSUMES

+  gEfiLegacyRegion2ProtocolGuid                 ## CONSUMES

+  gEfiLegacyBiosProtocolGuid                    ## PRODUCES

 

 [Pcd]

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase

-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLegacyBiosCacheLegacyRegion  ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEbdaReservedMemorySize       ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdEndOpromShadowAddress        ## SOMETIMES_CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLowPmmMemorySize             ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdHighPmmMemorySize            ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemoryBase      ## CONSUMES

+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdOpromReservedMemorySize      ## CONSUMES

 

 [Depex]

   gEfiLegacyRegion2ProtocolGuid AND gEfiLegacyInterruptProtocolGuid AND gEfiLegacyBiosPlatformProtocolGuid AND gEfiLegacy8259ProtocolGuid AND gEfiGenericMemTestProtocolGuid AND gEfiCpuArchProtocolGuid AND gEfiTimerArchProtocolGuid AND gEfiVariableWriteArchProtocolGuid

 

+[UserExtensions.TianoCore."ExtraFiles"]

+  LegacyBiosDxeExtra.uni