MipiSysTLib.h File Reference

Go to the source code of this file.

Functions
RETURN_STATUS EFIAPI	InitMipiSystHandle (IN OUT VOID *MipiSystHandle)
RETURN_STATUS EFIAPI	MipiSystWriteDebug (IN VOID *MipiSystHandle, IN UINT32 Severity, IN UINT16 Len, IN CONST CHAR8 *Str)
RETURN_STATUS EFIAPI	MipiSystWriteCatalog (IN VOID *MipiSystHandle, IN UINT32 Severity, IN UINT64 CatId)

Detailed Description

This header file declares functions consuming MIPI Sys-T submodule.

Copyright (c) 2023, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file MipiSysTLib.h.

Function Documentation

InitMipiSystHandle()

RETURN_STATUS EFIAPI InitMipiSystHandle

(

IN OUT VOID *

MipiSystHandle

)

Invoke initialization function in Mipi Sys-T module to initialize Mipi Sys-T handle.

Parameters

[in,out]

MipiSystHandle

A pointer to MIPI_SYST_HANDLE structure.

Return values

RETURN_SUCCESS	MIPI_SYST_HANDLE instance was initialized.
Other	MIPI_SYST_HANDLE instance was not initialized.

Definition at line 23 of file MipiSysTLib.c.

MipiSystWriteCatalog()

RETURN_STATUS EFIAPI MipiSystWriteCatalog	(	IN VOID *	MipiSystHandle,
		IN UINT32	Severity,
		IN UINT64	CatId
	)

Invoke catalog_write_message function in Mipi Sys-T module.

Parameters

[in]	MipiSystHandle	A pointer to MIPI_SYST_HANDLE structure.
[in]	Severity	Severity type of input message.
[in]	CatId	Catalog Id.

Return values

RETURN_SUCCESS	Data in buffer was processed.
RETURN_INVALID_PARAMETER	On entry, MipiSystHandle is a NULL pointer.

MipiSystWriteDebug()

RETURN_STATUS EFIAPI MipiSystWriteDebug	(	IN VOID *	MipiSystHandle,
		IN UINT32	Severity,
		IN UINT16	Len,
		IN CONST CHAR8 *	Str
	)

Invoke write_debug_string function in Mipi Sys-T module.

Parameters

[in]	MipiSystHandle	A pointer to MIPI_SYST_HANDLE structure.
[in]	Severity	Severity type of input message.
[in]	Len	Length of data buffer.
[in]	Str	A pointer to data buffer.

Return values

RETURN_SUCCESS	Data in buffer was processed.
RETURN_ABORTED	No data need to be written to Trace Hub.
RETURN_INVALID_PARAMETER	On entry, MipiSystHandle or Str is a NULL pointer.