gem5 v24.0.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes | List of all members
gem5::scmi::BaseProtocol Class Reference

This protocol describes the properties of the implementation and provides generic error management. More...

#include <scmi_protocols.hh>

Inheritance diagram for gem5::scmi::BaseProtocol:
gem5::scmi::Protocol

Public Types

enum class  Commands {
  VERSION = 0x0 , ATTRIBUTES = 0x1 , MESSAGE_ATTRIBUTES = 0x2 , DISCOVER_VENDOR = 0x3 ,
  DISCOVER_SUB_VENDOR = 0x4 , DISCOVER_IMPLEMENTATION_VERSION = 0x5 , DISCOVER_LIST_PROTOCOLS = 0x6 , DISCOVER_AGENT = 0x7 ,
  NOTIFY_ERRORS = 0x8 , SET_DEVICE_PERMISSIONS = 0x9 , SET_PROTOCOL_PERMISSIONS = 0xa , RESET_AGENT_CONFIGURATION = 0xb
}
 

Public Member Functions

 BaseProtocol (Platform &_platform)
 
void handleMessage (Message &msg) override
 
void version (Message &msg) override
 
void attributes (Message &msg) override
 
void messageAttributes (Message &msg) override
 
void discoverVendor (Message &msg)
 
void discoverSubVendor (Message &msg)
 
void discoverImplVersion (Message &msg)
 
void discoverListProtocols (Message &msg)
 
void discoverAgent (Message &msg)
 
void invalidCommand (Message &msg)
 
- Public Member Functions inherited from gem5::scmi::Protocol
 Protocol (Platform &_platform)
 
virtual ~Protocol ()
 
const std::string name () const
 

Protected Member Functions

bool implementedProtocol (Commands message_id) const
 

Protected Attributes

const std::string vendor
 
const std::string subvendor
 
const uint32_t implementationVersion
 
- Protected Attributes inherited from gem5::scmi::Protocol
Platform & platform
 

Static Private Attributes

static const uint32_t PROTOCOL_VERSION = 0x10000
 

Additional Inherited Members

- Static Public Attributes inherited from gem5::scmi::Protocol
static const uint32_t MAX_STRING_SIZE = 15
 

Detailed Description

This protocol describes the properties of the implementation and provides generic error management.

The Base protocol provides commands to:

  • Describe protocol version
  • Discover implementation attributes and vendor identification.
  • Discover which protocols are implemented.
  • Discover which agents are in the system.
  • Register for notifications of platform errors.
  • Configure the platform in order to control and modify an agent visibility of platform resources and commands. This protocol is mandatory.

Definition at line 110 of file scmi_protocols.hh.

Member Enumeration Documentation

◆ Commands

enum class gem5::scmi::BaseProtocol::Commands
strong
Enumerator
VERSION 
ATTRIBUTES 
MESSAGE_ATTRIBUTES 
DISCOVER_VENDOR 
DISCOVER_SUB_VENDOR 
DISCOVER_IMPLEMENTATION_VERSION 
DISCOVER_LIST_PROTOCOLS 
DISCOVER_AGENT 
NOTIFY_ERRORS 
SET_DEVICE_PERMISSIONS 
SET_PROTOCOL_PERMISSIONS 
RESET_AGENT_CONFIGURATION 

Definition at line 117 of file scmi_protocols.hh.

Constructor & Destructor Documentation

◆ BaseProtocol()

gem5::BaseProtocol::BaseProtocol ( Platform & _platform)
explicit

Definition at line 54 of file scmi_protocols.cc.

References fatal_if, gem5::scmi::Protocol::MAX_STRING_SIZE, subvendor, and vendor.

Member Function Documentation

◆ attributes()

void gem5::BaseProtocol::attributes ( Message & msg)
overridevirtual

Implements gem5::scmi::Protocol.

Definition at line 122 of file scmi_protocols.cc.

References gem5::scmi::Message::length, gem5::scmi::Platform::numAgents(), gem5::scmi::Platform::numProtocols(), gem5::scmi::Message::payload, gem5::scmi::Protocol::platform, gem5::replaceBits(), and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ discoverAgent()

void gem5::BaseProtocol::discoverAgent ( Message & msg)

Definition at line 247 of file scmi_protocols.cc.

References gem5::scmi::Platform::getAgent(), gem5::scmi::Message::length, gem5::scmi::NOT_FOUND, gem5::scmi::Platform::numAgents(), gem5::scmi::Message::payload, gem5::scmi::Protocol::platform, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ discoverImplVersion()

void gem5::BaseProtocol::discoverImplVersion ( Message & msg)

Definition at line 202 of file scmi_protocols.cc.

