module xdc.runtime.Rta

The Rta module contains target and configuration code for providing RTA support

C synopsis
XDCscript usage
XDCspec declarations
Individual elements
Additional documentation

The 'Command' enum defines the available control commands, and the 'CommandPacket' structure defines the format of commands received from the host. [ more ... ]

XDCspec summary sourced in xdc/runtime/Rta.xdc

module Rta { ...

// inherits xdc.runtime.IModule

C synopsis target-domain

#include <xdc/runtime/Rta.h>

module-wide constants & types

typedef Int Rta_Command// Command ids;

enum {

Rta_Command_READ_MASK,

Rta_Command_WRITE_MASK,

Rta_Command_LOGGER_OFF,

Rta_Command_LOGGER_ON,

Rta_Command_GET_CPU_SPEED,

Rta_Command_RESET_LOGGER,

Rta_Command_CHANGE_PERIOD

} ;

typedef struct Rta_CommandPacket// Structure of command received from host TODO - Either the types should be changed to 32-bits, or the packet size information should be added to the RTA XML file {

Rta_Command cmdId;

UArg arg0;

UArg arg1;

} Rta_CommandPacket;

typedef struct Rta_ResponsePacket// Structure of response packet sent back to host {

Rta_Command cmdId;

UArg resp0;

UArg resp1;

} Rta_ResponsePacket;

module-wide config parameters

extern const Assert_Id Rta_A_invalidLogger// Assert if logger id in control command is invalid;

extern const Error_Id Rta_E_badCommand// Error raised if Agent receives an invalid command;

extern const Log_Event Rta_LD_cmdRcvd// Logged when the Agent receives a command;

extern const Log_Event Rta_LD_writeMask// Logged when a diags mask is changed;

module-wide functions

Void Rta_acknowledgeCmd// ( Rta_ResponsePacket *resp );

Void Rta_changePeriod// ( Rta_ResponsePacket *resp, UArg period );

Void Rta_disableLog// ( Rta_ResponsePacket *resp, UArg log );

Void Rta_enableLog// ( Rta_ResponsePacket *resp, UArg log );

Void Rta_getCpuSpeed// ( Rta_ResponsePacket *resp );

Void Rta_processCommand// Executes a command packet and prepares the response packet( Rta_CommandPacket *cmd, Rta_ResponsePacket *resp );

Void Rta_readMask// ( Rta_ResponsePacket *resp, UArg addr );

Void Rta_resetLog// ( Rta_ResponsePacket *resp, UArg log );

Void Rta_writeMask// ( Rta_ResponsePacket *resp, UArg addr, UArg val );

module-wide built-ins

Types_ModuleId Rta_Module_id// Get this module's unique id( );

Bool Rta_Module_startupDone// Test if this module has completed startup( );

IHeap_Handle Rta_Module_heap// The heap from which this module allocates memory( );

Bool Rta_Module_hasMask// Test whether this module has a diagnostics mask( );

Bits16 Rta_Module_getMask// Returns the diagnostics mask for this module( );

Void Rta_Module_setMask// Set the diagnostics mask for this module( Bits16 mask );

XDCscript usage meta-domain

var Rta = xdc.useModule('xdc.runtime.Rta');

module-wide constants & types

values of type Rta.Command// Command ids

const Rta.Command_READ_MASK;

const Rta.Command_WRITE_MASK;

const Rta.Command_LOGGER_OFF;

const Rta.Command_LOGGER_ON;

const Rta.Command_GET_CPU_SPEED;

const Rta.Command_RESET_LOGGER;

const Rta.Command_CHANGE_PERIOD;

var obj = new Rta.CommandPacket// Structure of command received from host TODO - Either the types should be changed to 32-bits, or the packet size information should be added to the RTA XML file;

obj.cmdId = Rta.Command ...

obj.arg0 = UArg ...

obj.arg1 = UArg ...

var obj = new Rta.ResponsePacket// Structure of response packet sent back to host;

obj.cmdId = Rta.Command ...

obj.resp0 = UArg ...

obj.resp1 = UArg ...

module-wide config parameters

Rta.A_invalidLogger// Assert if logger id in control command is invalid = Assert.Desc {

msg: "A_invalidLogger: The logger id %d is invalid."

};

Rta.E_badCommand// Error raised if Agent receives an invalid command = Error.Desc {

msg: "E_badCommand: Received invalid command, id: %d."

};

Rta.LD_cmdRcvd// Logged when the Agent receives a command = Log.EventDesc {

mask: Diags.USER2,

msg: "LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"

};

Rta.LD_writeMask// Logged when a diags mask is changed = Log.EventDesc {

mask: Diags.USER2,

msg: "LD_writeMask: Mask addres: 0x%x, New mask value: 0x%x"

};

Rta.common$// Common module configuration parameters = Types.Common$ undefined;

XDCspec declarations sourced in xdc/runtime/Rta.xdc

package xdc.runtime;

module Rta {

module-wide constants & types

enum Command// Command ids {

Command_READ_MASK,

Command_WRITE_MASK,

Command_LOGGER_OFF,

Command_LOGGER_ON,

Command_GET_CPU_SPEED,

Command_RESET_LOGGER,

Command_CHANGE_PERIOD

};

struct CommandPacket// Structure of command received from host TODO - Either the types should be changed to 32-bits, or the packet size information should be added to the RTA XML file {

Rta.Command cmdId;

UArg arg0;

UArg arg1;

};

struct ResponsePacket// Structure of response packet sent back to host {

Rta.Command cmdId;

UArg resp0;

UArg resp1;

};

module-wide config parameters

config Assert.Id A_invalidLogger// Assert if logger id in control command is invalid = {

msg: "A_invalidLogger: The logger id %d is invalid."

};

config Error.Id E_badCommand// Error raised if Agent receives an invalid command = {

msg: "E_badCommand: Received invalid command, id: %d."

};

config Log.Event LD_cmdRcvd// Logged when the Agent receives a command = {

mask: Diags.USER2,

msg: "LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"

};

config Log.Event LD_writeMask// Logged when a diags mask is changed = {

mask: Diags.USER2,

msg: "LD_writeMask: Mask addres: 0x%x, New mask value: 0x%x"

};

metaonly config Types.Common$ common$// Common module configuration parameters;

module-wide functions

Void acknowledgeCmd// ( Rta.ResponsePacket *resp );

Void changePeriod// ( Rta.ResponsePacket *resp, UArg period );

Void disableLog// ( Rta.ResponsePacket *resp, UArg log );

Void enableLog// ( Rta.ResponsePacket *resp, UArg log );

Void getCpuSpeed// ( Rta.ResponsePacket *resp );

Void processCommand// Executes a command packet and prepares the response packet( Rta.CommandPacket *cmd, Rta.ResponsePacket *resp );

Void readMask// ( Rta.ResponsePacket *resp, UArg addr );

Void resetLog// ( Rta.ResponsePacket *resp, UArg log );

Void writeMask// ( Rta.ResponsePacket *resp, UArg addr, UArg val );

}

DETAILS

The 'Command' enum defines the available control commands, and the 'CommandPacket' structure defines the format of commands received from the host.

All commands should send back a response, even if only to acknowledge receipt and completion of the command. The format of the response is defined by the 'ResponsePacket' structure.

The Rta_processCommand can be used to process commands received from a host to call the appropriate API. Alternatively, the individual APIs can be called if not all of the defined commands are used.

enum Rta.Command