SCMI base protocol APIs

Introduction

This module contains SCMI base protocol APIs.

Files
file	scmi_base.h
	Header file containing scmi base protocol APIs.

Functions
int32_t	SCMI_baseGenericProtocolVersion (SCMI_Handle handle, SCMI_StandardProtocol protocolId, uint32_t *version)
	API to get generic protocol version. More...
int32_t	SCMI_getBaseProtocolVersion (SCMI_Handle handle, uint32_t *version)
	API to get base protocol version. More...
int32_t	SCMI_baseGetProtocolAttributes (SCMI_Handle handle, uint32_t *numAgents, uint32_t *numProtocols)
	API to get protocol attributes for base protocol. This gives number of agents and number of protocols supported in the platform. More...
int32_t	SCMI_baseGetMessageAttributes (SCMI_Handle handle, uint32_t messageId, uint32_t *attributes)
	API to get message attributes for base protocol. More...
int32_t	SCMI_baseDiscoverVendor (SCMI_Handle handle, uint8_t *vendor)
	API to get vendor name string. More...
int32_t	SCMI_baseDiscoverSubVendor (SCMI_Handle handle, uint8_t *subVendor)
	API to get Sub-vendor name string. More...
int32_t	SCMI_baseDiscoverImplementationVersion (SCMI_Handle handle, uint32_t *implVersion)
	API to get vendor implementation version. More...
int32_t	SCMI_baseDiscoverListProtocols (SCMI_Handle handle, uint32_t *protocolCount, uint8_t *protocols)
	API to get supported protocols count and list by platform. More...

Function Documentation

SCMI_baseGenericProtocolVersion()

int32_t SCMI_baseGenericProtocolVersion	(	SCMI_Handle	handle,
		SCMI_StandardProtocol	protocolId,
		uint32_t *	version
	)

API to get generic protocol version.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
protocolId	SCMI standard protocol
version	Pointer to version

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_getBaseProtocolVersion()

int32_t SCMI_getBaseProtocolVersion	(	SCMI_Handle	handle,
		uint32_t *	version
	)

API to get base protocol version.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
version	Pointer to version

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseGetProtocolAttributes()

int32_t SCMI_baseGetProtocolAttributes	(	SCMI_Handle	handle,
		uint32_t *	numAgents,
		uint32_t *	numProtocols
	)

API to get protocol attributes for base protocol. This gives number of agents and number of protocols supported in the platform.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
numAgents	Number of agents
numProtocols	Number of protocols

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseGetMessageAttributes()

int32_t SCMI_baseGetMessageAttributes	(	SCMI_Handle	handle,
		uint32_t	messageId,
		uint32_t *	attributes
	)

API to get message attributes for base protocol.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
messageId	Base protocol message identifier
attributes	Attributes for the message

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseDiscoverVendor()

int32_t SCMI_baseDiscoverVendor	(	SCMI_Handle	handle,
		uint8_t *	vendor
	)

API to get vendor name string.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
vendor	Array to get vendor name

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseDiscoverSubVendor()

int32_t SCMI_baseDiscoverSubVendor	(	SCMI_Handle	handle,
		uint8_t *	subVendor
	)

API to get Sub-vendor name string.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
subVendor	Array to get Sub-vendor name

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseDiscoverImplementationVersion()

int32_t SCMI_baseDiscoverImplementationVersion	(	SCMI_Handle	handle,
		uint32_t *	implVersion
	)

API to get vendor implementation version.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
implVersion	Pointer to implementation version.

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_baseDiscoverListProtocols()

int32_t SCMI_baseDiscoverListProtocols	(	SCMI_Handle	handle,
		uint32_t *	protocolCount,
		uint8_t *	protocols
	)

API to get supported protocols count and list by platform.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
protocolCount	Protocols count.
protocols	Array for protocols list.

Returns

SystemP_SUCCESS or SystemP_FAILURE