Base Protocol

SCMI Base protocol operations. More...

Files
file	base.h
	Header file for the SCMI Base Protocol.

Data Structures
struct	scmi_revision_info
	SCMI base protocol revision information. More...
struct	scmi_agent_info
	SCMI base protocol agent info. More...

Macros
#define	SCMI_BASE_PROTOCOL_SUPPORTED_VERSION   0x20001
	Supported version of the SCMI Base protocol.
#define	SCMI_BASE_AGENT_ID_OWN   0xFFFFFFFF
	Special parameter to request the calling agent's identity from the platform.

Functions
int	scmi_base_get_revision_info (struct scmi_revision_info *rev)
	SCMI base protocol get revision information.
int	scmi_base_discover_agent (uint32_t agent_id, struct scmi_agent_info *agent_inf)
	SCMI base protocol discover the name of an agent and agent id.
int	scmi_base_device_permission (uint32_t agent_id, uint32_t device_id, bool allow)
	SCMI base protocol set an agent permissions to access devices.
int	scmi_base_reset_agent_cfg (uint32_t agent_id, bool reset_perm)
	SCMI base protocol reset platform resource settings that were configured by an agent.

Detailed Description

SCMI Base protocol operations.

Macro Definition Documentation

SCMI_BASE_AGENT_ID_OWN

#define SCMI_BASE_AGENT_ID_OWN   0xFFFFFFFF

#include <zephyr/drivers/firmware/scmi/base.h>

Special parameter to request the calling agent's identity from the platform.

SCMI_BASE_PROTOCOL_SUPPORTED_VERSION

#define SCMI_BASE_PROTOCOL_SUPPORTED_VERSION   0x20001

#include <zephyr/drivers/firmware/scmi/base.h>

Supported version of the SCMI Base protocol.

Function Documentation

scmi_base_device_permission()

int scmi_base_device_permission	(	uint32_t	agent_id,
		uint32_t	device_id,
		bool	allow )

#include <zephyr/drivers/firmware/scmi/base.h>

SCMI base protocol set an agent permissions to access devices.

Parameters

agent_id	SCMI agent id.
device_id	SCMI device id.
allow	If set to true, allow agent access to the device.

Return values

0	If successful, negative errno on an error.

scmi_base_discover_agent()

int scmi_base_discover_agent	(	uint32_t	agent_id,
		struct scmi_agent_info *	agent_inf )

#include <zephyr/drivers/firmware/scmi/base.h>

SCMI base protocol discover the name of an agent and agent id.

Parameters

agent_id	SCMI agent id. The platform will return caller SCMI agent id if set to SCMI_BASE_AGENT_ID_OWN.
agent_inf	pointer on SCMI agent information struct scmi_agent_info.

Return values

0	If successful, negative errno on an error.

scmi_base_get_revision_info()

int scmi_base_get_revision_info

(

struct scmi_revision_info *

rev

)

#include <zephyr/drivers/firmware/scmi/base.h>

SCMI base protocol get revision information.

Parameters

rev	pointer on revision information struct scmi_revision_info.

Return values

0	If successful, negative errno on an error.

scmi_base_reset_agent_cfg()

int scmi_base_reset_agent_cfg	(	uint32_t	agent_id,
		bool	reset_perm )

#include <zephyr/drivers/firmware/scmi/base.h>

SCMI base protocol reset platform resource settings that were configured by an agent.

Parameters

agent_id	SCMI agent id.
reset_perm	If set to true, reset all access permission settings of the agent.

Return values

0	If successful, negative errno on an error.