module ti.uia.sysbios.LoggingSetup

metaonly module ti.uia.sysbios.LoggingSetup

Module to aid in configuring TI-RTOS logging using UIA and System Analyzer

DETAILS
EXAMPLE
Configuration settings
Individual elements

The LoggingSetup module automates the process of configuring an application to use UIA events, and configures TI-RTOS modules to capture user-specified information such as CPU Load, Task Load and Task Execution so that it can be displayed by System Analyzer. It also automates the creation of infrastructure modules such as loggers, the ServiceManager and RTA modules to enable the capture and upload of the events over a user-specified transport. Both JTAG and Non-JTAG transports are supported. [ more ... ]

Configuration settings sourced in ti/uia/sysbios/LoggingSetup.xdc

var LoggingSetup = xdc.useModule('ti.uia.sysbios.LoggingSetup');

module-wide constants & types

values of type LoggingSetup.LoggerType// Enum of the type of loggers that can be used

const LoggingSetup.LoggerType_MIN// LoggerMin - Minimal footprint logger (JTAG only);

const LoggingSetup.LoggerType_STOPMODE// LoggerStopMode (JTAG only);

const LoggingSetup.LoggerType_JTAGRUNMODE// LoggerRunMode JTAG (c6x only);

const LoggingSetup.LoggerType_RUNMODE// LoggerRunMode ETHERNET upload;

const LoggingSetup.LoggerType_IDLE// LoggerIdle - Upload in Idle loop;

const LoggingSetup.LoggerType_STREAMER2// LoggerStreamer2 - Application manages logger buffers;

values of type LoggingSetup.TimestampSize//

const LoggingSetup.TimestampSize_AUTO// Use the logger's default timestamp size;

const LoggingSetup.TimestampSize_NONE// No timestamps logged with events;

const LoggingSetup.TimestampSize_32b// 32-bit timestamps;

const LoggingSetup.TimestampSize_64b// 64-bit timestamps;

module-wide config parameters

LoggingSetup.benchmarkLogging// Enable logging of benchmark events = Bool false;

LoggingSetup.countingAndGraphingLogging// Enable logging of counting and graphing events = Bool false;

LoggingSetup.cpuId// CPU ID to put in the packet header as the endpoint ID = Int 0;

LoggingSetup.enableContextAwareFunctionProfiler// Enable System Analyzer's Context Aware Function Profiler = Bool false;

LoggingSetup.enableTaskProfiler// Enable System Analyzer's Task Profiler = Bool false;

LoggingSetup.loadHwiLogging// Enable Hardware Interrupt (Hwi) event logging = Bool false;

LoggingSetup.loadLogger// User-created logger used for the Load module Log events = ILogger.Handle null;

LoggingSetup.loadLoggerSize// Size (in MAUs) of the packet used to upload the Load module Log events = SizeT 512;

LoggingSetup.loadLogging// Enable CPU load event logging = Bool true;

LoggingSetup.loadLoggingRuntimeControl// Specify whether load logging can be enabled / disabled at runtime = Bool false;

LoggingSetup.loadSwiLogging// Enable Software Interrupt (Swi) event logging = Bool false;

LoggingSetup.loadTaskLogging// Enable Task load logging = Bool false;

LoggingSetup.loggerType// Configures the type of logger to use = LoggingSetup.LoggerType LoggingSetup.LoggerType_STOPMODE;

LoggingSetup.mainLogger// Logger used for application Log events = ILogger.Handle null;

LoggingSetup.mainLoggerSize// Size (in MAUs) of packet used for application Log events = SizeT 1024;

LoggingSetup.mainLogging// Enable logging of application code = Bool true;

LoggingSetup.mainLoggingRuntimeControl// Specify whether application logging can be enabled / disabled at runtime = Bool true;

LoggingSetup.maxEventSize// For Snapshot events with loggers that support the writeMemoryRange API, this specifies the maximum event size (in Maus) that can be written with a single event. Must be less than or equal to the logger's buffer size - 64 = SizeT 128;

