McsaTutorial1ReadingCDocs

MCSA Tutorial1 : How to read UIA CDOC documentation

The target-side APIs and events that are used to instrument your application code are provided in a RTSC package named UIA (Unified Instrumentation Architecture).

Within the UIA package, content is organized as follows:

• ti / uia / events: UIA Event definitions
• ti / uia / runtime: Core UIA APIs
• ti / uia / services: Modules that process commands from the MCSA Host tools
• ti / uia / family: Device-specific or ISA-specific modules
• ti / uia / sysbios: UIA APIs that depend on SYS/BIOS

Documentation for the UIA package is automatically installed in CCS when the package is installed.

Using CCS Help to view the UIA CDOC documentation

To view the CDOC documentation using CCS Help, open Help / Help Contents and then open the entry named Multicore System Analyzer (UIA Target), as shown below:

Viewing the UIA CDOC documentation using a web browser

If you do not wish to use CCS to view the documentation, you can alternatively use a web browser. Open the index.html file in the UIA package's docs\cdoc folder as shown below:

Links:

• Tutorial 1A: how to instrument your application code to log errors, warnings, and informational events
• Tutorial 1B: how to benchmark your application code so that you can see how long it takes to execute code on a running system
• Tutorial 1C: how to control which events in your application are enabled and disabled
• Tutorial 1D: how to configure which UIA modules your application uses
• Tutorial 1E: how to create a 'configuration-only' project to provide access to UIA modules

• Back up to the MCSA Tutorials page
• Back up to the MCSA Home