Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cpu.h File Reference

SCMI power domain protocol helpers. More...

Go to the source code of this file.

Data Structures

struct  scmi_cpu_sleep_mode_config
 Describes the parameters for the CPU_STATE_SET command. More...
 

Macros

#define SCMI_CPU_SLEEP_FLAG_IRQ_MUX   0x1U
 
#define SCMI_PROTOCOL_CPU_DOMAIN   130
 

Enumerations

enum  scmi_cpu_domain_message {
  SCMI_CPU_DOMAIN_MSG_PROTOCOL_VERSION = 0x0 , SCMI_CPU_DOMAIN_MSG_PROTOCOL_ATTRIBUTES = 0x1 , SCMI_CPU_DOMAIN_MSG_PROTOCOL_MESSAGE_ATTRIBUTES = 0x2 , SCMI_CPU_DOMAIN_MSG_CPU_DOMAIN_ATTRIBUTES = 0x3 ,
  SCMI_CPU_DOMAIN_MSG_CPU_START = 0x4 , SCMI_CPU_DOMAIN_MSG_CPU_STOP = 0x5 , SCMI_CPU_DOMAIN_MSG_CPU_RESET_VECTOR_SET = 0x6 , SCMI_CPU_DOMAIN_MSG_CPU_SLEEP_MODE_SET = 0x7 ,
  SCMI_CPU_DOMAIN_MSG_CPU_IRQ_WAKE_SET = 0x8 , SCMI_CPU_DOMAIN_MSG_CPU_NON_IRQ_WAKE_SET = 0x9 , SCMI_CPU_DOMAIN_MSG_CPU_PD_LPM_CONFIG_SET = 0xA , SCMI_CPU_DOMAIN_MSG_CPU_PER_LPM_CONFIG_SET = 0xB ,
  SCMI_CPU_DOMAIN_MSG_CPU_INFO_GET = 0xC , SCMI_CPU_DOMAIN_MSG_NEGOTIATE_PROTOCOL_VERSION = 0x10
}
 CPU domain protocol command message IDs. More...
 

Functions

int scmi_cpu_sleep_mode_set (struct scmi_cpu_sleep_mode_config *cfg)
 Send the CPU_SLEEP_MODE_SET command and get its reply.
 

Detailed Description

SCMI power domain protocol helpers.

Macro Definition Documentation

◆ SCMI_CPU_SLEEP_FLAG_IRQ_MUX

#define SCMI_CPU_SLEEP_FLAG_IRQ_MUX   0x1U

◆ SCMI_PROTOCOL_CPU_DOMAIN

#define SCMI_PROTOCOL_CPU_DOMAIN   130

Enumeration Type Documentation

◆ scmi_cpu_domain_message

CPU domain protocol command message IDs.

Enumerator
SCMI_CPU_DOMAIN_MSG_PROTOCOL_VERSION 
SCMI_CPU_DOMAIN_MSG_PROTOCOL_ATTRIBUTES 
SCMI_CPU_DOMAIN_MSG_PROTOCOL_MESSAGE_ATTRIBUTES 
SCMI_CPU_DOMAIN_MSG_CPU_DOMAIN_ATTRIBUTES 
SCMI_CPU_DOMAIN_MSG_CPU_START 
SCMI_CPU_DOMAIN_MSG_CPU_STOP 
SCMI_CPU_DOMAIN_MSG_CPU_RESET_VECTOR_SET 
SCMI_CPU_DOMAIN_MSG_CPU_SLEEP_MODE_SET 
SCMI_CPU_DOMAIN_MSG_CPU_IRQ_WAKE_SET 
SCMI_CPU_DOMAIN_MSG_CPU_NON_IRQ_WAKE_SET 
SCMI_CPU_DOMAIN_MSG_CPU_PD_LPM_CONFIG_SET 
SCMI_CPU_DOMAIN_MSG_CPU_PER_LPM_CONFIG_SET 
SCMI_CPU_DOMAIN_MSG_CPU_INFO_GET 
SCMI_CPU_DOMAIN_MSG_NEGOTIATE_PROTOCOL_VERSION 

Function Documentation

◆ scmi_cpu_sleep_mode_set()

int scmi_cpu_sleep_mode_set ( struct scmi_cpu_sleep_mode_config * cfg)

Send the CPU_SLEEP_MODE_SET command and get its reply.

Parameters
cfgpointer to structure containing configuration to be set
Return values
0if successful
negativeerrno if failure