LoggingSetup.memorySectionName// Memory section name for the buffer managed by the static instance (default is null) = String null;

LoggingSetup.multicoreEventCorrelation// Set to true for multi-core applications = Bool false;

LoggingSetup.numCores// Number of cores running the same image with an instance in shared memory = Int 1;

LoggingSetup.profileLogging// Enable logging of function profiling events = Bool false;

LoggingSetup.snapshotLogging// Enable logging of snapshot events = Bool false;

LoggingSetup.syncLoggerSize// Size (in MAUs) of the logger used for the LogSync modules' sync point events = SizeT LogSync.defaultSyncLoggerSize;

LoggingSetup.sysbiosHwiLogging// Enable the SYSBIOS Hwi and Clock modules' event logging = Bool false;

LoggingSetup.sysbiosHwiLoggingRuntimeControl// Specify whether Hwi and Clock logging can be enabled / disabled at runtime = Bool false;

LoggingSetup.sysbiosLogger// Logger used for SYSBIOS modules' Log events = ILogger.Handle null;

LoggingSetup.sysbiosLoggerSize// Size (in MAUs) of the packet used for the TI-RTOS modules' Log events = SizeT 1024;

LoggingSetup.sysbiosSemaphoreLogging// Enable the SYSBIOS Semaphore module's event logging = Bool false;

LoggingSetup.sysbiosSemaphoreLoggingRuntimeControl// Specify whether Semaphore logging can be enabled / disabled at runtime = Bool false;

LoggingSetup.sysbiosSwiLogging// Enable SYSBIOS Swi module's event logging = Bool false;

LoggingSetup.sysbiosSwiLoggingRuntimeControl// Specify whether Swi logging can be enabled / disabled at runtime = Bool false;

LoggingSetup.sysbiosTaskLogging// Enable the SYSBIOS Task module's event logging = Bool true;

LoggingSetup.sysbiosTaskLoggingRuntimeControl// Specify whether Task logging can be enabled / disabled at runtime = Bool true;

LoggingSetup.timestampSize// Size of the timestamps logged with the events. Set to TimestampSize_NONE to disable timestamps = LoggingSetup.TimestampSize LoggingSetup.TimestampSize_AUTO;

DETAILS

The following configuration script demonstrates the use of the LoggingSetup module in the XDC configuration file for the application:

EXAMPLE

Example 1: Configuring an application to use the default settings provided by LoggingSetup. The following default settings are automatically applied:

Logging UIA events from user-provided C code. User provided C code is treated as part of the xdc.runtime.Main module. A circular buffer of size mainLoggerSize Bytes is enabled by default to support this.
Event logging is enabled for the TI-RTOS Load and Task modules in order to allow System Analyzer to display CPU Load, and Task Execution information. Logging of SWI and HWI events is disabled by default. In order to optimize event capture and minimize event loss, three loggers are created: one to store events from the TI-RTOS Load module another to store events from other TI-RTOS modules, and the third to store user Log events.
The events will be logged to LoggerStopMode loggers, and will be uploaded over JTAG when the target halts.

  // the Log module provides logging APIs for use by the user's software
  var Log = xdc.useModule('xdc.runtime.Log');
  // the LoggingSetup module's default settings configure much of the UIA infrastructure.
  var LoggingSetup = xdc.useModule('ti.uia.sysbios.LoggingSetup');

Example 2: Use all the default settings of LoggingSetup, except use the minimal footprint logger, LoggerMin. The following settings will be applied:

Logging UIA events from user-provided C code.
Event logging is enabled for the TI-RTOS Load and Task modules, and disabled for SWI and HWI.
The events will be logged via LoggerMin, and will be uploaded over JTAG when the target halts.
All events will be logged into one buffer whose default sise is ti.uia.loggers.LoggerMin.bufSize

enum LoggingSetup.LoggerType

		mainLoggingRuntimeControl
		true	false
mainLogging	true	RUNTIME_ON	ALWAYS_ON
mainLogging	false	RUNTIME_OFF	ALWAYS_OFF

Diags Mask Settings for xdc.runtime.Main