module ti.sysbios.rta.SupportLogger
index URL

The SupportLogger is used to log the Timestamp frequency so that the RTA tool can convert the log event timestamps into seconds. This log occurs during module startup

C synopsis target-domain sourced in ti/sysbios/rta/SupportLogger.xdc
#include <ti/sysbios/rta/SupportLogger.h>
Functions common to all target modules
SupportLogger_Module_getMask// Returns the diagnostics mask for this module, SupportLogger_Module_hasMask// Test whether this module has a diagnostics mask, SupportLogger_Module_heap// The heap from which this module allocates memory, SupportLogger_Module_id// Get this module's unique id, SupportLogger_Module_setMask// Set the diagnostics mask for this module, SupportLogger_Module_startupDone// Test if this module has completed startup
Constants
extern const Int 
SupportLogger_createLogSize// Size of SupportLogger LoggerBuf in records. Allow one record per Task, Swi, and Hwi instance in the system;
extern const Log_Event 
SupportLogger_LM_timestampFreq// Logged in Module_startup to record Timestamp freq;
 
 
config SupportLogger_LM_timestampFreq  // module-wide
index URL

Logged in Module_startup to record Timestamp freq

C synopsis target-domain
extern const Log_Event SupportLogger_LM_timestampFreq;
 
 
config SupportLogger_createLogSize  // module-wide
index URL

Size of SupportLogger LoggerBuf in records. Allow one record per Task, Swi, and Hwi instance in the system

C synopsis target-domain
extern const Int SupportLogger_createLogSize;
 
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId SupportLogger_Module_id();
// Get this module's unique id
 
Bool SupportLogger_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SupportLogger_Module_heap();
// The heap from which this module allocates memory
 
Bool SupportLogger_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SupportLogger_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SupportLogger_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sysbios/rta/SupportLogger.xdc
var SupportLogger = xdc.useModule('ti.sysbios.rta.SupportLogger');
module-wide config parameters
    SupportLogger.LM_timestampFreq// Logged in Module_startup to record Timestamp freq = Log.EventDesc {
        mask: Diags.USER1 | Diags.USER2,
        msg: "LM_timestampFreq: Timestamp Frequency hi: %d, lo: %d"
    };
    SupportLogger.createLogSize// Size of SupportLogger LoggerBuf in records. Allow one record per Task, Swi, and Hwi instance in the system = Int 32;
 
    SupportLogger.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config SupportLogger.LM_timestampFreq  // module-wide
index URL

Logged in Module_startup to record Timestamp freq

XDCscript usage meta-domain
SupportLogger.LM_timestampFreq = Log.EventDesc {
    mask: Diags.USER1 | Diags.USER2,
    msg: "LM_timestampFreq: Timestamp Frequency hi: %d, lo: %d"
};
 
C SYNOPSIS
SupportLogger_LM_timestampFreq
 
config SupportLogger.createLogSize  // module-wide
index URL

Size of SupportLogger LoggerBuf in records. Allow one record per Task, Swi, and Hwi instance in the system

XDCscript usage meta-domain
SupportLogger.createLogSize = Int 32;
 
C SYNOPSIS
SupportLogger_createLogSize
 
metaonly config SupportLogger.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
SupportLogger.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 Thu, 01 Mar 2012 16:58:16 GMT