module ti.uia.services.Rta
C synopsis target-domain sourced in ti/uia/services/Rta.xdc
 
config Rta_LD_cmdRcvd  // module-wide

Logged when the Rta receives a command

C synopsis target-domain
extern const Log_Event Rta_LD_cmdRcvd;
 
 
config Rta_LD_recordsSent  // module-wide

Logged on every packet is sent call from the Rta

C synopsis target-domain
extern const Log_Event Rta_LD_recordsSent;
 
 
config Rta_LD_writeMask  // module-wide

Logged when a diags mask is changed

C synopsis target-domain
extern const Log_Event Rta_LD_writeMask;
 
 
config Rta_periodInMs  // module-wide

Period in miliseconds of the RTA Transfer Agent

C synopsis target-domain
extern const Int Rta_periodInMs;
 
DETAILS
Configures how often the RTA should collect events. The minimum value is 100ms.
This value does not guarantee that the collection will run at this rate. Even if the period has expired, the collection will not occur until the current running Task has yielded and there are no other higher priority Tasks ready.
Setting the period to 0, disables all collection of events. There must be a setPeriod message sent from an instrumentation host to Rta to enable it.
Default is 100 milliseconds.
 
Rta_disableAllLogs()  // module-wide

Function to disable all the logs being processed by Rta

C synopsis target-domain
Void Rta_disableAllLogs();
 
DETAILS
Runtime function to disable all the logs that are being processed/read by Rta. When disabled, all new Log records are discarded.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests.
 
Rta_enableAllLogs()  // module-wide

Function to enable all the logs being processed by Rta

C synopsis target-domain
Void Rta_enableAllLogs();
 
DETAILS
Runtime function to enable disable all the logs that are being processed/read by Rta.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests
 
Rta_resetAllLogs()  // module-wide

Function to resets enable all the logs being processed by Rta

C synopsis target-domain
Void Rta_resetAllLogs();
 
DETAILS
Runtime function to enable resets all the logs that are being processed/read by Rta. All records in the logs are discarded. The state of the logger (e.g. enabled or disabled) is not changed.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests
 
Rta_snapshotAllLogs()  // module-wide

Function to delay processing of the Rta service

C synopsis target-domain
Void Rta_snapshotAllLogs(UArg reset, UArg waitPeriod);
 
ARGUMENTS
reset — Flag to denote whether to reset the loggers or not. TRUE means reset all the loggers processed by Rta. FALSE means do not reset any of the loggers processed by Rta.
waitPeriod — Duration in milliseconds to wait to run the Rta service.
DETAILS
This function informs Rta to delay for the specified waitPeriod (in ms). After the waitPeriod has expired, Rta will process all the loggers that it manages. The state of Rta (e.g. started or stopped) will be maintained after the waitPeriod is expired and all the logs processed.
The reset flag determines whether to reset all the loggers at the start of the waitPeriod (true -> reset). The state of the loggers (e.g. enabled or disabled) is not changed by this flag.
 
Rta_startDataTx()  // module-wide

Function to start the Rta service

C synopsis target-domain
Void Rta_startDataTx();
 
DETAILS
This function allows the Rta service to be turned on.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests
 
Rta_stopDataTx()  // module-wide

Function to stop the Rta service

C synopsis target-domain
Void Rta_stopDataTx();
 
DETAILS
This function allows the Rta service to be turned off.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests
Module-Wide Built-Ins

C synopsis target-domain
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(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/uia/services/Rta.xdc
var Rta = xdc.useModule('ti.uia.services.Rta');
module-wide config parameters
        mask: Diags.USER2,
        msg: "LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"
    };
        mask: Diags.USER2,
        msg: "LD_recordsSent: Sent %d bytes from logger [%d] 0x%x"
    };
        mask: Diags.USER2,
        msg: "LD_writeMask: Mask addres: 0x%x, New mask value: 0x%x"
    };
 
 
 
config Rta.LD_cmdRcvd  // module-wide

Logged when the Rta receives a command

Configuration settings
Rta.LD_cmdRcvd = Log.EventDesc {
    mask: Diags.USER2,
    msg: "LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"
};
 
C SYNOPSIS
 
config Rta.LD_recordsSent  // module-wide

Logged on every packet is sent call from the Rta

Configuration settings
Rta.LD_recordsSent = Log.EventDesc {
    mask: Diags.USER2,
    msg: "LD_recordsSent: Sent %d bytes from logger [%d] 0x%x"
};
 
C SYNOPSIS
 
config Rta.LD_writeMask  // module-wide

Logged when a diags mask is changed

Configuration settings
Rta.LD_writeMask = Log.EventDesc {
    mask: Diags.USER2,
    msg: "LD_writeMask: Mask addres: 0x%x, New mask value: 0x%x"
};
 
C SYNOPSIS
 
config Rta.periodInMs  // module-wide

Period in miliseconds of the RTA Transfer Agent

Configuration settings
Rta.periodInMs = Int 100;
 
DETAILS
Configures how often the RTA should collect events. The minimum value is 100ms.
This value does not guarantee that the collection will run at this rate. Even if the period has expired, the collection will not occur until the current running Task has yielded and there are no other higher priority Tasks ready.
Setting the period to 0, disables all collection of events. There must be a setPeriod message sent from an instrumentation host to Rta to enable it.
Default is 100 milliseconds.
C SYNOPSIS
 
metaonly config Rta.common$  // module-wide

Common module configuration parameters

Configuration settings
Rta.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Tue, 14 Feb 2017 00:15:18 GMT