xref: /OK3568_Linux_fs/kernel/tools/perf/util/arm-spe-decoder/arm-spe-decoder.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * arm_spe_decoder.h: Arm Statistical Profiling Extensions support
4*4882a593Smuzhiyun  * Copyright (c) 2019-2020, Arm Ltd.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef INCLUDE__ARM_SPE_DECODER_H__
8*4882a593Smuzhiyun #define INCLUDE__ARM_SPE_DECODER_H__
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <stdbool.h>
11*4882a593Smuzhiyun #include <stddef.h>
12*4882a593Smuzhiyun #include <stdint.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include "arm-spe-pkt-decoder.h"
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun enum arm_spe_events {
17*4882a593Smuzhiyun 	EV_EXCEPTION_GEN	= 0,
18*4882a593Smuzhiyun 	EV_RETIRED		= 1,
19*4882a593Smuzhiyun 	EV_L1D_ACCESS		= 2,
20*4882a593Smuzhiyun 	EV_L1D_REFILL		= 3,
21*4882a593Smuzhiyun 	EV_TLB_ACCESS		= 4,
22*4882a593Smuzhiyun 	EV_TLB_WALK		= 5,
23*4882a593Smuzhiyun 	EV_NOT_TAKEN		= 6,
24*4882a593Smuzhiyun 	EV_MISPRED		= 7,
25*4882a593Smuzhiyun 	EV_LLC_ACCESS		= 8,
26*4882a593Smuzhiyun 	EV_LLC_MISS		= 9,
27*4882a593Smuzhiyun 	EV_REMOTE_ACCESS	= 10,
28*4882a593Smuzhiyun 	EV_ALIGNMENT		= 11,
29*4882a593Smuzhiyun 	EV_PARTIAL_PREDICATE	= 17,
30*4882a593Smuzhiyun 	EV_EMPTY_PREDICATE	= 18,
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun enum arm_spe_sample_type {
34*4882a593Smuzhiyun 	ARM_SPE_L1D_ACCESS	= 1 << 0,
35*4882a593Smuzhiyun 	ARM_SPE_L1D_MISS	= 1 << 1,
36*4882a593Smuzhiyun 	ARM_SPE_LLC_ACCESS	= 1 << 2,
37*4882a593Smuzhiyun 	ARM_SPE_LLC_MISS	= 1 << 3,
38*4882a593Smuzhiyun 	ARM_SPE_TLB_ACCESS	= 1 << 4,
39*4882a593Smuzhiyun 	ARM_SPE_TLB_MISS	= 1 << 5,
40*4882a593Smuzhiyun 	ARM_SPE_BRANCH_MISS	= 1 << 6,
41*4882a593Smuzhiyun 	ARM_SPE_REMOTE_ACCESS	= 1 << 7,
42*4882a593Smuzhiyun };
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun struct arm_spe_record {
45*4882a593Smuzhiyun 	enum arm_spe_sample_type type;
46*4882a593Smuzhiyun 	int err;
47*4882a593Smuzhiyun 	u64 from_ip;
48*4882a593Smuzhiyun 	u64 to_ip;
49*4882a593Smuzhiyun 	u64 timestamp;
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun struct arm_spe_insn;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun struct arm_spe_buffer {
55*4882a593Smuzhiyun 	const unsigned char *buf;
56*4882a593Smuzhiyun 	size_t len;
57*4882a593Smuzhiyun 	u64 offset;
58*4882a593Smuzhiyun 	u64 trace_nr;
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun struct arm_spe_params {
62*4882a593Smuzhiyun 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
63*4882a593Smuzhiyun 	void *data;
64*4882a593Smuzhiyun };
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun struct arm_spe_decoder {
67*4882a593Smuzhiyun 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
68*4882a593Smuzhiyun 	void *data;
69*4882a593Smuzhiyun 	struct arm_spe_record record;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	const unsigned char *buf;
72*4882a593Smuzhiyun 	size_t len;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	struct arm_spe_pkt packet;
75*4882a593Smuzhiyun };
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun struct arm_spe_decoder *arm_spe_decoder_new(struct arm_spe_params *params);
78*4882a593Smuzhiyun void arm_spe_decoder_free(struct arm_spe_decoder *decoder);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun int arm_spe_decode(struct arm_spe_decoder *decoder);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun #endif
83