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

diff --git a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf
index 114b708a8d6287619526e025bbcac5b339ae64f8..7cd7a87126913f966dd4967691294a548f6645c5 100644 (file)
--- a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf
+++ b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf
@@ -3,7 +3,7 @@
 #\r
 #  This DXE driver will invoke Debug Agent Library to initialize the debug agent.\r
 #\r
-# Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # which accompanies this distribution.  The full text of the license may be found at\r
@@ -17,6 +17,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DebugAgentDxe\r
+  MODULE_UNI_FILE                = DebugAgentDxe.uni\r
   FILE_GUID                      = 9727502C-034E-472b-8E1B-67BB28C6CFDB\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0  \r
@@ -46,3 +47,6 @@
 \r
 [Depex]\r
   TRUE\r
+\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  DebugAgentDxeExtra.uni\r

diff --git a/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf b/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf
index d20a01206936253a4bc782d5a91dfc32bd917b38..26397bd3c056b86910dc06f138bbcfcce46a66be 100644 (file)
--- a/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf
+++ b/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf
@@ -4,7 +4,7 @@
 #  This PEIM will invoke Debug Agent Library to initialize the debug agent in \r
 #  whole PEI phase.\r
 #\r
-# Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # which accompanies this distribution.  The full text of the license may be found at\r
@@ -18,6 +18,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DebugAgentPei\r
+  MODULE_UNI_FILE                = DebugAgentPei.uni\r
   FILE_GUID                      = D9D114EF-F40B-4d48-AAA0-A3DC99C9F5BD\r
   MODULE_TYPE                    = PEIM\r
   VERSION_STRING                 = 1.0  \r
@@ -42,3 +43,6 @@
 \r
 [Depex]\r
   TRUE\r
+\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  DebugAgentPeiExtra.uni\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf
index 0a3a519042b95d0de25c291696516fa754c374bd..2a67a6b707112825b4bc4fdf5c491aff4e78c5d9 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf
+++ b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  Debug Agent library instance for Dxe Core and Dxe modules.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DxeDebugAgentLib\r
+  MODULE_UNI_FILE                = DxeDebugAgentLib.uni\r
   FILE_GUID                      = BA6BAD25-B814-4747-B0B0-0FBB61D40B90\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 0.7\r
@@ -80,19 +81,22 @@
   MemoryAllocationLib\r
 \r
 [Guids]\r
-  gEfiDebugAgentGuid                            ## PRODUCES ## Configuration Table\r
-  gEfiDebugAgentGuid                            ## CONSUMES ## HOB\r
-  gEfiVectorHandoffTableGuid                    ## SOMETIMES_PRODUCES ## Configuration Table\r
-  \r
+  ## SOMETIMES_PRODUCES ## SystemTable\r
+  ## CONSUMES ## HOB\r
+  gEfiDebugAgentGuid\r
+  ## SOMETIMES_CONSUMES ## SystemTable\r
+  ## SOMETIMES_PRODUCES ## SystemTable\r
+  gEfiVectorHandoffTableGuid\r
+\r
 [Ppis]\r
   gEfiVectorHandoffInfoPpiGuid                  ## UNDEFINED\r
-  \r
+\r
 [Protocols]\r
-  gEfiSerialIoProtocolGuid                      ## PRODUCES\r
-  gEfiDevicePathProtocolGuid                    ## PRODUCES \r
+  gEfiSerialIoProtocolGuid                      ## SOMETIMES_PRODUCES\r
+  gEfiDevicePathProtocolGuid                    ## SOMETIMES_PRODUCES \r
 \r
 [Pcd]\r
-  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                  ## CONSUMES\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger  ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                  ## SOMETIMES_CONSUMES\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger  ## SOMETIMES_CONSUMES\r
   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize    ## CONSUMES\r
 \r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf
index 8de4cbd9ee860ab0ee31e3965f8224daad0b28ac..793962d507679808e6e07199f741d33c75cc4888 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf
+++ b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  Debug Agent library instance for SEC Core and PEI modules.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = SecPeiDebugAgentLib\r
+  MODULE_UNI_FILE                = SecPeiDebugAgentLib.uni\r
   FILE_GUID                      = 508B7D59-CD4E-4a6b-A45B-6D3B2D90111E\r
   MODULE_TYPE                    = PEIM\r
   VERSION_STRING                 = 0.7\r
@@ -76,14 +77,16 @@
   PeCoffExtraActionLib\r
 \r
 [Ppis]\r
-  gEfiPeiMemoryDiscoveredPpiGuid\r
+  gEfiPeiMemoryDiscoveredPpiGuid                ## NOTIFY\r
   gEfiVectorHandoffInfoPpiGuid                  ## PRODUCES\r
 \r
 [Guids]\r
-  gEfiDebugAgentGuid                            ## PRODUCES ## HOB\r
+  ## PRODUCES ## HOB\r
+  ## CONSUMES ## HOB\r
+  gEfiDebugAgentGuid\r
 \r
 [Pcd]\r
