module ti.uia.loggers.LoggerRunMode

General purpose logger enabling applications to stream data to an instrumentation host through JTAG or ethernet

LoggerRunMode events can be streamed to an instrumentation host in real-time, for targets that support either real-time JTAG or UIA Ethernet transport. Events can be uploaded without having to halt the target. [ more ... ]
C synopsis target-domain sourced in ti/uia/loggers/LoggerRunMode.xdc
#include <ti/uia/loggers/LoggerRunMode.h>
Functions
Void
Void
Void
SizeT 
Void 
Void
Functions common to all ILogger modules
Bool 
Bool 
Void 
Void 
Void 
Void 
Void 
LoggerRunMode_write8// Process a log event with 8 arguments(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
Functions common to all IUIATransfer modules
Bool 
UInt16 
SizeT 
Bool 
Void 
Functions common to all IFilterLogger modules
Void 
Functions common to all ILoggerSnapshot modules
Void 
LoggerRunMode_writeMemoryRange// Log an event along with values from a range of memory addresses(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, UInt32 snapshotId, IArg fileName, IArg LineNum, IArg fmt, IArg startAdrs, UInt32 lengthInMAUs);
Functions common to all target instances
LoggerRunMode_handle// Convert this instance structure pointer into an instance handle, LoggerRunMode_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, LoggerRunMode_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure, LoggerRunMode_Handle_downCast3// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure, LoggerRunMode_Handle_downCast4// conditionally move 4 levels down the inheritance hierarchy; NULL upon failure, LoggerRunMode_Handle_label// The label associated with this instance object, LoggerRunMode_Handle_name// The name of this instance object, LoggerRunMode_Handle_upCast// unconditionally move one level up the inheritance hierarchy, LoggerRunMode_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy, LoggerRunMode_Handle_upCast3// unconditionally move 3 levels up the inheritance hierarchy, LoggerRunMode_Handle_upCast4// unconditionally move 4 levels up the inheritance hierarchy, LoggerRunMode_Object_count// The number of statically-created instance objects, LoggerRunMode_Object_first// The handle of the first dynamically-created instance object, or NULL, LoggerRunMode_Object_get// The handle of the i-th statically-created instance object (array == NULL), LoggerRunMode_Object_heap// The heap used to allocate dynamically-created instance objects, LoggerRunMode_Object_next// The handle of the next dynamically-created instance object, or NULL, LoggerRunMode_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
Typedefs
typedef struct
typedef struct
typedef struct
typedef enum
typedef enum
Constants
extern const Bool 
extern const Bool 
extern const Diags_Mask 
extern const Diags_Mask 
extern const Diags_Mask 
extern const Diags_Mask 
extern const Int 
extern const Bool 
 
DETAILS
LoggerRunMode events can be streamed to an instrumentation host in real-time, for targets that support either real-time JTAG or UIA Ethernet transport. Events can be uploaded without having to halt the target.
Each LoggerRunMode instance has its own buffer for events logged to that instance. By including the header file, ti/uia/runtime/LogUC.h, you can specify the LoggerRunMode instance that you want the event logged to.
The logger's buffer is split up into three or more 'packets' for more efficient streaming to the host. While one packet is being read by the host, the others can be written to. When a packet is filled, the logger starts writing to the next available packet. Each packet must be large enough to hold maxEventSize bytes, plus an additional number of bytes (64) for a header. If the configured bufSize is not big enough for three packets of this minimum size, bufSize will be increased automatically.
The logger stores the events in a UIAPacket_Hdr structure that allows them to be sent directly to System Analyzer (e.g. via UDP), enabling efficient streaming of the data from the target to the host. The first four 32-bit words contain a UIAPacket_Hdr structure. This struct is used by the host (e.g. System Analyzer in CCS) to help decode the data (e.g. endianess, length of data, etc.).
The size of the buffer includes the UIAPacket_Hdr. LoggerRunMode treats the buffer as a UInt32 array, so the application must guarantee the buffers are aligned on word addresses. Alignment on cache line boundaries is recommended for best performance.
LoggerRunMode will overwrite older events if the host is not able to upload events quickly enough.
LoggerRunMode was designed to have as minimal impact as possible on an application when calling a Log function. There are several configuration parameters that allow an application to get the optimal performance in exchange for certain restrictions.
Interrupts are disabled during the duration of the log call.
NOTE: It is recommended that you use LoggingSetup to configure the Logger instances. For example to use LoggerRunMode with real-time JTAG transport, set LoggingSetup.loggerType to LoggingSetup.LoggerType_JTAGRUNMODE.
EXAMPLES
The following XDC configuration statements create a logger module, and assign it as the default logger for all modules.
  var Defaults = xdc.useModule('xdc.runtime.Defaults');
  var Diags = xdc.useModule('xdc.runtime.Diags');
  var LoggerRunMode = xdc.useModule('ti.uia.loggers.LoggerRunMode');

  LoggerRunMode.isTimestampEnabled = true;

  var loggerParams = new LoggerRunMode.Params();

  Program.global.logger0 = LoggerRunMode.create(loggerParams);
  Defaults.common$.logger = Program.global.logger0;

