From nobody Mon Feb 9 12:29:16 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+104275+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+104275+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1683562539; cv=none; d=zohomail.com; s=zohoarc; b=frBuFntL3fjP6x93KWmPLm5imSSyPAdcnf3IlzcEoTdV/1sbgVnGzB/mqbCcUzT8R+NPPkzfeDxBLnyyBx6v0vLpLkoQvPiSKP24K9Wl0JldyGP+vvEU/v+hBqe1l+GorgS2cyM9FK8fAdUMAFAe/on2YSqDCtiHQFbZoRIeR0Q= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1683562539; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=B70xiNliHLVLuVnhaVads88n82jcIvxd38qcjA3CwUo=; b=T3BmoG6+V0sj6vpfYywBiUgVDhR6hPCwQIbO0Zo9V8COGva+ORA+K0sT4AGsI/NCZq88UPxVFfBnowC5kwHScUsnYfbadiGJF6OpDK91nQW1kOhtlISzqVGgJ/cHiyzIhQfq3nKWItc8odJFk1aMJcjonVO/dVpD1VzuQKLb1Ag= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+104275+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1683562539588664.5738450214591; Mon, 8 May 2023 09:15:39 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id Z4yQYY1788612xVFhEwkKwnN; Mon, 08 May 2023 09:15:39 -0700 X-Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mx.groups.io with SMTP id smtpd.web11.100689.1683523969170226818 for ; Sun, 07 May 2023 22:32:53 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10703"; a="412819046" X-IronPort-AV: E=Sophos;i="5.99,258,1677571200"; d="scan'208";a="412819046" X-Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 May 2023 22:32:38 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10703"; a="767934623" X-IronPort-AV: E=Sophos;i="5.99,258,1677571200"; d="scan'208";a="767934623" X-Received: from hsuc1x-desk2.gar.corp.intel.com ([10.227.107.44]) by fmsmga004.fm.intel.com with ESMTP; 07 May 2023 22:32:37 -0700 From: victorx.hsu@intel.com To: devel@edk2.groups.io Cc: VictorX Hsu , Michael D Kinney , Guo Gua , Chan Laura , Prakashan Krishnadas Veliyathuparambil , K N Karthik Subject: [edk2-devel] [PATCH 2/4] MdeModulePkg: Add TraceHubDebugSysTLib library Date: Mon, 8 May 2023 13:31:54 +0800 Message-Id: In-Reply-To: References: MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,victorx.hsu@intel.com X-Gm-Message-State: uf2YvlPgCKZ3JvggYdb52SCax1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1683562539; bh=7TgmtB8qH2XKywVKpptaYSf3oMs3y3d6S65kflRiQw8=; h=Cc:Date:From:Reply-To:Subject:To; b=SYGSr4JW75T11fYenfc+xVQgz42yldCScZVhlWpO/cP9gk/6eReVlZDIPqP1BBnhbyU m58ryv10n73Oz1vi8SQZQKcSvsPU56akPbIT0RMkN7Fw4seaYBmIGRMIvhKB5PfgIwKYy YEnMENUBzfa7rzlEJZJ9BJBG3KbokMyQUHc= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1683562541047100024 Content-Type: text/plain; charset="utf-8" From: VictorX Hsu REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D4144 This Library provides API to dump Trace Hub message. Cc: Michael D Kinney Cc: Guo Gua Cc: Chan Laura Cc: Prakashan Krishnadas Veliyathuparambil Cc: K N Karthik Signed-off-by: VictorX Hsu --- .../Include/Guid/TraceHubDebugInfoHob.h | 25 ++ .../BaseTraceHubDebugSysTLib.c | 251 +++++++++++++++ .../BaseTraceHubDebugSysTLib.inf | 44 +++ .../DxeSmmTraceHubDebugSysTLib.c | 247 +++++++++++++++ .../DxeSmmTraceHubDebugSysTLib.inf | 50 +++ .../InternalTraceHubApi.c | 82 +++++ .../InternalTraceHubApi.h | 46 +++ .../InternalTraceHubApiCommon.c | 208 +++++++++++++ .../InternalTraceHubApiCommon.h | 119 +++++++ .../PeiTraceHubDebugSysTLib.c | 290 ++++++++++++++++++ .../PeiTraceHubDebugSysTLib.inf | 50 +++ .../Library/TraceHubDebugSysTLib/Readme.md | 30 ++ MdeModulePkg/MdeModulePkg.dec | 21 ++ MdeModulePkg/MdeModulePkg.dsc | 3 + MdeModulePkg/MdeModulePkg.uni | 18 ++ MdePkg/Include/Library/TraceHubDebugSysTLib.h | 81 +++++ MdePkg/MdePkg.dec | 4 + 17 files changed, 1569 insertions(+) create mode 100644 MdeModulePkg/Include/Guid/TraceHubDebugInfoHob.h create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubD= ebugSysTLib.c create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubD= ebugSysTLib.inf create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHu= bDebugSysTLib.c create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHu= bDebugSysTLib.inf create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTrace= HubApi.c create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTrace= HubApi.h create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTrace= HubApiCommon.c create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTrace= HubApiCommon.h create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDe= bugSysTLib.c create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDe= bugSysTLib.inf create mode 100644 MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md create mode 100644 MdePkg/Include/Library/TraceHubDebugSysTLib.h diff --git a/MdeModulePkg/Include/Guid/TraceHubDebugInfoHob.h b/MdeModulePk= g/Include/Guid/TraceHubDebugInfoHob.h new file mode 100644 index 0000000000..3a8fcc3d21 --- /dev/null +++ b/MdeModulePkg/Include/Guid/TraceHubDebugInfoHob.h @@ -0,0 +1,25 @@ +/** @file +This header file declares Trace Hub related structure. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#ifndef TRACE_HUB_DEBUG_INFO_HOB_H_ +#define TRACE_HUB_DEBUG_INFO_HOB_H_ + +#define TRACEHUB_DEBUG_INFO_HOB_REVISION 1 +#define MAX_TRACE_HUB_DEBUG_INSTANCE 5 + +typedef struct { + UINT16 Revision; // Structure revision + BOOLEAN Flag; // Flag to enable or disable Trace Hub d= ebug message. + UINT8 DebugLevel; // Debug level for Trace Hub. + UINT8 Rvsd[4]; // Reserved for future use + UINT64 TraceHubMmioAddress; // MMIO address where Trace Hub debug me= ssage output to. +} TRACEHUB_DEBUG_INFO_HOB; + +extern GUID gTraceHubDebugInfoHobGuid; + +#endif // TRACE_HUB_DEBUG_INFO_HOB_H_ diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSys= TLib.c b/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSysTLib= .c new file mode 100644 index 0000000000..fbf1cc2a9e --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSysTLib.c @@ -0,0 +1,251 @@ +/** @file +System prints Trace Hub message in SEC/PEI/DXE/SMM based on fixed PCDs. +Only support single Trace Hub debug instance. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include "InternalTraceHubApiCommon.h" +#include "InternalTraceHubApi.h" + +/** + Write debug string to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Buffer A pointer to the data buffer. + @param[in] NumberOfBytes The size of data buffer. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTDebugWrite ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + RETURN_STATUS Status; + UINT32 DbgInstCount; + UINT16 Index; + + DbgInstCount =3D 0; + + if (NumberOfBytes =3D=3D 0) { + // + // No data need to be written to Trace Hub + // + return RETURN_ABORTED; + } + + if (Buffer =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + DbgInstCount =3D CountThDebugInstance (); + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + MipiSystHandle.systh_header =3D &MipiSystHeader; + + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + NULL, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubDebugType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteDebug ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + (UINT16)NumberOfBytes, + (CHAR8 *)Buffer + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} + +/** + Write catalog status code message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] Guid Driver Guid. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64StatusCode ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN GUID *Guid + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + RETURN_STATUS Status; + UINT32 DbgInstCount; + UINT16 Index; + GUID ConvertedGuid; + + DbgInstCount =3D 0; + + if (Guid =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + DbgInstCount =3D CountThDebugInstance (); + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + ConvertedGuid =3D SwapBytesGuid (Guid); + CopyMem (&MipiSystHandle.systh_guid, &ConvertedGuid, sizeof (GUID)); + MipiSystHandle.systh_tag.et_guid =3D 1; + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + NULL, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} + +/** + Write catalog message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] NumberOfParams Number of entries in argument list. + @param[in] ... Catalog message parameters. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64 ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN UINTN NumberOfParams, + ... + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + VA_LIST Args; + UINTN Index; + RETURN_STATUS Status; + UINT32 DbgInstCount; + + DbgInstCount =3D 0; + + if (NumberOfParams > sizeof (MipiSystHandle.systh_param) / sizeof (UINT3= 2)) { + return RETURN_INVALID_PARAMETER; + } + + DbgInstCount =3D CountThDebugInstance (); + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + MipiSystHandle.systh_param_count =3D (UINT32)NumberOfParams; + VA_START (Args, NumberOfParams); + for (Index =3D 0; Index < NumberOfParams; Index++) { + MipiSystHandle.systh_param[Index] =3D VA_ARG (Args, UINT32); + } + + VA_END (Args); + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + NULL, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} + +/** + Collect the total number of Trace Hub debug instance in the system. + + @retval UINT32 The total number of Trace Hub debug instance in the = system. +**/ +UINT32 +EFIAPI +CountThDebugInstance ( + VOID + ) +{ + UINT32 DbgInstCount; + + // + // 1 from PCD. + // + DbgInstCount =3D 1; + + return DbgInstCount; +} diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSys= TLib.inf b/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSysTL= ib.inf new file mode 100644 index 0000000000..3edc4e8fd8 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSysTLib.inf @@ -0,0 +1,44 @@ +## @file +# Debug library to output Trace Hub message. +# Support SEC/PEI/DXE/SMM phase TraceHub debug message based on fixed set= tings. +# +# Copyright (c) 2023, Intel Corporation. All rights reserved.
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x00010005 + BASE_NAME =3D BaseTraceHubDebugSysTLib + FILE_GUID =3D 336DA571-AD65-423C-9A43-E0056E5B2D8D + MODULE_TYPE =3D BASE + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D TraceHubDebugSysTLib + +# +# The following information is for reference only and not required by the = build tools. +# +# VALID_ARCHITECTURES =3D IA32 X64 +# + +[LibraryClasses] + BaseLib + PcdLib + BaseMemoryLib + MipiSysTLib + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[Sources] + BaseTraceHubDebugSysTLib.c + InternalTraceHubApiCommon.c + InternalTraceHubApiCommon.h + InternalTraceHubApi.h + +[Pcd] + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugLevel + gEfiMdeModulePkgTokenSpaceGuid.PcdEnableTraceHubDebugMsg + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugMmioAddress diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugS= ysTLib.c b/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugSys= TLib.c new file mode 100644 index 0000000000..626e86c880 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugSysTLib.c @@ -0,0 +1,247 @@ +/** @file +System prints Trace Hub message in DXE/SMM based on fixed PCDs and HOB. +Support at most MAX_TRACE_HUB_DEBUG_INSTANCE of Trace Hub debug instances +in the system. +Trace Hub PCDs will be applied if no HOB exist. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "InternalTraceHubApiCommon.h" +#include "InternalTraceHubApi.h" + +GLOBAL_REMOVE_IF_UNREFERENCED TRACEHUB_DEBUG_INFO_HOB mThDebugInstArray[M= AX_TRACE_HUB_DEBUG_INSTANCE]; +GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mDbgInstCount =3D 0; + +/** + Write debug string to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Buffer A pointer to the data buffer. + @param[in] NumberOfBytes The size of data buffer. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTDebugWrite ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + RETURN_STATUS Status; + UINT16 Index; + + if (NumberOfBytes =3D=3D 0) { + // + // No data need to be written to Trace Hub + // + return RETURN_ABORTED; + } + + if (Buffer =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + if (mDbgInstCount =3D=3D 0) { + mDbgInstCount =3D CountThDebugInstance (); + } + + if (mThDebugInstArray[0].TraceHubMmioAddress =3D=3D 0) { + PackThDebugInstance (&mThDebugInstArray[0], mDbgInstCount); + } + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + MipiSystHandle.systh_header =3D &MipiSystHeader; + + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + for (Index =3D 0; Index < mDbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + (UINT8 *)&mThDebugInstArray[Index], + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubDebugType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteDebug ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + (UINT16)NumberOfBytes, + (CHAR8 *)Buffer + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} + +/** + Write catalog status code message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] Guid Driver Guid. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64StatusCode ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN GUID *Guid + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + UINTN Index; + RETURN_STATUS Status; + GUID ConvertedGuid; + + if (mDbgInstCount =3D=3D 0) { + mDbgInstCount =3D CountThDebugInstance (); + } + + if (mThDebugInstArray[0].TraceHubMmioAddress =3D=3D 0) { + PackThDebugInstance (&mThDebugInstArray[0], mDbgInstCount); + } + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + if (Guid !=3D NULL) { + ConvertedGuid =3D SwapBytesGuid (Guid); + CopyMem (&MipiSystHandle.systh_guid, &ConvertedGuid, sizeof (GUID)); + MipiSystHandle.systh_tag.et_guid =3D 1; + } else { + MipiSystHandle.systh_tag.et_modunit =3D 2; + MipiSystHandle.systh_tag.et_guid =3D 0; + } + + for (Index =3D 0; Index < mDbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + (UINT8 *)&mThDebugInstArray[Index], + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} + +/** + Write catalog message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] NumberOfParams Number of entries in argument list. + @param[in] ... Catalog message parameters. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64 ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN UINTN NumberOfParams, + ... + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + VA_LIST Args; + UINTN Index; + RETURN_STATUS Status; + + if (NumberOfParams > sizeof (MipiSystHandle.systh_param) / sizeof (UINT3= 2)) { + return RETURN_INVALID_PARAMETER; + } + + if (mDbgInstCount =3D=3D 0) { + mDbgInstCount =3D CountThDebugInstance (); + } + + if (mThDebugInstArray[0].TraceHubMmioAddress =3D=3D 0) { + PackThDebugInstance (&mThDebugInstArray[0], mDbgInstCount); + } + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + MipiSystHandle.systh_param_count =3D (UINT32)NumberOfParams; + VA_START (Args, NumberOfParams); + for (Index =3D 0; Index < NumberOfParams; Index++) { + MipiSystHandle.systh_param[Index] =3D VA_ARG (Args, UINT32); + } + + VA_END (Args); + + for (Index =3D 0; Index < mDbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + (UINT8 *)&mThDebugInstArray[Index], + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + } + + return Status; +} diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugS= ysTLib.inf b/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugS= ysTLib.inf new file mode 100644 index 0000000000..9ba1b9c42f --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugSysTLib.= inf @@ -0,0 +1,50 @@ +## @file +# Debug library to output Trace Hub message. +# Support DXE/SMM phase TraceHub debug message based on fixed or dynamic = settings. +# +# Copyright (c) 2023, Intel Corporation. All rights reserved.
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x00010005 + BASE_NAME =3D DxeSmmTraceHubDebugSysTLib + FILE_GUID =3D A9B7B825-7902-4616-8556-085DA4DFEC72 + MODULE_TYPE =3D DXE_DRIVER + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D TraceHubDebugSysTLib|DXE_CORE DXE_DRI= VER SMM_CORE DXE_SMM_DRIVER UEFI_DRIVER UEFI_APPLICATION + +# +# The following information is for reference only and not required by the = build tools. +# +# VALID_ARCHITECTURES =3D IA32 X64 +# + +[LibraryClasses] + BaseLib + PcdLib + HobLib + BaseMemoryLib + MemoryAllocationLib + MipiSysTLib + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[Sources] + DxeSmmTraceHubDebugSysTLib.c + InternalTraceHubApiCommon.c + InternalTraceHubApiCommon.h + InternalTraceHubApi.h + InternalTraceHubApi.c + +[Guids] + gTraceHubDebugInfoHobGuid + +[Pcd] + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugLevel + gEfiMdeModulePkgTokenSpaceGuid.PcdEnableTraceHubDebugMsg + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugMmioAddress diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.= c b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.c new file mode 100644 index 0000000000..4f2dd0f2e5 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.c @@ -0,0 +1,82 @@ +/** @file +Functions implementation in this file are not common for all type of Trace= HubDebugSysTLib. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include "InternalTraceHubApi.h" + +/** + Count the total number of Trace Hub debug instance in the system. + + @retval UINT32 The total number of Trace Hub debug instance in the = system. +**/ +UINT32 +EFIAPI +CountThDebugInstance ( + VOID + ) +{ + UINT8 *DgbContext; + UINT32 DbgInstCount; + + DbgInstCount =3D 0; + + DgbContext =3D (UINT8 *)GetFirstGuidHob (&gTraceHubDebugInfoHobGuid); + if (DgbContext !=3D NULL) { + while (DgbContext !=3D NULL) { + DbgInstCount++; + DgbContext =3D (UINT8 *)GetNextGuidHob (&gTraceHubDebugInfoHobGuid, = GET_NEXT_HOB (DgbContext)); + } + } else { + DbgInstCount++; + } + + // + // Trace Hub HOB larger than MAX_TRACE_HUB_DEBUG_INSTANCE won't be proce= ssed. + // + if (DbgInstCount > MAX_TRACE_HUB_DEBUG_INSTANCE) { + DbgInstCount =3D MAX_TRACE_HUB_DEBUG_INSTANCE; + } + + return DbgInstCount; +} + +/** + Pack Trace Hub debug instances in the system. + + @param[in, out] ThPtr A pointer to TRACEHUB_DEBUG_INFO_HOB structur= e. + @param[in] Count Number of Trace Hub HOBs. +**/ +VOID +EFIAPI +PackThDebugInstance ( + IN OUT TRACEHUB_DEBUG_INFO_HOB *ThPtr, + IN UINT32 Count + ) +{ + UINT8 *DgbContext; + UINT16 Index; + + ZeroMem (ThPtr, sizeof (TRACEHUB_DEBUG_INFO_HOB) * MAX_TRACE_HUB_DEBUG_I= NSTANCE); + DgbContext =3D GetFirstGuidHob (&gTraceHubDebugInfoHobGuid); + if (DgbContext !=3D NULL) { + for (Index =3D 0; Index < Count; Index++) { + CopyMem (&ThPtr[Index], GET_GUID_HOB_DATA (DgbContext), sizeof (TRAC= EHUB_DEBUG_INFO_HOB)); + DgbContext =3D GetNextGuidHob (&gTraceHubDebugInfoHobGuid, GET_NEXT_= HOB (DgbContext)); + } + } else { + for (Index =3D 0; Index < Count; Index++) { + ThPtr[Index].TraceHubMmioAddress =3D FixedPcdGet64 (PcdTraceHubDebug= MmioAddress); + ThPtr[Index].Flag =3D FixedPcdGetBool (PcdEnableTrace= HubDebugMsg); + ThPtr[Index].DebugLevel =3D FixedPcdGet8 (PcdTraceHubDebugL= evel); + } + } +} diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.= h b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.h new file mode 100644 index 0000000000..a185c17d8c --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApi.h @@ -0,0 +1,46 @@ +/** @file +This header file declares functions that are not for common use. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef INTERNAL_TRACE_HUB_API_H_ +#define INTERNAL_TRACE_HUB_API_H_ + +/** + Count the total number of Trace Hub debug instance in the system. + + @retval UINT32 The total number of Trace Hub debug instance in the = system. +**/ +UINT32 +EFIAPI +CountThDebugInstance ( + VOID + ); + +/** + Pack Trace Hub debug instances in the system. + + @param[in, out] ThPtr A pointer to TRACEHUB_DEBUG_INFO_HOB structur= e. + @param[in] Count Number of Trace Hub HOBs. +**/ +VOID +EFIAPI +PackThDebugInstance ( + IN OUT TRACEHUB_DEBUG_INFO_HOB *ThPtr, + IN UINT32 Count + ); + +/** + Convert physical address to virtual address for the pointer to TRACEHUB_= DEBUG_INFO_HOB structure. +**/ +VOID +EFIAPI +InternalCreateThExitBootSvcEvent ( + VOID + ); + +#endif // INTERNAL_TRACE_HUB_API_H_ diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiC= ommon.c b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiComm= on.c new file mode 100644 index 0000000000..f32eb43192 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiCommon.c @@ -0,0 +1,208 @@ +/** @file +Functions implementation defined in this file are common for all type of T= raceHubDebugSysTLib + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include +#include +#include "InternalTraceHubApiCommon.h" +#include "InternalTraceHubApi.h" + +/** + Conditionally determine whether to enable Trace Hub message. + + @param[in] Flag Flag to enable or disable Trace Hub message. + @param[in] DbgLevel Debug Level of Trace Hub. + @param[in] SeverityType Severity type of input message. + + @retval TRUE Enable trace hub message. + @retval FALSE Disable trace hub message. +**/ +BOOLEAN +EFIAPI +TraceHubDataEnabled ( + IN BOOLEAN Flag, + IN UINT8 DbgLevel, + IN TRACE_HUB_SEVERITY_TYPE SeverityType + ) +{ + if (Flag =3D=3D TraceHubRoutingDisable) { + return FALSE; + } + + if (DbgLevel =3D=3D TraceHubDebugLevelError) { + if (((SeverityType =3D=3D SeverityFatal) || (SeverityType =3D=3D Sever= ityError))) { + return TRUE; + } + } else if (DbgLevel =3D=3D TraceHubDebugLevelErrorWarning) { + if (((SeverityType =3D=3D SeverityFatal) || (SeverityType =3D=3D Sever= ityError) || (SeverityType =3D=3D SeverityWarning))) { + return TRUE; + } + } else if (DbgLevel =3D=3D TraceHubDebugLevelErrorWarningInfo) { + if (((SeverityType =3D=3D SeverityFatal) || (SeverityType =3D=3D Sever= ityError) || (SeverityType =3D=3D SeverityWarning) || (SeverityType =3D=3D = SeverityNormal))) { + return TRUE; + } + } else if (DbgLevel =3D=3D TraceHubDebugLevelErrorWarningInfoVerbose) { + return TRUE; + } + + return FALSE; +} + +/** + Convert GUID from LE to BE or BE to LE. + + @param[in] Guid GUID to be converted. + + @retval RETURN_SUCCESS Operation is successful. +**/ +GUID +EFIAPI +SwapBytesGuid ( + IN GUID *Guid + ) +{ + GUID ConvertedGuid; + UINT64 GuidData4; + + ZeroMem (&ConvertedGuid, sizeof (GUID)); + ConvertedGuid.Data1 =3D SwapBytes32 (Guid->Data1); + ConvertedGuid.Data2 =3D SwapBytes16 (Guid->Data2); + ConvertedGuid.Data3 =3D SwapBytes16 (Guid->Data3); + CopyMem (&GuidData4, Guid->Data4, sizeof (Guid->Data4)); + GuidData4 =3D SwapBytes64 (GuidData4); + CopyMem (ConvertedGuid.Data4, &GuidData4, sizeof (GuidData4)); + + return ConvertedGuid; +} + +/** + Check whether to output Trace Hub message according to some conditions. + Trace Hub message will be disabled if TraceHubDataEnabled() return FALSE + or Trace Hub MMIO address is 0. + + @param[in, out] MipiSystHandle A pointer to MIPI_SYST_HANDLE structur= e. + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in] SeverityType Severity type of input message. + @param[in] PrintType Either catalog print or debug print. + + @retval RETURN_SUCCESS Current Trace Hub message need to be output. + @retval Other Current Trace Hub message will be disabled. +**/ +RETURN_STATUS +EFIAPI +CheckWhetherToOutputMsg ( + IN OUT MIPI_SYST_HANDLE *MipiSystHandle, + IN UINT8 *DgbContext, + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN TRACEHUB_PRINTTYPE PrintType + ) +{ + UINT8 DbgLevel; + BOOLEAN Flag; + UINT64 Addr; + RETURN_STATUS Status; + + if (MipiSystHandle =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + if (PrintType =3D=3D TraceHubDebugType) { + Status =3D GetTraceHubMsgVisibility (DgbContext, &Flag, &DbgLevel); + if (RETURN_ERROR (Status)) { + return Status; + } + + if (!TraceHubDataEnabled (Flag, DbgLevel, SeverityType)) { + return RETURN_ABORTED; + } + } + + Status =3D GetTraceHubMmioAddress (DgbContext, &Addr); + if (RETURN_ERROR (Status)) { + return Status; + } + + MipiSystHandle->systh_platform.TraceHubPlatformData.MmioAddr =3D Addr; + if (MipiSystHandle->systh_platform.TraceHubPlatformData.MmioAddr =3D=3D = 0) { + return RETURN_ABORTED; + } + + return RETURN_SUCCESS; +} + +/** + Get Trace Hub MMIO Address. + + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in, out] TraceAddress Trace Hub MMIO Address. + + @retval RETURN_SUCCESS Operation is successfully. + @retval Other Operation is failed. +**/ +RETURN_STATUS +EFIAPI +GetTraceHubMmioAddress ( + IN UINT8 *DgbContext, + IN OUT UINT64 *TraceAddress + ) +{ + TRACEHUB_DEBUG_INFO_HOB *ThDbgContext; + + if (TraceAddress =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + if (DgbContext !=3D NULL) { + ThDbgContext =3D (TRACEHUB_DEBUG_INFO_HOB *)DgbContext; + *TraceAddress =3D ThDbgContext->TraceHubMmioAddress; + } else { + *TraceAddress =3D FixedPcdGet64 (PcdTraceHubDebugMmioAddress); + } + + return RETURN_SUCCESS; +} + +/** + Get visibility of Trace Hub Msg. + + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in, out] Flag Flag to enable or disable Trace Hub mess= age. + @param[in, out] DbgLevel Debug Level of Trace Hub. + + @retval RETURN_SUCCESS Operation is successfully. + @retval Other Operation is failed. +**/ +RETURN_STATUS +EFIAPI +GetTraceHubMsgVisibility ( + IN UINT8 *DgbContext, + IN OUT BOOLEAN *Flag, + IN OUT UINT8 *DbgLevel + ) +{ + TRACEHUB_DEBUG_INFO_HOB *ThDbgContext; + + if ((Flag =3D=3D NULL) || (DbgLevel =3D=3D NULL)) { + return RETURN_INVALID_PARAMETER; + } + + if (DgbContext !=3D NULL) { + ThDbgContext =3D (TRACEHUB_DEBUG_INFO_HOB *)DgbContext; + *Flag =3D ThDbgContext->Flag; + *DbgLevel =3D ThDbgContext->DebugLevel; + } else { + *DbgLevel =3D FixedPcdGet8 (PcdTraceHubDebugLevel); + *Flag =3D FixedPcdGetBool (PcdEnableTraceHubDebugMsg); + } + + return RETURN_SUCCESS; +} diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiC= ommon.h b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiComm= on.h new file mode 100644 index 0000000000..771c4400af --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/InternalTraceHubApiCommon.h @@ -0,0 +1,119 @@ +/** @file +This header file declares functions and type for common use. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef INTERNAL_TRACE_HUB_API_COMMON_H_ +#define INTERNAL_TRACE_HUB_API_COMMON_H_ + +typedef enum { + TraceHubDebugType =3D 0, + TraceHubCatalogType +} TRACEHUB_PRINTTYPE; + +typedef enum { + TraceHubRoutingDisable =3D 0, + TraceHubRoutingEnable, + TraceHubRoutingMax +} TRACE_HUB_ROUTING; + +typedef enum { + TraceHubDebugLevelError =3D 0, + TraceHubDebugLevelErrorWarning, + TraceHubDebugLevelErrorWarningInfo, + TraceHubDebugLevelErrorWarningInfoVerbose, + TraceHubDebugLevelMax +} TRACE_HUB_DEBUG_LEVEL; + +/** + Conditionally determine whether to enable Trace Hub message. + + @param[in] Flag Flag to enable or disable Trace Hub message. + @param[in] DbgLevel Debug Level of Trace Hub. + @param[in] SeverityType Severity type of input message. + + @retval TRUE Enable trace hub message. + @retval FALSE Disable trace hub message. +**/ +BOOLEAN +EFIAPI +TraceHubDataEnabled ( + IN BOOLEAN Flag, + IN UINT8 DbgLevel, + IN TRACE_HUB_SEVERITY_TYPE SeverityType + ); + +/** + Convert GUID from LE to BE or BE to LE. + + @param[in] Guid GUID to be converted. + + @retval RETURN_SUCCESS Operation is successful. +**/ +GUID +EFIAPI +SwapBytesGuid ( + IN OUT GUID *Guid + ); + +/** + Check whether to output Trace Hub message according to some conditions. + Trace Hub message will be disabled if TraceHubDataEnabled() return FALSE + or Trace Hub MMIO address is 0. + + @param[in, out] MipiSystHandle A pointer to MIPI_SYST_HANDLE structur= e. + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in] SeverityType Severity type of input message. + @param[in] PrintType Either catalog print or debug print. + + @retval RETURN_SUCCESS Current Trace Hub message need to be output. + @retval Other Current Trace Hub message will be disabled. +**/ +RETURN_STATUS +EFIAPI +CheckWhetherToOutputMsg ( + IN OUT MIPI_SYST_HANDLE *MipiSystHandle, + IN UINT8 *DgbContext, + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN TRACEHUB_PRINTTYPE PrintType + ); + +/** + Get Trace Hub MMIO Address. + + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in, out] TraceAddress Trace Hub MMIO Address. + + @retval RETURN_SUCCESS Operation is successfully. + @retval Other Operation is failed. +**/ +RETURN_STATUS +EFIAPI +GetTraceHubMmioAddress ( + IN UINT8 *DgbContext, + IN OUT UINT64 *TraceAddress + ); + +/** + Get visibility of Trace Hub Msg. + + @param[in] DgbContext A pointer to Trace Hub debug instance. + @param[in, out] Flag Flag to enable or disable Trace Hub mess= age. + @param[in, out] DbgLevel Debug Level of Trace Hub. + + @retval RETURN_SUCCESS Operation is successfully. + @retval Other Operation is failed. +**/ +RETURN_STATUS +EFIAPI +GetTraceHubMsgVisibility ( + IN UINT8 *DgbContext, + IN OUT BOOLEAN *Flag, + IN OUT UINT8 *DbgLevel + ); + +#endif // INTERNAL_TRACE_HUB_API_COMMON_H_ diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysT= Lib.c b/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysTLib.c new file mode 100644 index 0000000000..fafd651499 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysTLib.c @@ -0,0 +1,290 @@ +/** @file +System prints Trace Hub message in PEI based on fixed PCDs and HOB. +System applies Trace Hub HOB once it detect gTraceHubDebugInfoHobGuid HOB. +Support at most MAX_TRACE_HUB_DEBUG_INSTANCE of Trace Hub debug instances +in the system. +Trace Hub PCDs will be applied if no HOB exist. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "InternalTraceHubApiCommon.h" +#include "InternalTraceHubApi.h" + +/** + Write debug string to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Buffer A pointer to the data buffer. + @param[in] NumberOfBytes The size of data buffer. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTDebugWrite ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + RETURN_STATUS Status; + UINT8 *DgbContext; + UINTN Index; + UINT32 DbgInstCount; + UINT8 *ThDebugInfo; + + DbgInstCount =3D 0; + + if (NumberOfBytes =3D=3D 0) { + // + // No data need to be written to Trace Hub + // + return RETURN_ABORTED; + } + + if (Buffer =3D=3D NULL) { + return RETURN_INVALID_PARAMETER; + } + + DbgInstCount =3D CountThDebugInstance (); + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + MipiSystHandle.systh_header =3D &MipiSystHeader; + + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + DgbContext =3D (UINT8 *)GetFirstGuidHob (&gTraceHubDebugInfoHobGuid); + if (DgbContext !=3D NULL) { + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } else { + ThDebugInfo =3D NULL; + } + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + ThDebugInfo, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubDebugType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteDebug ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + (UINT16)NumberOfBytes, + (CHAR8 *)Buffer + ); + if (RETURN_ERROR (Status)) { + break; + } + } + + if (DgbContext !=3D NULL) { + DgbContext =3D (UINT8 *)GetNextGuidHob (&gTraceHubDebugInfoHobGuid, = GET_NEXT_HOB (DgbContext)); + if (DgbContext =3D=3D NULL) { + break; + } + + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } + } + + return Status; +} + +/** + Write catalog status code message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] Guid Driver Guid. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64StatusCode ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN GUID *Guid + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + UINT32 DbgInstCount; + UINT8 *DgbContext; + RETURN_STATUS Status; + UINTN Index; + UINT8 *ThDebugInfo; + GUID ConvertedGuid; + + DbgInstCount =3D 0; + + DbgInstCount =3D CountThDebugInstance (); + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + if (Guid !=3D NULL) { + ConvertedGuid =3D SwapBytesGuid (Guid); + CopyMem (&MipiSystHandle.systh_guid, &ConvertedGuid, sizeof (GUID)); + MipiSystHandle.systh_tag.et_guid =3D 1; + } else { + MipiSystHandle.systh_tag.et_modunit =3D 2; + MipiSystHandle.systh_tag.et_guid =3D 0; + } + + DgbContext =3D (UINT8 *)GetFirstGuidHob (&gTraceHubDebugInfoHobGuid); + if (DgbContext !=3D NULL) { + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } else { + ThDebugInfo =3D NULL; + } + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + ThDebugInfo, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + + if (DgbContext !=3D NULL) { + DgbContext =3D (UINT8 *)GetNextGuidHob (&gTraceHubDebugInfoHobGuid, = GET_NEXT_HOB (DgbContext)); + if (DgbContext =3D=3D NULL) { + break; + } + + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } + } + + return Status; +} + +/** + Write catalog message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] NumberOfParams Number of entries in argument list. + @param[in] ... Catalog message parameters. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64 ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN UINTN NumberOfParams, + ... + ) +{ + MIPI_SYST_HANDLE MipiSystHandle; + MIPI_SYST_HEADER MipiSystHeader; + VA_LIST Args; + UINTN Index; + UINT32 DbgInstCount; + UINT8 *DgbContext; + RETURN_STATUS Status; + UINT8 *ThDebugInfo; + + DbgInstCount =3D 0; + + if (NumberOfParams > sizeof (MipiSystHandle.systh_param) / sizeof (UINT3= 2)) { + return RETURN_INVALID_PARAMETER; + } + + DbgInstCount =3D CountThDebugInstance (); + + MipiSystHandle.systh_header =3D &MipiSystHeader; + + ZeroMem (&MipiSystHandle, sizeof (MIPI_SYST_HANDLE)); + Status =3D InitMipiSystHandle (&MipiSystHandle); + if (RETURN_ERROR (Status)) { + return Status; + } + + MipiSystHandle.systh_param_count =3D (UINT32)NumberOfParams; + VA_START (Args, NumberOfParams); + for (Index =3D 0; Index < NumberOfParams; Index++) { + MipiSystHandle.systh_param[Index] =3D VA_ARG (Args, UINT32); + } + + VA_END (Args); + + DgbContext =3D (UINT8 *)GetFirstGuidHob (&gTraceHubDebugInfoHobGuid); + if (DgbContext !=3D NULL) { + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } else { + ThDebugInfo =3D NULL; + } + + for (Index =3D 0; Index < DbgInstCount; Index++) { + Status =3D CheckWhetherToOutputMsg ( + &MipiSystHandle, + ThDebugInfo, + (MIPI_SYST_SEVERITY)SeverityType, + TraceHubCatalogType + ); + if (!RETURN_ERROR (Status)) { + Status =3D MipiSystWriteCatalog ( + &MipiSystHandle, + (MIPI_SYST_SEVERITY)SeverityType, + Id + ); + if (RETURN_ERROR (Status)) { + break; + } + } + + if (DgbContext !=3D NULL) { + DgbContext =3D (UINT8 *)GetNextGuidHob (&gTraceHubDebugInfoHobGuid, = GET_NEXT_HOB (DgbContext)); + if (DgbContext =3D=3D NULL) { + break; + } + + ThDebugInfo =3D GET_GUID_HOB_DATA (DgbContext); + } + } + + return Status; +} diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysT= Lib.inf b/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysTLib= .inf new file mode 100644 index 0000000000..2a8184d927 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysTLib.inf @@ -0,0 +1,50 @@ +## @file +# Debug library to output Trace Hub message. +# Support PEI phase TraceHub debug message based on fixed or dynamic sett= ings. +# +# Copyright (c) 2023, Intel Corporation. All rights reserved.
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x00010005 + BASE_NAME =3D PeiTraceHubDebugSysTLib + FILE_GUID =3D C61E8C2E-0935-4E3D-BCBB-5ED84AFD9FD1 + MODULE_TYPE =3D PEIM + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D TraceHubDebugSysTLib|PEI_CORE PEIM + +# +# The following information is for reference only and not required by the = build tools. +# +# VALID_ARCHITECTURES =3D IA32 X64 +# + +[LibraryClasses] + BaseLib + PcdLib + HobLib + BaseMemoryLib + MemoryAllocationLib + MipiSysTLib + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[Sources] + PeiTraceHubDebugSysTLib.c + InternalTraceHubApiCommon.c + InternalTraceHubApiCommon.h + InternalTraceHubApi.h + InternalTraceHubApi.c + +[Guids] + gTraceHubDebugInfoHobGuid + +[Pcd] + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugLevel + gEfiMdeModulePkgTokenSpaceGuid.PcdEnableTraceHubDebugMsg + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugMmioAddress diff --git a/MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md b/MdeModul= ePkg/Library/TraceHubDebugSysTLib/Readme.md new file mode 100644 index 0000000000..24253eb223 --- /dev/null +++ b/MdeModulePkg/Library/TraceHubDebugSysTLib/Readme.md @@ -0,0 +1,30 @@ +## Introduction of TrcaceHubDebugSysTLib ## +TrcaceHubDebugSysTLib library is a top level library for dumping Trace Hub= messages. +It provides Trace Hub related APIs to dump Trace Hub message via MIPI SYS-= T submodule. +User need to properly configure following Trace Hub related PCDs and HOB. + (See MdeModulePkg.dec to get detailed definition for PCDs below) + - PcdTraceHubDebugLevel + - PcdEnableTraceHubDebugMsg + - PcdTraceHubDebugMmioAddress + (See TraceHubDebugInfoHob.h to get detailed definition for HOB below) + - gTraceHubDebugInfoHobGuid + +## BaseTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in SEC/PEI/DXE/SMM based on fixed PCDs. +Only support single Trace Hub debug instance. + +## PeiTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in PEI based on fixed PCDs and HOB. +System applies Trace Hub HOB once it detect gTraceHubDebugInfoHobGuid HOB. +Support at most MAX_TRACE_HUB_DEBUG_INSTANCE of Trace Hub debug instances +in the system. +Trace Hub PCDs will be applied if no HOB exist. + +## DxeSmmTraceHubDebugSysTLib.inf ## +System prints Trace Hub message in DXE/SMM based on fixed PCDs and HOB. +Support at most MAX_TRACE_HUB_DEBUG_INSTANCE of Trace Hub debug instances +in the system. +Trace Hub PCDs will be applied if no HOB exist. + +## Note ## +Trace Hub debug library not support DXE_RUNTIME_DRIVER type of module curr= ently. diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec index 3eb4a79bf7..42a1a8e338 100644 --- a/MdeModulePkg/MdeModulePkg.dec +++ b/MdeModulePkg/MdeModulePkg.dec @@ -438,6 +438,9 @@ ## Include/UniversalPayload/SerialPortInfo.h gUniversalPayloadSerialPortInfoGuid =3D { 0xaa7e190d, 0xbe21, 0x4409, { = 0x8e, 0x67, 0xa2, 0xcd, 0xf, 0x61, 0xe1, 0x70 } } =20 + ## Include/Guid/TraceHubDebugInfoHob.h + gTraceHubDebugInfoHobGuid =3D { 0xf88c9c23, 0x646c, 0x4f6c, { 0x8e, 0x3d= , 0x36, 0xa9, 0x43, 0xc1, 0x08, 0x35 } } + ## GUID used for Boot Discovery Policy FormSet guid and related variable= s. gBootDiscoveryPolicyMgrFormsetGuid =3D { 0x5b6f7107, 0xbb3c, 0x4660, { 0= x92, 0xcd, 0x54, 0x26, 0x90, 0x28, 0x0b, 0xbd } } =20 @@ -1094,6 +1097,24 @@ # @Prompt Enable UEFI Stack Guard. gEfiMdeModulePkgTokenSpaceGuid.PcdCpuStackGuard|FALSE|BOOLEAN|0x30001055 =20 + ## Indicate debug level of Trace Hub. + # 0x0 - TraceHubDebugLevelError.
+ # 0x1 - TraceHubDebugLevelErrorWarning.
+ # 0x2 - TraceHubDebugLevelErrorWarningInfo.
+ # 0x3 - TraceHubDebugLevelErrorWarningInfoVerbose.
+ # @Prompt Debug level of Trace Hub. + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugLevel|0|UINT8|0x30001056 + + ## Flag to enable or disable Trace Hub message. + # FALSE - Disable Trace Hub debug message.
+ # TRUE - Enable Trace Hub debug message.
+ # @Prompt Enable or Disable Trace Hub message. + gEfiMdeModulePkgTokenSpaceGuid.PcdEnableTraceHubDebugMsg|0|BOOLEAN|0x300= 01057 + + ## Indicate MMIO address where Trace Hub message output to. + # @Prompt Output MMIO address of Trace Hub message. + gEfiMdeModulePkgTokenSpaceGuid.PcdTraceHubDebugMmioAddress|0|UINT64|0x30= 001058 + [PcdsFixedAtBuild, PcdsPatchableInModule] ## Dynamic type PCD can be registered callback function for Pcd setting = action. # PcdMaxPeiPcdCallBackNumberPerPcdEntry indicates the maximum number of= callback function diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc index 1014598f31..5b1f50e9c0 100644 --- a/MdeModulePkg/MdeModulePkg.dsc +++ b/MdeModulePkg/MdeModulePkg.dsc @@ -515,6 +515,9 @@ MdeModulePkg/Universal/RegularExpressionDxe/RegularExpressionDxe.inf MdeModulePkg/Universal/SmmCommunicationBufferDxe/SmmCommunicationBufferD= xe.inf MdeModulePkg/Universal/Disk/RamDiskDxe/RamDiskDxe.inf + MdeModulePkg/Library/TraceHubDebugSysTLib/BaseTraceHubDebugSysTLib.inf + MdeModulePkg/Library/TraceHubDebugSysTLib/PeiTraceHubDebugSysTLib.inf + MdeModulePkg/Library/TraceHubDebugSysTLib/DxeSmmTraceHubDebugSysTLib.inf =20 [Components.X64] MdeModulePkg/Universal/CapsulePei/CapsuleX64.inf diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni index 33ce9f6198..a17d34d60b 100644 --- a/MdeModulePkg/MdeModulePkg.uni +++ b/MdeModulePkg/MdeModulePkg.uni @@ -1290,6 +1290,24 @@ = " TRUE - UEFI Stack Guard will be enabled.
\n" = " FALSE - UEFI Stack Guard will be disabled.
" =20 +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdTraceHubDebugLevel_PROMPT #= language en-US "Debug level of Trace Hub." + +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdTraceHubDebugLevel_HELP #= language en-US "Indicate debug level of Trace Hub" + = " 0x0 - TraceHubDebugLevelError.
" + = " 0x1 - TraceHubDebugLevelErrorWarning.
" + = " 0x2 - TraceHubDebugLevelErrorWarningInfo.
" + = " 0x3 - TraceHubDebugLevelErrorWarningInfoVerbose.
" + +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEnableTraceHubDebugMsg_PROMP= T #language en-US "Flag to enable or disable Trace Hub message" + +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdEnableTraceHubDebugMsg_HELP = #language en-US "Enable or Disable Trace Hub message" + = " FALSE - Disable Trace Hub debug message.
" + = " TRUE - Enable Trace Hub debug message.
" + +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdTraceHubDebugMmioAddress_PRO= MPT #language en-US "Output MMIO address of Trace Hub message" + +#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdTraceHubDebugMmioAddress_HEL= P #language en-US "Indicate MMIO address where Trace Hub message output = to." + #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdSetNvStoreDefaultId_PROMPT = #language en-US "NV Storage DefaultId" =20 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdSetNvStoreDefaultId_HELP = #language en-US "This dynamic PCD enables the default variable setting.\n" diff --git a/MdePkg/Include/Library/TraceHubDebugSysTLib.h b/MdePkg/Include= /Library/TraceHubDebugSysTLib.h new file mode 100644 index 0000000000..7df20e67d6 --- /dev/null +++ b/MdePkg/Include/Library/TraceHubDebugSysTLib.h @@ -0,0 +1,81 @@ +/** @file +This header file declares Trace Hub related top level APIs. + +Copyright (c) 2023, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef TRACE_HUB_DEBUG_SYST_LIB_H_ +#define TRACE_HUB_DEBUG_SYST_LIB_H_ + +typedef enum { + SeverityNone =3D 0, + SeverityFatal =3D 1, + SeverityError =3D 2, + SeverityWarning =3D 3, + SeverityNormal =3D 4, + SeverityUser1 =3D 5, + SeverityUser2 =3D 6, + SeverityUser3 =3D 7, + SeverityMax +} TRACE_HUB_SEVERITY_TYPE; + +/** + Write debug string to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Buffer A pointer to the data buffer. + @param[in] NumberOfBytes The size of data buffer. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTDebugWrite ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT8 *Buffer, + IN UINTN NumberOfBytes + ); + +/** + Write catalog status code message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] Guid Driver Guid. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64StatusCode ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN GUID *Guid + ); + +/** + Write catalog message to specified Trace Hub MMIO address. + + @param[in] SeverityType Severity type of input message. + @param[in] Id Catalog ID. + @param[in] NumberOfParams Number of entries in argument list. + @param[in] ... Catalog message parameters. + + @retval RETURN_SUCCESS Data was written to Trace Hub. + @retval Other Failed to output Trace Hub message. +**/ +RETURN_STATUS +EFIAPI +TraceHubSysTWriteCataLog64 ( + IN TRACE_HUB_SEVERITY_TYPE SeverityType, + IN UINT64 Id, + IN UINTN NumberOfParams, + ... + ); + +#endif // TRACE_HUB_DEBUG_SYST_LIB_H_ diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index d68ed988c0..597f4f7137 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -298,6 +298,10 @@ # MipiSysTLib|Include/Library/MipiSysTLib.h =20 + ## @libraryclass Provides API to output Trace Hub debug message. + # + TraceHubDebugSysTLib|Include/Library/TraceHubDebugSysTLib.h + [LibraryClasses.IA32, LibraryClasses.X64, LibraryClasses.AARCH64] ## @libraryclass Provides services to generate random number. # --=20 2.40.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#104275): https://edk2.groups.io/g/devel/message/104275 Mute This Topic: https://groups.io/mt/98764723/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-