TraceHubDebugSysTLib.h File Reference

Go to the source code of this file.

Enumerations
enum	TRACE_HUB_SEVERITY_TYPE {   SeverityNone = 0 , SeverityFatal = 1 , SeverityError = 2 , SeverityWarning = 3 ,   SeverityNormal = 4 , SeverityUser1 = 5 , SeverityUser2 = 6 , SeverityUser3 = 7 ,   SeverityMax }

Functions
RETURN_STATUS EFIAPI	TraceHubSysTDebugWrite (IN TRACE_HUB_SEVERITY_TYPE SeverityType, IN UINT8 *Buffer, IN UINTN NumberOfBytes)
RETURN_STATUS EFIAPI	TraceHubSysTWriteCataLog64StatusCode (IN TRACE_HUB_SEVERITY_TYPE SeverityType, IN UINT64 Id, IN GUID *Guid)
RETURN_STATUS EFIAPI	TraceHubSysTWriteCataLog64 (IN TRACE_HUB_SEVERITY_TYPE SeverityType, IN UINT64 Id, IN UINTN NumberOfParams,...)

Detailed Description

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

Definition in file TraceHubDebugSysTLib.h.

Enumeration Type Documentation

TRACE_HUB_SEVERITY_TYPE

enum TRACE_HUB_SEVERITY_TYPE

Definition at line 13 of file TraceHubDebugSysTLib.h.

Function Documentation

TraceHubSysTDebugWrite()

RETURN_STATUS EFIAPI TraceHubSysTDebugWrite	(	IN TRACE_HUB_SEVERITY_TYPE	SeverityType,
		IN UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

Write debug string to specified Trace Hub MMIO address.

Parameters

[in]	SeverityType	Severity type of input message.
[in]	Buffer	A pointer to the data buffer.
[in]	NumberOfBytes	The size of data buffer.

Return values

RETURN_SUCCESS	Data was written to Trace Hub.
Other	Failed to output Trace Hub message.

Definition at line 34 of file BaseTraceHubDebugSysTLib.c.

TraceHubSysTWriteCataLog64()

RETURN_STATUS EFIAPI TraceHubSysTWriteCataLog64	(	IN TRACE_HUB_SEVERITY_TYPE	SeverityType,
		IN UINT64	Id,
		IN UINTN	NumberOfParams,
			...
	)

Write catalog message to specified Trace Hub MMIO address.

Parameters

[in]	SeverityType	Severity type of input message.
[in]	Id	Catalog ID.
[in]	NumberOfParams	Number of entries in argument list.
[in]	...	Catalog message parameters.

Return values

RETURN_SUCCESS	Data was written to Trace Hub.
Other	Failed to output Trace Hub message.

Definition at line 166 of file BaseTraceHubDebugSysTLib.c.

TraceHubSysTWriteCataLog64StatusCode()

RETURN_STATUS EFIAPI TraceHubSysTWriteCataLog64StatusCode	(	IN TRACE_HUB_SEVERITY_TYPE	SeverityType,
		IN UINT64	Id,
		IN GUID *	Guid
	)

Write catalog status code message to specified Trace Hub MMIO address.

Parameters

[in]	SeverityType	Severity type of input message.
[in]	Id	Catalog ID.
[in]	Guid	Driver Guid.

Return values

RETURN_SUCCESS	Data was written to Trace Hub.
Other	Failed to output Trace Hub message.

Definition at line 102 of file BaseTraceHubDebugSysTLib.c.