1
2
3
4
5
6
7#ifndef INCLUDE__ARM_SPE_PKT_DECODER_H__
8#define INCLUDE__ARM_SPE_PKT_DECODER_H__
9
10#include <stddef.h>
11#include <stdint.h>
12
13#define ARM_SPE_PKT_DESC_MAX 256
14
15#define ARM_SPE_NEED_MORE_BYTES -1
16#define ARM_SPE_BAD_PACKET -2
17
18#define ARM_SPE_PKT_MAX_SZ 16
19
20enum arm_spe_pkt_type {
21 ARM_SPE_BAD,
22 ARM_SPE_PAD,
23 ARM_SPE_END,
24 ARM_SPE_TIMESTAMP,
25 ARM_SPE_ADDRESS,
26 ARM_SPE_COUNTER,
27 ARM_SPE_CONTEXT,
28 ARM_SPE_OP_TYPE,
29 ARM_SPE_EVENTS,
30 ARM_SPE_DATA_SOURCE,
31};
32
33struct arm_spe_pkt {
34 enum arm_spe_pkt_type type;
35 unsigned char index;
36 uint64_t payload;
37};
38
39
40#define SPE_HEADER0_PAD 0x0
41#define SPE_HEADER0_END 0x1
42#define SPE_HEADER0_TIMESTAMP 0x71
43
44#define SPE_HEADER0_MASK1 (GENMASK_ULL(7, 6) | GENMASK_ULL(3, 0))
45#define SPE_HEADER0_EVENTS 0x42
46#define SPE_HEADER0_SOURCE 0x43
47
48#define SPE_HEADER0_MASK2 GENMASK_ULL(7, 2)
49#define SPE_HEADER0_CONTEXT 0x64
50#define SPE_HEADER0_OP_TYPE 0x48
51
52#define SPE_HEADER0_EXTENDED 0x20
53
54#define SPE_HEADER0_MASK3 GENMASK_ULL(7, 3)
55#define SPE_HEADER0_ADDRESS 0xb0
56#define SPE_HEADER0_COUNTER 0x98
57#define SPE_HEADER1_ALIGNMENT 0x0
58
59#define SPE_HDR_SHORT_INDEX(h) ((h) & GENMASK_ULL(2, 0))
60#define SPE_HDR_EXTENDED_INDEX(h0, h1) (((h0) & GENMASK_ULL(1, 0)) << 3 | \
61 SPE_HDR_SHORT_INDEX(h1))
62
63
64#define SPE_ADDR_PKT_HDR_INDEX_INS 0x0
65#define SPE_ADDR_PKT_HDR_INDEX_BRANCH 0x1
66#define SPE_ADDR_PKT_HDR_INDEX_DATA_VIRT 0x2
67#define SPE_ADDR_PKT_HDR_INDEX_DATA_PHYS 0x3
68
69
70#define SPE_ADDR_PKT_ADDR_BYTE7_SHIFT 56
71#define SPE_ADDR_PKT_ADDR_GET_BYTES_0_6(v) ((v) & GENMASK_ULL(55, 0))
72#define SPE_ADDR_PKT_ADDR_GET_BYTE_6(v) (((v) & GENMASK_ULL(55, 48)) >> 48)
73
74#define SPE_ADDR_PKT_GET_NS(v) (((v) & BIT_ULL(63)) >> 63)
75#define SPE_ADDR_PKT_GET_EL(v) (((v) & GENMASK_ULL(62, 61)) >> 61)
76#define SPE_ADDR_PKT_GET_CH(v) (((v) & BIT_ULL(62)) >> 62)
77#define SPE_ADDR_PKT_GET_PAT(v) (((v) & GENMASK_ULL(59, 56)) >> 56)
78
79#define SPE_ADDR_PKT_EL0 0
80#define SPE_ADDR_PKT_EL1 1
81#define SPE_ADDR_PKT_EL2 2
82#define SPE_ADDR_PKT_EL3 3
83
84
85#define SPE_CTX_PKT_HDR_INDEX(h) ((h) & GENMASK_ULL(1, 0))
86
87
88#define SPE_CNT_PKT_HDR_INDEX_TOTAL_LAT 0x0
89#define SPE_CNT_PKT_HDR_INDEX_ISSUE_LAT 0x1
90#define SPE_CNT_PKT_HDR_INDEX_TRANS_LAT 0x2
91
92
93enum arm_spe_events {
94 EV_EXCEPTION_GEN = 0,
95 EV_RETIRED = 1,
96 EV_L1D_ACCESS = 2,
97 EV_L1D_REFILL = 3,
98 EV_TLB_ACCESS = 4,
99 EV_TLB_WALK = 5,
100 EV_NOT_TAKEN = 6,
101 EV_MISPRED = 7,
102 EV_LLC_ACCESS = 8,
103 EV_LLC_MISS = 9,
104 EV_REMOTE_ACCESS = 10,
105 EV_ALIGNMENT = 11,
106 EV_PARTIAL_PREDICATE = 17,
107 EV_EMPTY_PREDICATE = 18,
108};
109
110
111#define SPE_OP_PKT_HDR_CLASS(h) ((h) & GENMASK_ULL(1, 0))
112#define SPE_OP_PKT_HDR_CLASS_OTHER 0x0
113#define SPE_OP_PKT_HDR_CLASS_LD_ST_ATOMIC 0x1
114#define SPE_OP_PKT_HDR_CLASS_BR_ERET 0x2
115
116#define SPE_OP_PKT_IS_OTHER_SVE_OP(v) (((v) & (BIT(7) | BIT(3) | BIT(0))) == 0x8)
117
118#define SPE_OP_PKT_COND BIT(0)
119
120#define SPE_OP_PKT_LDST_SUBCLASS_GET(v) ((v) & GENMASK_ULL(7, 1))
121#define SPE_OP_PKT_LDST_SUBCLASS_GP_REG 0x0
122#define SPE_OP_PKT_LDST_SUBCLASS_SIMD_FP 0x4
123#define SPE_OP_PKT_LDST_SUBCLASS_UNSPEC_REG 0x10
124#define SPE_OP_PKT_LDST_SUBCLASS_NV_SYSREG 0x30
125
126#define SPE_OP_PKT_IS_LDST_ATOMIC(v) (((v) & (GENMASK_ULL(7, 5) | BIT(1))) == 0x2)
127
128#define SPE_OP_PKT_AR BIT(4)
129#define SPE_OP_PKT_EXCL BIT(3)
130#define SPE_OP_PKT_AT BIT(2)
131#define SPE_OP_PKT_ST BIT(0)
132
133#define SPE_OP_PKT_IS_LDST_SVE(v) (((v) & (BIT(3) | BIT(1))) == 0x8)
134
135#define SPE_OP_PKT_SVE_SG BIT(7)
136
137
138
139
140
141
142
143#define SPE_OP_PKG_SVE_EVL(v) (32 << (((v) & GENMASK_ULL(6, 4)) >> 4))
144#define SPE_OP_PKT_SVE_PRED BIT(2)
145#define SPE_OP_PKT_SVE_FP BIT(1)
146
147#define SPE_OP_PKT_IS_INDIRECT_BRANCH(v) (((v) & GENMASK_ULL(7, 1)) == 0x2)
148
149const char *arm_spe_pkt_name(enum arm_spe_pkt_type);
150
151int arm_spe_get_packet(const unsigned char *buf, size_t len,
152 struct arm_spe_pkt *packet);
153
154int arm_spe_pkt_desc(const struct arm_spe_pkt *packet, char *buf, size_t len);
155#endif
156