tools/perf/util/cs-etm-decoder/cs-etm-decoder.h
Source file repositories/reference/linux-study-clean/tools/perf/util/cs-etm-decoder/cs-etm-decoder.h
File Facts
- System
- Linux kernel
- Corpus path
tools/perf/util/cs-etm-decoder/cs-etm-decoder.h- Extension
.h- Size
- 2457 bytes
- Lines
- 112
- Domain
- Support Tooling And Documentation
- Bucket
- tools
- Inferred role
- Support Tooling And Documentation: implementation source
- Status
- source implementation candidate
Why This File Exists
Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/types.hopencsd/ocsd_if_types.hstdio.h
Detected Declarations
struct cs_etm_decoderstruct cs_etm_packetstruct cs_etm_packet_queuestruct cs_etm_queuestruct cs_etmv3_trace_paramsstruct cs_etmv4_trace_paramsstruct cs_ete_trace_paramsstruct cs_etm_trace_paramsstruct cs_etm_decoder_paramsenum cs_etm_decoder_operation
Annotated Snippet
struct cs_etmv3_trace_params {
u32 reg_ctrl;
u32 reg_trc_id;
u32 reg_ccer;
u32 reg_idr;
};
struct cs_etmv4_trace_params {
u32 reg_idr0;
u32 reg_idr1;
u32 reg_idr2;
u32 reg_idr8;
u32 reg_configr;
u32 reg_traceidr;
};
struct cs_ete_trace_params {
u32 reg_idr0;
u32 reg_idr1;
u32 reg_idr2;
u32 reg_idr8;
u32 reg_configr;
u32 reg_traceidr;
u32 reg_devarch;
};
struct cs_etm_trace_params {
int protocol;
union {
struct cs_etmv3_trace_params etmv3;
struct cs_etmv4_trace_params etmv4;
struct cs_ete_trace_params ete;
};
};
struct cs_etm_decoder_params {
int operation;
void (*packet_printer)(const char *msg, void *data);
cs_etm_mem_cb_type mem_acc_cb;
bool formatted;
bool fsyncs;
bool hsyncs;
bool frame_aligned;
void *data;
};
/*
* The following enums are indexed starting with 1 to align with the
* open source coresight trace decoder library.
*/
enum {
CS_ETM_PROTO_ETMV3 = 1,
CS_ETM_PROTO_ETMV4i,
CS_ETM_PROTO_ETMV4d,
CS_ETM_PROTO_PTM,
CS_ETM_PROTO_ETE
};
enum cs_etm_decoder_operation {
CS_ETM_OPERATION_PRINT = 1,
CS_ETM_OPERATION_DECODE,
CS_ETM_OPERATION_MAX,
};
int cs_etm_decoder__process_data_block(struct cs_etm_decoder *decoder,
u64 indx, const u8 *buf,
size_t len, size_t *consumed);
struct cs_etm_decoder *
cs_etm_decoder__new(int num_cpu,
struct cs_etm_decoder_params *d_params,
struct cs_etm_trace_params t_params[]);
void cs_etm_decoder__free(struct cs_etm_decoder *decoder);
int cs_etm_decoder__add_mem_access_cb(struct cs_etm_decoder *decoder,
u64 start, u64 end,
cs_etm_mem_cb_type cb_func);
int cs_etm_decoder__get_packet(struct cs_etm_packet_queue *packet_queue,
struct cs_etm_packet *packet);
int cs_etm_decoder__reset(struct cs_etm_decoder *decoder);
const char *cs_etm_decoder__get_name(struct cs_etm_decoder *decoder);
#endif /* INCLUDE__CS_ETM_DECODER_H__ */
Annotation
- Immediate include surface: `linux/types.h`, `opencsd/ocsd_if_types.h`, `stdio.h`.
- Detected declarations: `struct cs_etm_decoder`, `struct cs_etm_packet`, `struct cs_etm_packet_queue`, `struct cs_etm_queue`, `struct cs_etmv3_trace_params`, `struct cs_etmv4_trace_params`, `struct cs_ete_trace_params`, `struct cs_etm_trace_params`, `struct cs_etm_decoder_params`, `enum cs_etm_decoder_operation`.
- Atlas domain: Support Tooling And Documentation / tools.
- Implementation status: source implementation candidate.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.