diff options
| author | Ruslan Bukin <br@FreeBSD.org> | 2019-10-10 13:19:21 +0000 |
|---|---|---|
| committer | Ruslan Bukin <br@FreeBSD.org> | 2019-10-10 13:19:21 +0000 |
| commit | cf98ba14dc260458f757fa46419575cf69f45a44 (patch) | |
| tree | 1cafc844f372337d2a95c8a416b915d46bf4daf8 /decoder/docs | |
| parent | a6157d81121ac9559d806dafa346039199598442 (diff) | |
Notes
Diffstat (limited to 'decoder/docs')
| -rw-r--r-- | decoder/docs/build_libs.md | 89 | ||||
| -rw-r--r-- | decoder/docs/doxygen_config.dox | 341 | ||||
| -rw-r--r-- | decoder/docs/prog_guide/cs_trace_hw.jpg | bin | 0 -> 78065 bytes | |||
| -rw-r--r-- | decoder/docs/prog_guide/decode_data_path_resp.jpg | bin | 0 -> 29840 bytes | |||
| -rw-r--r-- | decoder/docs/prog_guide/dt_components.jpg | bin | 0 -> 59125 bytes | |||
| -rw-r--r-- | decoder/docs/prog_guide/lib_usage.jpg | bin | 0 -> 36058 bytes | |||
| -rw-r--r-- | decoder/docs/prog_guide/memacc_objs.jpg | bin | 0 -> 42596 bytes | |||
| -rw-r--r-- | decoder/docs/prog_guide/prog_guide_generic_pkts.md | 400 | ||||
| -rw-r--r-- | decoder/docs/prog_guide/prog_guide_main.md | 597 | ||||
| -rw-r--r-- | decoder/docs/test_progs.md | 61 |
10 files changed, 1318 insertions, 170 deletions
diff --git a/decoder/docs/build_libs.md b/decoder/docs/build_libs.md index b7c8536ca5f0..dc7d85da9401 100644 --- a/decoder/docs/build_libs.md +++ b/decoder/docs/build_libs.md @@ -6,47 +6,102 @@ Building and using the Library {#build_lib} Platform Support ---------------- -The current makefiles and build projects support building the library on Linux and Windows, -x86 or x64 hosts. - -Support is expected for ARM linux and baremetal, AArch32 and AArch64 platforms. +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. +The library and test programs are built from the library `./build/<platform>` directory, where +<platform> is either 'linux' or 'win-vs2015' See [`./docs/test_progs.md`](@ref test_progs) for further information on use of the test programs. -### Linux x86/x64 ### +### 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. -Go to the `./build/linux/` and run `make` in that directory. +e.g. -Options to pass to the makefile are:- -- `LINUX64=1` : build the 64 bit version of the library +`./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. -Libraries are delivered to the `./lib/linux<bitsize>/<dbg\rel>` directories. -e.g. `./lib/linux64/rel` will contain the linux 64 bit release libraries. +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. -The following libraries are built:- -- `libcstraced.so` : shared library containing the main C++ based decoder library -- `libcstraced_c_api.so` : shared library containing the C-API wrapper library. Dependent on `libcstraced.so` +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/linux<bitsize>/<dgb\rel>` directories. +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/linux<bitsize>/<dgb\rel>` directories. +This is the `libsnapshot_parser.a` library, delivered to the `./tests/lib/<tgt_dir>` directories. + +__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 ### +### 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. diff --git a/decoder/docs/doxygen_config.dox b/decoder/docs/doxygen_config.dox index acc6137f4264..0ca0cf7349b0 100644 --- a/decoder/docs/doxygen_config.dox +++ b/decoder/docs/doxygen_config.dox @@ -1,4 +1,4 @@ -# Doxyfile 1.8.8 +# Doxyfile 1.8.12 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -38,7 +38,7 @@ PROJECT_NAME = "OpenCSD - CoreSight Trace Decode Library" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.5 +PROJECT_NUMBER = 0.10.0 # 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 @@ -46,10 +46,10 @@ PROJECT_NUMBER = 0.5 PROJECT_BRIEF = -# With the PROJECT_LOGO tag one can specify an logo or 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. +# 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 = @@ -60,7 +60,7 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = ./. -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# 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 @@ -93,14 +93,14 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# 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 +# 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 @@ -145,7 +145,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# 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. @@ -215,9 +215,9 @@ MULTILINE_CPP_IS_BRIEF = NO 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. +# 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 @@ -286,7 +286,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # 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: 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. @@ -303,10 +303,19 @@ EXTENSION_MAPPING = 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 by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. +# 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 @@ -346,13 +355,20 @@ SIP_SUPPORT = NO 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 +# 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 @@ -411,7 +427,7 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# 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. @@ -421,35 +437,35 @@ LOOKUP_CACHE_SIZE = 0 EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# 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 +# 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 +# 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 +# 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. When set to YES local methods, +# 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 in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. @@ -474,21 +490,21 @@ 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. +# 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 +# (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 +# 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. @@ -502,7 +518,7 @@ HIDE_IN_BODY_DOCS = 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 +# 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. @@ -511,12 +527,19 @@ INTERNAL_DOCS = NO 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 +# 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. @@ -544,14 +567,14 @@ 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. +# 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 +# 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. @@ -596,27 +619,25 @@ SORT_BY_SCOPE_NAME = 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 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 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 +# 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 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. @@ -641,8 +662,8 @@ ENABLED_SECTIONS = 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 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 @@ -706,7 +727,7 @@ CITE_BIB_FILES = 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 +# 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. @@ -714,7 +735,7 @@ QUIET = NO WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# 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. @@ -731,12 +752,18 @@ 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. +# 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 @@ -760,22 +787,25 @@ WARN_LOGFILE = # 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. +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = ../include \ ../include/interfaces \ - ../include/etmv3 \ - ../include/etmv4 \ - ../include/ptm \ - ../include/c_api \ - ../include/stm \ + ../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 \ - ../include + ./prog_guide \ + ../include/opencsd \ + ../include \ + ../tests/auto-fdo/autofdo.md # 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 @@ -788,12 +818,17 @@ 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. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. +# *.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 \ @@ -904,7 +939,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = +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 @@ -920,6 +955,10 @@ IMAGE_PATH = # 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 = @@ -929,11 +968,15 @@ INPUT_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 +# 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. @@ -993,7 +1036,7 @@ REFERENCED_BY_RELATION = 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 +# 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. @@ -1040,13 +1083,13 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES -# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# 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 -# compiled with the --with-libclang option. +# generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO @@ -1089,7 +1132,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1155,10 +1198,10 @@ HTML_STYLESHEET = # 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 therefor more robust against future updates. +# 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 stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the +# 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. @@ -1175,7 +1218,7 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to +# 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 @@ -1206,8 +1249,9 @@ 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 NO can help when comparing the output of multiple runs. -# The default value is: YES. +# 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 @@ -1303,28 +1347,28 @@ GENERATE_HTMLHELP = NO 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 +# 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 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) +# 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 +# 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. @@ -1438,7 +1482,7 @@ DISABLE_INDEX = NO # 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 stylesheets (see HTML_EXTRA_STYLESHEET) one can +# 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 @@ -1466,7 +1510,7 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# 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. @@ -1495,7 +1539,7 @@ 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 prerendered bitmaps. Use this if you do not have LaTeX +# 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. @@ -1581,7 +1625,7 @@ SERVER_BASED_SEARCH = NO # 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 +# 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/). # @@ -1594,7 +1638,7 @@ 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 +# 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. @@ -1632,7 +1676,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1663,7 +1707,7 @@ LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX +# 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. @@ -1681,9 +1725,12 @@ COMPACT_LATEX = NO 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. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times +# 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. @@ -1698,9 +1745,9 @@ EXTRA_PACKAGES = # 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 empy string, -# for the replacement values of the other commands the user is refered to -# HTML_HEADER. +# $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 = @@ -1716,6 +1763,17 @@ LATEX_HEADER = 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 @@ -1734,7 +1792,7 @@ LATEX_EXTRA_FILES = 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 +# 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. @@ -1775,11 +1833,19 @@ LATEX_SOURCE_CODE = NO 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 +# 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. @@ -1794,7 +1860,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES doxygen generates more compact 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. @@ -1831,11 +1897,21 @@ RTF_STYLESHEET_FILE = 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 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1879,7 +1955,7 @@ 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 +# 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. @@ -1893,7 +1969,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program +# 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. @@ -1906,7 +1982,7 @@ XML_PROGRAMLISTING = YES # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files +# 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. @@ -1920,7 +1996,7 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the +# 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. @@ -1933,10 +2009,10 @@ 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. +# 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 @@ -1945,7 +2021,7 @@ 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 +# 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. @@ -1953,7 +2029,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary +# 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. @@ -1961,9 +2037,9 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely +# 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 +# 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. @@ -1983,14 +2059,14 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all +# 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 +# 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. @@ -2006,7 +2082,7 @@ MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES the includes files in the +# 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. @@ -2082,20 +2158,21 @@ TAGFILES = 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. +# 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 +# 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 +# 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. @@ -2112,14 +2189,14 @@ 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 +# 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 = NO +CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see: @@ -2137,7 +2214,7 @@ MSCGEN_PATH = DIA_PATH = -# If set to YES, the inheritance and collaboration graphs will hide inheritance +# 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. @@ -2210,7 +2287,7 @@ COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# 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. @@ -2262,7 +2339,8 @@ INCLUDED_BY_GRAPH = YES # # 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. +# 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. @@ -2273,7 +2351,8 @@ CALL_GRAPH = YES # # 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. +# 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. @@ -2296,11 +2375,15 @@ GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. +# 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 and svg. +# 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. @@ -2348,10 +2431,14 @@ DIAFILE_DIRS = # 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. -# This tag requires that the tag HAVE_DOT is set to YES. 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 @@ -2388,7 +2475,7 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# 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. @@ -2405,7 +2492,7 @@ DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot +# 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. diff --git a/decoder/docs/prog_guide/cs_trace_hw.jpg b/decoder/docs/prog_guide/cs_trace_hw.jpg Binary files differnew file mode 100644 index 000000000000..af88f51455f4 --- /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 Binary files differnew file mode 100644 index 000000000000..eb7edb9e40e3 --- /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 Binary files differnew file mode 100644 index 000000000000..0b0270d995b0 --- /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 Binary files differnew file mode 100644 index 000000000000..6baaa12344b3 --- /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 Binary files differnew file mode 100644 index 000000000000..ad329d4bdf2c --- /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 000000000000..9f69aacad44e --- /dev/null +++ b/decoder/docs/prog_guide/prog_guide_generic_pkts.md @@ -0,0 +1,400 @@ +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) */ + + }; + + 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_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_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 000000000000..87afbf0225c6 --- /dev/null +++ b/decoder/docs/prog_guide/prog_guide_main.md @@ -0,0 +1,597 @@ +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 + + + +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: + + + +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. + +  + + 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 will use a default error logger from the library - with a message logger +that will output to `stderr`. Client applications can adjust the configuration of this error logger and +message logger, or 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 | +|:----------|:--------------------|:------------|:-----------------------------| +| __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. + + + +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 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); + ///... + } +~~~ + +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); +~~~ + + +### 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. + + + +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/test_progs.md b/decoder/docs/test_progs.md index 51cb526085a7..27194553f230 100644 --- a/decoder/docs/test_progs.md +++ b/decoder/docs/test_progs.md @@ -52,8 +52,10 @@ __Command Line Options__ *Decode options* -- `-id <n>` : Set an ID to list (may be used mutiple times) - default if no id set is for all IDs to be printed. +- `-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. - `-o_raw_packed` : Output raw packed trace frames. @@ -140,42 +142,49 @@ Command line:- `trc_pkt_lister -ss_dir ..\..\..\snapshots\juno_r1_1 -decode -id 0x10` ~~~~~~~~~~~~~~~~ -Idx:17230; ID:10; RCTDL_GEN_TRC_ELEM_TRACE_ON() -Idx:17232; ID:10; RCTDL_GEN_TRC_ELEM_PE_CONTEXT(EL1N; AArch64; VMID=0x0; CTXTID=0x0; ) -Idx:17248; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000096a00:[0xffffffc000096a10] ) + +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; RCTDL_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000594ac0 ) +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; RCTDL_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000592b58 ) +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=0x005AC4C8; +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; RCTDL_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=0x000EA588; +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; RCTDL_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=0x00592B60; +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=0x00592B64 ~[0x164] -Idx:17283; ID:10; RCTDL_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=0x00083280; +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; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083280:[0xffffffc000083284] ) -Idx:17292; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083d40:[0xffffffc000083d9c] ) -Idx:17292; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc000083d9c:[0xffffffc000083dac] ) -Idx:17293; ID:10; [0x95 0xf7 0x09 ]; I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0x000813DC ~[0x13DC] +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; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc0000813dc:[0xffffffc0000813f0] ) -Idx:17297; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008f2e0:[0xffffffc00008f2e4] ) -Idx:17298; ID:10; [0x95 0x7e ]; I_ADDR_S_IS0 : Address, Short, IS0.; Addr=0x000813F8 ~[0x1F8] +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; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc0000813f8:[0xffffffc00008140c] ) -Idx:17300; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008141c:[0xffffffc000081434] ) -Idx:17300; ID:10; RCTDL_GEN_TRC_ELEM_INSTR_RANGE(exec range=0xffffffc00008140c:[0xffffffc000081414] ) -Idx:17300; ID:10; RCTDL_GEN_TRC_ELEM_ADDR_NACC( 0xffffffc000117cf0 ) - +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 ) ~~~~~~~~~~~~~~~~ |
