module ti.uia.loggers.LoggerMin

This general purpose logger is useful in situations where a very small memory overhead is required

C synopsis
Individual elements
DETAILS
EXAMPLES
Configuration settings
Individual elements

The logger stores all events in a single buffer with a compact UIAPacket event packet structure that allows them to be sent directly to System Analyzer via JTAG. [ more ... ]

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

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

Functions
Void	LoggerMin_construct// Initialize a new instance object inside the provided structure(LoggerMin_Struct structP, const LoggerMin_Params params);
LoggerMin_Handle	LoggerMin_create// Allocate and initialize a new instance object and return its handle(const LoggerMin_Params params, Error_Block eb);
Void	LoggerMin_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(LoggerMin_Handle *handleP);
Void	LoggerMin_destruct// Finalize the instance object inside the provided structure(LoggerMin_Struct *structP);
Void	LoggerMin_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(LoggerMin_Params *params);
Functions common to all ILogger modules
Bool	LoggerMin_disable// Disable a log(LoggerMin_Handle handle);
Bool	LoggerMin_enable// Enable a log(LoggerMin_Handle handle);
Void	LoggerMin_write0// Process a log event with 0 arguments(LoggerMin_Handle handle, Log_Event evt, Types_ModuleId mid);
Void	LoggerMin_write1// Process a log event with 1 argument(LoggerMin_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
Void	LoggerMin_write2// Process a log event with 2 arguments(LoggerMin_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
Void	LoggerMin_write4// Process a log event with 4 arguments(LoggerMin_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
Void	LoggerMin_write8// Process a log event with 8 arguments(LoggerMin_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 target instances
	LoggerMin_handle// Convert this instance structure pointer into an instance handle, LoggerMin_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, LoggerMin_Handle_label// The label associated with this instance object, LoggerMin_Handle_name// The name of this instance object, LoggerMin_Handle_upCast// unconditionally move one level up the inheritance hierarchy, LoggerMin_Object_count// The number of statically-created instance objects, LoggerMin_Object_first// The handle of the first dynamically-created instance object, or NULL, LoggerMin_Object_get// The handle of the i-th statically-created instance object (array == NULL), LoggerMin_Object_heap// The heap used to allocate dynamically-created instance objects, LoggerMin_Object_next// The handle of the next dynamically-created instance object, or NULL, LoggerMin_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	LoggerMin_Module_getMask// Returns the diagnostics mask for this module, LoggerMin_Module_hasMask// Test whether this module has a diagnostics mask, LoggerMin_Module_heap// The heap from which this module allocates memory, LoggerMin_Module_id// Get this module's unique id, LoggerMin_Module_setMask// Set the diagnostics mask for this module, LoggerMin_Module_startupDone// Test if this module has completed startup
Typedefs
typedef LoggerMin_Object *	LoggerMin_Handle// Client reference to an instance object;
typedef struct	LoggerMin_Object// Opaque internal representation of an instance object LoggerMin_Object;
typedef struct	LoggerMin_Params// Instance config-params structure ...
typedef struct	LoggerMin_Struct// Opaque client structure large enough to hold an instance object LoggerMin_Struct;
typedef enum	LoggerMin_TimestampSize// Enum of size of timestamps to log with events ...
Constants
extern const SizeT	LoggerMin_bufSize// LoggerMin buffer size in MAUs (Minimum Addressable Units e.g. Bytes);
extern const Bool	LoggerMin_supportLoggerDisable// Allow Logger instances to be enabled/disabled during runtime;
extern const LoggerMin_TimestampSize	LoggerMin_timestampSize// Configure the size of the timestamp to use. For minimum event footprint, configure as TimestampSize_32b (default);

DETAILS

The logger stores all events in a single buffer with a compact UIAPacket event packet structure that allows them to be sent directly to System Analyzer via JTAG.

LoggerMin 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. Set LoggingSetup.loggerType to LoggingSetup.LoggerType_MIN to specify that the Logger is based on LoggerMin.

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

  LoggerMin.bufSize = 256;
  LoggerMin.timestampSize = LoggerMin.TimestampSize_32b;
  Defaults.common$.logger = LoggerMin.create();

The following XDC configuration statements show how to use LoggingSetup with LoggerMin.

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

enum LoggerMin_TimestampSize