diff options
author | Andrew Turner <andrew@FreeBSD.org> | 2020-06-15 11:30:04 +0000 |
---|---|---|
committer | Andrew Turner <andrew@FreeBSD.org> | 2020-06-15 11:30:04 +0000 |
commit | d7aa8d0a1f110421252d79f5acfb72d89187ad1f (patch) | |
tree | 8b0efac880d3949a9d25ab9bb34792eac605eee6 /decoder/docs | |
parent | cf98ba14dc260458f757fa46419575cf69f45a44 (diff) | |
download | src-vendor/opencsd.tar.gz src-vendor/opencsd.zip |
Import OpenCSD v0.14.2vendor/opencsd/v0.14.2vendor/opencsd
Sponsored by: Innovate UK
Notes
Notes:
svn path=/vendor/opencsd/dist/; revision=362193
svn path=/vendor/opencsd/v0.14.2/; revision=362194; tag=vendor/opencsd/v0.14.2
Diffstat (limited to 'decoder/docs')
-rw-r--r-- | decoder/docs/doxygen_config.dox | 2 | ||||
-rw-r--r-- | decoder/docs/prog_guide/prog_guide_generic_pkts.md | 15 | ||||
-rw-r--r-- | decoder/docs/test_progs.md | 3 |
3 files changed, 18 insertions, 2 deletions
diff --git a/decoder/docs/doxygen_config.dox b/decoder/docs/doxygen_config.dox index 0ca0cf7349b0..3913d3ac5ea5 100644 --- a/decoder/docs/doxygen_config.dox +++ b/decoder/docs/doxygen_config.dox @@ -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.10.0 +PROJECT_NUMBER = 0.14.2 # 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 diff --git a/decoder/docs/prog_guide/prog_guide_generic_pkts.md b/decoder/docs/prog_guide/prog_guide_generic_pkts.md index 9f69aacad44e..e4d50b79fc80 100644 --- a/decoder/docs/prog_guide/prog_guide_generic_pkts.md +++ b/decoder/docs/prog_guide/prog_guide_generic_pkts.md @@ -83,7 +83,7 @@ typedef struct _ocsd_generic_trace_elem { trace_on_reason_t trace_on_reason; /* reason for the trace on packet */ ocsd_swt_info_t sw_trace_info; /* software trace packet info */ uint32_t num_instr_range; /* number of instructions covered by range packet (for T32 this cannot be calculated from en-st/i_size) */ - + unsync_info_t unsync_eot_info; /* additional information for unsync / end-of-trace packets. */ }; const void *ptr_extended_data; /* pointer to extended data buffer (data trace, sw trace payload) / custom structure */ @@ -142,6 +142,19 @@ __ETMv3, PTM__ : These protocols can output a cycle count directly as part of th the trace range. In this case `has_cc` will be 1 and `cycle_count` will be valid. +### OCSD_GEN_TRC_ELEM_I_RANGE_NOPATH ### +__packet fields valid__: `isa, st_addr, en_addr, num_instr_range` + +`num_instr_range` represents the number of instructions executed in this range, but there is incomplete information +as to program execution path from start to end of range. +If `num_instr` is 0, then an unknown number of instructions were executed between the start and end of the range. +`st_addr` represents the start of execution represented by this packet. +`en_addr` represents the address where execution will continue from after the instructions represented by this packet. +`isa` represents the ISA for the instruction at `en_addr`. + +Used when ETMv4 Q elements are being traced. + + ### OCSD_GEN_TRC_ELEM_ADDR_NACC ### __packet fields valid__: `st_addr` diff --git a/decoder/docs/test_progs.md b/decoder/docs/test_progs.md index 27194553f230..c02d02e96271 100644 --- a/decoder/docs/test_progs.md +++ b/decoder/docs/test_progs.md @@ -20,6 +20,9 @@ See [external_custom.md](@ref custom_decoders) for details. These programs are both built at the same time as the library for the same set of platforms. See [build_libs.md](@ref build_lib) for build details. +_Note:_ The programs above use the library's [core name mapper helper class] (@ref CoreArchProfileMap) to map +the name of the core into a profile / architecture pair that the library can use. +The snapshot definition must use one of the names recognised by this class or an error will occur. Trace "Snapshot" directory. ---------------------------- |