1  /* SPDX-License-Identifier: GPL-2.0-only */
2  /*
3   *  linux/arch/arm/include/asm/pmu.h
4   *
5   *  Copyright (C) 2009 picoChip Designs Ltd, Jamie Iles
6   */
7  
8  #ifndef __ARM_PMU_H__
9  #define __ARM_PMU_H__
10  
11  #include <linux/interrupt.h>
12  #include <linux/perf_event.h>
13  #include <linux/platform_device.h>
14  #include <linux/sysfs.h>
15  #include <asm/cputype.h>
16  
17  #ifdef CONFIG_ARM_PMU
18  
19  /*
20   * The Armv7 and Armv8.8 or less CPU PMU supports up to 32 event counters.
21   * The Armv8.9/9.4 CPU PMU supports up to 33 event counters.
22   */
23  #ifdef CONFIG_ARM
24  #define ARMPMU_MAX_HWEVENTS		32
25  #else
26  #define ARMPMU_MAX_HWEVENTS		33
27  #endif
28  /*
29   * ARM PMU hw_event flags
30   */
31  #define ARMPMU_EVT_64BIT		0x00001 /* Event uses a 64bit counter */
32  #define ARMPMU_EVT_47BIT		0x00002 /* Event uses a 47bit counter */
33  #define ARMPMU_EVT_63BIT		0x00004 /* Event uses a 63bit counter */
34  
35  static_assert((PERF_EVENT_FLAG_ARCH & ARMPMU_EVT_64BIT) == ARMPMU_EVT_64BIT);
36  static_assert((PERF_EVENT_FLAG_ARCH & ARMPMU_EVT_47BIT) == ARMPMU_EVT_47BIT);
37  static_assert((PERF_EVENT_FLAG_ARCH & ARMPMU_EVT_63BIT) == ARMPMU_EVT_63BIT);
38  
39  #define HW_OP_UNSUPPORTED		0xFFFF
40  #define C(_x)				PERF_COUNT_HW_CACHE_##_x
41  #define CACHE_OP_UNSUPPORTED		0xFFFF
42  
43  #define PERF_MAP_ALL_UNSUPPORTED					\
44  	[0 ... PERF_COUNT_HW_MAX - 1] = HW_OP_UNSUPPORTED
45  
46  #define PERF_CACHE_MAP_ALL_UNSUPPORTED					\
47  [0 ... C(MAX) - 1] = {							\
48  	[0 ... C(OP_MAX) - 1] = {					\
49  		[0 ... C(RESULT_MAX) - 1] = CACHE_OP_UNSUPPORTED,	\
50  	},								\
51  }
52  
53  /* The events for a given PMU register set. */
54  struct pmu_hw_events {
55  	/*
56  	 * The events that are active on the PMU for the given index.
57  	 */
58  	struct perf_event	*events[ARMPMU_MAX_HWEVENTS];
59  
60  	/*
61  	 * A 1 bit for an index indicates that the counter is being used for
62  	 * an event. A 0 means that the counter can be used.
63  	 */
64  	DECLARE_BITMAP(used_mask, ARMPMU_MAX_HWEVENTS);
65  
66  	/*
67  	 * When using percpu IRQs, we need a percpu dev_id. Place it here as we
68  	 * already have to allocate this struct per cpu.
69  	 */
70  	struct arm_pmu		*percpu_pmu;
71  
72  	int irq;
73  };
74  
75  enum armpmu_attr_groups {
76  	ARMPMU_ATTR_GROUP_COMMON,
77  	ARMPMU_ATTR_GROUP_EVENTS,
78  	ARMPMU_ATTR_GROUP_FORMATS,
79  	ARMPMU_ATTR_GROUP_CAPS,
80  	ARMPMU_NR_ATTR_GROUPS
81  };
82  
83  struct arm_pmu {
84  	struct pmu	pmu;
85  	cpumask_t	supported_cpus;
86  	char		*name;
87  	int		pmuver;
88  	irqreturn_t	(*handle_irq)(struct arm_pmu *pmu);
89  	void		(*enable)(struct perf_event *event);
90  	void		(*disable)(struct perf_event *event);
91  	int		(*get_event_idx)(struct pmu_hw_events *hw_events,
92  					 struct perf_event *event);
93  	void		(*clear_event_idx)(struct pmu_hw_events *hw_events,
94  					 struct perf_event *event);
95  	int		(*set_event_filter)(struct hw_perf_event *evt,
96  					    struct perf_event_attr *attr);
97  	u64		(*read_counter)(struct perf_event *event);
98  	void		(*write_counter)(struct perf_event *event, u64 val);
99  	void		(*start)(struct arm_pmu *);
100  	void		(*stop)(struct arm_pmu *);
101  	void		(*reset)(void *);
102  	int		(*map_event)(struct perf_event *event);
103  	DECLARE_BITMAP(cntr_mask, ARMPMU_MAX_HWEVENTS);
104  	bool		secure_access; /* 32-bit ARM only */
105  #define ARMV8_PMUV3_MAX_COMMON_EVENTS		0x40
106  	DECLARE_BITMAP(pmceid_bitmap, ARMV8_PMUV3_MAX_COMMON_EVENTS);
107  #define ARMV8_PMUV3_EXT_COMMON_EVENT_BASE	0x4000
108  	DECLARE_BITMAP(pmceid_ext_bitmap, ARMV8_PMUV3_MAX_COMMON_EVENTS);
109  	struct platform_device	*plat_device;
110  	struct pmu_hw_events	__percpu *hw_events;
111  	struct hlist_node	node;
112  	struct notifier_block	cpu_pm_nb;
113  	/* the attr_groups array must be NULL-terminated */
114  	const struct attribute_group *attr_groups[ARMPMU_NR_ATTR_GROUPS + 1];
115  	/* store the PMMIR_EL1 to expose slots */
116  	u64		reg_pmmir;
117  
118  	/* Only to be used by ACPI probing code */
119  	unsigned long acpi_cpuid;
120  };
121  
122  #define to_arm_pmu(p) (container_of(p, struct arm_pmu, pmu))
123  
124  u64 armpmu_event_update(struct perf_event *event);
125  
126  int armpmu_event_set_period(struct perf_event *event);
127  
128  int armpmu_map_event(struct perf_event *event,
129  		     const unsigned (*event_map)[PERF_COUNT_HW_MAX],
130  		     const unsigned (*cache_map)[PERF_COUNT_HW_CACHE_MAX]
131  						[PERF_COUNT_HW_CACHE_OP_MAX]
132  						[PERF_COUNT_HW_CACHE_RESULT_MAX],
133  		     u32 raw_event_mask);
134  
135  typedef int (*armpmu_init_fn)(struct arm_pmu *);
136  
137  struct pmu_probe_info {
138  	unsigned int cpuid;
139  	unsigned int mask;
140  	armpmu_init_fn init;
141  };
142  
143  #define PMU_PROBE(_cpuid, _mask, _fn)	\
144  {					\
145  	.cpuid = (_cpuid),		\
146  	.mask = (_mask),		\
147  	.init = (_fn),			\
148  }
149  
150  #define ARM_PMU_PROBE(_cpuid, _fn) \
151  	PMU_PROBE(_cpuid, ARM_CPU_PART_MASK, _fn)
152  
153  #define ARM_PMU_XSCALE_MASK	((0xff << 24) | ARM_CPU_XSCALE_ARCH_MASK)
154  
155  #define XSCALE_PMU_PROBE(_version, _fn) \
156  	PMU_PROBE(ARM_CPU_IMP_INTEL << 24 | _version, ARM_PMU_XSCALE_MASK, _fn)
157  
158  int arm_pmu_device_probe(struct platform_device *pdev,
159  			 const struct of_device_id *of_table,
160  			 const struct pmu_probe_info *probe_table);
161  
162  #ifdef CONFIG_ACPI
163  int arm_pmu_acpi_probe(armpmu_init_fn init_fn);
164  #else
arm_pmu_acpi_probe(armpmu_init_fn init_fn)165  static inline int arm_pmu_acpi_probe(armpmu_init_fn init_fn) { return 0; }
166  #endif
167  
168  #ifdef CONFIG_KVM
169  void kvm_host_pmu_init(struct arm_pmu *pmu);
170  #else
171  #define kvm_host_pmu_init(x)	do { } while(0)
172  #endif
173  
174  bool arm_pmu_irq_is_nmi(void);
175  
176  /* Internal functions only for core arm_pmu code */
177  struct arm_pmu *armpmu_alloc(void);
178  void armpmu_free(struct arm_pmu *pmu);
179  int armpmu_register(struct arm_pmu *pmu);
180  int armpmu_request_irq(int irq, int cpu);
181  void armpmu_free_irq(int irq, int cpu);
182  
183  #define ARMV8_PMU_PDEV_NAME "armv8-pmu"
184  
185  #endif /* CONFIG_ARM_PMU */
186  
187  #define ARMV8_SPE_PDEV_NAME "arm,spe-v1"
188  #define ARMV8_TRBE_PDEV_NAME "arm,trbe"
189  
190  /* Why does everything I do descend into this? */
191  #define __GEN_PMU_FORMAT_ATTR(cfg, lo, hi)				\
192  	(lo) == (hi) ? #cfg ":" #lo "\n" : #cfg ":" #lo "-" #hi
193  
194  #define _GEN_PMU_FORMAT_ATTR(cfg, lo, hi)				\
195  	__GEN_PMU_FORMAT_ATTR(cfg, lo, hi)
196  
197  #define GEN_PMU_FORMAT_ATTR(name)					\
198  	PMU_FORMAT_ATTR(name,						\
199  	_GEN_PMU_FORMAT_ATTR(ATTR_CFG_FLD_##name##_CFG,			\
200  			     ATTR_CFG_FLD_##name##_LO,			\
201  			     ATTR_CFG_FLD_##name##_HI))
202  
203  #define _ATTR_CFG_GET_FLD(attr, cfg, lo, hi)				\
204  	((((attr)->cfg) >> lo) & GENMASK_ULL(hi - lo, 0))
205  
206  #define ATTR_CFG_GET_FLD(attr, name)					\
207  	_ATTR_CFG_GET_FLD(attr,						\
208  			  ATTR_CFG_FLD_##name##_CFG,			\
209  			  ATTR_CFG_FLD_##name##_LO,			\
210  			  ATTR_CFG_FLD_##name##_HI)
211  
212  #endif /* __ARM_PMU_H__ */
213