module ti.uia.loggers.LoggerStopMode

General purpose logger enabling applications to log data that can be read by an instrumentation host over JTAG, when the target is halted

C synopsis
Individual elements
DETAILS
EXAMPLES
Configuration settings
Individual elements

Each LoggerStopMode 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 LoggerStopMode instance that you want the event logged to. [ more ... ]

C synopsis target-domain sourced in ti/uia/loggers/LoggerStopMode.xdc

#include <ti/uia/loggers/LoggerStopMode.h>

Functions
Void	LoggerStopMode_construct// Initialize a new instance object inside the provided structure(LoggerStopMode_Struct structP, const LoggerStopMode_Params params);
LoggerStopMode_Handle	LoggerStopMode_create// Allocate and initialize a new instance object and return its handle(const LoggerStopMode_Params params, Error_Block eb);
Void	LoggerStopMode_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(LoggerStopMode_Handle *handleP);
Void	LoggerStopMode_destruct// Finalize the instance object inside the provided structure(LoggerStopMode_Struct *structP);
Void	LoggerStopMode_flush// Reset the logger's write pointer back to the beginning of the buffer(LoggerStopMode_Handle handle);
SizeT	LoggerStopMode_getBufSize// Returns the Log's configured buffer size(LoggerStopMode_Handle handle);
Void	LoggerStopMode_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(LoggerStopMode_Params *params);
Functions common to all ILogger modules
Bool	LoggerStopMode_disable// Disable a log(LoggerStopMode_Handle handle);
Bool	LoggerStopMode_enable// Enable a log(LoggerStopMode_Handle handle);
Void	LoggerStopMode_write0// Process a log event with 0 arguments(LoggerStopMode_Handle handle, Log_Event evt, Types_ModuleId mid);
Void	LoggerStopMode_write1// Process a log event with 1 argument(LoggerStopMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
Void	LoggerStopMode_write2// Process a log event with 2 arguments(LoggerStopMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
Void	LoggerStopMode_write4// Process a log event with 4 arguments(LoggerStopMode_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
Void	LoggerStopMode_write8// Process a log event with 8 arguments(LoggerStopMode_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	LoggerStopMode_getContents// Fills buffer that is passed in with unread data, up to size bytes in length(LoggerStopMode_Handle handle, Ptr hdrBuf, SizeT size, SizeT *cpSize);
UInt16	LoggerStopMode_getInstanceId// Returns an ID value that uniquely identifies this instance of the logger(LoggerStopMode_Handle handle);
SizeT	LoggerStopMode_getMaxLength// (LoggerStopMode_Handle handle);
IUIATransfer_TransferType	LoggerStopMode_getTransferType// (LoggerStopMode_Handle handle);
Bool	LoggerStopMode_isEmpty// Returns true if the transfer buffer has no unread data(LoggerStopMode_Handle handle);
Void	LoggerStopMode_reset// Reset a log to empty state and enable it(LoggerStopMode_Handle handle);
Functions common to all IFilterLogger modules
Diags_Mask	LoggerStopMode_getFilterLevel// Returns the mask of diags categories currently set to the specified level(LoggerStopMode_Handle handle, Diags_EventLevel level);
Void	LoggerStopMode_setFilterLevel// Sets the level of detail that instances will log(LoggerStopMode_Handle handle, Diags_Mask mask, Diags_EventLevel filterLevel);
Functions common to all ILoggerSnapshot modules
Void	LoggerStopMode_writeMemoryRange// Log an event along with values from a range of memory addresses(LoggerStopMode_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
	LoggerStopMode_handle// Convert this instance structure pointer into an instance handle, LoggerStopMode_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, LoggerStopMode_Handle_downCast2// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure, LoggerStopMode_Handle_downCast3// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure, LoggerStopMode_Handle_downCast4// conditionally move 4 levels down the inheritance hierarchy; NULL upon failure, LoggerStopMode_Handle_label// The label associated with this instance object, LoggerStopMode_Handle_name// The name of this instance object, LoggerStopMode_Handle_upCast// unconditionally move one level up the inheritance hierarchy, LoggerStopMode_Handle_upCast2// unconditionally move 2 levels up the inheritance hierarchy, LoggerStopMode_Handle_upCast3// unconditionally move 3 levels up the inheritance hierarchy, LoggerStopMode_Handle_upCast4// unconditionally move 4 levels up the inheritance hierarchy, LoggerStopMode_Object_count// The number of statically-created instance objects, LoggerStopMode_Object_first// The handle of the first dynamically-created instance object, or NULL, LoggerStopMode_Object_get// The handle of the i-th statically-created instance object (array == NULL), LoggerStopMode_Object_heap// The heap used to allocate dynamically-created instance objects, LoggerStopMode_Object_next// The handle of the next dynamically-created instance object, or NULL, LoggerStopMode_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	LoggerStopMode_Module_getMask// Returns the diagnostics mask for this module, LoggerStopMode_Module_hasMask// Test whether this module has a diagnostics mask, LoggerStopMode_Module_heap// The heap from which this module allocates memory, LoggerStopMode_Module_id// Get this module's unique id, LoggerStopMode_Module_setMask// Set the diagnostics mask for this module, LoggerStopMode_Module_startupDone// Test if this module has completed startup
