Reset domain management Protocol

Reset domain management via SCMI. More...

Files
file	reset.h
	Header file for the SCMI Reset Protocol.

Data Structures
struct	scmi_reset_domain_attr
	SCMI Reset domain attributes. More...

Macros
#define	SCMI_RESET_ATTR_NUM_DOMAINS   GENMASK(15, 0)
	Mask for the number of reset domains in the PROTOCOL_ATTRIBUTES report.
#define	SCMI_RESET_ATTR_GET_NUM_DOMAINS(attr)
	Extract the number of reset domains from the protocol attributes.
#define	SCMI_RESET_AUTONOMOUS   BIT(0)
	Autonomous Reset flag: the reset must be performed autonomously by the platform.
#define	SCMI_RESET_EXPLICIT_ASSERT   BIT(1)
	Explicit assert/deassert flag: explicitly assert reset signal.
#define	SCMI_RESET_ASYNCHRONOUS_RESET   BIT(2)
	Asynchronous reset flag: the reset must complete asynchronously.
#define	SCMI_RESET_ARCH_COLD_RESET   0
	Architectural Cold Reset type.
#define	SCMI_RESET_PROTOCOL_SUPPORTED_VERSION   0x30001
	Supported version of the SCMI Reset protocol.

Functions
int	scmi_reset_domain_get_attr (struct scmi_protocol *proto, uint32_t id, struct scmi_reset_domain_attr *dom_attr)
	SCMI reset domain protocol get attributes of the reset domain.
int	scmi_reset_domain (struct scmi_protocol *proto, uint32_t id, uint32_t flags, uint32_t reset_state)
	SCMI reset domain protocol reset domain.

Detailed Description

Reset domain management via SCMI.

Macro Definition Documentation

SCMI_RESET_ARCH_COLD_RESET

#define SCMI_RESET_ARCH_COLD_RESET   0

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

Architectural Cold Reset type.

SCMI_RESET_ASYNCHRONOUS_RESET

#define SCMI_RESET_ASYNCHRONOUS_RESET   BIT(2)

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

Asynchronous reset flag: the reset must complete asynchronously.

SCMI_RESET_ATTR_GET_NUM_DOMAINS

#define SCMI_RESET_ATTR_GET_NUM_DOMAINS

(

attr

)

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

Value:

FIELD_GET(SCMI_RESET_ATTR_NUM_DOMAINS, (attr))

Extract the number of reset domains from the protocol attributes.

SCMI_RESET_ATTR_NUM_DOMAINS

#define SCMI_RESET_ATTR_NUM_DOMAINS   GENMASK(15, 0)

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

Mask for the number of reset domains in the PROTOCOL_ATTRIBUTES report.

SCMI_RESET_AUTONOMOUS

#define SCMI_RESET_AUTONOMOUS   BIT(0)

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

Autonomous Reset flag: the reset must be performed autonomously by the platform.

SCMI_RESET_EXPLICIT_ASSERT

#define SCMI_RESET_EXPLICIT_ASSERT   BIT(1)

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

Explicit assert/deassert flag: explicitly assert reset signal.

SCMI_RESET_PROTOCOL_SUPPORTED_VERSION

#define SCMI_RESET_PROTOCOL_SUPPORTED_VERSION   0x30001

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

Supported version of the SCMI Reset protocol.

Function Documentation

scmi_reset_domain()

int scmi_reset_domain	(	struct scmi_protocol *	proto,
		uint32_t	id,
		uint32_t	flags,
		uint32_t	reset_state )

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

SCMI reset domain protocol reset domain.

Parameters

proto	pointer to SCMI clock protocol data
id	ID of the Reset domain for which the query is done
flags	the additional conditions and requirements specific to the request
reset_state	the reset state being requested

Returns

0 on success, negative errno on failure

scmi_reset_domain_get_attr()

int scmi_reset_domain_get_attr	(	struct scmi_protocol *	proto,
		uint32_t	id,
		struct scmi_reset_domain_attr *	dom_attr )

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

SCMI reset domain protocol get attributes of the reset domain.

Parameters

proto	pointer to SCMI clock protocol data
id	ID of the Reset domain for which the query is done
dom_attr	pointer to return Reset domain id attributes

Returns

0 on success, negative errno on failure