From 4e363936ecb2e38ad4955c8d7718d2ff5204dbb0 Mon Sep 17 00:00:00 2001 From: "Gao, Liming" Date: Thu, 28 Aug 2014 05:13:05 +0000 Subject: [PATCH] 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 Reviewed-by: Michael Kinney git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15937 6f19259b-4bc3-4df7-8a09-765794883524 --- .../DebugAgentDxe/DebugAgentDxe.inf | 6 ++++- .../DebugAgentPei/DebugAgentPei.inf | 6 ++++- .../Library/DebugAgent/DxeDebugAgentLib.inf | 24 +++++++++++-------- .../DebugAgent/SecPeiDebugAgentLib.inf | 15 +++++++----- .../Library/DebugAgent/SmmDebugAgentLib.inf | 13 ++++++---- .../DebugCommunicationLibSerialPort.inf | 10 ++++---- .../DebugCommunicationLibUsb.inf | 13 +++++----- .../PeCoffExtraActionLibDebug.inf | 7 +++--- 8 files changed, 57 insertions(+), 37 deletions(-) diff --git a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf index 114b708a8d..7cd7a87126 100644 --- a/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf +++ b/SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.inf @@ -3,7 +3,7 @@ # # This DXE driver will invoke Debug Agent Library to initialize the debug agent. # -# Copyright (c) 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.
# This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at @@ -17,6 +17,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DebugAgentDxe + MODULE_UNI_FILE = DebugAgentDxe.uni FILE_GUID = 9727502C-034E-472b-8E1B-67BB28C6CFDB MODULE_TYPE = DXE_DRIVER VERSION_STRING = 1.0 @@ -46,3 +47,6 @@ [Depex] TRUE + +[UserExtensions.TianoCore."ExtraFiles"] + DebugAgentDxeExtra.uni diff --git a/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf b/SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.inf index d20a012069..26397bd3c0 100644 --- 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 # whole PEI phase. # -# Copyright (c) 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.
# This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at @@ -18,6 +18,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DebugAgentPei + MODULE_UNI_FILE = DebugAgentPei.uni FILE_GUID = D9D114EF-F40B-4d48-AAA0-A3DC99C9F5BD MODULE_TYPE = PEIM VERSION_STRING = 1.0 @@ -42,3 +43,6 @@ [Depex] TRUE + +[UserExtensions.TianoCore."ExtraFiles"] + DebugAgentPeiExtra.uni diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf index 0a3a519042..2a67a6b707 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf +++ b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgentLib.inf @@ -1,7 +1,7 @@ ## @file # Debug Agent library instance for Dxe Core and Dxe modules. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DxeDebugAgentLib + MODULE_UNI_FILE = DxeDebugAgentLib.uni FILE_GUID = BA6BAD25-B814-4747-B0B0-0FBB61D40B90 MODULE_TYPE = DXE_DRIVER VERSION_STRING = 0.7 @@ -80,19 +81,22 @@ MemoryAllocationLib [Guids] - gEfiDebugAgentGuid ## PRODUCES ## Configuration Table - gEfiDebugAgentGuid ## CONSUMES ## HOB - gEfiVectorHandoffTableGuid ## SOMETIMES_PRODUCES ## Configuration Table - + ## SOMETIMES_PRODUCES ## SystemTable + ## CONSUMES ## HOB + gEfiDebugAgentGuid + ## SOMETIMES_CONSUMES ## SystemTable + ## SOMETIMES_PRODUCES ## SystemTable + gEfiVectorHandoffTableGuid + [Ppis] gEfiVectorHandoffInfoPpiGuid ## UNDEFINED - + [Protocols] - gEfiSerialIoProtocolGuid ## PRODUCES - gEfiDevicePathProtocolGuid ## PRODUCES + gEfiSerialIoProtocolGuid ## SOMETIMES_PRODUCES + gEfiDevicePathProtocolGuid ## SOMETIMES_PRODUCES [Pcd] - gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## CONSUMES - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## SOMETIMES_CONSUMES + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger ## SOMETIMES_CONSUMES gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize ## CONSUMES diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf index 8de4cbd9ee..793962d507 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf +++ b/SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgentLib.inf @@ -1,7 +1,7 @@ ## @file # Debug Agent library instance for SEC Core and PEI modules. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = SecPeiDebugAgentLib + MODULE_UNI_FILE = SecPeiDebugAgentLib.uni FILE_GUID = 508B7D59-CD4E-4a6b-A45B-6D3B2D90111E MODULE_TYPE = PEIM VERSION_STRING = 0.7 @@ -76,14 +77,16 @@ PeCoffExtraActionLib [Ppis] - gEfiPeiMemoryDiscoveredPpiGuid + gEfiPeiMemoryDiscoveredPpiGuid ## NOTIFY gEfiVectorHandoffInfoPpiGuid ## PRODUCES [Guids] - gEfiDebugAgentGuid ## PRODUCES ## HOB + ## PRODUCES ## HOB + ## CONSUMES ## HOB + gEfiDebugAgentGuid [Pcd] - gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## CONSUMES - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger ## CONSUMES - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## SOMETIMES_CONSUMES + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger ## SOMETIMES_CONSUMES + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize ## SOMETIMES_CONSUMES diff --git a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf index 048481ebaa..aeb36974e0 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf +++ b/SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgentLib.inf @@ -1,7 +1,7 @@ ## @file # Debug Agent library instance for SMM modules. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = SmmDebugAgentLib + MODULE_UNI_FILE = SmmDebugAgentLib.uni FILE_GUID = CB07D74C-598F-4268-A5D1-644FB4A481E8 MODULE_TYPE = DXE_SMM_DRIVER VERSION_STRING = 0.7 @@ -74,11 +75,13 @@ SmmServicesTableLib [Guids] - gEfiDebugAgentGuid ## CONSUMES ## Configuration Table - gEfiVectorHandoffTableGuid ## SOMETIMES_PRODUCES ## Configuration Table + ## CONSUMES ## SystemTable + ## CONSUMES ## HOB + gEfiDebugAgentGuid + gEfiVectorHandoffTableGuid ## PRODUCES # SMM Configuration Table [Pcd] - gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## CONSUMES + gEfiMdePkgTokenSpaceGuid.PcdFSBClock ## SOMETIMES_CONSUMES ## Skip Page Fault exception (14) by default in SMM - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00004000 ## CONSUMES + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00004000 ## SOMETIMES_CONSUMES diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf index 6ee5ddccee..640d0833a5 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.inf @@ -1,7 +1,7 @@ ## @file # Debug Communication Library instance based on serila port. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DebugCommunicationLibSerialPort + MODULE_UNI_FILE = DebugCommunicationLibSerialPort.uni FILE_GUID = 8CC435C5-6330-4269-B0C3-E3BD05C86FB8 MODULE_TYPE = BASE VERSION_STRING = 0.7 @@ -40,6 +41,7 @@ BaseLib [PCD] - ## The value of data buffer size used for Serial debug port handle. - ## It should be equal to sizeof (SERIAL_DEBUG_PORT_HANDLE). - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|17 + # The value of data buffer size used for Serial debug port handle. + # It should be equal to sizeof (SERIAL_DEBUG_PORT_HANDLE). + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|17 ## SOMETIMES_CONSUMES + diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf index 37e365a7a3..0cfdc9d615 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.inf @@ -1,7 +1,7 @@ ## @file # Debug Communication Library instance based on usb debug port. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = DebugCommunicationLibUsb + MODULE_UNI_FILE = DebugCommunicationLibUsb.uni FILE_GUID = 87438836-AD8D-4e3e-9249-895120A67240 MODULE_TYPE = BASE VERSION_STRING = 0.7 @@ -35,18 +36,16 @@ [Pcd] ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller. ## Note that the memory BAR address is only used before Pci bus resource allocation. - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase - + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase ## SOMETIMES_CONSUMES ## The memory BAR of ehci host controller, in which usb debug feature is enabled. ## Note that the memory BAR address is only used before Pci bus resource allocation. - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase - + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase ## SOMETIMES_CONSUMES ## The pci address of ehci host controller, in which usb debug feature is enabled. ## The format of pci address please refer to SourceLevelDebugPkg.dec - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress ## CONSUMES ## The value of data buffer size used for USB debug port handle. ## It should be equal to sizeof (USB_DEBUG_PORT_HANDLE). - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|40 + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|40 ## SOMETIMES_CONSUMES [LibraryClasses] TimerLib diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf index 9310ccfe83..717aa97d87 100644 --- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf +++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf @@ -1,7 +1,7 @@ ## @file # PeCoffExtraAction Library to support source level debug. # -# Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.
+# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.
# # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -16,6 +16,7 @@ [Defines] INF_VERSION = 0x00010005 BASE_NAME = PeCoffExtraActionLib + MODULE_UNI_FILE = PeCoffExtraActionLib.uni FILE_GUID = 8F01CBD5-E069-44d7-90C9-35F0318603AD MODULE_TYPE = BASE VERSION_STRING = 0.7 @@ -52,5 +53,5 @@ PcdLib [Pcd] - gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod - + gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod ## CONSUMES + -- 2.39.2