commit	5bcc98b70bebbc6658beacfb31399d8d867a669b	[log] [tgz]
author	Mike Leach <mike.leach@arm.com>	Tue Mar 08 04:47:54 2016 +0000
committer	Mike Leach <mike.leach@arm.com>	Tue Mar 08 04:47:54 2016 +0000
tree	cac27128ec361fef541f1a27e028394c961af86d
parent	9fba4f8f456ea56c56c430095a3724d81d3dea28 [diff]

tree: cac27128ec361fef541f1a27e028394c961af86d

README.md

OpenCSD - An open source CoreSight(tm) Trace Decode library {#mainpage}

This library provides an API suitable for the decode of ARM(r) CoreSight(tm) trace streams.

The library will decode formatted trace in three stages:-

Frame Deformatting : Removal CoreSight frame formatting from individual trace streams.
Packet Processing : Separate individual trace streams into discrete packets.
Packet Decode : Convert the packets into fully decoded trace describing the program flow on a core.

The library is implemented in C++ with an optional "C" API.

CoreSight Trace Component Support.

Current Version 0.001

Current support:

ETMv4 instruction trace - packet processing and packet decode.
ETMv3 instruction and data trace - packet processing.
STM software trace - packet processing.

Support to be added:

ETMv3 instruction trace - packet decode.
PTM instruction trace - packet processing and decode.
ITM software trace - packet processing.
ETMv3 data trace - packet decode.
ETMv4 data trace - packet processing and decode.

Documentation

API Documentation is provided inline in the source header files, which use the doxygen standard mark-up. Run doxygen on the ./doxygen_config.dox file located in the ./docs directory..

doxygen ./doxygen_config.dox

This will produce the documentation in the ./docs/html directory. The doxygen configuration also includes the *.md files as part of the documentation.

Building the Library

See [build_libs.md](@ref build_lib) in the ./docs directory for build details.

How the Library is used in Linux `perf`

The library and additional infrastructure for programming CoreSight components has been integrated with the standard linux perfomance analysis tool perf.

See [HOWTO.md](@ref howto_perf) for details.

Version and Modification Information

Version 0.001

Library initial development phase.

Licence Information

This library is licensed under the BSD three clause licence.

A copy of this license is in the LICENCE file included with the source code.