commit | 629855d4cf413f73e9d6ed8cdd9657fbe61a6241 | [log] [tgz] |
---|---|---|
author | Mike Leach <mike.leach@linaro.org> | Wed Jul 20 17:22:07 2016 +0100 |
committer | Mike Leach <mike.leach@linaro.org> | Thu Aug 18 13:01:01 2016 +0100 |
tree | 46ba3d17d4ba6305c0e5fa82a13ab4e9248580c8 | |
parent | 727063d6ce86eb48231cb6714d06d352cd2edebd [diff] |
opencsd: Doxygen and Code comment updates. Improved documentation in main code and test program. Added the include/common directory to the files scanned by doxygen. 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.
Current Version 0.004
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 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
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.