commit | 12aa605bcc0a24ab9cfef1cf01c8ad976262711b | [log] [tgz] |
---|---|---|
author | Mathieu Poirier <mathieu.poirier@linaro.org> | Fri Jan 19 10:46:53 2018 -0700 |
committer | Mike Leach <mike.leach@linaro.org> | Wed Jan 31 12:04:46 2018 +0000 |
tree | cfec026f9abe0bf8d067730dae8435896f5021af | |
parent | bd26505e694ac105ee63dbbed9a44141a2749d4a [diff] |
HOWTO: Reflect final upstream revision Since libopencsd is not part of the 'mainstream' libraries upstream maintainers have decided not to display its status on the system by default. To do so the VF=1 option is required, something this patch documents. Signed-off-by: Mathieu Poirier <mathieu.poirier@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.8.0
ETMv4 (v4.1) instruction trace - packet processing and packet decode.
PTM (v1.1) instruction trace - packet processing and packet decode.
ETMv3 (v3.5) instruction trace - packet processing and packet decode.
ETMv3 (v3.5) data trace - packet processing.
STM (v1.1) 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.
This git repository for OpenCSD contains only source for the OpenCSD decoder library. From version 0.4, releases appear as versioned tags on the master branch.
From version 0.7.4, the required updates to CoreSight drivers and perf, that are not currently upstream in the linux kernel tree, are now contained in a separate repository to be found at:
https://github.com/Linaro/perf-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.
Using the github site: https://github.com/Linaro/OpenCSD
Mailing list: coresight@lists.linaro.org