References implementationVersion, gem5::scmi::Message::length, gem5::scmi::Message::payload, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ discoverListProtocols()

void gem5::BaseProtocol::discoverListProtocols ( Message & msg)

Definition at line 213 of file scmi_protocols.cc.

References gem5::scmi::END, gem5::scmi::INVALID_PARAMETERS, gem5::scmi::Message::length, gem5::scmi::Platform::numProtocols(), gem5::scmi::Message::payload, gem5::scmi::Protocol::platform, gem5::scmi::Platform::protocolList(), gem5::scmi::START, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ discoverSubVendor()

void gem5::BaseProtocol::discoverSubVendor ( Message & msg)

Definition at line 189 of file scmi_protocols.cc.

References gem5::scmi::Message::length, gem5::scmi::Protocol::MAX_STRING_SIZE, gem5::scmi::Message::payload, subvendor, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ discoverVendor()

void gem5::BaseProtocol::discoverVendor ( Message & msg)

Definition at line 176 of file scmi_protocols.cc.

References gem5::scmi::Message::length, gem5::scmi::Protocol::MAX_STRING_SIZE, gem5::scmi::Message::payload, gem5::scmi::SUCCESS, and vendor.

Referenced by handleMessage().

◆ handleMessage()

void gem5::BaseProtocol::handleMessage ( Message & msg)
overridevirtual

Implements gem5::scmi::Protocol.

Definition at line 67 of file scmi_protocols.cc.

References ATTRIBUTES, attributes(), DISCOVER_AGENT, DISCOVER_IMPLEMENTATION_VERSION, DISCOVER_LIST_PROTOCOLS, DISCOVER_SUB_VENDOR, DISCOVER_VENDOR, discoverAgent(), discoverImplVersion(), discoverListProtocols(), discoverSubVendor(), discoverVendor(), DPRINTF, invalidCommand(), MESSAGE_ATTRIBUTES, messageAttributes(), gem5::scmi::Platform::messageID(), NOTIFY_ERRORS, RESET_AGENT_CONFIGURATION, SET_DEVICE_PERMISSIONS, SET_PROTOCOL_PERMISSIONS, VERSION, version(), and warn.

◆ implementedProtocol()

bool gem5::BaseProtocol::implementedProtocol ( Commands message_id) const
protected

Definition at line 138 of file scmi_protocols.cc.

References ATTRIBUTES, DISCOVER_AGENT, DISCOVER_IMPLEMENTATION_VERSION, DISCOVER_LIST_PROTOCOLS, DISCOVER_SUB_VENDOR, DISCOVER_VENDOR, MESSAGE_ATTRIBUTES, and VERSION.

Referenced by messageAttributes().

◆ invalidCommand()

void gem5::BaseProtocol::invalidCommand ( Message & msg)

Definition at line 280 of file scmi_protocols.cc.

References gem5::scmi::Message::length, gem5::scmi::NOT_FOUND, and gem5::scmi::Message::payload.

Referenced by handleMessage().

◆ messageAttributes()

void gem5::BaseProtocol::messageAttributes ( Message & msg)
overridevirtual

Implements gem5::scmi::Protocol.

Definition at line 156 of file scmi_protocols.cc.

References implementedProtocol(), gem5::scmi::Message::length, gem5::scmi::NOT_FOUND, gem5::scmi::Message::payload, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

◆ version()

void gem5::BaseProtocol::version ( Message & msg)
overridevirtual

Implements gem5::scmi::Protocol.

Definition at line 111 of file scmi_protocols.cc.

References gem5::scmi::Message::length, gem5::scmi::Message::payload, PROTOCOL_VERSION, and gem5::scmi::SUCCESS.

Referenced by handleMessage().

Member Data Documentation

◆ implementationVersion

const uint32_t gem5::scmi::BaseProtocol::implementationVersion
protected

Definition at line 152 of file scmi_protocols.hh.

Referenced by discoverImplVersion().

◆ PROTOCOL_VERSION

const uint32_t gem5::scmi::BaseProtocol::PROTOCOL_VERSION = 0x10000
staticprivate

Definition at line 112 of file scmi_protocols.hh.

Referenced by version().

◆ subvendor

const std::string gem5::scmi::BaseProtocol::subvendor
protected

Definition at line 151 of file scmi_protocols.hh.

Referenced by BaseProtocol(), and discoverSubVendor().

◆ vendor

const std::string gem5::scmi::BaseProtocol::vendor
protected

Definition at line 150 of file scmi_protocols.hh.

Referenced by BaseProtocol(), and discoverVendor().

The documentation for this class was generated from the following files:
Generated on Tue Jun 18 2024 16:24:22 for gem5 by doxygen 1.11.0