module ti.uia.events.UIAHWICtx

index URL

UIA Hardware Interrupt Context Instrumentation

*       C synopsis

*  Individual elements

*       DETAILS

*       EXAMPLES

The UIAHWICtx module defines context change events and methods that allow tooling to identify hardware interrupt context switches and to enable HWI-aware filtering, trace and analysis. [ more ... ]

C synopsis

target-domain

sourced in ti/uia/events/UIAHWICtx.h

#include <ti/uia/events/UIAHWICtx.h>

Typedefs

typedef Bool 

Constants

extern const Bits16 

extern const Log_Event 

extern const Log_Event 

extern const Bits16 

 

DETAILS

The UIAHWICtx module defines context change events and methods that allow tooling to identify hardware interrupt context switches and to enable HWI-aware filtering, trace and analysis.

Note: in order to reduce overhead, UIAHWICtx does not support context-aware filtering

EXAMPLES

Example 1: The following example shows how to turn on and off logging of ANALYSIS events from the application source code. See the Diags_setMask() function for details on specifying the control string.

  // turn on logging of ANALYSIS events in the module
  Diags_setMask("my.pkg.Mod+Z");
 
  // turn off logging of ANALYSIS events in the module
  Diags_setMask("my.pkg.Mod-Z");

 

typedef UIAHWICtx_IsLoggingEnabledFxn

index URL

C synopsis

target-domain

typedef Bool (*UIAHWICtx_IsLoggingEnabledFxn)(Int);

 

 

config UIAHWICtx_ENABLEMASK  // module-wide

index URL

Ctx Filter Enable Mask

C synopsis

target-domain

extern const Bits16 UIAHWICtx_ENABLEMASK;

 

DETAILS

configures which bit of the ti_uia_runtime_CtxFilter_gFlags is assigned to control context aware filtering for frame context changes. Must be configured with a value that is 2**SYNCID.

 

config UIAHWICtx_SYNCID  // module-wide

index URL

Trace Synchronization ID

C synopsis

target-domain

extern const Bits16 UIAHWICtx_SYNCID;

 

DETAILS

configures the value to be written into the 4 bit context change type field used by the UIASync trace synchronization

 

config UIAHWICtx_isLoggingEnabledFxn  // module-wide

index URL

C synopsis

target-domain

extern const IUIACtx_IsLoggingEnabledFxn UIAHWICtx_isLoggingEnabledFxn;

 

 

config UIAHWICtx_start  // module-wide

index URL

Hardware Interrupt start event

C synopsis

target-domain

extern const Log_Event UIAHWICtx_start;

 

VALUES

fmt — a constant string that describes the HWI and provides a format specifier for the HWI handle

handle — an integer which uniquely identifies the HWI

DETAILS

Used to log the start of a hardware interrupt service routine

EXAMPLE

The following C code shows how to log a Context Change event that identifies the start of a HWI. It implements a BIOS hook function. Alternatively, the LogCtxChg_hwiStart API can be called directly from the HWI service routine.

  #include <ti/uia/runtime/LogCtxChg.h>
   ...
  Void hwiBeginHook(Hwi_Handle handle) {
    LogCtxChg_hwiStart("Hwi_Handle:0x%x",handle);
  }

This event has an associated format string (%$S) which is recursively formatted with any addition arguments. The following text is an example of what will be displayed for the event:

  "HWI start: Hwi_Handle:0x80001200"
 

 

config UIAHWICtx_stop  // module-wide

index URL

Hardware Interrupt exit event

C synopsis

target-domain

extern const Log_Event UIAHWICtx_stop;

 

VALUES

fmt — a constant string that describes the HWI and provides a format specifier for the HWI handle

handle — an integer which uniquely identifies the HWI

DETAILS

Used to log the end of a hardware interrupt service routine

EXAMPLE

The following C code shows how to log a Context Change event that identifies the end of a HWI. It implements a BIOS hook function. Alternatively, the LogCtxChg_hwiStop API can be called directly from the HWI service routine.

  #include <ti/uia/runtime/LogCtxChg.h>
   ...
  Void hwiEndHook(Hwi_Handle handle) {
    LogCtxChg_hwiStop("Hwi_Handle:0x%x",handle);
  }

This event has an associated format string (%$S) which is recursively formatted with any addition arguments. The following text is an example of what will be displayed for the event:

  "HWI stop: Hwi_Handle:0x80001200"
 

generated on Wed, 14 Mar 2012 16:46:04 GMT