APIs for SCMI

Introduction

This module contains APIs to program and use the SCMI module.

Sub Modules
	SCMI Clock IDs
	SCMI Clock protocol APIs
	SCMI DEVICE IDs
	SCMI base protocol APIs
	SCMI power domain protocol APIs
	SCMI transport APIs

Files
file	scp/scmi/v0/scmi.h
	SCMI Driver API/interface file. This is SCMI top level include for applications.

Data Structures
struct	SCMI_SharedMemory
	SCMI_SharedMemory - Description of a Shared memory buffer. More...
struct	SCMI_messageHeader
struct	SCMI_MessageData
struct	SCMI_AgentDataInfo
struct	SCMI_PowerDomainProtocol
struct	SCMI_ClockProtocol
struct	SCMI_Object
struct	SCMI_Config

Functions
void	SCMI_init (void)
	SCMI initialization function. This function should be called before calling any driver APIs and only once. More...
void	SCMI_deinit (void)
	This function de-initializes the SCMI module. More...
SCMI_Handle	SCMI_open (uint32_t instanceIndex)
	This function opens a given SCMI instance. More...
void	SCMI_close (SCMI_Handle handle)
	This function closes a given SCMI instance. More...
SCMI_Handle	SCMI_getHandle (uint32_t driverInstanceIndex)
	This function returns the handle of an open SCMI Instance from the instance index. More...
int32_t	SCMI_getSCMIProtocolErrorMapped (int32_t errorCode)
	This function translates the SCMI error codes to SystemP error codes. More...
void	SCMI_getProtocolVersionLog (uint32_t instanceIndex)
	This function logs the SCMI version probed during init time. More...
uint32_t	SCMI_getInitDriverIndex (void)
	This function returns the initialised instance index. More...

Typedefs
typedef void *	SCMI_Handle
	A handle that is returned from a SCMI_open() call. More...

Macros
#define	SCMI_MAX_POSSIBLE_PARENTS   (16U)

Macro Definition Documentation

SCMI_MAX_POSSIBLE_PARENTS

#define SCMI_MAX_POSSIBLE_PARENTS   (16U)

< Maximum possible parents

Typedef Documentation

SCMI_Handle

typedef void* SCMI_Handle

A handle that is returned from a SCMI_open() call.

Function Documentation

SCMI_init()

void SCMI_init

(

void

)

SCMI initialization function. This function should be called before calling any driver APIs and only once.

SCMI_deinit()

void SCMI_deinit

(

void

)

This function de-initializes the SCMI module.

SCMI_open()

SCMI_Handle SCMI_open

(

uint32_t

instanceIndex

)

This function opens a given SCMI instance.

Parameters

instanceIndex

Index of config to use in the SCMI_Config array

Returns

A SCMI_Handle on success or a NULL on an error or if it has been opened already

SCMI_close()

void SCMI_close

(

SCMI_Handle

handle

)

This function closes a given SCMI instance.

Precondition

SCMI_open() has to be called first

Parameters

handle

SCMI_Handle returned from SCMI_open API.

See also

SCMI_open()

SCMI_getHandle()

SCMI_Handle SCMI_getHandle

(

uint32_t

driverInstanceIndex

)

This function returns the handle of an open SCMI Instance from the instance index.

Parameters

driverInstanceIndex

Index of config to use in the SCMI_Config array

Returns

An SCMI_Handle if it has been opened already or NULL otherwise

SCMI_getSCMIProtocolErrorMapped()

int32_t SCMI_getSCMIProtocolErrorMapped

(

int32_t

errorCode

)

This function translates the SCMI error codes to SystemP error codes.

Parameters

errorCode

Error code returned from the SCMI message

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_getProtocolVersionLog()

void SCMI_getProtocolVersionLog

(

uint32_t

instanceIndex

)

This function logs the SCMI version probed during init time.

Parameters

instanceIndex

Instance of SCMI that was opened in SCMI_open

SCMI_getInitDriverIndex()

uint32_t SCMI_getInitDriverIndex

(

void

)

This function returns the initialised instance index.

Returns

instanceIndex First instance which is open for SCMI driver