xref: /OK3568_Linux_fs/kernel/tools/perf/util/arm-spe-decoder/arm-spe-pkt-decoder.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Arm Statistical Profiling Extensions (SPE) support
4*4882a593Smuzhiyun  * Copyright (c) 2017-2018, Arm Ltd.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef INCLUDE__ARM_SPE_PKT_DECODER_H__
8*4882a593Smuzhiyun #define INCLUDE__ARM_SPE_PKT_DECODER_H__
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <stddef.h>
11*4882a593Smuzhiyun #include <stdint.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #define ARM_SPE_PKT_DESC_MAX		256
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define ARM_SPE_NEED_MORE_BYTES		-1
16*4882a593Smuzhiyun #define ARM_SPE_BAD_PACKET		-2
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define ARM_SPE_PKT_MAX_SZ		16
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun enum arm_spe_pkt_type {
21*4882a593Smuzhiyun 	ARM_SPE_BAD,
22*4882a593Smuzhiyun 	ARM_SPE_PAD,
23*4882a593Smuzhiyun 	ARM_SPE_END,
24*4882a593Smuzhiyun 	ARM_SPE_TIMESTAMP,
25*4882a593Smuzhiyun 	ARM_SPE_ADDRESS,
26*4882a593Smuzhiyun 	ARM_SPE_COUNTER,
27*4882a593Smuzhiyun 	ARM_SPE_CONTEXT,
28*4882a593Smuzhiyun 	ARM_SPE_OP_TYPE,
29*4882a593Smuzhiyun 	ARM_SPE_EVENTS,
30*4882a593Smuzhiyun 	ARM_SPE_DATA_SOURCE,
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun struct arm_spe_pkt {
34*4882a593Smuzhiyun 	enum arm_spe_pkt_type	type;
35*4882a593Smuzhiyun 	unsigned char		index;
36*4882a593Smuzhiyun 	uint64_t		payload;
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #define SPE_ADDR_PKT_HDR_INDEX_INS		(0x0)
40*4882a593Smuzhiyun #define SPE_ADDR_PKT_HDR_INDEX_BRANCH		(0x1)
41*4882a593Smuzhiyun #define SPE_ADDR_PKT_HDR_INDEX_DATA_VIRT	(0x2)
42*4882a593Smuzhiyun #define SPE_ADDR_PKT_HDR_INDEX_DATA_PHYS	(0x3)
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #define SPE_ADDR_PKT_NS				BIT(7)
45*4882a593Smuzhiyun #define SPE_ADDR_PKT_CH				BIT(6)
46*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL_OFFSET			(5)
47*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL_MASK			(0x3 << SPE_ADDR_PKT_EL_OFFSET)
48*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL0			(0)
49*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL1			(1)
50*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL2			(2)
51*4882a593Smuzhiyun #define SPE_ADDR_PKT_EL3			(3)
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun const char *arm_spe_pkt_name(enum arm_spe_pkt_type);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun int arm_spe_get_packet(const unsigned char *buf, size_t len,
56*4882a593Smuzhiyun 		       struct arm_spe_pkt *packet);
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun int arm_spe_pkt_desc(const struct arm_spe_pkt *packet, char *buf, size_t len);
59*4882a593Smuzhiyun #endif
60