commit | 35b4fbc55bb29aee38a9cd0b4bb6079abee36255 | [log] [tgz] |
---|---|---|
author | Mike Leach <mike.leach@linaro.org> | Fri Nov 18 17:24:14 2016 +0000 |
committer | Mike Leach <mike.leach@linaro.org> | Tue Nov 29 13:41:37 2016 +0000 |
tree | b15fcc2fbb0360016a8d33353c425fe642d24f93 | |
parent | 998059f0bc263a30ff7d1dcca1de99be979ca729 [diff] |
opencsd: Documentation and Doxygen comment updates. Document describing the trace and debug snapshot file formats used in the tests/snapshots directory. Doxygen comment updates. README.md and test_progs.md documentation updates. Signed-off-by: Mike Leach <mike.leach@linaro.org>
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:-
The library is implemented in C++ with an optional "C" API.
From version 0.4, library versioning will use a semantic versioning format (per http://semver.org) of the form Major.minor.patch (M.m.p).
Internal library version calls, documentation and git repository will use this format moving forwards. Where a patch version is not quoted, or quoted as .x then comments will apply to the entire release.
Releases will be at M.m.0, with patch version incremented for bugfixes or documentation updates.
Releases will appear on the master branch in the git repository with an appropriate version tag.
Current Version 0.5.0
ETMv4 instruction trace - packet processing and packet decode.
PTM instruction trace - packet processing and packet decode.
ETMv3 instruction trace - packet processing and packet decode.
ETMv3 data trace - packet processing.
STM software trace - packet processing and packet decode.
External Decoders - support for addition of external / custom decoders into the library.
Note: for ITM and STM, packet decode is combining Master+Channel+Marker+Payload packets into a single generic output packet.
At present, the git repository for OpenCSD contains both branches/tags for the OpenCSD library itself, and branches that have the perf updates that are not yet upstream in the main linux tree for using perf to record and decode trace.
These perf branches are snapshots of the kernel tree and are thus quite large. It is advised if only the OpenCSD library is required, clone only selected branches. Otherwise, downloading may take some time.
e.g.
git clone -b opencsd-0v003 --single-branch https://github.com/Linaro/OpenCSD
(From version 0.4, releases appear as versioned tags on the master branch.)
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.
See [build_libs.md](@ref build_lib) in the ./docs
directory for build details.
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.
perf
tools integration - BKK16, 8th March 2016This library is licensed under the BSD three clause licence.
A copy of this license is in the LICENCE
file included with the source code.
Using the github site: https://github.com/Linaro/OpenCSD
Mailing list: coresight@lists.linaro.org