-  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                  ## CONSUMES\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger  ## CONSUMES\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize    ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                  ## SOMETIMES_CONSUMES\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger  ## SOMETIMES_CONSUMES\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize    ## SOMETIMES_CONSUMES\r
 \r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf
index 048481ebaac08a19fcbf8981dcbb055898c5b85f..aeb36974e050583a29737bbbf8cd443acbeded4e 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf
+++ b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  Debug Agent library instance for SMM modules.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = SmmDebugAgentLib\r
+  MODULE_UNI_FILE                = SmmDebugAgentLib.uni\r
   FILE_GUID                      = CB07D74C-598F-4268-A5D1-644FB4A481E8\r
   MODULE_TYPE                    = DXE_SMM_DRIVER\r
   VERSION_STRING                 = 0.7\r
@@ -74,11 +75,13 @@
   SmmServicesTableLib\r
 \r
 [Guids]\r
-  gEfiDebugAgentGuid                            ## CONSUMES ## Configuration Table\r
-  gEfiVectorHandoffTableGuid                    ## SOMETIMES_PRODUCES ## Configuration Table\r
+  ## CONSUMES ## SystemTable\r
+  ## CONSUMES ## HOB\r
+  gEfiDebugAgentGuid\r
+  gEfiVectorHandoffTableGuid            ## PRODUCES # SMM Configuration Table\r
 \r
 [Pcd]\r
-  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                             ## CONSUMES\r
+  gEfiMdePkgTokenSpaceGuid.PcdFSBClock                                             ## SOMETIMES_CONSUMES\r
   ## Skip Page Fault exception (14) by default in SMM\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00004000  ## CONSUMES\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00004000  ## SOMETIMES_CONSUMES\r
 \r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf
index 6ee5ddccee4164ff8908fdf2729a6d2713323932..640d0833a5d1b45dec6b864c6bb2a4a648f85762 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  Debug Communication Library instance based on serila port.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DebugCommunicationLibSerialPort\r
+  MODULE_UNI_FILE                = DebugCommunicationLibSerialPort.uni\r
   FILE_GUID                      = 8CC435C5-6330-4269-B0C3-E3BD05C86FB8\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 0.7\r
@@ -40,6 +41,7 @@
   BaseLib\r
 \r
 [PCD]\r
-  ## The value of data buffer size used for Serial debug port handle.\r
-  ## It should be equal to sizeof (SERIAL_DEBUG_PORT_HANDLE).\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|17\r
+  # The value of data buffer size used for Serial debug port handle.\r
+  # It should be equal to sizeof (SERIAL_DEBUG_PORT_HANDLE).\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|17   ## SOMETIMES_CONSUMES\r
+\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf
index 37e365a7a3ae1bcbda2c7f4fd9aed5173b953495..0cfdc9d615f930694c2c13158ed384618fda0269 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  Debug Communication Library instance based on usb debug port.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = DebugCommunicationLibUsb\r
+  MODULE_UNI_FILE                = DebugCommunicationLibUsb.uni\r
   FILE_GUID                      = 87438836-AD8D-4e3e-9249-895120A67240\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 0.7\r
@@ -35,18 +36,16 @@
 [Pcd]\r
   ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller.\r
   ## Note that the memory BAR address is only used before Pci bus resource allocation.\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase\r
-\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase    ## SOMETIMES_CONSUMES\r
   ## The memory BAR of ehci host controller, in which usb debug feature is enabled.\r
   ## Note that the memory BAR address is only used before Pci bus resource allocation.\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase\r
-\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase         ## SOMETIMES_CONSUMES\r
   ## The pci address of ehci host controller, in which usb debug feature is enabled.\r
   ## The format of pci address please refer to SourceLevelDebugPkg.dec\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress              ## CONSUMES\r
   ## The value of data buffer size used for USB debug port handle.\r
   ## It should be equal to sizeof (USB_DEBUG_PORT_HANDLE).\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|40\r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|40   ## SOMETIMES_CONSUMES\r
 \r
 [LibraryClasses]\r
   TimerLib\r

diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf
index 9310ccfe83d2f8d25e06ac3ca25d928928c491c3..717aa97d8705fd300faae6fe417b4be0bda8649b 100644 (file)
--- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf
+++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf
@@ -1,7 +1,7 @@
 ## @file\r
 #  PeCoffExtraAction Library to support source level debug.\r
 #\r
-#  Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2010 - 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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PeCoffExtraActionLib\r
+  MODULE_UNI_FILE                = PeCoffExtraActionLib.uni\r
   FILE_GUID                      = 8F01CBD5-E069-44d7-90C9-35F0318603AD\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 0.7\r
@@ -52,5 +53,5 @@
   PcdLib\r
 \r
 [Pcd]\r
-  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod\r
-  \r
+  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod    ## CONSUMES\r
+\r