util/cs-etm-decoder/cs-etm-decoder.h

0001 /*
0002  * SPDX-License-Identifier: GPL-2.0
0003  *
0004  * Copyright(C) 2015-2018 Linaro Limited.
0005  *
0006  * Author: Tor Jeremiassen <tor@ti.com>
0007  * Author: Mathieu Poirier <mathieu.poirier@linaro.org>
0008  */
0009
0010 #ifndef INCLUDE__CS_ETM_DECODER_H__
0011 #define INCLUDE__CS_ETM_DECODER_H__
0012
0013 #include <linux/types.h>
0014 #include <stdio.h>
0015
0016 struct cs_etm_decoder;
0017 struct cs_etm_packet;
0018 struct cs_etm_packet_queue;
0019
0020 struct cs_etm_queue;
0021
0022 typedef u32 (*cs_etm_mem_cb_type)(struct cs_etm_queue *, u8, u64, size_t, u8 *);
0023
0024 struct cs_etmv3_trace_params {
0025     u32 reg_ctrl;
0026     u32 reg_trc_id;
0027     u32 reg_ccer;
0028     u32 reg_idr;
0029 };
0030
0031 struct cs_etmv4_trace_params {
0032     u32 reg_idr0;
0033     u32 reg_idr1;
0034     u32 reg_idr2;
0035     u32 reg_idr8;
0036     u32 reg_configr;
0037     u32 reg_traceidr;
0038 };
0039
0040 struct cs_ete_trace_params {
0041     u32 reg_idr0;
0042     u32 reg_idr1;
0043     u32 reg_idr2;
0044     u32 reg_idr8;
0045     u32 reg_configr;
0046     u32 reg_traceidr;
0047     u32 reg_devarch;
0048 };
0049
0050 struct cs_etm_trace_params {
0051     int protocol;
0052     union {
0053         struct cs_etmv3_trace_params etmv3;
0054         struct cs_etmv4_trace_params etmv4;
0055         struct cs_ete_trace_params ete;
0056     };
0057 };
0058
0059 struct cs_etm_decoder_params {
0060     int operation;
0061     void (*packet_printer)(const char *msg);
0062     cs_etm_mem_cb_type mem_acc_cb;
0063     u8 formatted;
0064     u8 fsyncs;
0065     u8 hsyncs;
0066     u8 frame_aligned;
0067     void *data;
0068 };
0069
0070 /*
0071  * The following enums are indexed starting with 1 to align with the
0072  * open source coresight trace decoder library.
0073  */
0074 enum {
0075     CS_ETM_PROTO_ETMV3 = 1,
0076     CS_ETM_PROTO_ETMV4i,
0077     CS_ETM_PROTO_ETMV4d,
0078     CS_ETM_PROTO_PTM,
0079     CS_ETM_PROTO_ETE
0080 };
0081
0082 enum cs_etm_decoder_operation {
0083     CS_ETM_OPERATION_PRINT = 1,
0084     CS_ETM_OPERATION_DECODE,
0085     CS_ETM_OPERATION_MAX,
0086 };
0087
0088 int cs_etm_decoder__process_data_block(struct cs_etm_decoder *decoder,
0089                        u64 indx, const u8 *buf,
0090                        size_t len, size_t *consumed);
0091
0092 struct cs_etm_decoder *
0093 cs_etm_decoder__new(int num_cpu,
0094             struct cs_etm_decoder_params *d_params,
0095             struct cs_etm_trace_params t_params[]);
0096
0097 void cs_etm_decoder__free(struct cs_etm_decoder *decoder);
0098
0099 int cs_etm_decoder__add_mem_access_cb(struct cs_etm_decoder *decoder,
0100                       u64 start, u64 end,
0101                       cs_etm_mem_cb_type cb_func);
0102
0103 int cs_etm_decoder__get_packet(struct cs_etm_packet_queue *packet_queue,
0104                    struct cs_etm_packet *packet);
0105
0106 int cs_etm_decoder__reset(struct cs_etm_decoder *decoder);
0107 const char *cs_etm_decoder__get_name(struct cs_etm_decoder *decoder);
0108
0109 #endif /* INCLUDE__CS_ETM_DECODER_H__ */