The following C code demonstrates logging to different LoggerRunMode instances.
  #include <xdc/std.h>
  #include <xdc/runtime/Diags.h>
  #include <xdc/runtime/Log.h>
  #include <ti/uia/loggers/LoggerRunMode.h>
  #include <ti/uia/runtime/LogUC.h>

  Int main(Int argc, String argv[])
  {
      Log_iwriteUC0(logger0, LoggerRunMode_L_test);
      Log_iwriteUC1(logger1, LoggerRunMode_L_test, 0x1000);
  }

The following XDC configuration statements show how to use LoggingSetup with LoggerRunMode.
  var LoggingSetup = xdc.useModule('ti.uia.sysbios.LoggingSetup');
  LoggingSetup.loggerType = LoggingSetup.LoggingSetup_JTAGRUNMODE;

 
enum LoggerRunMode_TransferType
C synopsis target-domain
typedef enum LoggerRunMode_TransferType {
    LoggerRunMode_TransferType_RELIABLE,
    LoggerRunMode_TransferType_LOSSY
} LoggerRunMode_TransferType;
 
 
enum LoggerRunMode_TransportType

This enum is used by the instrumentation host to determine what the transport is

C synopsis target-domain
typedef enum LoggerRunMode_TransportType {
    LoggerRunMode_TransportType_JTAG,
    LoggerRunMode_TransportType_ETHERNET
} LoggerRunMode_TransportType;
 
 
config LoggerRunMode_filterByLevel  // module-wide

Support filtering of events by event level

C synopsis target-domain
extern const Bool LoggerRunMode_filterByLevel;
 
DETAILS
To improve logging performance, this feature can be disabled by setting filterByLevel to false.
See 'setFilterLevel' for an explanation of level filtering.
 
config LoggerRunMode_isTimestampEnabled  // module-wide

Enable or disable logging the 64-bit local CPU timestamp at the start of each event

C synopsis target-domain
extern const Bool LoggerRunMode_isTimestampEnabled;
 
DETAILS
Having a timestamp allows an instrumentation host (e.g. System Analyzer) to display events with the correct system time.
 
config LoggerRunMode_level1Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL1

C synopsis target-domain
extern const Diags_Mask LoggerRunMode_level1Mask;
 
DETAILS
See 'level4Mask' for details.
 
config LoggerRunMode_level2Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL2

C synopsis target-domain
extern const Diags_Mask LoggerRunMode_level2Mask;
 
DETAILS
See 'level4Mask' for details.
 
config LoggerRunMode_level3Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL3

C synopsis target-domain
extern const Diags_Mask LoggerRunMode_level3Mask;
 
DETAILS
See 'level4Mask' for details.
 
config LoggerRunMode_level4Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL4

C synopsis target-domain
extern const Diags_Mask LoggerRunMode_level4Mask;
 
DETAILS
If 'filterByLevel' is true, then all LoggerBuf instances will filter incoming events based on their event level.
The LoggerRunMode module allows for specifying a different filter level for every Diags bit. These filtering levels are module wide; LoggerBuf does not support specifying the levels on a per-instance basis.
The setFilterLevel API can be used to change the filtering levels at runtime.
The default filtering levels are assigned using the 'level1Mask' - 'level4Mask' config parameters. These are used to specify, for each of the four event levels, the set of bits which should filter at that level by default.
The default filtering configuration sets the filter level to Diags.LEVEL4 for all logging-related diags bits so that all events are logged by default.
 
config LoggerRunMode_numCores  // module-wide

The number of C6X cores running the same image with an instance in shared memory

C synopsis target-domain
extern const Int LoggerRunMode_numCores;
 
