SCMI transport APIs

Introduction

This module contains SCMI transport APIs.

Files
file	scmi_transport.h
	Header file containing scmi transport APIs.

Data Structures
struct	SCMI_TransportFxns
struct	SCMI_TransportObject

Functions
int32_t	SCMITransport_processMessage (SCMI_Handle handle, SCMI_MessageData *message)
	Driver implementation to send a SCMI message. More...
int32_t	SCMITransport_fetchResponse (SCMI_Handle handle, SCMI_MessageData *message)
	Driver implementation to receive a response for SCMI message. More...

Typedefs
typedef int32_t(*	SCMI_TransportProcessMessage) (SCMI_Handle handle, SCMI_MessageData *message)
	Driver implementation to send a SCMI message. More...
typedef int32_t(*	SCMI_TransportFetchResponse) (SCMI_Handle handle, SCMI_MessageData *message)
	Driver implementation to receive a response for SCMI message. More...

Typedef Documentation

SCMI_TransportProcessMessage

typedef int32_t(* SCMI_TransportProcessMessage) (SCMI_Handle handle, SCMI_MessageData *message)

Driver implementation to send a SCMI message.

Typically this callback is hidden from the end application and is implemented when a new type of transport needs to be implemented.

Parameters

handle	[in] SCMI driver handle
message	[in] SCMI message structure

Returns

SystemP_SUCCESS on success, else SystemP_FAILURE

SCMI_TransportFetchResponse

typedef int32_t(* SCMI_TransportFetchResponse) (SCMI_Handle handle, SCMI_MessageData *message)

Driver implementation to receive a response for SCMI message.

Typically this callback is hidden from the end application and is implemented when a new type of transport needs to be implemented.

Parameters

handle	[in] SCMI driver handle
message	[in] SCMI message structure

Returns

SystemP_SUCCESS on success, else SystemP_FAILURE

Function Documentation

SCMITransport_processMessage()

int32_t SCMITransport_processMessage	(	SCMI_Handle	handle,
		SCMI_MessageData *	message
	)

Driver implementation to send a SCMI message.

Typically this callback is hidden from the end application and is implemented when a new type of transport needs to be implemented.

Parameters

handle	[in] SCMI driver handle
message	[in] SCMI message structure

Returns

SystemP_SUCCESS on success, else SystemP_FAILURE

SCMITransport_fetchResponse()

int32_t SCMITransport_fetchResponse	(	SCMI_Handle	handle,
		SCMI_MessageData *	message
	)

Driver implementation to receive a response for SCMI message.

Typically this callback is hidden from the end application and is implemented when a new type of transport needs to be implemented.

Parameters

handle	[in] SCMI driver handle
message	[in] SCMI message structure

Returns

SystemP_SUCCESS on success, else SystemP_FAILURE