power.h File Reference

Header file for the SCMI Power Domain Protocol. More...

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

Go to the source code of this file.

Data Structures
struct	scmi_power_state_config
	Describes the parameters for the POWER_STATE_SET command. More...

Macros
#define	SCMI_POWER_STATE_SET_FLAGS_ASYNC   BIT(0)
#define	SCMI_POWER_DOMAIN_PROTOCOL_SUPPORTED_VERSION   0x30001
SCMI power domain state parameters
#define	SCMI_POWER_STATE_TYPE_SHIFT   30U
	Power state type field bit shift.
#define	SCMI_POWER_STATE_ID_MASK   (BIT(28) - 1)
	Power state ID field mask.
#define	SCMI_POWER_STATE_PARAM(type, id)
	Construct SCMI power state parameter.
SCMI power domain generic states
#define	SCMI_POWER_STATE_GENERIC_ON   SCMI_POWER_STATE_PARAM(0, 0)
	Power domain is in ON state.
#define	SCMI_POWER_STATE_GENERIC_OFF   SCMI_POWER_STATE_PARAM(1, 0)
	Power domain is in OFF state.

Enumerations
enum	scmi_power_domain_message {   SCMI_POWER_DOMAIN_MSG_PROTOCOL_VERSION = 0x0 , SCMI_POWER_DOMAIN_MSG_PROTOCOL_ATTRIBUTES = 0x1 , SCMI_POWER_DOMAIN_MSG_PROTOCOL_MESSAGE_ATTRIBUTES = 0x2 , SCMI_POWER_DOMAIN_MSG_POWER_DOMAIN_ATTRIBUTES = 0x3 ,   SCMI_POWER_DOMAIN_MSG_POWER_STATE_SET = 0x4 , SCMI_POWER_DOMAIN_MSG_POWER_STATE_GET = 0x5 , SCMI_POWER_DOMAIN_MSG_POWER_STATE_NOTIFY = 0x6 , SCMI_POWER_DOMAIN_MSG_POWER_STATE_CHANGE_REQEUSTED_NOTIFY = 0x7 ,   SCMI_POWER_DOMAIN_MSG_POWER_DOMAIN_NAME_GET = 0x8 , SCMI_POWER_DOMAIN_MSG_NEGOTIATE_PROTOCOL_VERSION = 0x10 }
	Power domain protocol command message IDs. More...

Functions
int	scmi_power_state_set (struct scmi_power_state_config *cfg)
	Send the POWER_STATE_SET command and get its reply.
int	scmi_power_state_get (uint32_t domain_id, uint32_t *power_state)
	Query the power domain state.

Detailed Description

Header file for the SCMI Power Domain Protocol.