metaonly module ti.bios.log.support.LogAux |
 |
 |
LogAux module
The LogAux module provides an API set that is auxiliary to BIOS log. This
API gives the user a degree of control over how the BIOS logs are used, and
allows the user to obtain data from BIOS logs in a format that can be read
by the RTA decoder.
[
more ... ]
XDCspec summary |
sourced in ti/bios/log/support/LogAux.xdc |
metaonly module LogAux { ...
XDCscript usage |
meta-domain |
var LogAux = xdc.useModule('ti.bios.log.support.LogAux');
XDCspec declarations |
sourced in ti/bios/log/support/LogAux.xdc |
metaonly module LogAux {
}
DETAILS
The LogAux module provides an API set that is auxiliary to BIOS log. This
API gives the user a degree of control over how the BIOS logs are used, and
allows the user to obtain data from BIOS logs in a format that can be read
by the RTA decoder.
In order to use the LogAux module, it is necessary to call the module's
init() function, which should be called during program startup:
The LogAux module's init() function could be called from the user's main()
function, for example.
The LogAux module provides the following features for accessing and
controlling BIOS logs:
- Enabling and Disabling a set of BIOS logs.
- Flushing a set of BIOS logs (log data is discarded, not returned).
- Reading raw log data from Target memory and copying it into a buffer for
- for a set of BIOS logs. The LogAux module will also "remember" which log
and what position it left off on previously in between reads.
The set of logs that each API will affect is determined by a 32-bit log mask
that is passed to the API. Each bit in this log mask corresponds to a BIOS
log ID. Only logs that are set by the log mask will be affected by the
LogAux APIs.
Order Of Log Data Sent By The LogAux Module
- Data for the ti_bios_log_create log is always sent first (if it is
enabled).
- After all data of the ti_bios_log_create log is sent, the data of all
remaing, enabled logs in the system will follow.
- The order of the data of these remaing logs is sent based on the order
in which these logs are stored in Target memory. (See the program's
generated map file to find the ordering of the BIOS LOG objects in
memory.
Using The LogAux Module To Read BIOS Logs
Log data may be read by using the LogAux_read() API. However, this API has
both a prerequisite - LogAux_open(), as well as a postrequisite -
LogAux_close(). In order to read the BIOS log data, the function call flow
must be as follows:
1. call LogAux_open() once.
2. make one or many calls to LogAux_read().
3. call LogAux_close() once.
generated on Sat, 23 May 2009 00:29:50 GMT