SCMI power domain protocol APIs

Introduction

This module contains SCMI power domain protocol APIs.

Files
file	scmi_power_domain.h
	Header file containing scmi power domain protocol APIs.

Functions
int32_t	SCMI_powerDomainGetProtocolAttrs (SCMI_Handle handle, uint32_t *numPowerDomains, uint64_t *statsAddr, uint32_t *statsLen)
	API to get power domain protocol attributes using power domain SCMI protocol. More...
int32_t	SCMI_powerDomainGetAttrs (SCMI_Handle handle, uint32_t domainId, uint32_t *attributes, uint8_t *name)
	API to get power domain attributes for a power domain Id. More...
int32_t	SCMI_powerDomainStateSet (SCMI_Handle handle, uint32_t domainId, uint32_t flags, uint32_t pstate)
	API to set power domain to on or off state. More...
int32_t	SCMI_powerDomainStateGet (SCMI_Handle handle, uint32_t domainId, uint32_t *pstate)
	API to get power domain state. More...
int32_t	SCMI_powerDomainNameGet (SCMI_Handle handle, uint32_t domainId, uint8_t *name)
	API to get power domain extended name. More...
int32_t	SCMI_powerDomainProtocolInit (SCMI_Handle handle)
	API to initialise power domain protocol. More...

Function Documentation

SCMI_powerDomainGetProtocolAttrs()

int32_t SCMI_powerDomainGetProtocolAttrs	(	SCMI_Handle	handle,
		uint32_t *	numPowerDomains,
		uint64_t *	statsAddr,
		uint32_t *	statsLen
	)

API to get power domain protocol attributes using power domain SCMI protocol.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
numPowerDomains	Pointer to get number of power domains
statsAddr	Pointer to get address for statistics shared memory
statsLen	Pointer to get length for statistics shared memory

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_powerDomainGetAttrs()

int32_t SCMI_powerDomainGetAttrs	(	SCMI_Handle	handle,
		uint32_t	domainId,
		uint32_t *	attributes,
		uint8_t *	name
	)

API to get power domain attributes for a power domain Id.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
domainId	Power domain Identifier
attributes	Pointer to power domain attributes
name	Pointer to name of power domain

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_powerDomainStateSet()

int32_t SCMI_powerDomainStateSet	(	SCMI_Handle	handle,
		uint32_t	domainId,
		uint32_t	flags,
		uint32_t	pstate
	)

API to set power domain to on or off state.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
domainId	Power domain Identifier
flags	Parameter flags for the power domain
pstate	Power state

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_powerDomainStateGet()

int32_t SCMI_powerDomainStateGet	(	SCMI_Handle	handle,
		uint32_t	domainId,
		uint32_t *	pstate
	)

API to get power domain state.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
domainId	Power domain Identifier
pstate	Power state pointer

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_powerDomainNameGet()

int32_t SCMI_powerDomainNameGet	(	SCMI_Handle	handle,
		uint32_t	domainId,
		uint8_t *	name
	)

API to get power domain extended name.

Parameters

handle	SCMI_Handle handle returned from SCMI_open
domainId	Power domain Identifier
name	Pointer to extended name

Returns

SystemP_SUCCESS or SystemP_FAILURE

SCMI_powerDomainProtocolInit()

int32_t SCMI_powerDomainProtocolInit

(

SCMI_Handle

handle

)

API to initialise power domain protocol.

Parameters

handle

SCMI_Handle handle returned from SCMI_open

Returns

SystemP_SUCCESS or SystemP_FAILURE