Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / OpenCSD / 14bab84591d85ba4f03d216e23f92d683dc4e36a
commit14bab84591d85ba4f03d216e23f92d683dc4e36a[log] [tgz]
authorMike Leach <mike.leach@linaro.org>Tue Apr 19 16:09:03 2016 +0100
committerMike Leach <mike.leach@linaro.org>Mon Jun 20 13:27:51 2016 +0100
treed71b8644f8619b3f8e56872f90a9e127bc196436
parent7f2bb5ab683a371cc24aa801834dce6f587e7b10 [diff]
opencsd: ETMv3 decoder - generic trace follower.

Generic trace follower created in separate class to simplify main
decoder an allow re-use in other decoders.

The follower handles accessing memory for opcodes and interfacing
with the instruction opcode analyser, calculating the next address,
 or indicating it is needed from the trace stream or not available
 via memory accessors supplied to the decoder.

Signed-off-by: Mike Leach <mike.leach@linaro.org>
6 files changed
tree: d71b8644f8619b3f8e56872f90a9e127bc196436
  1. decoder/
  2. .gitignore
  3. HOWTO.md
  4. LICENSE
  5. README.md
  6. TODO
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:-

  1. Frame Deformatting : Removal CoreSight frame formatting from individual trace streams.
  2. Packet Processing : Separate individual trace streams into discrete packets.
  3. 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.002

Current support:

  • ETMv4 instruction trace - packet processing and packet decode.
  • PTM 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.
  • 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 development - tested with perf tools integration - BKK16, 8th March 2016
  • Version 0.002: Library development - added in PTM decoder support. Restructure header dir, replaced ARM rctdl prefix with opencsd/ocsd.

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.