system.h File Reference

Header file for the SCMI System Power Management Protocol. More...

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

Go to the source code of this file.

Data Structures
struct	scmi_system_power_state_config
	System power state configuration. More...

Macros
#define	SCMI_SYSTEM_POWER_PROTOCOL_SUPPORTED_VERSION   0x20001
	Version of the SCMI system power protocol supported by this driver.
Standard SCMI System Power States
#define	SCMI_SYSTEM_POWER_STATE_SHUTDOWN   0x00000000U
	Shutdown off.
#define	SCMI_SYSTEM_POWER_STATE_COLD_RESET   0x00000001U
	Cold reset.
#define	SCMI_SYSTEM_POWER_STATE_WARM_RESET   0x00000002U
	Warm reset.
#define	SCMI_SYSTEM_POWER_STATE_POWER_UP   0x00000003U
	Power up.
#define	SCMI_SYSTEM_POWER_STATE_SUSPEND   0x00000004U
	Suspend.
System Power State flags
#define	SCMI_SYSTEM_POWER_FLAG_FORCEFUL   (0 << SCMI_SYSTEM_POWER_FLAG_SHIFT)
	Forceful request.
#define	SCMI_SYSTEM_POWER_FLAG_GRACEFUL   (1 << SCMI_SYSTEM_POWER_FLAG_SHIFT)
	Graceful request.
SCMI system message attributes
#define	SCMI_SYSTEM_MSG_ATTR_SUSPEND   (1 << SCMI_SYSTEM_MSG_ATTR_SUSPEND_SHIFT)
	System suspend support.
#define	SCMI_SYSTEM_MSG_ATTR_WARM_RESET   (1 << SCMI_SYSTEM_MSG_ATTR_WARM_RESET_SHIFT)
	System warm reset support.

Functions
int	scmi_system_protocol_version (uint32_t *version)
	Get protocol version.
int	scmi_system_protocol_attributes (uint32_t *attributes)
	Get protocol attributes.
int	scmi_system_protocol_message_attributes (uint32_t message_id, uint32_t *attributes)
	Get protocol message attributes.
int	scmi_system_protocol_version_negotiate (uint32_t version)
	Negotiate protocol version.
int	scmi_system_power_state_set (struct scmi_system_power_state_config *cfg)
	Set system power state.

Detailed Description

Header file for the SCMI System Power Management Protocol.