metaonly module ti.bios.log.support.LogTrack

LogTrack module

The LogTrack module is used for tracking values which include CPU load, user defined values, and dynamic TSK creation. The LogTrack module "tracks," or prints out information about these values to the two special BIOS logs "ti_bios_log_track" and "ti_bios_log_create". [ more ... ]
XDCspec summary sourced in ti/bios/log/support/LogTrack.xdc
metaonly module LogTrack {  ...
XDCscript usage meta-domain
XDCspec declarations sourced in ti/bios/log/support/LogTrack.xdc
DETAILS
The LogTrack module is used for tracking values which include CPU load, user defined values, and dynamic TSK creation. The LogTrack module "tracks," or prints out information about these values to the two special BIOS logs "ti_bios_log_track" and "ti_bios_log_create".
To use the LogTrack module, import the configuration code from one of the following two files, depending on the build type (Tconf or RTSC) being used for the user's program:
a. ti/bios/log/support/LogTrack.tci
If the user app is built using Tconf, then include this file into the build by adding the following statement into the *.tcf file:
         utils.importFile('LogTrack.tci');
b. ti/bios/log/support/package.xs
If the user app is built using RTSC, then the user must use the Load module. This is done by adding the following line to the *.cfg file:
         var LogTrack = xdc.useModule('ti.bios.log.support.LogTrack');
NOTE: The two above mentioned methods are mutually exclusive. One can't use both method 'a' and method 'b' in the same program build; the user must choose the appropriate one for their build.
Additionally, it's necessary to call the module's init function, which should be called during program startup:
  LogTrack_init()
The LogTrack module's init function could be called from the user's main() function, for example.
By default, a BIOS PRD object (which runs every 10ms) prints out the CPU load of the DSP, followed by four zero values. These values are printed to the BIOS log "ti_bios_log_track". Also, the user may change these four values that the LogTrack module prints. This may be done by setting the address locations of those values using the following API:
  extern Void LogTrack_setTrackAddrs(Uint32 *addr1, Uint32 *addr2, Uint32
          *addr3, Uint32 *addr4);
In order for an address to be valid, it must be a memory mapped address. It is required that all four arguments to this API be filled; however if the user does not wish to print four different address values, then the address 0x0 may be supplied as a "don't care" value. This API will print the value stored in each address, unless it is address 0x0, in which case it will print "0".
The LogTrack module also contains a hook function to print information about dynamically created BIOS tasks (TSK). Each time a BIOS TSK instance is created at run time, its information is printed to the "ti_bios_log_create" BIOS log.
 
config LogTrack.createLogSize  // module-wide

size of the "ti_bios_log_create" log

XDCscript usage meta-domain
LogTrack.createLogSize = Int 1024;
 
 
config LogTrack.trackLogSize  // module-wide

size of the "ti_bios_log_track" log

XDCscript usage meta-domain
LogTrack.trackLogSize = Int 4096;
 
 
config LogTrack.trackPeriod  // module-wide

period of the PRD which prints out CPU load and the user defined addresses in the LogTrack_Config structure

XDCscript usage meta-domain
LogTrack.trackPeriod = Int 10;
 
generated on Sat, 23 May 2009 00:29:50 GMT