SCMI Namespace Reference

Classes
class	AgentChannel
	This is a Agent to Platform channel (The agent is the initiator) More...
class	BaseProtocol
	This protocol describes the properties of the implementation and provides generic error management. More...
class	Communication
	The SCMI Communication class models a bidirectional communication between the SCMI platform and the agent. More...
struct	Message
class	Platform
class	PlatformChannel
	This is a Platform to Agent channel (The platform is the initiator) More...
class	Protocol
class	VirtualChannel
	Generic communication channel between the Agent and the Platform. More...

Enumerations
enum	ProtocolID : uint8_t {   BASE = 0x10, START = 0x11, POWER_DOMAIN = START, SYSTEM_POWER = 0x12,   PERFORMANCE_DOMAIN = 0x13, CLOCK = 0x14, SENSOR = 0x15, END = SENSOR }
enum	MessageType { MessageType::COMMANDS = 0, MessageType::DELAYED_RESPONSES = 2, MessageType::NOTIFICATIONS = 3 }
enum	StatusCode {   SUCCESS = 0, NOT_SUPPORTED = -1, INVALID_PARAMETERS = -2, DENIED = -3,   NOT_FOUND = -4, OUT_OF_RANGE = -5, BUSY = -6, COMMS_ERROR = -7,   GENERIC_ERROR = -8, HARDWARE_ERROR = -9, PROTOCOL_ERROR = -10 }

Functions
	BitUnion32 (MessageHeader) Bitfield< 27
	EndBitUnion (MessageHeader) union Payload

Variables
static const uint8_t	PROTOCOL_MAX = 6
	token
Bitfield< 17, 10 >	protocolId
Bitfield< 9, 8 >	messageType
Bitfield< 7, 0 >	messageId

Enumeration Type Documentation

MessageType

enum SCMI::MessageType

strong

Enumerator
COMMANDS
DELAYED_RESPONSES
NOTIFICATIONS

Definition at line 69 of file scmi_platform.hh.

ProtocolID

enum SCMI::ProtocolID : uint8_t

Enumerator
BASE
START
POWER_DOMAIN
SYSTEM_POWER
PERFORMANCE_DOMAIN
CLOCK
SENSOR
END

Definition at line 57 of file scmi_platform.hh.

StatusCode

enum SCMI::StatusCode

Enumerator
SUCCESS
NOT_SUPPORTED
INVALID_PARAMETERS
DENIED
NOT_FOUND
OUT_OF_RANGE
BUSY
COMMS_ERROR
GENERIC_ERROR
HARDWARE_ERROR
PROTOCOL_ERROR

Definition at line 50 of file scmi_protocols.hh.

Function Documentation

BitUnion32()

SCMI::BitUnion32

(

MessageHeader

)

EndBitUnion()

SCMI::EndBitUnion

(

MessageHeader

)

Definition at line 81 of file scmi_platform.hh.

References SCMI::Protocol::MAX_STRING_SIZE, messageId, name(), PROTOCOL_MAX, and ArmISA::status.

Variable Documentation

messageId

Bitfield<7,0> SCMI::messageId

Definition at line 80 of file scmi_platform.hh.

Referenced by EndBitUnion().

messageType

Bitfield<9,8> SCMI::messageType

Definition at line 79 of file scmi_platform.hh.

PROTOCOL_MAX

const uint8_t SCMI::PROTOCOL_MAX = 6

static

Definition at line 55 of file scmi_platform.hh.

Referenced by EndBitUnion().

protocolId

Bitfield<17,10> SCMI::protocolId

Definition at line 78 of file scmi_platform.hh.

token

SCMI::token

Definition at line 77 of file scmi_platform.hh.

Referenced by arrayParamIn(), ObjectMatch::domatch(), GenericISA::M5DebugOnceFault< Flavor >::lookUpToken(), tokenize(), and RegisterBank< BankByteOrder >::RegisterLBuf< 12 >::unserialize().