Typedefs
typedef LoggerStopMode_Object *	LoggerStopMode_Handle// Client reference to an instance object;
typedef struct	LoggerStopMode_Object// Opaque internal representation of an instance object LoggerStopMode_Object;
typedef struct	LoggerStopMode_Params// Instance config-params structure ...
typedef struct	LoggerStopMode_Struct// Opaque client structure large enough to hold an instance object LoggerStopMode_Struct;
typedef enum	LoggerStopMode_TransferType// ...
Constants
extern const Bool	LoggerStopMode_filterByLevel// Support filtering of events by event level;
extern const Bool	LoggerStopMode_isTimestampEnabled// Enable or disable logging the 64-bit local CPU timestamp at the start of each event;
extern const Diags_Mask	LoggerStopMode_level1Mask// Mask of diags categories whose initial filtering level is Diags.LEVEL1;
extern const Diags_Mask	LoggerStopMode_level2Mask// Mask of diags categories whose initial filtering level is Diags.LEVEL2;
extern const Diags_Mask	LoggerStopMode_level3Mask// Mask of diags categories whose initial filtering level is Diags.LEVEL3;
extern const Diags_Mask	LoggerStopMode_level4Mask// Mask of diags categories whose initial filtering level is Diags.LEVEL4;
extern const Int	LoggerStopMode_numCores// Number of C6X cores running the same image with an instance in shared memory;
extern const Bool	LoggerStopMode_supportLoggerDisable// Allow LoggerStopMode instances to be enabled/disabled during runtime;

DETAILS

The size of the buffer includes a UIAPacket_Hdr. LoggerStopMode treats the buffer as a UInt32 array, so the application must guarantee that buffers are aligned on word addresses. Alignment on cache line boundaries is recommended for best performance.

When the buffer is filled, LoggerStopMode will update the QueueDescriptor data structure (which provides the interface needed by the host's JTAG transport handler to read the logged event data) and wrap around the buffer's write pointer.

LoggerStopMode 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. Set LoggingSetup.loggerType to LoggingSetup.LoggerType_STOPMODE to specify that the Logger instances are based on LoggerStopMode.

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 LoggerStopMode = xdc.useModule('ti.uia.loggers.LoggerStopMode');

  LoggerStopMode.isTimestampEnabled = true;

  var loggerParams = new LoggerStopMode.Params();
  Program.global.logger0 = LoggerStopMode.create(loggerParams);
  Defaults.common$.logger = Program.global.logger0;

  Program.global.logger1 = LoggerStopMode.create(loggerParams);

The following XDC configuration statements show how to use LoggingSetup with LoggerStopMode. Note that the second line is unnecessary, since LoggerStopMode is the default logger for LoggingSetup.

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

enum LoggerStopMode_TransferType