Adding upstream version 1.3.3.upstream/1.3.3upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

13 files changed, 4227 insertions, 0 deletions

diff --git a/decoder/docs/build_libs.md b/decoder/docs/build_libs.md
new file mode 100644
index 0000000..e3435a2
--- /dev/null
+++ b/decoder/docs/build_libs.md
@@ -0,0 +1,174 @@
+Building and using the Library   {#build_lib}
+==============================
+
+@brief How to build the library and test programs and include the library in an application
+
+Platform Support
+----------------
+
+The current makefiles and build projects support building the library on:
+ - Linux and Windows, x86 or x64 hosts.
+ - ARM linux - AArch32 and AArch64
+ - ARM aarch32 and aarch64 libs, x-compiled on x86/64 hosts.
+
+In addition to building the library from the project, the library may be installed into the standard
+`/usr/lib/` area in Linux, and will soon be available as a package from Linux Distros.
+
+Building the Library
+--------------------
+
+The library and test programs are built from the library `./build/<platform>` directory, where
+<platform> is either 'linux' or 'win-vs2015' / 'win-vs2022'
+
+See [`./docs/test_progs.md`](@ref test_progs) for further information on use of the test 
+programs.
+
+### Linux x86/x64/ARM ###
+
+Libraries are built into a <tgt_dir>. This is used as the final output directory for the
+libraries in `decoder/lib/<tgt_dir>`, and also as a sub-directory of the build process for
+intermediate files - `decoder/build/linux/ref_trace_decode_lib/<tgt_dir>`.
+
+For a standard build, go to the `./build/linux/` and run `make` in that directory.
+
+This will set <tgt_dir> to `builddir` for all build variants of the library. Using this only one variant of the library can be built at any one time.
+
+For development, alternatively use `make -f makefile.dev`
+
+This will set <tgt_dir> to `linux<bit-variant>/<dbg|rel>` and therefore build libraries into the
+`decoder/lib/linux<bit-variant>/<dbg|rel>` directories, allowing multiple variants of the library
+to be present during development.
+
+e.g.
+
+`./lib/linux64/rel` will contain the linux 64 bit release libraries.
+
+`./lib/linux-arm64/dbg` will contain the linux aarch 64 debug libraries for ARM.
+
+Options to pass to both makefiles are:-
+- `DEBUG=1`   : build the debug version of the library.
+
+Options to pass to makefile.dev are:-
+- ARCH=<arch> : sets the bit variant in the delivery directories. Set if cross compilation for ARCH
+                other than host. Otherwise ARCH is auto-detected.
+                <arch> can be x86, x86_64, arm, arm64, aarch64, aarch32
+
+For cross compilation, set the environment variable `CROSS_COMPILE` to the name path/prefix for the
+compiler to use. The following would set the environment to cross-compile for ARM
+
+         export PATH=$PATH:~/work/gcc-x-aarch64-6.2/bin
+         export ARCH=arm64
+         export CROSS_COMPILE=aarch64-linux-gnu-
+
+The makefile will scan the `ocsd_if_version.h` to get the library version numbers and use these
+in the form Major.minor.patch when naming the output .so files.
+
+Main C++ library names:
+- `libcstraced.so.M.m.p` : shared library containing the main C++ based decoder library
+- `libcstrace.so.M`      : symbolic link name to library - major version only.
+- `libcstrace.so`        : symbolic link name to library - no version.
+
+C API wrapper library names:
+- `libcstraced_c_api.so.M.m.p` : shared library containing the C-API wrapper library. Dependent on `libcstraced.so.M`
+- `libcstraced_c_api.so.M`     : symbolic link name to library - major version only.
+- `libcstraced_c_api.so`       : symbolic link name to library - no version.
+
+Static versions of the libraries:
+- `libcstraced.a`        : static library containing the main C++ based decoder library.
+- `libcstraced_c_api.a`  : static library containing the C-API wrapper library.
+
+Test programs are delivered to the `./tests/bin/<tgt_dir>` directories.
+
+The test programs are built to used the .so versions of the libraries. 
+-  `trc_pkt_lister`         - dependent on `libcstraced.so`.
+-  `simple_pkt_print_c_api` - dependent on `libcstraced_c_api.so` & hence `libcstraced.so`.
+
+The test program build for `trc_pkt_lister` also builds an auxiliary library used by this program for test purposes only.
+This is the `libsnapshot_parser.a` library, delivered to the `./tests/lib/<tgt_dir>` directories.
+
+**Note on Linux Build Directory Names**
+
+Due to tool limitations, the makefiles will not operate correctly if the path to the opencsd directories contains spaces.
+
+e.g. checking out the project into a directory such as ` /home/name/my opencsd/` will result in build failures.
+
+__Installing on Linux__
+
+The libraries can be installed on linux using the `make install` command. This will usually require root privileges. Installation will be the version in the `./lib/<tgt_dir>` directory, according to options chosen.
+
+e.g.  ` make -f makefile.dev DEBUG=1 install`
+
+will install from `./lib/linux64/dbg`
+
+The libraries `libopencsd` and `libopencsd_c_api` are installed to `/usr/lib`.
+
+Sufficient header files to build using the C-API library will be installed to `/usr/include/opencsd`.
+
+The installation can be removed using `make clean_install`. No additional options are necessary. 
+
+
+### Windows (x86/x64)  ###
+
+Use the `.\build\win\ref_trace_decode_lib\ref_trace_decode_lib.sln` file to load a solution
+which contains all library and test build projects.
+
+Libraries are delivered to the `./lib/win<bitsize>/<dbg\rel>` directories.
+e.g. `./lib/win64/rel` will contain the windows 64 bit release libraries.
+
+The solution contains four configurations:-
+- *Debug* : builds debug versions of static C++ main library and C-API libraries, test programs linked to the static library.
+- *Debug-dll* : builds debug versions of static main library and C-API DLL. C-API statically linked to the main library. 
+C-API test built as `simple_pkt_print_c_api-dl.exe` and linked against the DLL version of the C-API library.
+- *Release* : builds release static library versions, test programs linked to static libraries.
+- *Release-dll* : builds release C-API DLL, static main library.
+
+_Note_: Currently there is no Windows DLL version of the main C++ library. This may follow once
+the project is nearer completion with further decode protocols, and the classes requiring export are established..
+
+Libraries built are:-
+- `libcstraced.lib` : static main C++ decoder library.
+- `cstraced_c_api.dll` : C-API DLL library. Statically linked against `libcstraced.lib` at .DLL build time.
+- `libcstraced_c_api.lib` : C-API static library. 
+
+There is also a project file to build an auxiliary library used `trc_pkt_lister` for test purposes only.
+This is the `snapshot_parser_lib.lib` library, delivered to the `./tests/lib/win<bitsize>/<dgb\rel>` directories.
+
+
+### Additional Build Options ###
+
+__Library Virtual Address Size__
+
+The ocsd_if_types.h file includes a #define that controls the size of the virtual addresses 
+used within the library. By default this is a 64 bit `uint64_t` value.
+
+When building for ARM architectures that have only a 32 bit Virtual Address, and building on 
+32 bit ARM architectures it may be desirable to build a library that uses a v-addr size of 
+32 bits. Define `USE_32BIT_V_ADDR` to enable this option
+
+
+Including the Library in an Application
+---------------------------------------
+
+The user source code includes a header according to the API to be used:-
+
+- Main C++ decoder library - include `opencsd.h`. Link to C++ library. 
+- C-API library - include `opencsd_c_api.h`. Link to C-API library.
+
+### Linux build ###
+
+By default linux builds will link against the .so versions of the library. Using the C-API library will also
+introduce a dependency on the main C++ decoder .so. Ensure that the library paths and link commands are part of the 
+application makefile.
+
+To use the static versions use appropriate linker options.
+
+### Windows build ###
+
+To link against the C-API DLL, include the .DLL name as a dependency in the application project options.
+
+To link against the C-API static library, include the library name in the dependency list, and define the macro 
+`OCSD_USE_STATIC_C_API` in the preprocessor definitions. This ensures that the correct static bindings are declared in
+the header file. Also link against the main C++ library.
+
+To link against the main C++ library include the library name in the dependency list.
+
diff --git a/decoder/docs/doxygen_config.dox b/decoder/docs/doxygen_config.dox
new file mode 100644
index 0000000..d8e80cd
--- /dev/null
+++ b/decoder/docs/doxygen_config.dox
@@ -0,0 +1,2501 @@
+# Doxyfile 1.8.12
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME           = "OpenCSD - CoreSight Trace Decode Library"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER         = 1.3.3
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF          = 
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO           = 
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       = ./.
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS         = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES    = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF           = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF       = "The $name class" \
+                         "The $name widget" \
+                         "The $name file" \
+                         is \
+                         provides \
+                         specifies \
+                         contains \
+                         represents \
+                         a \
+                         an \
+                         the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC    = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES        = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH        = 
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH    = 
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES            = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF      = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF           = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS           = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES  = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE               = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES                = 
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST              = 
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C  = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN   = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL   = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING      = 
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT       = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 0.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS   = 0
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT       = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT            = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT   = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING            = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS  = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE        = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE        = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC         = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS  = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES   = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS     = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS  = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS      = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS          = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES       = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES     = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC  = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS        = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES       = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME     = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING  = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST      = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST      = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST       = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS       = 
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES  = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
+# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES        = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES        = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER    = 
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE            = 
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES         = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET                  = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS               = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR      = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC       = NO
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered.
+# The default value is: NO.
+
+WARN_AS_ERROR          = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT            = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE           = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT                  = ../include \
+                         ../include/interfaces \
+                         ../include/opencsd/etmv3 \
+                         ../include/opencsd/etmv4 \
+                         ../include/opencsd/ptm \
+                         ../include/opencsd/c_api \
+                         ../include/opencsd/stm \
+                         ../include/mem_acc \
+                         ../../README.md \
+                         . \
+                         ../../HOWTO.md \
+                         ../include/common \
+                         ./prog_guide \
+                         ../include/opencsd \
+                         ../include \
+                         ../tests/auto-fdo/autofdo.md \
+                         ../include/opencsd/ete
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING         = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
+
+FILE_PATTERNS          = *.c \
+                         *.cc \
+                         *.cxx \
+                         *.cpp \
+                         *.c++ \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.idl \
+                         *.ddl \
+                         *.odl \
+                         *.h \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.cs \
+                         *.d \
+                         *.php \
+                         *.php4 \
+                         *.php5 \
+                         *.phtml \
+                         *.inc \
+                         *.m \
+                         *.markdown \
+                         *.md \
+                         *.mm \
+                         *.dox \
+                         *.py \
+                         *.f90 \
+                         *.f \
+                         *.for \
+                         *.tcl \
+                         *.vhd \
+                         *.vhdl \
+                         *.ucf \
+                         *.qsf \
+                         *.as \
+                         *.js
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE              = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE                = 
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       = 
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS        = 
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH           = 
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS       = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH             = prog_guide
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+INPUT_FILTER           = 
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+FILTER_PATTERNS        = 
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES    = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS = 
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER         = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS    = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION    = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS        = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS       = YES
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# generated with the -Duse-libclang=ON option for CMake.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS          = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX     = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX    = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX          = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML          = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER            = 
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER            = 
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET        = 
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET  = 
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES       = 
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE    = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT    = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA  = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET        = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME  = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP      = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE               = 
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION           = 
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI           = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING     = 
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND             = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP           = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE               = 
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE          = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME   = 
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS  = 
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS  = 
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION           = 
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP   = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX          = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW      = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH         = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE       = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT    = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX            = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT         = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS     = 
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE       = 
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH    = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH        = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL       = 
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE        = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID     = 
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS  = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX         = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE             = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES         = 
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER           = 
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER           = 
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET = 
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES      = 
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE        = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES     = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE      = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE        = plain
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP        = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS         = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE    = 
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE    = 
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE        = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION          = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR             = 
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT             = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK       = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT         = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sf.net) file that captures the
+# structure of the code including all documentation. Note that this feature is
+# still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX = 
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH           = 
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS  = 
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED             = 
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED      = 
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES               = 
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE       = 
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS        = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES         = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            = 
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH               = 
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT               = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS        = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME           = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH           = 
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK               = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS   = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS     = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH          = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH             = YES
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH           = YES
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT       = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG        = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH               = 
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS           = 
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS           = 
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS           = 
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH      = 
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH  = 
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS      = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP            = YES
diff --git a/decoder/docs/external_custom.md b/decoder/docs/external_custom.md
new file mode 100644
index 0000000..64e5191
--- /dev/null
+++ b/decoder/docs/external_custom.md
@@ -0,0 +1,148 @@
+Attaching External Custom Decoders    {#custom_decoders}
+==================================
+
+@brief A description of the C API external decoder interface.
+
+Introduction
+------------
+
+An external custom decoder is one which decodes a CoreSight trace byte stream from a source other
+than an ARM core which cannot be decoded by the standard built-in decoders within the library.
+
+An example of this may be a trace stream from a DSP device.
+
+The external decoder API allows a suitable decoder to be attached to the library and used in the 
+same way as the built-in decoders. This means that the external decoder can be created and destroyed
+using the decode tree API, and will integrate seamlessly with any ARM processor decoders that are part
+of the same tree.
+
+An external decoder will be required to use three standard structures:-
+
+- `ocsd_extern_dcd_fact_t` : This is a decoder "factory" that allows the creation of the custom decoders.
+- `ocsd_extern_dcd_inst_t` : This structure provides decoder data to the library for a single decoder instance.
+- `ocsd_extern_dcd_cb_fns` : This structure provides a set of callback functions allowing the decoder to use library functionality in the same way as built-in decoders.
+
+These structures consist of data and function pointers to allow integration with the library infrastructure.
+
+Registering A Decoder
+---------------------
+
+A single API function is provided to allow a decoder to be registered with the library by name. 
+
+    ocsd_err_t ocsd_register_custom_decoder(const char *name, ocsd_extern_dcd_fact_t *p_dcd_fact);
+
+This registers the custom decoder with the library using the supplied name and factory structure.
+As part of the registration function the custom decoder will be assigned a protocol ID which may be used in 
+API functions requiring this parameter.
+
+Once registered, the standard API functions used with the built-in decoders will work with the custom decoder.
+
+The Factory Structure
+---------------------
+This structure contains the interface that is registered with the library to allow the creation of custom decoder instances.
+
+The mandatory functions that must be provided include:
+- `fnCreateCustomDecoder`  : Creates a decoder. This function will fill in a `ocsd_extern_dcd_inst_t` structure for the decoder instance.
+- `fnDestroyCustomDecoder` : Destroys the decoder. Takes the `decoder_handle` attribute of the instance structure.
+- `fnGetCSIDFromConfig`    : Extracts the CoreSight Trace ID from the decoder configuration structure. 
+                             May be called before the create function. The CSID is used as part of the creation process to 
+                             attach the decoder to the correct trace byte stream.
+
+`fnPacketToString` : This optional function will provide a human readable string from a protocol specific packet structure.
+
+`protocol_id` : This is filled in when the decoder type is registered with the library. Used in some API 
+                calls to specify the decoder protocol type.
+
+
+
+Creating a Custom Decoder Instance
+----------------------------------
+
+Once the custom decoder factory has been registered with the library then using the decoder uses the standard creation API:-
+
+`ocsd_dt_create_decoder(const dcd_tree_handle_t handle, const char *decoder_name, const int create_flags,
+                                             const void *decoder_cfg, unsigned char *pCSID)`
+
+                                             
+This creates a decoder by type name in the current decode tree and attaches it to the trace data stream associated with a CoreSight trace ID extracted from 
+the trace configuration. 
+
+To create a custom decoder instance simply use the custom name and a pointer to the custom configuration structure.                                             
+
+Calling this on a custom decoder name will result in a call to the factor function `fnCreateCustomDecoder` function:-
+`ocsd_err_t CreateCustomDecoder(const int create_flags, const void *decoder_cfg, const ocsd_extern_dcd_cb_fns *p_lib_callbacks, ocsd_extern_dcd_inst_t *p_decoder_inst)`
+
+This will first require that the `ocsd_extern_dcd_inst_t` structure is populated.
+
+There is are two mandatory function calls in this structure that may be called by the library 
+
+   `fnTraceDataIn` : the decoder must provide this as this is called by the library to provide the 
+                     raw trace data to the decoder.
+                     
+    `fn_update_pkt_mon` : Allows the library to communicate when packet sink / packet monitor interfaces are attached to the decoder and in use.
+    
+The decoder creation process will also fill in the additional information to allow the library to correctly call back into the custom decoder using the `decoder_handle` parameter.
+
+Secondly the library will provide a structure of callback functions - `ocsd_extern_dcd_cb_fns` - that the decoder can use to access standard library functionality.
+This includes the standard error and message logging functions, the memory access and ARM instruction decode functions, plus the current output sink for generic 
+trace elements generated by the decoder. The decoder is not required to use these functions - indeed the ARM instruction decode will not be useful to none ARM 
+architecture decoders, but should where possible use these functions if being used as part of a combined ARM / custom decoder tree. This will simplify client 
+use of the external decoders.
+
+The `create_flags` parameter will describe the expected operational mode for the decoder. The flags are:-
+- `OCSD_CREATE_FLG_PACKET_PROC`  : Packet processing only - the decoder will split the incoming stream into protocol trace packets and output these.
+- `OCSD_CREATE_FLG_FULL_DECODER` : Full decode - the decoder will split the incoming stream into protocol trace packets and further decode and analyse these to produce generic trace output which may describe the program flow. 
+
+Finally the decoder creation function will interpret the custom configuration (`decoder_cfg`) and fill in the CoreSight Trace ID parameter `pCSID` 
+for this decoder instance. Decoder configuration structures describe registers and parameters used in programming up the trace source. The only 
+minimum requirement is that it is possible to extract a CoreSight trace ID from the configuration to allow the library to attach the correct byte 
+stream to the decoder.
+
+
+Example : The echo_test decoder
+--------------------------------
+
+The echo_test decoder is provided to both test the C-API interfaces provided for using custom decoders and as a worked example for using these interfaces.
+
+This decoder is initialised and created by the `c_api_pkt_print_test` program when the `-extern` command line option is used. 
+
+In order to use a custom decoder, the header files for that decoder must be included by the client as they are not part of the built-in provided by the standard library includes.
+
+    #include "ext_dcd_echo_test_fact.h"     // provides the ext_echo_get_dcd_fact() fn
+    #include "ext_dcd_echo_test.h"          // provides the echo_dcd_cfg_t config structure.
+
+The `register_extern_decoder()` function in the test shows how simple the API is to use.
+
+The implementation of the decoder provides an external function to get a factory structure.
+
+    p_ext_fact = ext_echo_get_dcd_fact();
+    
+Assuming this returns a structure then the decoder is registered by name.
+
+    if (p_ext_fact)
+    {
+        err = ocsd_register_custom_decoder(EXT_DCD_NAME, p_ext_fact);
+    }
+
+After this the test uses the same code path as the built in decoders when testing the custom decoder.
+The test function `ocsd_err_t create_decoder_extern(dcd_tree_handle_t dcd_tree_h)` is called if the test parameters indicate a custom decoder is needed.
+This populates the custom configuration structure specific to the echo_test decoder (`echo_dcd_cfg_t`), then passes this plus the decoder name to the same `create_generic_decoder()` function used when testing the built in decoders.
+
+
+    static ocsd_err_t create_decoder_extern(dcd_tree_handle_t dcd_tree_h)
+    {
+        echo_dcd_cfg_t trace_cfg_ext;
+
+        /* setup the custom configuration */
+        trace_cfg_ext.cs_id = 0x010;
+        if (test_trc_id_override != 0)
+        {
+            trace_cfg_ext.cs_id = (uint32_t)test_trc_id_override;
+        }
+
+        /* create an external decoder - no context needed as we have a single stream to a single handler. */
+        return create_generic_decoder(dcd_tree_h, EXT_DCD_NAME, (void *)&trace_cfg_ext, 0);
+    }
+
+From the test program perspective, these are the only changes made to the test program to test this decoder.
+The `create_generic_decoder()` then uses the normal C-API calls such as `ocsd_dt_create_decoder()` and `ocsd_dt_attach_packet_callback()` to hook the decoder into the decode tree infrastructure.
diff --git a/decoder/docs/man/trc_pkt_lister.1 b/decoder/docs/man/trc_pkt_lister.1
new file mode 100644
index 0000000..a2e2679
--- /dev/null
+++ b/decoder/docs/man/trc_pkt_lister.1
@@ -0,0 +1,127 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.TH TRC_PKT_LISTER 1 "2018-03-28" 
+
+.SH NAME
+trc_pkt_lister \- decodes captured CoreSight\*R trace
+.SH SYNOPSIS
+.RI trc_pkt_lister
+[ \-ss_dir \fI<dir>\fP ]
+[ -ss_verbose ]
+[ \-id \fI<n>\fP ]
+[ \-src_name \fI<name>\fP ]
+[ \-decode ]
+[ \-decode_only ]
+[ \-src_addr_n ]
+[ \-o_raw_packed ]
+[ \-o_raw_unpacked ]
+[ \-logstdout ]
+[ \-logstderr ]
+[ \-logfile ]
+[ \-logfilename \fI<name>\fP ]
+.br
+.SH DESCRIPTION
+.B trc_pkt_lister
+is a tool that takes a snapshot directory as an input, and lists and/or
+decodes all the trace packets for a single source, for any currently
+supported protocol.
+.PP
+The output will be a list of discrete packets, generic output packets
+and any error messages to file and/or screen as selected by the input
+command line options.
+.PP
+By default the program will list packets only (no decode), for the
+first discovered trace sink (ETB, ETF, ETR) in the snapshot directory,
+with all streams output.
+.SH OPTIONS
+.SS Snapshot selection
+The program defaults to \./ if no \-ss_dir option is given
+.TP
+.B \-ss\_dir <dir>
+Set the directory path to a trace snapshot.
+.TP
+\fB\fC\-ss\_verbose\fR
+Verbose output when reading the snapshot.
+.SS Decode options
+.TP
+.B \-id <n>
+Set an ID to list (may be used multiple times) \- default if no id set is for all IDs to be printed.
+.TP
+.B \-src\_name <name>
+List packets from a given snapshot source name (defaults to first source found).
+.TP
+.B \-decode
+Full decode of the packets from the trace snapshot (default is to list undecoded packets only.
+.TP
+.B \-decode_only
+Does not list the undecoded packets, just the trace decode.
+.TP
+.B \-src\_addr\_n
+In ETE protocol, indicate skipped N atoms in source address packet ranges by breaking the decode 
+range into multiple ranges on N atoms.
+.TP
+.B \-o\_raw\_packed
+Output raw packed trace frames.
+.TP
+.B \-o\_raw\_unpacked
+Output raw unpacked trace data per ID.
+.SS Output options
+Default is to output to file and stdout. Setting any option overrides and limits to only
+the options set.
+.TP
+.B \-logstdout
+output to stdout.
+.TP
+.B \-logstderr
+output to stderr.
+.TP
+.B \-logfile
+output to file using the default log file name.
+.TP
+.B \-logfilename <name>
+change the name of the output log file.
+.SH FILES
+.B Trace Snapshot directory.
+.PP
+The \fR./tests/snapshots\fP directory contains a number of trace
+snapshots used for testing the library.  Trace snapshots are dumps of
+captured binary trace data, CoreSight component configurations and
+memory dumps to allow trace decode.
+.PP
+Snapshots are generated on ARM targets and can then be analysed
+offline. The snapshot format is available in a separate document.
+.SH EXAMPLE
+Example command lines with short output excerpts.
+.PP
+.BI TC2 " ETMv3 packet processor output, raw packet output."
+.br
+Command line:
+.br
+.RI "trc\_pkt\_lister -ss\_dir ../../snapshots/TC2 -o_raw_unpacked"
+.PP
+Output:
+.br
+Frame Data; Index  17958; ID_DATA[0x11]; 16 04 c0 86 42 97 e1 c4 
+.br
+Idx:17945; ID:11;	I_SYNC : Instruction Packet synchronisation.; (Periodic); Addr=0xc00
+416e2; S;  ISA=Thumb2; 
+.br
+Idx:17961; ID:11;	P_HDR : Atom P-header.; WEN; Cycles=1
+.br
+Frame Data; Index  17968; ID_DATA[0x11]; ce af 90 80 80 00 a4 84 a0 84 a4 88 
+.br
+Idx:17962; ID:11;	TIMESTAMP : Timestamp Value.; TS=0x82f9d13097 (562536984727) 
+.br
+Idx:17974; ID:11;	P_HDR : Atom P-header.; WW; Cycles=2
+.PP
+.BI Juno " ETB\_1 selected for STM packet output, raw packet output"
+.br
+Command line:
+.br
+.RI "trc\_pkt\_lister -ss\_dir ../../snapshots/juno_r1_1 -o\_raw\_unpacked -src\_name ETB\_1"
+.PP
+.BI Juno " ETMv4 full trace decode + packet monitor, source trace ID 0x10 only."
+.br
+Command line:
+.br
+.RI "trc\_pkt\_lister -ss\_dir ../../snapshots/juno\_r1\_1 -decode -id 0x10"
+
diff --git a/decoder/docs/prog_guide/cs_trace_hw.jpg b/decoder/docs/prog_guide/cs_trace_hw.jpg
new file mode 100644
index 0000000..af88f51
--- /dev/null
+++ b/decoder/docs/prog_guide/cs_trace_hw.jpg
diff --git a/decoder/docs/prog_guide/decode_data_path_resp.jpg b/decoder/docs/prog_guide/decode_data_path_resp.jpg
new file mode 100644
index 0000000..eb7edb9
--- /dev/null
+++ b/decoder/docs/prog_guide/decode_data_path_resp.jpg
diff --git a/decoder/docs/prog_guide/dt_components.jpg b/decoder/docs/prog_guide/dt_components.jpg
new file mode 100644
index 0000000..0b0270d
--- /dev/null
+++ b/decoder/docs/prog_guide/dt_components.jpg
diff --git a/decoder/docs/prog_guide/lib_usage.jpg b/decoder/docs/prog_guide/lib_usage.jpg
new file mode 100644
index 0000000..6baaa12
--- /dev/null
+++ b/decoder/docs/prog_guide/lib_usage.jpg
diff --git a/decoder/docs/prog_guide/memacc_objs.jpg b/decoder/docs/prog_guide/memacc_objs.jpg
new file mode 100644
index 0000000..ad329d4
--- /dev/null
+++ b/decoder/docs/prog_guide/memacc_objs.jpg
diff --git a/decoder/docs/prog_guide/prog_guide_generic_pkts.md b/decoder/docs/prog_guide/prog_guide_generic_pkts.md
new file mode 100644
index 0000000..4a2f5b2
--- /dev/null
+++ b/decoder/docs/prog_guide/prog_guide_generic_pkts.md
@@ -0,0 +1,453 @@
+OpenCSD Library - Generic Trace Packet Descriptions   {#generic_pkts}	
+===================================================
+
+@brief Interpretation of the Generic Trace output packets.
+
+Generic Trace Packets - Collection.
+-----------------------------------
+
+### Packet interface ###
+
+The generic trace packets are the fully decoded output from the trace library. 
+
+These are delivered to the client application in the form of a callback function. Packets from all trace sources 
+will use the same single callback function, with the CoreSight Trace ID provided to identify the source.
+
+The callback is in the form of an interface class ITrcGenElemIn, which has a single function:
+
+~~~{.cpp}
+virtual ocsd_datapath_resp_t TraceElemIn(    const ocsd_trc_index_t index_sop,
+                                             const uint8_t trc_chan_id,
+                                             const OcsdTraceElement &elem
+										) = 0;
+~~~
+
+The client program will create derived class providing this interface to collect trace packets from the library.
+
+The parameters describe the output packet and source channel:
+|Parameter                        | Description                                                             | 
+|:--------------------------------|:------------------------------------------------------------------------|
+| `ocsd_trc_index_t index_sop`    | Index of the first byte of the trace packet that generated this output. |
+| `uint8_t trc_chan_id`           | The source CoreSight Trace ID.                                          |
+| `OcsdTraceElement &elem`        | The packet class - wraps the `ocsd_generic_trace_elem` structure.       | 
+
+_Note_ : `index_sop` may be the same for multiple output packets. This is due to an one byte atom packet which
+can represent multiple atoms and hence multiple ranges.
+
+The C-API provides a similarly specified callback function definition, with an additional opaque `void *` pointer
+that the client application may use.
+
+~~~{.c}
+/** function pointer type for decoder outputs. all protocols, generic data element input */
+typedef ocsd_datapath_resp_t (* FnTraceElemIn)( const void *p_context, 
+                                                const ocsd_trc_index_t index_sop, 
+                                                const uint8_t trc_chan_id, 
+                                                const ocsd_generic_trace_elem *elem); 
+~~~
+
+### The Packet Structure ###
+
+~~~{.c}
+typedef struct _ocsd_generic_trace_elem {
+    ocsd_gen_trc_elem_t elem_type;   /* Element type - remaining data interpreted according to this value */
+    ocsd_isa           isa;          /* instruction set for executed instructions */
+    ocsd_vaddr_t       st_addr;      /* start address for instruction execution range / inaccessible code address / data address */
+    ocsd_vaddr_t       en_addr;        /* end address (exclusive) for instruction execution range. */
+    ocsd_pe_context    context;        /* PE Context */
+    uint64_t           timestamp;      /* timestamp value for TS element type */
+    uint32_t           cycle_count;    /* cycle count for explicit cycle count element, or count for element with associated cycle count */
+    ocsd_instr_type    last_i_type;    /* Last instruction type if instruction execution range */
+    ocsd_instr_subtype last_i_subtype; /* sub type for last instruction in range */
+ 
+    //! per element flags
+    union {
+        struct {
+            uint32_t last_instr_exec:1;     /* 1 if last instruction in range was executed; */
+			uint32_t last_instr_sz:3;       /* size of last instruction in bytes (2/4) */
+            uint32_t has_cc:1;              /* 1 if this packet has a valid cycle count included (e.g. cycle count included as part of instruction range packet, always 1 for pure cycle count packet.*/
+            uint32_t cpu_freq_change:1;     /* 1 if this packet indicates a change in CPU frequency */
+            uint32_t excep_ret_addr:1;      /* 1 if en_addr is the preferred exception return address on exception packet type */
+            uint32_t excep_data_marker:1;   /* 1 if the exception entry packet is a data push marker only, with no address information (used typically in v7M trace for marking data pushed onto stack) */
+            uint32_t extended_data:1;       /* 1 if the packet extended data pointer is valid. Allows packet extensions for custom decoders, or additional data payloads for data trace.  */
+            uint32_t has_ts:1;              /* 1 if the packet has an associated timestamp - e.g. SW/STM trace TS+Payload as a single packet */
+            uint32_t last_instr_cond:1;     /* 1 if the last instruction was conditional */
+            uint32_t excep_ret_addr_br_tgt:1; /* 1 if exception return address (en_addr) is also the target of a taken branch addr from the previous range. */
+        };
+        uint32_t flag_bits;
+    };
+
+    //! packet specific payloads
+    union {  
+        uint32_t exception_number;          /* exception number for exception type packets */
+        trace_event_t  trace_event;         /* Trace event - trigger etc      */
+        trace_on_reason_t trace_on_reason;  /* reason for the trace on packet */
+        ocsd_swt_info_t sw_trace_info;      /* software trace packet info    */
+		uint32_t num_instr_range;	        /* number of instructions covered by range packet (for T32 this cannot be calculated from en-st/i_size) */
+        unsync_info_t unsync_eot_info;      /* additional information for unsync / end-of-trace packets. */
+		trace_marker_payload_t sync_marker; /* marker element - sync later element to position in stream */
+        trace_memtrans_t mem_trans;         /* memory transaction packet - transaction event */
+	};
+
+    const void *ptr_extended_data;        /* pointer to extended data buffer (data trace, sw trace payload) / custom structure */
+
+} ocsd_generic_trace_elem;
+~~~
+
+The packet structure contains multiple fields and flag bits. The validity of any of these fields or flags
+is dependent on the `elem_type` member. The client program must not assume that field values will persist 
+between packets, and must process all valid data during the callback function.
+
+The packet reference guide below defines the fields valid for each packet type.
+
+--------------------------------------------------------------------------------------------------
+
+Generic Trace Packets - Packet Reference.
+-----------------------------------------
+
+This section contains reference descriptions of each of the generic trace packets types define as part of the 
+`ocsd_gen_trc_elem_t` enum value that appears as the first `elem_type` field in the packet structure.
+
+The descriptions will include information on which fields in the packets are always valid, optional and any protocol specific information. 
+
+The tags used in the reference are:-
+- __packet fields valid__ : fields that are always valid and filled for this packet type.
+- __packet fields optional__ : fields that _may_ be filled for this packet type.
+ The form `flag -> field` indicates a flag that may be set and the value that is valid if the flag is true
+- __protocol specific__ : indicates type or fields may be source protocol specific.
+
+_Note_: while most of the packets are not protocol specific, there are some protocol differences that mean
+certain types and fields will differ slightly across protocols. These differences are highlighted in the 
+reference.
+
+### OCSD_GEN_TRC_ELEM_NO_SYNC ###
+__packet fields valid__: None
+
+Element output before the decoder has synchronised with the input stream, or synchronisation is lost.
+
+### OCSD_GEN_TRC_ELEM_INSTR_RANGE ###
+__packet fields valid__: `isa, st_addr, en_addr, last_i_type, last_i_subtype, last_instr_exec, last_instr_sz, num_instr_range, last_instr_cond`
+
+__packet fields optional__: `has_cc -> cycle_count,`
+
+__protocol specific__ : ETMv3, PTM 
+
+This should be the most common packet output for full trace decode. Represents a range of instructions of 
+a single `isa`, executed by the PE. Instruction byte range is from `st_addr` (inclusive) to `en_addr` (exclusive).
+The total number of instructions executed for the range is given in `num_instr_range`.
+
+Information on the last instruction in the range is provided. `last_i_type` shows if the last instruction
+was a branch or otherwise - which combined with `last_instr_exec` determines if the branch was taken.
+The last instruction size in bytes is given, to allow clients to quickly determine the address of the last 
+instruction by subtraction from `en_addr`. This value can be 2 or 4 bytes in the T32 instruction set. 
+
+__ETMv3, PTM__ : These protocols can output a cycle count directly as part of the trace packet that generates 
+the trace range. In this case `has_cc` will be 1 and `cycle_count` will be valid.
+
+
+### OCSD_GEN_TRC_ELEM_I_RANGE_NOPATH ###  
+__packet fields valid__: `isa, st_addr, en_addr, num_instr_range`
+
+`num_instr_range` represents the number of instructions executed in this range, but there is incomplete information 
+as to program execution path from start to end of range.
+If `num_instr` is 0, then an unknown number of instructions were executed between the start and end of the range.
+`st_addr` represents the start of execution represented by this packet.
+`en_addr` represents the address where execution will continue from after the instructions represented by this packet.
+`isa` represents the ISA for the instruction at `en_addr`.
+
+Used when ETMv4 Q elements are being traced.
+
+
+### OCSD_GEN_TRC_ELEM_ADDR_NACC ###
+__packet fields valid__: `st_addr`
+
+Trace decoder found address in trace that cannot be accessed in the mapped memory images.
+`st_addr` is the address that cannot be found.
+
+Decoder will wait for new address to appear in trace before attempting to restart decoding. 
+ 
+
+### OCSD_GEN_TRC_ELEM_UNKNOWN ###
+__packet fields valid__: None
+
+Decoder saw invalid packet for protocol being processed. Likely incorrect protocol settings, or corrupted 
+trace data.
+  
+### OCSD_GEN_TRC_ELEM_TRACE_ON ###
+__packet fields valid__: trace_on_reason
+
+__packet fields optional__: `has_cc -> cycle_count,`
+
+__protocol specific__ : ETMv3, PTM
+ 
+Notification that trace has started / is synced after a discontinuity or at start of trace decode.
+
+__ETMv3, PTM__ : These protocols can output a cycle count directly as part of the trace packet that generates 
+the trace on indicator. In this case `has_cc`  will be 1 and `cycle_count` will be valid.
+
+
+### OCSD_GEN_TRC_ELEM_EO_TRACE ###
+__packet fields valid__: None
+
+Marker for end of trace data. Sent once for each CoreSight ID channel.
+
+### OCSD_GEN_TRC_ELEM_PE_CONTEXT ###
+__packet fields valid__: context
+
+__packet fields optional__: `has_cc -> cycle_count,`
+
+__protocol specific__ : ETMv3, PTM
+
+This packet indicates an update to the PE context - which may be the initial context in a trace stream, or a 
+change since the trace started.
+
+The context is contained in a `ocsd_pe_context` structure.
+
+~~~{.c}
+typedef struct _ocsd_pe_context {    
+    ocsd_sec_level security_level;     /* security state */
+    ocsd_ex_level  exception_level;    /* exception level */
+    uint32_t        context_id;         /* context ID */
+    uint32_t        vmid;               /* VMID */
+    struct {
+        uint32_t bits64:1;              /* 1 if 64 bit operation */
+        uint32_t ctxt_id_valid:1;       /* 1 if context ID value valid */
+        uint32_t vmid_valid:1;          /* 1 if VMID value is valid */
+        uint32_t el_valid:1;            /* 1 if EL value is valid (ETMv4 traces current EL, other protocols do not) */
+    };
+} ocsd_pe_context;
+~~~
+
+__ETMv3, PTM__ : These protocols can output a cycle count directly as part of the trace packet that generates 
+the PE context. In this case `has_cc`  will be 1 and `cycle_count` will be valid.
+
+__ETMv3__ :  From ETM 3.5 onwards, exception_level can be set to `ocsd_EL2` when tracing through hypervisor code.
+On all other occasions this will be set to `ocsd_EL_unknown`.
+
+
+### OCSD_GEN_TRC_ELEM_ADDR_UNKNOWN ###
+__packet fields optional__: `has_cc -> cycle_count,`
+
+__protocol specific__: ETMv3
+
+This packet will only be seen when decoding an ETMv3 protocol source. This indicates that the decoder
+is waiting for a valid address in order to process trace correctly. 
+
+The packet can have a cycle count associated with it which the client must account for when tracking cycles used.
+The packet will be sent once when unknown address occurs. Further `OCSD_GEN_TRC_ELEM_CYCLE_COUNT` packets may follow
+ before the decode receives a valid address to continue decode.
+
+
+### OCSD_GEN_TRC_ELEM_EXCEPTION ###
+__packet fields valid__: `exception_number`
+
+__packet fields optional__: `has_cc -> cycle_count, excep_ret_addr -> en_addr, excep_data_marker, excep_ret_addr_br_tgt`
+
+__protocol specific__: ETMv4, ETMv3, PTM
+
+All protocols will include the exception number in the packet.
+
+__ETMv4__ : This protocol may provide the preferred return address for the exception - this is the address of
+the instruction that could be executed on exception return. This address appears in `en_addr` if `excep_ret_addr` = 1.
+
+Additionally, this address could also represent the target address of a branch, if the exception occured at the branch target, before any further instructions were execute. If htis is the case then the excep_ret_addr_br_tgt flag will be set. This makes explicit what was previously only implied by teh packet ordered. This information could be used for clients such as perf that branch source/target address pairs.
+
+__ETMv3__ : This can set the `excep_data_marker` flag. This indicates that the exception packet is a marker
+to indicate exception entry in a 7M profile core, for the purposes of tracking data. This will __not__ provide
+an exception number in this case.
+
+__PTM__ : Can have an associated cycle count (`has_cc == 1`), and may provide preferred return address in `en_addr` 
+if `excep_ret_addr` = 1.
+
+### OCSD_GEN_TRC_ELEM_EXCEPTION_RET ###
+__packet fields valid__: None
+
+Marker that a preceding branch was an exception return.
+
+### OCSD_GEN_TRC_ELEM_TIMESTAMP ###
+__packet fields valid__: `timestamp`
+
+__packet fields optional__: `has_cc -> cycle_count,`
+
+__protocol specific__: ETMv4, PTM
+
+The timestamp packet explicitly provides a timestamp value for the trace stream ID in the callback interface.
+
+__PTM__ : This can have an associated cycle count (`has_cc == 1`). For this protocol, the cycle count __is__ part
+of the cumulative cycle count for the trace session.
+
+__ETMv4__ : This can have an associated cycle count (`has_cc == 1`). For this protocl, the cycle coun represents
+the number of cycles between the previous cycle count packet and this timestamp packet, but __is not__ part of 
+the cumulative cycle count for the trace session.
+
+
+### OCSD_GEN_TRC_ELEM_CYCLE_COUNT ###
+__packet fields valid__: `has_cc -> cycle_count`
+
+Packet contains a cycle count value. A cycle count value represents the number of cycles passed since the 
+last cycle count value seen. The cycle count value may be associated with a specific packet or instruction
+range preceding the cycle count packet.
+
+Cycle count packets may be added together to build a cumulative count for the trace session.
+
+### OCSD_GEN_TRC_ELEM_EVENT ###
+__packet fields valid__: `trace_event`
+
+This is a hardware event injected into the trace by the ETM/PTM hardware resource programming. See the
+relevent trace hardware reference manuals for the programming of these events. 
+
+The `trace_event` is a `trace_event_t` structure that can have an event type - and an event number.
+
+~~~{.c}
+typedef struct _trace_event_t {
+    uint16_t ev_type;          /* event type - unknown (0) trigger (1), numbered event (2)*/
+    uint16_t ev_number;        /* event number if numbered event type */
+} trace_event_t;
+~~~
+
+The event types depend on the trace hardware:-
+
+__ETMv4__ : produces numbered events. The event number is a bitfield of up to four events that occurred.
+Events 0-3 -> bits 0-3. The bitfield allows a single packet to represent multiple different events occurring.
+
+_Note_: The ETMv4 specification has further information on timing of events and event packets.  Event 0 
+is also considered a trigger event in ETMv4 hardware, but is not explicitly represented as such in the OCSD protocol.
+
+__PTM__, __ETMv3__ : produce trigger events. Event number always set to 0.
+
+
+### OCSD_GEN_TRC_ELEM_SWTRACE ###
+__packet fields valid__: `sw_trace_info`
+
+__packet fields optional__: `has_ts -> timestamp`, ` extended_data -> ptr_extended_data`
+
+The Software trace packet always has a filled in `sw_trace_info` field to describe the current master and channel ID, 
+plus the packet type and size of any payload data.
+
+SW trace packets that have a payload will use the extended_data flag and pointer to deliver this data.
+
+SW trace packets that include timestamp information will us the `has_ts` flag and fill in the timestamp value.
+
+
+### OCSD_GEN_TRC_ELEM_SYNC_MARKER ###
+__packet fields valid__: `sync_marker`
+
+Synchronisation marker - marks position in stream of an element that is output later.
+e.g. a timestamp marker can be output to represent the correct position in the stream for a 
+timestamp packet the is output later.
+
+The `sync_marker` field has a structure as shown below.
+
+~~~{.c}
+typedef enum _trace_sync_marker_t {
+    ELEM_MARKER_TS,        /**< Marker for timestamp element */
+} trace_sync_marker_t;
+
+typedef struct _trace_marker_payload_t {
+    trace_sync_marker_t type;   /**< type of sync marker */
+    uint32_t value;             /**< sync marker value - usage depends on type */
+} trace_marker_payload_t;
+~~~
+
+### OCSD_GEN_TRC_ELEM_MEMTRANS ###
+__packet fields valid__: `mem_trans`
+
+Memory transaction elements may appear in the output stream, if they are not otherwise cancelled
+by speculative trace packets.
+
+The memory transaction field has values as defined in the enum below:-
+
+~~~{.c}
+typedef enum _memtrans_t {
+    OCSD_MEM_TRANS_TRACE_INIT,/* Trace started while PE in transactional state */
+    OCSD_MEM_TRANS_START,     /* Trace after this packet is part of a transactional memory sequence */
+    OCSD_MEM_TRANS_COMMIT,    /* Transactional memory sequence valid. */
+    OCSD_MEM_TRANS_FAIL,      /* Transactional memory sequence failed - operations since start of transaction have been unwound. */  
+} trace_memtrans_t;
+~~~
+
+
+### OCSD_GEN_TRC_ELEM_CUSTOM ###
+__packet fields optional__: `extended_data -> ptr_extended_data`,_any others_
+
+Custom protocol decoders can use this packet type to provide protocol specific information. 
+
+Standard fields may be used for similar purposes as defined above, or the extended data pointer can reference
+other data.
+
+--------------------------------------------------------------------------------------------------
+
+Generic Trace Packets - Notes on interpretation.
+------------------------------------------------
+
+The interpretation of the trace output should always be done with reference to the underlying protocol 
+specifications. 
+
+While the output packets are in general protocol agnostic, there are some inevitable 
+differences related to the underlying protocol that stem from the development of the trace hardware over time.
+
+### OCSD ranges and Trace Atom Packets ###
+The most common raw trace packet in all the protocols is the Atom packet, and this packet is the basis for most of
+the `OCSD_GEN_TRC_ELEM_INSTR_RANGE` packets output from the library. A trace range will be output for each atom 
+in the raw trace stream - the `last_instr_exec` flag taking the value of the Atom - 1 for E, 0 for N.
+
+`OCSD_GEN_TRC_ELEM_INSTR_RANGE` packets can also be generated for non-atom packets, where flow changes - e.g.
+exceptions.
+
+
+### Multi feature OCSD output packets ###
+Where a raw trace packet contains additional information on top of the basic packet data, then this additional
+information will be added to the OCSD output packet and flagged accordingly (in the `flag_bits` union in the
+packet structure).
+
+Typically this will be atom+cycle count packets in ETMv3 and PTM protocols. For efficiency and to retain
+the coupling between the information an `OCSD_GEN_TRC_ELEM_INSTR_RANGE` packet will be output in this case
+with a `has_cc` flag set and the `cycle_count` value filled.
+
+ETMv3 and PTM can add a cycle count to a number of packets, or explicitly emit a cycle count only packet. By
+contrast ETMv4 only emits cycle count only packets.
+
+Clients processing the library output must be aware of these optional additions to the base packet. The 
+OCSD packet descriptions above outline where the additional information can occur.
+
+### Cycle counts ###
+
+Cycle counts are cumulative, and represent cycles since the last cycle count output.
+Explicit cycle count packets are associated with the previous range event, otherwise where a 
+packet includes a cycle count as additional information, then the count is associated with that
+specific packet - which will often be a range packet.
+
+The only exception to this is where the underlying protocol is ETMv4, and a cycle count is included
+in a timestamp packet. Here the cycle count represents that number of cycles since the last cycle count
+packet that occurred before the timestamp packet was emitted. This cycle count is not part of the cumulative 
+count. See the ETMv4 specification for further details.
+
+
+### Correlation - timestamps and cycle counts ###
+
+Different trace streams can be correlated using either timestamps, or timestamps plus cycle counts. 
+
+Both timestamps and cycle counts are enabled by programming ETM control registers, and it is also possible 
+to control the frequency that timestamps appear, or the threshold at which cycle count packets are emitted by
+additional programming. 
+
+The output of timestamps and cycle counts increases the amount of trace generated, very significantly when cycle 
+counts are present, so the choice of generating these elements needs to be balanced against the requirement
+for their use.
+
+Decent correlation can be gained by the use of timestamps alone - especially if the source is programmed to 
+produce them more frequently than the default timestamp events. More precise correllation can be performed if
+the 'gaps' between timestamps can be resolved using cycle counts. 
+
+Correlation is performed by identifying the same/close timestamp values in two separate trace streams. Cycle counts 
+if present can then be used to resolve the correlation with additional accuracy. 
+
+
+
+
+
+
+
+
+
+
+
diff --git a/decoder/docs/prog_guide/prog_guide_main.md b/decoder/docs/prog_guide/prog_guide_main.md
new file mode 100644
index 0000000..9504bdc
--- /dev/null
+++ b/decoder/docs/prog_guide/prog_guide_main.md
@@ -0,0 +1,611 @@
+OpenCSD Library - Programmers Guide    {#prog_guide}	
+===================================
+
+@brief  A guide to programming the OpenCSD library.
+
+Introduction and review of Coresight Hardware 
+---------------------------------------------
+
+The OpenCSD trace decode library is designed to allow programmers to decode ARM CoreSight trace
+data. This guide will describe the various stages of configuring and programming a decoder instance 
+for a given CoreSight system.
+
+The diagram below shows a typical Coresight trace hardware arrangement
+
+![Example CoreSight Trace Capture Hardware](cs_trace_hw.jpg)
+
+The design shown has four Cortex cores, each with an ETM, along with a system STM all of which generate trace into the
+trace funnel. The output of the funnel is fed into a trace sink, which might be an ETB or ETR, saving the trace
+which is multiplexed into CoreSight trace frames in the trace sink memory. The colours represent the sources 
+of trace data, each of which will be tagged with a CoreSight Trace ID.
+
+### CoreSight Trace ID ###
+The CoreSight Trace ID - also referred to as the Trace Source Channel ID - is a unique 8 bit number programmed
+into each trace source in a system (ETM,PTM,STM) which identifies the source to both the hardware components 
+downstream and the software trace decoders. This ID is used 
+
+Overview of Configuration and Decode
+------------------------------------
+
+The OpenCSD library will take the trace data from the trace sink, and when correctly configured and programmed, will
+demultiplex and decode each of the trace sources.
+
+The library supports ETMV3, PTM, ETMv4 and STM trace protocols. The decode occurs in three stages:
+- __Demultiplex__ - the combined trace streams in CoreSight trace frame format are split into their constituent streams according to the CoreSight trace ID.
+- __Packet Processing__ - the individual trace ID streams are resolved into discrete trace packets.
+- __Packet Decode__ - the trace packets are interpreted to produce a decoded representation of instructions executed.
+
+There are input configuration requirements for each stage of the decode process - these allow the decode process to correctly 
+interpret the incoming byte stream.
+- __Demultiplex__ - Input flags are set to indicate if the frames are 16 byte aligned or if the stream contains alignment 
+bytes between frames.
+- __Packet Processing__ - The hardware configuration of the trace source must be provided. This consists of a sub-set of the
+hardware register values for the source.  Each protocol has differing requirements, represented by an input structure of the 
+register values.
+- __Packet Decode__ - For ETM/PTM packet decode, this stage requires the memory images of the code executed in order 
+to determine the path through the code. These are provided either as memory dumps, or as links to binary code files.
+
+_Note_ : STM, being a largely software generated data trace, does not require memory images to recover the data written by the source
+processors.
+
+The diagram below shows the basic stages of decode for the library when used in a client application:
+
+![Example Library Usage for Trace Decode](lib_usage.jpg)
+
+The DecodeTree object is a representation of the structure of the CoreSight hardware, but in reverse in that the data is pushed into the 
+tree, through the demultiplexor and then along the individual trace stream decode paths till the output decode packets are produced.
+
+These outpup packets are referred to as Generic Trace packets, and are at this stage protocol independent. They consist primarily of
+PE context information and address ranges representing the instructions processed.
+
+### Decode Tree ###
+
+The DecodeTree is the principal wrapper for all the decoders the library supports. This provides a programming 
+API which allows the creation of protocol packet processors and decoders. 
+
+The API allows the client application to configure the de-multiplexor, create and connect packet processors and 
+packet decoders to the trace data streams and collect the output generic decoded trace packets. The DecodeTree 
+provides a built in instruction decoder to allow correct trace decode, and an additional API through a memory 
+access handler to allow the client applications to provide the images of the traced code in file or memory dump  
+format. 
+
+Once a DecodeTree is configured, then it can be re-used for multiple sets of captured trace data where the same
+set of applications has been traced, or by changing only the supplied memory images, different traced applications
+on the same hardware configuration.
+
+The process for programming a decode tree for a specific set of trace hardware is as follows;-
+1. Create the decode tree and specify the de-multiplexor options.
+2. For each trace protocol of interest, use the API to create a decoder, providing the hardware configuration, 
+including the CoreSight trace ID for that trace stream. Specify packet processing only, or full decode. Client
+program must know the correct protocol to use for each trace stream.
+3. Attach callback(s) to receive the decoded generic trace output (ITrcGenElemIn).
+4. Provide the memory images if using full decode.
+
+The DecodeTree can now be used to process the trace data by pushing the captured trace data through the trace
+ data input API call (ITrcDataIn) and analyzing as required the resulting decoded trace (ITrcGenElemIn).
+ 
+ The objects and connections used for a single trace stream are shown below.
+ 
+ ![Decode Tree objects - single trace stream](dt_components.jpg)
+ 
+ All these components can be created and used outside of a DecodeTree, but that is beyond the scope of this
+ guide and expected to be used for custom implementations only.
+
+Programming Examples - decoder configuration.
+---------------------------------------------
+
+The remainder of this programming guide will provide programming exceprts for each of the required stages
+to get a working decode tree, capable of processing trace data.
+
+The guide will be based on an ETMv4 system, similar to the example above, using the C++ interface, but 
+equivalent calls from the C-API wrapper library will also be provided.
+
+The source code for the two test applications `trc_pkt_lister` and `c_api_pkt_print_test` may be used as 
+further programming guidance.
+
+### Create the decode tree ###
+
+The first step is to create the decode tree. Key choices here are the flags defining expected trace data
+input format and de-mux operations.
+
+~~~{.cpp}
+	uint32_t formatterCfgFlags = OCSD_DFRMTR_FRAME_MEM_ALIGN; /* basic operational mode for on-chip captured trace */
+	DecodeTree *pTree = DecodeTree::CreateDecodeTree(OCSD_TRC_SRC_FRAME_FORMATTED, formatterCfgFlags);
+~~~
+
+This creates a decode tree that is usable in the majority of cases - that is for trace captured in on chip
+RAM via ETB or ETR. Additional flags are available if a TPIU is used that will indicate to the frame de-mux
+that additional frame synchronisation data is present.
+
+In limited cases where the hardware has a single trace source, or only a single source is being used, then
+it is possible to switch off the hardware frame formatter in the ETB/ETR/TPIU. In this case @ref OCSD_TRC_SRC_SINGLE
+ (from enum @ref ocsd_dcd_tree_src_t) may be defined as the first parameter to the function.
+ 
+C-API version of above code:
+~~~{.c}
+	dcd_tree_handle_t dcdtree_handle = ocsd_create_dcd_tree(OCSD_TRC_SRC_FRAME_FORMATTED, OCSD_DFRMTR_FRAME_MEM_ALIGN);
+~~~
+
+### Error loggers and printers ###
+
+The library defines a standard error logging interface ITraceErrorLog which many of the key components can register 
+with to output errors. The process of registering the source means that errors can be tied to a particular component, 
+or CoreSight Trace ID. The library provides a standard error logger object - ocsdDefaultErrorLogger - which 
+keeps a copy of the last error logged, plus a copy of the last error logged for each data stream associated 
+with a CoreSight trace ID. 
+
+The error logger can be attached to an output logger - ocsdMsgLogger - which can print text versions of the
+error, or other error messages, out to screen or logging file. Errors can be filtered according to a severity rating,
+defined by @ref ocsd_err_severity_t.
+
+The DecodeTree can use a default error logger from the library - with a message logger that will output to `stderr`. 
+
+Client applications can create and adjust the configuration of this error logger and message logger by getting and intialising
+ the logger. 
+
+~~~{.cpp}
+	// ** Initialise default error logger.
+	DecodeTree::getDefaultErrorLogger()->initErrorLogger(verbosity,true);
+~~~	
+
+Alternatively clients may provide their own configured error logger / message logger pair.
+
+The test program `trc_pkt_lister` provides a customised version of an `ocsdMsgLogger` / `ocsdDefaultErrorLogger` pair
+to ensure that messages and errors are logged to the screen and a file of its choice. This logger is eventually
+passed through to the decode tree.
+
+Code excerpts below (trc_pkt_lister.cpp):
+
+~~~{.cpp}
+	static ocsdMsgLogger logger;
+	static int logOpts = ocsdMsgLogger::OUT_STDOUT | ocsdMsgLogger::OUT_FILE;
+	static std::string logfileName = "trc_pkt_lister.ppl";
+	
+	// ** other vars
+	
+	main() {
+		
+		// ** some init code
+	
+	    logger.setLogOpts(logOpts);
+		logger.setLogFileName(logfileName.c_str());	
+
+
+		ocsdDefaultErrorLogger err_log;
+		err_log.initErrorLogger(OCSD_ERR_SEV_INFO);
+		err_log.setOutputLogger(&logger);
+		
+		// pass err_log reference into snapshot library code
+		SnapShotReader ss_reader;
+		ss_reader.setErrorLogger(&err_log);
+		
+		// ** rest of program 
+	}
+~~~
+	
+In the library code for the snapshot reader (ss_to_dcd_tree.cpp):
+
+~~~{.cpp}	
+	bool CreateDcdTreeFromSnapShot::createDecodeTree()
+	{
+		// ** create a decode tree
+		
+	    // use our error logger - don't use the tree default.
+        m_pDecodeTree->setAlternateErrorLogger(m_pErrLogInterface);
+	}
+	
+~~~
+
+__Note__:  The Snapshot reader library is test code designed to allow the test application read trace snapshots 
+which are in the form defined by the open specification in `./decoder/docs/specs/ARM Trace and Debug Snapshot file format 0v2.pdf`
+
+This format is used in ARM's DS-5 debugger, and the open source CoreSight Access Library (CSAL).
+
+### Configuring decoders ###
+
+The next task is to configure the requried decoders. The client program must know the type of ETM/PTM in use
+to correctly set the decoder configuration.
+
+Each class of trace source has a specific set of register values that the decoder requires to correctly interpret the 
+raw trace data and convert it to packets then fully decode.
+
+Configuration of an ETMv4 decoder requires initialisation of the EtmV4Config class, which is achieved by filling in a 
+@ref ocsd_etmv4_cfg structure:-
+
+~~~{.c}
+	typedef struct _ocsd_etmv4_cfg 
+	{
+		uint32_t                reg_idr0;    /**< ID0 register */
+		uint32_t                reg_idr1;    /**< ID1 register */
+		uint32_t                reg_idr2;    /**< ID2 register */
+		uint32_t                reg_idr8;
+		uint32_t                reg_idr9;   
+		uint32_t                reg_idr10;
+		uint32_t                reg_idr11;
+		uint32_t                reg_idr12;
+		uint32_t                reg_idr13;
+		uint32_t                reg_configr;  /**< Config Register */
+		uint32_t                reg_traceidr;  /**< Trace Stream ID register */
+		ocsd_arch_version_t    arch_ver;   /**< Architecture version */
+		ocsd_core_profile_t    core_prof;  /**< Core Profile */
+	} ocsd_etmv4_cfg;
+~~~
+
+The structure contains a number of read-only ID registers, and key programmable control registers that define
+the trace output features - such as if the ETM will output timestamps or cycle counts - and the CoreSight Trace ID.
+
+Once this structure is filled in then the decoder can be configured in the decode tree:-
+
+~~~{.cpp}
+	ocsd_etmv4_cfg config;
+	
+	// ...
+	// code to fill in config from programmed registers and id registers
+	// ...
+	
+	EtmV4Config configObj(&config);		// initialise decoder config class 
+	std::string decoderName(OCSD_BUILTIN_DCD_ETMV4I);  // use built in ETMv4 instruction decoder.
+	int decoderCreateFlags = OCSD_CREATE_FLG_FULL_DECODER; // decoder type to create - OCSD_CREATE_FLG_PACKET_PROC for packet processor only
+	ocsd_err_t err = pDecodeTree->createDecoder(decoderName, decoderCreateFlags,&configObj);
+~~~
+
+This code creates a full trace decoder for an ETMv4 source, which consists of a packet processor and packet decoder pair. The decoder is automatically associated with the 
+CoreSight Trace ID programmed into the register provided in the `config` structure. 
+
+It is also possible to create a packet processor only decoder if the `OCSD_CREATE_FLG_PACKET_PROC` flag is 
+used instead. These packet only decoders can be used to create a dump of the raw trace as discrete trace packets.
+
+All decoders a registered with the library using a name - the standard ARM protocols are considered built in
+decoders and are registered automatically. The library contains defined names for these decoders - `OCSD_BUILTIN_DCD_ETMV4I`
+ being the name used for ETMv4 protocol.
+
+The C-API uses the call create_generic_decoder() with the same configuration structure:-
+
+~~~{.c}
+	ocsd_etmv4_cfg config;
+	
+	// ...
+	// code to fill in config from programmed registers and id registers
+	// ...
+	
+	const char * decoderName = OCSD_BUILTIN_DCD_ETMV4I);  // use built in ETMv4 instruction decoder.
+	int decoderCreateFlags = OCSD_CREATE_FLG_FULL_DECODER; // decoder type to create - OCSD_CREATE_FLG_PACKET_PROC for packet processor only
+	void *p_context =  // <some_client_context>
+	ocsd_err_t err = create_generic_decoder(dcdtree_handle,decoderName,(void *)&config,p_context);	
+~~~
+
+The configuration must be completed for each trace source in the decode tree which requires decoding.
+
+The different trace source types have different configuration structures, classes and names
+
+| protocol  | config struct       |  class      |  name define                 | 
+|:----------|:--------------------|:------------|:-----------------------------|
+| __ETE__   | @ref ocsd_ete_cfg   | ETEConfig   | @ref OCSD_BUILTIN_DCD_ETE    |
+| __ETMv4__ | @ref ocsd_etmv4_cfg | EtmV4Config | @ref OCSD_BUILTIN_DCD_ETMV4I |
+| __ETMv3__ | @ref ocsd_etmv3_cfg | EtmV3Config | @ref OCSD_BUILTIN_DCD_ETMV3  |
+| __PTM__   | @ref ocsd_ptm_cfg   | PtmConfig   | @ref OCSD_BUILTIN_DCD_PTM    |
+| __STM__   | @ref ocsd_stm_cfg   | STMConfig   | @ref OCSD_BUILTIN_DCD_STM    |
+
+### Adding in Memory Images ###
+
+Memory images are needed when a full trace decode is required. Memory images consist of a base address and length, and 
+contain instruction opcodes that may be executed during the operation of the traced program. The images are used by 
+the decoder to follow the path of the traced program by interpreting the information contained within the trace that 
+defines which program branches are taken and the target addresses of those branches.
+
+The library defined memory image accessor objects, which can be simple memory buffers, files containing the binary
+code image, or a callback that allows the client to handle memory accesses directly. When files are used, the 
+ object may contain a set of base addresses and lengths, with offsets into the file - allowing the decoder 
+ to directly access multiple code segments in executable image files.
+
+Memory image objects are collated by a memory mapper. This interfaces to the decoder through the ITargetMemAccess interface,
+and selects the correct image object for the address requested by the decoder. The memory mapper will also validate image 
+objects as they are added to the decoder, and will not permit overlapping images. 
+
+![Memory Mapper and Memory Images](memacc_objs.jpg)
+
+The client can add memory images to the decoder via API calls to the decode tree. These methods add memory image accessors of various
+types to be managed by a memory access mapper:-
+
+~~~{.cpp}
+	class DecodeTree {
+		// ...
+		ocsd_err_t createMemAccMapper(memacc_mapper_t type = MEMACC_MAP_GLOBAL);
+		// ...
+		ocsd_err_t addBufferMemAcc(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t *p_mem_buffer, const uint32_t mem_length);
+		ocsd_err_t addBinFileMemAcc(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const std::string &filepath);
+		ocsd_err_t addBinFileRegionMemAcc(const ocsd_file_mem_region_t *region_array, const int num_regions, const ocsd_mem_space_acc_t mem_space, const std::string &filepath);     */
+		ocsd_err_t addCallbackMemAcc(const ocsd_vaddr_t st_address, const ocsd_vaddr_t en_address, const ocsd_mem_space_acc_t mem_space, Fn_MemAcc_CB p_cb_func, const void *p_context); 
+		// ...
+	}	
+~~~
+
+The `createMemAccMapper()` function must be called to create the mapper, before the `add...MemAcc()` calls are used.
+
+It is further possible to differentiate between memory image access objects by the memory space for which they are valid. If it is known that a certain code image 
+is present in secure EL3, then an image can be associated with the @ref ocsd_mem_space_acc_t type value @ref OCSD_MEM_SPACE_EL3, which will allow another image to be 
+present at the same address but a different exception level.  However, for the majority of systems, such detailed knowledge of the code is not available, or 
+overlaps across memory spaces do not occur. In these cases, and for general use (including Linux trace decode),  @ref OCSD_MEM_SPACE_ANY should be used.
+
+The C-API contains a similar set of calls to set up memory access objects:-
+
+~~~{.c}
+	OCSD_C_API ocsd_err_t ocsd_dt_add_buffer_mem_acc(const dcd_tree_handle_t handle, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t *p_mem_buffer, const uint32_t mem_length); 
+	OCSD_C_API ocsd_err_t ocsd_dt_add_binfile_mem_acc(const dcd_tree_handle_t handle, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const char *filepath); 
+	OCSD_C_API ocsd_err_t ocsd_dt_add_binfile_region_mem_acc(const dcd_tree_handle_t handle, const ocsd_file_mem_region_t *region_array, const int num_regions, const ocsd_mem_space_acc_t mem_space, const char *filepath); 
+	OCSD_C_API ocsd_err_t ocsd_dt_add_callback_mem_acc(const dcd_tree_handle_t handle, const ocsd_vaddr_t st_address, const ocsd_vaddr_t en_address, const ocsd_mem_space_acc_t mem_space, Fn_MemAcc_CB p_cb_func, const void *p_context); 
+~~~
+
+Note that the C-API will automatically create a default mapper when the first memory access object is added.
+
+### Adding the output callbacks ###
+
+The decoded trace output ia collect by the client application through callback functions registered with the library.
+
+Depending on the decode configuration chosen, this can be in the form of the fully decoded trace output as generic trace
+packets, or discrete trace packets for each trace stream ID.
+
+__Full Decode__
+
+When full decode is chosen then all output is via the generic packet interface:
+
+~~~{.cpp}
+	class ITrcGenElemIn
+	{
+		///...
+		
+		virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop,
+                                              const uint8_t trc_chan_id,
+                                              const OcsdTraceElement &el);
+    }
+~~~
+
+The client application registers a callback class or function with this signature. 
+
+For each output packet the libary calls the registered function,  providing the byte index into the raw trace for the first 
+byte of the trace protocol packet that resulted in its generation, plus the CoreSight trace ID of the source stream, 
+#and the output packet itself.
+
+The client callback must process the packet before returning the call - the reference to the packet data is only 
+valid for the duration of the call. This means that the client will either have to copy and buffer packets for later
+processing if required, process immediately, or use an appropriate combination, dependent on the requirements of the
+client.
+
+The client callback provides a ocsd_datapath_resp_t response code to indicate to the input side of the library if decoding is to continue.
+
+~~~{.cpp}
+	DecodeTree *pTree;
+	TrcGenericElementPrinter genElemPrinter; // derived from ITrcGenElemIn, overrides TraceElemIn() to print incoming packet to logger.
+	
+	///...
+	
+	pTree->setGenTraceElemOutI(genElemPrinter);
+	
+~~~
+
+Alternatively in C-API, the callback function pointer type is defined:-
+
+~~~{.c}
+	typedef ocsd_datapath_resp_t (* FnTraceElemIn)( const void *p_context, 
+													const ocsd_trc_index_t index_sop, 
+													const uint8_t trc_chan_id, 
+													const ocsd_generic_trace_elem *elem); 	
+~~~
+
+giving API calls to set up:-
+
+~~~{.c}
+	FnTraceElemIn gen_pkt_fn = &gen_trace_elem_analyze; // set to function matching signature.
+	dcd_tree_handle_t dcdtree_handle;
+	
+	// ...
+	
+	ret = ocsd_dt_set_gen_elem_outfn(dcdtree_handle, gen_pkt_fn, 0);
+~~~
+
+The output packets and their intepretatation are described here [prog_guide_generic_pkts.md](@ref generic_pkts).
+
+__Packet Process only, or Monitor packets in Full Decode__
+
+The client can set up the library for packet processing only, in which case the library output is 
+the trace packets only, so these packets need a sink callback for each channel being output.
+
+When full decode is in operation, then the principle output is the generic packets that are output for
+all channels in operation to the single callback mentioned above. Additional callbacks can be added to 
+each of the trace channels to monitor the packet processing stage as it happens at point that the packets 
+are passed to the full decoder.
+
+Both methods of processing the discrete trace packets require callbacks to be registered on a 
+per Trace ID / channel basis. The specifics of the callback and the resulting packet will vary according to 
+the protocol of the trace source.
+
+The .cpp interface registers a packet sink / packet monitor object with the relevant decoder object. 
+
+This sink object is based on the tempated IPktDataIn interface.
+
+~~~{.cpp}
+template<class P> class IPktDataIn : public ITrcTypedBase {
+	// ...
+	    virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op,
+                                                const ocsd_trc_index_t index_sop,
+                                                const P *p_packet_in) = 0;
+}
+~~~
+
+The template type parameter will be the protocol type for the trace source in question - e.g. EtmV4ITrcPacket.
+This interface contains a method that will be called with trace packets. 
+
+The monitor object must be based on the IPktRawDataMon class, with a similarly typed template parameter and callback
+function. 
+
+~~~{.cpp}
+template<class P> class IPktRawDataMon : public ITrcTypedBase {
+	// ...
+	    virtual void RawPacketDataMon( const ocsd_datapath_op_t op,
+                                   const ocsd_trc_index_t index_sop,
+                                   const P *pkt,
+                                   const uint32_t size,
+                                   const uint8_t *p_data) = 0;
+}
+~~~
+
+Given a suitable callback object the process for attaching to the decode is as follows:-
+
+~~~{.cpp}
+	// client custom packet sink for ETMv4 - derived from IPktDataIn 
+	class MyTracePacketSinkETMv4 : public IPktDataIn<EtmV4ITrcPacket> {
+		// ...
+	};
+
+	uint8_t CSID;	
+	DecodeTree *pTree;	// pointer to decode tree
+    MyTracePacketSinkETMv4 *pSink;     
+ 
+	// ... obtain CSID and decode tree object
+ 
+	// decode trees manage decode elements using a tree element object, registered against CSID.
+    DecodeTreeElement *pElement = pTree->getDecoderElement(CSID);
+	pSink = new MyTracePacketSinkETMv4();
+	if (pElement && pSink)
+		err = pElement->getDecoderMngr()->attachPktSink(pElement->getDecoderHandle(), pSink);
+            
+~~~
+
+The decode tree object is used to obtain the decode tree element associated with the Coresight trace ID. 
+The IDecoderMngr interface on this object is used to attach the packet sink object to the required decoder.
+
+For monitor objects use an attachPktMonitor() call with a suitably derived monitor sink object.
+
+The key difference between the packet sink, and the packet monitor is that the monitor is not in the trace decode 
+data path, so does not return ocsd_datapath_resp_t values. The monitor callback also provides the raw trace byte 
+data for the packet.
+
+Device tree call for registering a callback in C-API and the function signatures for each type of shown below..
+The C-API code contains underlying managment code that connects the callback with the correct packet decoder object.
+
+~~~{.c}
+OCSD_C_API ocsd_err_t ocsd_dt_attach_packet_callback(  const dcd_tree_handle_t handle,    // decode tree handle
+                                                const unsigned char CSID,				  // trace channel ID
+                                                const ocsd_c_api_cb_types callback_type,  // defines packet only processing sink or monitor function signature.
+                                                void *p_fn_callback_data,                 // pointer to the callback function for the packet data.
+                                                const void *p_context);				      // opaque context to use inside the callback.
+~~~
+
+Callback definition for packet only sink callback type:
+~~~{.c}
+/** function pointer type for packet processor packet output sink, packet analyser/decoder input - generic declaration */
+typedef ocsd_datapath_resp_t (* FnDefPktDataIn)(const void *p_context, 
+                                                const ocsd_datapath_op_t op, 
+                                                const ocsd_trc_index_t index_sop, 
+                                                const void *p_packet_in
+												);
+~~~
+
+Callback  definition for packet monitor callback type
+~~~{.c}
+/** function pointer type for packet processor packet monitor sink, raw packet monitor / display input - generic declaration */
+typedef void (* FnDefPktDataMon)(const void *p_context,
+                                 const ocsd_datapath_op_t op,
+                                 const ocsd_trc_index_t index_sop,
+                                 const void *p_packet_in,
+                                 const uint32_t size,
+                                 const uint8_t *p_data
+								 );
+~~~
+
+As with the `.cpp` code, the monitor callback does not have a return value, but also has the raw trace bytes for the packet as part of
+the monitor.
+
+In both cases in the C-API, the `void *p_packet_in` must be cast to packet structure appropriate to the trace protocol associated with the 
+CSID value. e.g. for ETMv4 this would be @ref ocsd_etmv4_i_pkt. 
+
+
+Programming Examples - using the configured Decode Tree.
+--------------------------------------------------------
+ 
+Once the decode tree has been configured then data raw trace data can be processed through the decode tree.
+
+The client program will require two functions to use the library. The first is on the input side of the library 
+which must be driven with raw data, until the data is complete, or an error occurs. This processing routine must 
+check the library returns and respond appropriately.
+
+The second consists of output callback(s) which process the decoded generic packets, or trace packets. 
+This routine will return response codes according to the needs of the client.
+
+![Trace Data call and response path](decode_data_path_resp.jpg)
+ 
+The diagram shows the data input and response path. The data is driven into the decoding library by the client raw data input 
+routine on the left. Processed packets are received by the client packet callback(s) on the right, and push response codes back
+through the library.
+
+The raw data input routine calls the standard ITrcDataIn interface with an operation code, and if appropriate some raw 
+trace data. The input operation code will define how the library treats the input parameters.
+
+
+| Operation          | Description                                                      | Trace Data provided |
+|:-------------------|:-----------------------------------------------------------------|:--------------------|
+| @ref OCSD_OP_DATA  | Process data provided by data pointer parameters.                | Yes                 |
+| @ref OCSD_OP_FLUSH | Call after prior wait response - finish processing previous data | No                  |
+| @ref OCSD_OP_EOT   | End of trace data. Library will complete any pending decode.     | No                  |
+| @ref OCSD_OP_RESET | Hard reset of decoder state - use current config for new data    | No                  |
+
+A set of standard responses is used to indicate to the raw data input whether it should continue to push data through the library, 
+pause and then flush, or if a fatal processing error has occurred. 
+
+The response codes can come from the internal library decoder, or from the part of the client that is handling the processing of the 
+output packets on the right of the diagram. 
+
+_Response Codes_: The are contained in the @ref _ocsd_datapath_resp_t enum.
+
+- __OCSD_RESP_CONT, OCSD_RESP_CONT_xxx__: 	Indicates that processing is to continue. Generated either internally by the library if more data 
+										is needed to generate an output packet, or by the output packet processors to indicate processing 
+										is to continue.
+- __OCSD_RESP_WAIT, OCSD_RESP_WAIT_xxx:__   Sent by the client processors to pause processing. This will freeze the internal state of the library
+									    and cause the WAIT response to be propogated through to the input side, with an indication of the number
+									    of bytes processed. After a WAIT, the input side must respond with flush operations, until a CONT is 
+										seen again and further data can then be input into the library.
+- __OCSR_RESP_FATAL_xxx__:                  Fatal processing error. No further processing can take place. See error response logger for reason.
+                                        Normally the result of corrupt or incorrect trace data.
+
+The user should note that the client program controls routines on both the input and output side of the library. The output routine may be buffering 
+output packets, and when the buffer is full, returns a WAIT ressponse. This will be propgated through to the input routine. This should now terminate
+data processing, saving state and the client will run a routine to empty / process the full packet buffer. Once the necessary processing is done, 
+then the input routine can be restarted, but __must__ follow the FLUSH operational rule described above.
+
+Excerpts from the data input routine used by the `trc_pkt_lister` program are shown below:
+
+~~~{.cpp}
+                   // process the current buffer load until buffer done, or fatal error occurs
+                    while((nBuffProcessed < nBuffRead) && !OCSD_DATA_RESP_IS_FATAL(dataPathResp))
+                    {
+                        if(OCSD_DATA_RESP_IS_CONT(dataPathResp))
+                        {
+                            dataPathResp = dcd_tree->TraceDataIn(
+                                OCSD_OP_DATA,
+                                trace_index,
+                                (uint32_t)(nBuffRead - nBuffProcessed),
+                                &(trace_buffer[0])+nBuffProcessed,
+                                &nUsedThisTime);
+
+                            nBuffProcessed += nUsedThisTime;
+                            trace_index += nUsedThisTime;
+
+                        }
+                        else // last response was _WAIT
+                        {
+                            // may need to acknowledge a wait from the gen elem printer
+                            if(genElemPrinter->needAckWait())
+                                genElemPrinter->ackWait();
+
+                            // dataPathResp not continue or fatal so must be wait...
+                            dataPathResp = dcd_tree->TraceDataIn(OCSD_OP_FLUSH,0,0,0,0);
+                        }
+                    }
+					
+~~~
+
+_Note_: in this test program, the WAIT response is an artificial test condition, so the input routine does not terminate on seeing it - it is cleared down
+and FLUSH is immediately sent. Normal client routines would most likely drop out of the processing loop, take actions to clear the WAIT condition, then
+resume processing with a FLUSH.
+
+See the `trc_pkt_lister` and `c_api_pkt_print_test` test program source code for further examples of driving data through the library.
diff --git a/decoder/docs/specs/ARM Trace and Debug Snapshot file format 0v2.pdf b/decoder/docs/specs/ARM Trace and Debug Snapshot file format 0v2.pdf
new file mode 100644
index 0000000..7a9b16f
--- /dev/null
+++ b/decoder/docs/specs/ARM Trace and Debug Snapshot file format 0v2.pdf
diff --git a/decoder/docs/test_progs.md b/decoder/docs/test_progs.md
new file mode 100644
index 0000000..3af7692
--- /dev/null
+++ b/decoder/docs/test_progs.md
@@ -0,0 +1,213 @@
+Test Programs    {#test_progs}
+=============
+
+@brief A description of the test programs used with the library.
+
+The Programs
+------------
+
+There are currently two test programs built alongside the library.
+
+1. `trc_pkt_lister` :  This test the C++ library by taking a trace "snapshot" directory as an input 
+and decodes all or a chosen set of trace sources from within the trace data buffers in the library. Command
+line parameters allow the test program to be controlled. 
+
+2. `c_api_pkt_print_test` : This program tests the "C" API functions, using hardcoded tests 
+based on the same "snapshots" used for the C++ library. Limited user control for this program. 
+This can also run tests using the external test decoder to validate the external decoder API. 
+See [external_custom.md](@ref custom_decoders) for details.
+
+These programs are both built at the same time as the library for the same set of platforms.
+See [build_libs.md](@ref build_lib) for build details.
+
+_Note:_ The programs above use the library's [core name mapper helper class] (@ref CoreArchProfileMap) to map 
+the name of the core into a profile / architecture pair that the library can use. 
+The snapshot definition must use one of the names recognised by this class or an error will occur.
+
+Trace "Snapshot" directory.
+----------------------------
+
+The `.\tests\snapshots` directory contains a number of trace snapshots used for testing the library.
+Trace snapshots are dumps of captured binary trace data, CoreSight component configurations and memory 
+dumps to allow trace decode.
+
+Snapshots are generated on ARM targets and can then be analysed offline. The snapshot format is available 
+in a separate document.
+
+The `trc_pkt_lister` program.
+-----------------------------
+
+This will take a snapshot directory as an input, and list and/or decode all the trace packets for a 
+single source, for any currently supported protocol.
+
+The output will be a list of discrete packets, generic output packets and any error messages
+to file and/or screen as selected by the input command line options.
+
+By default the program will list packets only (no decode), for the first discovered trace sink
+(ETB, ETF, ETR) in the snapshot directory, with all streams output.
+
+__Command Line Options__
+
+*Snapshot selection*
+
+- `-ss_dir <dir>` : Set the directory path to a trace snapshot.
+- `-ss_verbose`   : Verbose output when reading the snapshot.
+
+*Decode options*
+
+- `-id <n>`          : Set an ID to list (may be used multiple times) - default if no id set is for all IDs to be printed.
+- `-src_name <name>` : List packets from a given snapshot source name (defaults to first source found).
+- `-tpiu`            : Input data is from a TPIU source that has TPIU FSYNC packets present.
+- `-tpiu_hsync`      : Input data is from a TPIU source that has both TPIU FSYNC and HSYNC packets present.
+- `-decode`          : Full decode of the packets from the trace snapshot (default is to list undecoded packets only.
+- `-decode_only`     : Does not list the undecoded packets, just the trace decode.
+- `-src_addr_n`      : ETE protocol; Indicate skipped N atoms in source address packet ranges by breaking the decode 
+                       range into multiple ranges on N atoms.
+- `-o_raw_packed`    : Output raw packed trace frames.
+- `-o_raw_unpacked`  : Output raw unpacked trace data per ID.
+
+*Output options*
+
+Default is to output to file and stdout. Setting any option overrides and limits to only
+the options set.
+- `-logstdout`          : output to stdout.
+- `-logstderr`          : output to stderr.
+- `-logfile`            : output to file using the default log file name.
+- `-logfilename <name>` : change the name of the output log file.
+
+
+__Test output examples__
+
+Example command lines with short output excerpts.
+
+*TC2, ETMv3 packet processor output, raw packet output.*
+
+Command line:-
+`trc_pkt_lister -ss_dir ..\..\..\snapshots\TC2 -o_raw_unpacked`
+
+~~~~~~~~~~~~~~~~
+Frame Data; Index  17958; ID_DATA[0x11]; 16 04 c0 86 42 97 e1 c4 
+Idx:17945; ID:11;	I_SYNC : Instruction Packet synchronisation.; (Periodic); Addr=0xc00416e2; S;  ISA=Thumb2; 
+Idx:17961; ID:11;	P_HDR : Atom P-header.; WEN; Cycles=1
+Frame Data; Index  17968; ID_DATA[0x11]; ce af 90 80 80 00 a4 84 a0 84 a4 88 
+Idx:17962; ID:11;	TIMESTAMP : Timestamp Value.; TS=0x82f9d13097 (562536984727) 
+Idx:17974; ID:11;	P_HDR : Atom P-header.; WW; Cycles=2
+Idx:17975; ID:11;	P_HDR : Atom P-header.; WE; Cycles=1
+Idx:17976; ID:11;	P_HDR : Atom P-header.; W; Cycles=1
+Idx:17977; ID:11;	P_HDR : Atom P-header.; WE; Cycles=1
+Idx:17978; ID:11;	P_HDR : Atom P-header.; WW; Cycles=2
+Idx:17979; ID:11;	P_HDR : Atom P-header.; WEWE; Cycles=2
+Frame Data; Index  17980; ID_DATA[0x10]; a0 82 
+Idx:17980; ID:10;	P_HDR : Atom P-header.; W; Cycles=1
+Idx:17981; ID:10;	P_HDR : Atom P-header.; WEE; Cycles=1
+Frame Data; Index  17984; ID_DATA[0x10]; b8 84 a4 88 a0 82 
+Idx:17984; ID:10;	P_HDR : Atom P-header.; WWWWWWW; Cycles=7
+Idx:17985; ID:10;	P_HDR : Atom P-header.; WE; Cycles=1
+Idx:17986; ID:10;	P_HDR : Atom P-header.; WW; Cycles=2
+Idx:17987; ID:10;	P_HDR : Atom P-header.; WEWE; Cycles=2
+Idx:17988; ID:10;	P_HDR : Atom P-header.; W; Cycles=1
+Idx:17989; ID:10;	P_HDR : Atom P-header.; WEE; Cycles=1
+~~~~~~~~~~~~~~~~
+
+*Juno - ETB_1 selected for STM packet output, raw packet output*
+
+Command line:-
+`trc_pkt_lister -ss_dir ..\..\..\snapshots\juno_r1_1 -o_raw_unpacked -src_name ETB_1`
+
+~~~~~~~~~~~~~~~~
+Trace Packet Lister: CS Decode library testing
+-----------------------------------------------
+
+Trace Packet Lister : reading snapshot from path ..\..\..\snapshots\juno_r1_1
+Using ETB_1 as trace source
+Trace Packet Lister : STM Protocol on Trace ID 0x20
+Frame Data; Index      0; ID_DATA[0x20]; ff ff ff ff ff ff ff ff ff ff 0f 0f 30 41 
+Idx:0; ID:20;	ASYNC:Alignment synchronisation packet.
+Idx:11; ID:20;	VERSION:Version packet.; Ver=3
+Frame Data; Index     16; ID_DATA[0x20]; f1 1a 00 00 00 30 10 af 01 00 00 10 03 f2 1a 
+Idx:13; ID:20;	M8:Set current master.; Master=0x41
+Idx:17; ID:20;	D32M:32 bit data; with marker.; Data=0x10000000
+Idx:22; ID:20;	C8:Set current channel.; Chan=0x0001
+Idx:23; ID:20;	D32M:32 bit data; with marker.; Data=0x10000001
+Idx:28; ID:20;	C8:Set current channel.; Chan=0x0002
+Frame Data; Index     32; ID_DATA[0x20]; 00 00 00 32 30 af 01 00 00 30 03 f4 1a 00 00 
+Idx:30; ID:20;	D32M:32 bit data; with marker.; Data=0x10000002
+Idx:36; ID:20;	C8:Set current channel.; Chan=0x0003
+Idx:37; ID:20;	D32M:32 bit data; with marker.; Data=0x10000003
+Idx:42; ID:20;	C8:Set current channel.; Chan=0x0004
+Frame Data; Index     48; ID_DATA[0x20]; 00 f4 ff ff ff ff ff ff ff ff ff ff f0 00 13 
+Idx:44; ID:20;	D32M:32 bit data; with marker.; Data=0x10000004
+Idx:50; ID:20;	ASYNC:Alignment synchronisation packet.
+Idx:61; ID:20;	VERSION:Version packet.; Ver=3
+~~~~~~~~~~~~~~~~
+
+*Juno - ETMv4 full trace decode + packet monitor, source trace ID 0x10 only.*
+
+Command line:-
+`trc_pkt_lister -ss_dir ..\..\..\snapshots\juno_r1_1 -decode -id 0x10`
+
+~~~~~~~~~~~~~~~~
+
+Idx:17204; ID:10; [0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x80 ];	I_ASYNC : Alignment Synchronisation.
+Idx:17218; ID:10; [0x01 0x01 0x00 ];	I_TRACE_INFO : Trace Info.; INFO=0x0
+Idx:17221; ID:10; [0x9d 0x00 0x35 0x09 0x00 0xc0 0xff 0xff 0xff ];	I_ADDR_L_64IS0 : Address, Long, 64 bit, IS0.; Addr=0xFFFFFFC000096A00; 
+Idx:17230; ID:10; [0x04 ];	I_TRACE_ON : Trace On.
+Idx:17232; ID:10; [0x85 0x00 0x35 0x09 0x00 0xc0 0xff 0xff 0xff 0xf1 0x00 0x00 0x00 0x00 0x00 ];	I_ADDR_CTXT_L_64IS0 : Address & Context, Long, 64 bit, IS0.; Addr=0xFFFFFFC000096A00; Ctxt: AArch64,EL1, NS; CID=0x00000000; VMID=0x0000;
+Idx:17248; ID:10; [0xf7 ];	I_ATOM_F1 : Atom format 1.; E
+Idx:17230; ID:10; OCSD_GEN_TRC_ELEM_TRACE_ON( [begin or filter])
+Idx:17232; ID:10; OCSD_GEN_TRC_ELEM_PE_CONTEXT((ISA=A64) EL1N; 64-bit; VMID=0x0; CTXTID=0x0; )
+Idx:17248; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000096a00:[0xffffffc000096a10] num_i(4) last_sz(4) (ISA=A64) E ISB )
+Idx:17249; ID:10; [0x9d 0x30 0x25 0x59 0x00 0xc0 0xff 0xff 0xff ];	I_ADDR_L_64IS0 : Address, Long, 64 bit, IS0.; Addr=0xFFFFFFC000594AC0; 
+Idx:17258; ID:10; [0xf7 ];	I_ATOM_F1 : Atom format 1.; E
+Idx:17258; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000594ac0 )
+Idx:17259; ID:10; [0x95 0xd6 0x95 ];	I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0xFFFFFFC000592B58 ~[0x12B58]
+Idx:17262; ID:10; [0xf9 ];	I_ATOM_F3 : Atom format 3.; ENN
+Idx:17262; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000592b58 )
+Idx:17264; ID:10; [0xf7 ];	I_ATOM_F1 : Atom format 1.; E
+Idx:17265; ID:10; [0x9a 0x32 0x62 0x5a 0x00 ];	I_ADDR_L_32IS0 : Address, Long, 32 bit, IS0.; Addr=0xFFFFFFC0005AC4C8; 
+Idx:17270; ID:10; [0xdb ];	I_ATOM_F2 : Atom format 2.; EE
+Idx:17270; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc0005ac4c8 )
+Idx:17271; ID:10; [0x9a 0x62 0x52 0x0e 0x00 ];	I_ADDR_L_32IS0 : Address, Long, 32 bit, IS0.; Addr=0xFFFFFFC0000EA588; 
+Idx:17276; ID:10; [0xfc ];	I_ATOM_F3 : Atom format 3.; NNE
+Idx:17276; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc0000ea588 )
+Idx:17277; ID:10; [0x9a 0x58 0x15 0x59 0x00 ];	I_ADDR_L_32IS0 : Address, Long, 32 bit, IS0.; Addr=0xFFFFFFC000592B60; 
+Idx:17283; ID:10; [0x06 0x1d ];	I_EXCEPT : Exception.;  IRQ; Ret Addr Follows;
+Idx:17285; ID:10; [0x95 0x59 ];	I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0xFFFFFFC000592B64 ~[0x164]
+Idx:17283; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000592b60 )
+Idx:17283; ID:10; OCSD_GEN_TRC_ELEM_EXCEPTION(pref ret addr:0xffffffc000592b64; excep num (0x0e) )
+Idx:17287; ID:10; [0x9a 0x20 0x19 0x08 0x00 ];	I_ADDR_L_32IS0 : Address, Long, 32 bit, IS0.; Addr=0xFFFFFFC000083280; 
+Idx:17292; ID:10; [0xfd ];	I_ATOM_F3 : Atom format 3.; ENE
+Idx:17292; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083280:[0xffffffc000083284] num_i(1) last_sz(4) (ISA=A64) E BR  )
+Idx:17292; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083d40:[0xffffffc000083d9c] num_i(23) last_sz(4) (ISA=A64) N BR   <cond>)
+Idx:17292; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083d9c:[0xffffffc000083dac] num_i(4) last_sz(4) (ISA=A64) E iBR b+link )
+Idx:17293; ID:10; [0x95 0xf7 0x09 ];	I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0xFFFFFFC0000813DC ~[0x13DC]
+Idx:17297; ID:10; [0xdb ];	I_ATOM_F2 : Atom format 2.; EE
+Idx:17297; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc0000813dc:[0xffffffc0000813f0] num_i(5) last_sz(4) (ISA=A64) E BR  b+link )
+Idx:17297; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008f2e0:[0xffffffc00008f2e4] num_i(1) last_sz(4) (ISA=A64) E iBR A64:ret )
+Idx:17298; ID:10; [0x95 0x7e ];	I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0xFFFFFFC0000813F8 ~[0x1F8]
+Idx:17300; ID:10; [0xe0 ];	I_ATOM_F6 : Atom format 6.; EEEN
+Idx:17300; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc0000813f8:[0xffffffc00008140c] num_i(5) last_sz(4) (ISA=A64) E BR  )
+Idx:17300; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008141c:[0xffffffc000081434] num_i(6) last_sz(4) (ISA=A64) E BR   <cond>)
+Idx:17300; ID:10; OCSD_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008140c:[0xffffffc000081414] num_i(2) last_sz(4) (ISA=A64) E BR  b+link )
+Idx:17300; ID:10; OCSD_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000117cf0 )
+
+~~~~~~~~~~~~~~~~
+
+The `c_api_pkt_print_test` program.
+-----------------------------------
+
+Program tests the C-API infrastructure, including as an option the external decoder support. 
+
+Limited to decoding trace from a single CoreSight ID. Uses the same "snapshots" as the C++ test program, but using hardcoded path values.
+
+__Command Line Options__
+
+By default the program will run the single CoreSight ID of 0x10 in packet processing output mode using the ETMv4 decoder on the Juno snapshot.
+
+- `-id <n>`          : Change the ID used for the test.
+- `-etmv3`           : Test the ETMv3 decoder - uses the TC2 snapshot.
+- `-ptm`             : Test the PTM decoder - uses the TC2 snapshot.
+- `-stm`             : Test the STM decoder - uses juno STM only snapshot.
+- `-extern`          : Use the 'echo_test' external decoder to test the custom decoder API.
+- `-decode`          : Output trace protocol packets and full decode generic packets.
+- `-decode_only`     : Output full decode generic packets only.