DETAILS
A common use case is to have the same binary image (e.g. .out file) run on multiple cores of multi-core device. This causes a problem if the logger's buffer is in shared memory (e.g. DDR). Since the image is the same for all the cores, each core will attempt to write to the same buffer in the shared memory. To avoid this, either place the logger's buffers in non-shared memory, or set the numCores parameter to the number of cores on the device.
Note: Use the bufSection along with the Program.sectMap to place a logger instance's buffer into specific memory.
Setting numCores to a value greater than 1 signals LoggerRunMode to statically set aside additional memory ((x numCores) to allow each core to have transferBufSize amount of memory.
Warning: Setting this parameter to a value greater than one should only be done when there is a single image used on multiple cores of a multi-core device AND the logger instance's buffer is in shared memory. While functionally it will still work, memory will be wasted if both these conditions are not met.
The default is 1, which means do not reserve any additional memory for the logger.
 
config LoggerRunMode_supportLoggerDisable  // module-wide

Allow LoggerRunMode instances to be enabled/disabled during runtime

C synopsis target-domain
extern const Bool LoggerRunMode_supportLoggerDisable;
 
DETAILS
Setting supportLoggerDisable to true will increase the footprint of LoggerRunMode.
 
LoggerRunMode_idleHook()  // module-wide

Hook function that can be called by SysBios's Idle loop. This function ensures that events are uploaded in a timely manner even if they are logged infrequently

C synopsis target-domain
Void LoggerRunMode_idleHook();
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId LoggerRunMode_Module_id();
// Get this module's unique id
 
Bool LoggerRunMode_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle LoggerRunMode_Module_heap();
// The heap from which this module allocates memory
 
Bool LoggerRunMode_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 LoggerRunMode_Module_getMask();
// Returns the diagnostics mask for this module
 
Void LoggerRunMode_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct LoggerRunMode_Object LoggerRunMode_Object;
// Opaque internal representation of an instance object
 
typedef LoggerRunMode_Object *LoggerRunMode_Handle;
// Client reference to an instance object
 
typedef struct LoggerRunMode_Struct LoggerRunMode_Struct;
// Opaque client structure large enough to hold an instance object
 
LoggerRunMode_Handle LoggerRunMode_handle(LoggerRunMode_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
LoggerRunMode_Struct *LoggerRunMode_struct(LoggerRunMode_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct LoggerRunMode_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    SizeT bufSize;
    // LoggerRunMode instance's buffer size in MAUs (Minimum Addressable Units e.g. Bytes)
    Int16 instanceId;
    // Unique id of the LoggerRunMode instance
    SizeT maxEventSize;
    // The maximum event size (in Maus) that can be written with a single event. Must be less than or equal to bufSize - 64
    IUIATransfer_TransferType transferType;
    // 
} LoggerRunMode_Params;
 
Void LoggerRunMode_Params_init(LoggerRunMode_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
 
config LoggerRunMode_Params.bufSize  // instance

LoggerRunMode instance's buffer size in MAUs (Minimum Addressable Units e.g. Bytes)

C synopsis target-domain
      ...
    SizeT bufSize;
 
DETAILS
NOTE: the buffer size must contain an integer number of 32-bit words (e.g. if a MAU = 1 byte, then the buffer size must be a multiple of 4). The buffer size must also be at least maxEventSize + 64.
 
config LoggerRunMode_Params.instanceId  // instance

Unique id of the LoggerRunMode instance

C synopsis target-domain
      ...
    Int16 instanceId;
 
 
config LoggerRunMode_Params.maxEventSize  // instance

The maximum event size (in Maus) that can be written with a single event. Must be less than or equal to bufSize - 64

C synopsis target-domain
      ...
    SizeT maxEventSize;
 
DETAILS
The writeMemoryRange API checks to see if the event size required to write the block of memory is larger than maxEventSize. If so, it will split the memory range up into a number of smaller blocks and log the blocks using separate events with a common snapshot ID in order to allow the events to be collated and the original memory block to be reconstructed on the host.
 
config LoggerRunMode_Params.transferType  // instance
C synopsis target-domain
      ...
    IUIATransfer_TransferType transferType;
 
Runtime Instance Creation

C synopsis target-domain
LoggerRunMode_Handle LoggerRunMode_create(const LoggerRunMode_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void LoggerRunMode_construct(LoggerRunMode_Struct *structP, const LoggerRunMode_Params *params);
// Initialize a new instance object inside the provided structure
ARGUMENTS
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
Instance Deletion

C synopsis target-domain
Void LoggerRunMode_delete(LoggerRunMode_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void LoggerRunMode_destruct(LoggerRunMode_Struct *structP);
// Finalize the instance object inside the provided structure
 
LoggerRunMode_disable()  // instance

Disable a log

C synopsis target-domain
Bool LoggerRunMode_disable(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Events written to a disabled log are silently discarded.
RETURNS
The function returns the state of the log (TRUE if enabled, FALSE if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.
 
LoggerRunMode_enable()  // instance

Enable a log

C synopsis target-domain
Bool LoggerRunMode_enable(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
RETURNS
The function returns the state of the log (TRUE if enabled, FALSE if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.
 
LoggerRunMode_getBufSize()  // instance

Returns the Log's configured buffer size

C synopsis target-domain
SizeT LoggerRunMode_getBufSize(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
RETURNS
Log's configured buffer size.
 
LoggerRunMode_getContents()  // instance

Fills buffer that is passed in with unread data, up to size bytes in length

C synopsis target-domain
Bool LoggerRunMode_getContents(LoggerRunMode_Handle handle, Ptr hdrBuf, SizeT size, SizeT *cpSize);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
hdrBuf — Ptr to a buffer that is at least <size> bytes in length
size — The max number of bytes to be read into the buffer
cpSize — The number of bytes actually copied
DETAILS
The logger is responsible for ensuring that no partial event records are stored in the buffer. Bytes are in target endianness.
RETURN
returns false if logger has no more records to read
 
LoggerRunMode_getFilterLevel()  // instance

Returns the mask of diags categories currently set to the specified level

C synopsis target-domain
Diags_Mask LoggerRunMode_getFilterLevel(LoggerRunMode_Handle handle, Diags_EventLevel level);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
See 'setFilterLevel' for an explanation of level filtering.
See 'setFilterLevel' for an explanation of level filtering.
 
LoggerRunMode_getInstanceId()  // instance

Returns an ID value that uniquely identifies this instance of the logger

C synopsis target-domain
UInt16 LoggerRunMode_getInstanceId(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Note that a value of 0 is reserved to indicate that the instance ID has not been initialized yet and a unique value needs to be generated.
 
LoggerRunMode_getMaxLength()  // instance
C synopsis target-domain
SizeT LoggerRunMode_getMaxLength(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
 
LoggerRunMode_getTransferType()  // instance
C synopsis target-domain
IUIATransfer_TransferType LoggerRunMode_getTransferType(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
 
LoggerRunMode_isEmpty()  // instance

Returns true if the transfer buffer has no unread data

C synopsis target-domain
Bool LoggerRunMode_isEmpty(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
RETURN
true if no unread data
 
LoggerRunMode_reset()  // instance

Reset a log to empty state and enable it

C synopsis target-domain
Void LoggerRunMode_reset(LoggerRunMode_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
WARNING
This method is not synchronized with other instance methods and, as a result, it must never be called when there is a chance that another instance method is currently in operation or when another method on this instance may preempt this call.
 
LoggerRunMode_setFilterLevel()  // instance

Sets the level of detail that instances will log

C synopsis target-domain
Void LoggerRunMode_setFilterLevel(LoggerRunMode_Handle handle, Diags_Mask mask, Diags_EventLevel filterLevel);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
mask — The diags categories to set the level for
The diags categories to set the level for
filterLevel — The new filtering level for the specified categories
The new filtering level for the specified categories
DETAILS
Events with the specified level or higher will be logged, events below the specified level will be dropped.
Events are filtered first by diags category, then by level. If an event's diags category is disabled in the module's diags mask, then it will be filtered out regardless of level. The event will not even be passed to the logger.
This API allows for setting the filtering level for more than one diags category at a time. The mask parameter can be a single category or multiple categories combined, and the level will be set for all of those categories.
Events with the specified level or higher will be logged, events below the specified level will be dropped.
Events are filtered first by diags category, then by level. If an event's diags category is disabled in the module's diags mask, then it will be filtered out regardless of level. The event will not even be passed to the logger.
This API allows for setting the filtering level for more than one diags category at a time. The mask parameter can be a single category or multiple categories combined, and the level will be set for all of those categories.
 
LoggerRunMode_write0()  // instance

Process a log event with 0 arguments

C synopsis target-domain
Void LoggerRunMode_write0(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Same as write4 except with 0 arguments rather than 4.
SEE
 
LoggerRunMode_write1()  // instance

Process a log event with 1 argument

C synopsis target-domain
Void LoggerRunMode_write1(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Same as write4 except with 1 arguments rather than 4.
SEE
 
LoggerRunMode_write2()  // instance

Process a log event with 2 arguments

C synopsis target-domain
Void LoggerRunMode_write2(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Same as write4 except with 2 arguments rather than 4.
SEE
 
LoggerRunMode_write4()  // instance

Process a log event with 4 arguments

C synopsis target-domain
Void LoggerRunMode_write4(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
evt — event to be logged
mid — module ID of the module which logged the event
a1 — arbitrary argument passed by caller
DETAILS
The evt argument is of type Log.Event, which encodes the Log.EventId, the Diags.Mask, and the Diags.EventLevel of the event. The event ID can be obtained via Types.getEventId(evt), the Diags mask can be obtained via Diags.getMask(evt), and the event level can be obtained via Diags.getLevel(evt).
The modId argument is the module ID of the module that logged the event.
The event information can be used by the logger to handle different events specially. For example, the event ID can be used to compare against other known Log.Events.
      if (Log_getEventId(MY_EVENT) == Log_getEventId(evt)) {
          :
      }
The Diags mask and event level can be used for filtering of events based on event level (see IFilterLogger), or even routing events to separate loggers based on diags category (see, for example, LoggerBuf.statusLogger).
The Diags mask and event level are useful for handling the event, but are generally not recorded by the logger because they are not needed in decoding and displaying the event. A more suitable value to record is a Types.Event, which encodes the event ID and module ID. For example, the Log.EventRec type stores a Types.Event in its record definition. A Types.Event can be created using the Types.makeEvent API given the event ID and module ID.
The event ID value of 0 is used to indicate an event triggered by a call to one of the Log_print[0-6] methods. These methods take a format string rather than a Log_Event argument and, as a result, the event ID encoded in evt is 0 and the parameter a1 is the format string.
Non-zero event IDs can also be used to access the msg string associated with the Log.EventDesc that originally defined the Log event.
      Log_EventId id = Log_getEventId(evt));
      if (id != 0) {
          String msg = Text_ropeText(id);
          System_aprintf(msg, a1, a2, a3, a4);
      }
This works because an event's ID is simply an offset into a table of characters (maintained by the Text module) containing the event's msg string.
The arguments a1, a2, etc. are parameters that are to be interpreted according to the message format string associated with evt.
SEE
 
LoggerRunMode_write8()  // instance

Process a log event with 8 arguments

C synopsis target-domain
Void LoggerRunMode_write8(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
DETAILS
Same as write4 except with 8 arguments rather than 4.
SEE
 
LoggerRunMode_writeMemoryRange()  // instance

Log an event along with values from a range of memory addresses

C synopsis target-domain
Void LoggerRunMode_writeMemoryRange(LoggerRunMode_Handle handle, Log_Event evt, Types_ModuleId mid, UInt32 snapshotId, IArg fileName, IArg LineNum, IArg fmt, IArg startAdrs, UInt32 lengthInMAUs);
 
ARGUMENTS
handle — handle of a previously-created LoggerRunMode instance object
evt — event to be logged
snapshotId — 0 = no other snapshot groups, Use value from LogSnapshot.getSnapshotId() for all snapshots to be grouped.
fileName — __FILE__ result
lineNum — __LINE__ result
fmt — a printf style format string
startAdrs — value for first format conversion character
lengthInMAUs — value for second format conversion character
DETAILS
If the mask in the specified LogSnapshot event has any bit set which is also set in the current module's diagnostics mask, then this call to write will "raise" the given LogSnapshot event.
Note that this API supports null terminated strings, arrays of characters and memory mapped registgers as well as blocks of memory. The LogSnapshot module provides macros that map the appropriate values to the writeMemoryRange API's arguments
SEE
Instance Convertors

C synopsis target-domain
ILoggerSnapshot_Handle LoggerRunMode_Handle_upCast(LoggerRunMode_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
LoggerRunMode_Handle LoggerRunMode_Handle_downCast(ILoggerSnapshot_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IUIATransfer_Handle LoggerRunMode_Handle_upCast2(LoggerRunMode_Handle handle);
// unconditionally move 2 levels up the inheritance hierarchy
 
LoggerRunMode_Handle LoggerRunMode_Handle_downCast2(IUIATransfer_Handle handle);
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
IFilterLogger_Handle LoggerRunMode_Handle_upCast3(LoggerRunMode_Handle handle);
// unconditionally move 3 levels up the inheritance hierarchy
 
LoggerRunMode_Handle LoggerRunMode_Handle_downCast3(IFilterLogger_Handle handle);
// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure
 
ILogger_Handle LoggerRunMode_Handle_upCast4(LoggerRunMode_Handle handle);
// unconditionally move 4 levels up the inheritance hierarchy
 
LoggerRunMode_Handle LoggerRunMode_Handle_downCast4(ILogger_Handle handle);
// conditionally move 4 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int LoggerRunMode_Object_count();
// The number of statically-created instance objects
 
LoggerRunMode_Handle LoggerRunMode_Object_get(LoggerRunMode_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
LoggerRunMode_Handle LoggerRunMode_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
LoggerRunMode_Handle LoggerRunMode_Object_next(LoggerRunMode_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle LoggerRunMode_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *LoggerRunMode_Handle_label(LoggerRunMode_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String LoggerRunMode_Handle_name(LoggerRunMode_Handle handle);
// The name of this instance object
 
Configuration settings sourced in ti/uia/loggers/LoggerRunMode.xdc
var LoggerRunMode = xdc.useModule('ti.uia.loggers.LoggerRunMode');
module-wide constants & types
    values of type LoggerRunMode.TransferType// 
        const LoggerRunMode.TransferType_RELIABLE;
        const LoggerRunMode.TransferType_LOSSY;
 
        const LoggerRunMode.TransportType_JTAG;
        const LoggerRunMode.TransportType_ETHERNET;
 
        obj.instanceId = Int  ...
        obj.priority = Int  ...
 
    var obj = new LoggerRunMode.RecordView// ;
        obj.sequence = Int  ...
        obj.timestampRaw = Long  ...
        obj.modName = String  ...
        obj.text = String  ...
        obj.eventId = Int  ...
        obj.eventName = String  ...
        obj.arg0 = IArg  ...
        obj.arg1 = IArg  ...
        obj.arg2 = IArg  ...
        obj.arg3 = IArg  ...
        obj.arg4 = IArg  ...
        obj.arg5 = IArg  ...
        obj.arg6 = IArg  ...
        obj.arg7 = IArg  ...
 
        obj.instanceId = Int  ...
module-wide config parameters
 
module-wide functions
    LoggerRunMode.getNumInstances// () returns Int
per-instance config parameters
    var params = new LoggerRunMode.Params// Instance config-params object;
        params.instanceId// Unique id of the LoggerRunMode instance = Int16 1;
        params.ptrToQueueDescriptorMeta//  = Ptr null;
per-instance creation
    var inst = LoggerRunMode.create// Create an instance-object(params);
 
 
enum LoggerRunMode.TransferType
Configuration settings
values of type LoggerRunMode.TransferType
    const LoggerRunMode.TransferType_RELIABLE;
    const LoggerRunMode.TransferType_LOSSY;
 
C SYNOPSIS
 
enum LoggerRunMode.TransportType

This enum is used by the instrumentation host to determine what the transport is

Configuration settings
values of type LoggerRunMode.TransportType
    const LoggerRunMode.TransportType_JTAG;
    const LoggerRunMode.TransportType_ETHERNET;
 
C SYNOPSIS
 
metaonly struct LoggerRunMode.MetaData

This data is added to the RTA MetaData file to support stop mode RTA

Configuration settings
var obj = new LoggerRunMode.MetaData;
 
    obj.instanceId = Int  ...
    obj.priority = Int  ...
 
 
metaonly struct LoggerRunMode.RecordView
Configuration settings
var obj = new LoggerRunMode.RecordView;
 
    obj.sequence = Int  ...
    obj.timestampRaw = Long  ...
    obj.modName = String  ...
    obj.text = String  ...
    obj.eventId = Int  ...
    obj.eventName = String  ...
    obj.arg0 = IArg  ...
    obj.arg1 = IArg  ...
    obj.arg2 = IArg  ...
    obj.arg3 = IArg  ...
    obj.arg4 = IArg  ...
    obj.arg5 = IArg  ...
    obj.arg6 = IArg  ...
    obj.arg7 = IArg  ...
 
 
metaonly struct LoggerRunMode.RtaData

Data added to the RTA MetaData file to support System Analyzer

Configuration settings
var obj = new LoggerRunMode.RtaData;
 
    obj.instanceId = Int  ...
 
 
config LoggerRunMode.filterByLevel  // module-wide

Support filtering of events by event level

Configuration settings
LoggerRunMode.filterByLevel = Bool false;
 
DETAILS
To improve logging performance, this feature can be disabled by setting filterByLevel to false.
See 'setFilterLevel' for an explanation of level filtering.
C SYNOPSIS
 
config LoggerRunMode.isTimestampEnabled  // module-wide

Enable or disable logging the 64-bit local CPU timestamp at the start of each event

Configuration settings
LoggerRunMode.isTimestampEnabled = Bool true;
 
DETAILS
Having a timestamp allows an instrumentation host (e.g. System Analyzer) to display events with the correct system time.
C SYNOPSIS
 
config LoggerRunMode.level1Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL1

Configuration settings
LoggerRunMode.level1Mask = Bits16 0;
 
DETAILS
See 'level4Mask' for details.
C SYNOPSIS
 
config LoggerRunMode.level2Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL2

Configuration settings
LoggerRunMode.level2Mask = Bits16 0;
 
DETAILS
See 'level4Mask' for details.
C SYNOPSIS
 
config LoggerRunMode.level3Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL3

Configuration settings
LoggerRunMode.level3Mask = Bits16 0;
 
DETAILS
See 'level4Mask' for details.
C SYNOPSIS
 
config LoggerRunMode.level4Mask  // module-wide

Mask of diags categories whose initial filtering level is Diags.LEVEL4

Configuration settings
LoggerRunMode.level4Mask = Bits16 Diags.ALL_LOGGING;
 
DETAILS
If 'filterByLevel' is true, then all LoggerBuf instances will filter incoming events based on their event level.
The LoggerRunMode module allows for specifying a different filter level for every Diags bit. These filtering levels are module wide; LoggerBuf does not support specifying the levels on a per-instance basis.
The setFilterLevel API can be used to change the filtering levels at runtime.
The default filtering levels are assigned using the 'level1Mask' - 'level4Mask' config parameters. These are used to specify, for each of the four event levels, the set of bits which should filter at that level by default.
The default filtering configuration sets the filter level to Diags.LEVEL4 for all logging-related diags bits so that all events are logged by default.
C SYNOPSIS
 
config LoggerRunMode.numCores  // module-wide

The number of C6X cores running the same image with an instance in shared memory

Configuration settings
LoggerRunMode.numCores = Int 1;
 
DETAILS
A common use case is to have the same binary image (e.g. .out file) run on multiple cores of multi-core device. This causes a problem if the logger's buffer is in shared memory (e.g. DDR). Since the image is the same for all the cores, each core will attempt to write to the same buffer in the shared memory. To avoid this, either place the logger's buffers in non-shared memory, or set the numCores parameter to the number of cores on the device.
Note: Use the bufSection along with the Program.sectMap to place a logger instance's buffer into specific memory.
Setting numCores to a value greater than 1 signals LoggerRunMode to statically set aside additional memory ((x numCores) to allow each core to have transferBufSize amount of memory.
Warning: Setting this parameter to a value greater than one should only be done when there is a single image used on multiple cores of a multi-core device AND the logger instance's buffer is in shared memory. While functionally it will still work, memory will be wasted if both these conditions are not met.
The default is 1, which means do not reserve any additional memory for the logger.
C SYNOPSIS
 
config LoggerRunMode.supportLoggerDisable  // module-wide

Allow LoggerRunMode instances to be enabled/disabled during runtime

Configuration settings
LoggerRunMode.supportLoggerDisable = Bool false;
 
DETAILS
Setting supportLoggerDisable to true will increase the footprint of LoggerRunMode.
C SYNOPSIS
 
metaonly config LoggerRunMode.cacheLineSizeInMAUs  // module-wide
Configuration settings
LoggerRunMode.cacheLineSizeInMAUs = Int 128;
 
 
metaonly config LoggerRunMode.common$  // module-wide

Common module configuration parameters

Configuration settings
LoggerRunMode.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.
 
metaonly config LoggerRunMode.cpuId  // module-wide

CPU ID to put in the packet header as the endpoint ID

Configuration settings
LoggerRunMode.cpuId = Int 0;
 
DETAILS
Not required for C6X or C7X devices (uses DNUM).
 
metaonly config LoggerRunMode.enableAutoConfigOfIdleHook  // module-wide

If true, the ti.sysbios.knl.Idle module will automatically be configured to call LoggerRunMode\s idleHook function. This function ensures that events are uploaded in a timely manner even if they are logged infrequently. Set to false if you do not wish to use the ti.sysbios.nk.Idle module

Configuration settings
LoggerRunMode.enableAutoConfigOfIdleHook = Bool true;
 
 
metaonly config LoggerRunMode.transportType  // module-wide

Transport used to send the records to an instrumentation host

Configuration settings
 
DETAILS
This parameter is used to specify the transport that will be used to send the buffer to an instrumentation host (e.g. System Analyzer in CCS).
This parameter is placed into the generated UIA XML file. The instrumentation host can use the XML file to help it auto-detect as much as possible and act accordingly.
 
metaonly LoggerRunMode.getLoggerInstanceId()  // module-wide

returns the id of this logger instance

Configuration settings
LoggerRunMode.getLoggerInstanceId(Any inst) returns Any
 
 
metaonly LoggerRunMode.getMetaArgs()  // module-wide

Returns any meta data needed to support RTA

Configuration settings
LoggerRunMode.getMetaArgs(Any inst, Any instNum) returns Any
 
DETAILS
This meta data should be returned in the form of a structure which can be converted into XML. This data is added to the RTA XML file during the application's configuration, and can be accessed later through the xdc.rta.MetaData module.
The MetaData is returned per instance of the ILogger module. The instance object is passed to the function as the first argument.
The second argument is the index of the instance in the list of the ILogger's static instances.
 
metaonly LoggerRunMode.getNumInstances()  // module-wide
Configuration settings
LoggerRunMode.getNumInstances() returns Int
 
 
metaonly LoggerRunMode.getPtrToQueueDescriptorMeta()  // module-wide

Each logger instance has a unique queue descriptor address that is stored in the Event Record header to identify itself to the host. This metaonly configuration parameter allows the UIA Metadata to determine what the address is for each statically created logger instance in order to emit XML code to allow the host to look up information about the logger instance (such as its name) based on the queue descriptor address that is stored in the event record header

Configuration settings
LoggerRunMode.getPtrToQueueDescriptorMeta(Any inst) returns Any
 
DETAILS
The pointer is returned per instance of the logger module. The instance object is passed to the function as the first argument.
 
metaonly LoggerRunMode.setPtrToQueueDescriptorMeta()  // module-wide

Sets the queue descriptor address in the logger's object instance data

Configuration settings
LoggerRunMode.setPtrToQueueDescriptorMeta(Any inst, Any queueDescriptorAdrs) returns Any
 
Instance Config Parameters

Configuration settings
var params = new LoggerRunMode.Params;
// Instance config-params object
    params.bufSection = String null;
    // Section name for the buffer managed by the static instance
    params.bufSize = SizeT 1024;
    // LoggerRunMode instance's buffer size in MAUs (Minimum Addressable Units e.g. Bytes)
    params.instanceId = Int16 1;
    // Unique id of the LoggerRunMode instance
    params.maxEventSize = SizeT 512;
    // The maximum event size (in Maus) that can be written with a single event. Must be less than or equal to bufSize - 64
    params.ptrToQueueDescriptorMeta = Ptr null;
    // 
    // 
 
config LoggerRunMode.Params.bufSize  // instance

LoggerRunMode instance's buffer size in MAUs (Minimum Addressable Units e.g. Bytes)

Configuration settings
var params = new LoggerRunMode.Params;
  ...
params.bufSize = SizeT 1024;
 
DETAILS
NOTE: the buffer size must contain an integer number of 32-bit words (e.g. if a MAU = 1 byte, then the buffer size must be a multiple of 4). The buffer size must also be at least maxEventSize + 64.
C SYNOPSIS
 
config LoggerRunMode.Params.instanceId  // instance

Unique id of the LoggerRunMode instance

Configuration settings
var params = new LoggerRunMode.Params;
  ...
params.instanceId = Int16 1;
 
C SYNOPSIS
 
config LoggerRunMode.Params.maxEventSize  // instance

The maximum event size (in Maus) that can be written with a single event. Must be less than or equal to bufSize - 64

Configuration settings
var params = new LoggerRunMode.Params;
  ...
params.maxEventSize = SizeT 512;
 
DETAILS
The writeMemoryRange API checks to see if the event size required to write the block of memory is larger than maxEventSize. If so, it will split the memory range up into a number of smaller blocks and log the blocks using separate events with a common snapshot ID in order to allow the events to be collated and the original memory block to be reconstructed on the host.
C SYNOPSIS
 
config LoggerRunMode.Params.transferType  // instance
Configuration settings
var params = new LoggerRunMode.Params;
  ...
 
C SYNOPSIS
 
metaonly config LoggerRunMode.Params.bufSection  // instance

Section name for the buffer managed by the static instance

Configuration settings
var params = new LoggerRunMode.Params;
  ...
params.bufSection = String null;
 
DETAILS
The default section is the 'dataMemory' in the platform.
 
metaonly config LoggerRunMode.Params.ptrToQueueDescriptorMeta  // instance
Configuration settings
var params = new LoggerRunMode.Params;
  ...
params.ptrToQueueDescriptorMeta = Ptr null;
 
Static Instance Creation

Configuration settings
var params = new LoggerRunMode.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = LoggerRunMode.create(params);
// Create an instance-object
ARGUMENTS
params — per-instance config params, or NULL to select default values (target-domain only)
eb — active error-handling block, or NULL to select default policy (target-domain only)
generated on Tue, 14 Feb 2017 00:15:13 GMT