include/linux/perf/arm_pmu.h

   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         irqreturn_t     (*handle_irq)(struct arm_pmu *pmu);
  88         void            (*enable)(struct perf_event *event);
  89         void            (*disable)(struct perf_event *event);
  90         int             (*get_event_idx)(struct pmu_hw_events *hw_events,
  91                                          struct perf_event *event);
  92         void            (*clear_event_idx)(struct pmu_hw_events *hw_events,
  93                                          struct perf_event *event);
  94         int             (*set_event_filter)(struct hw_perf_event *evt,
  95                                             struct perf_event_attr *attr);
  96         u64             (*read_counter)(struct perf_event *event);
  97         void            (*write_counter)(struct perf_event *event, u64 val);
  98         void            (*start)(struct arm_pmu *);
  99         void            (*stop)(struct arm_pmu *);
 100         void            (*reset)(void *);
 101         int             (*map_event)(struct perf_event *event);
 102         /*
 103          * Called by KVM to map the PMUv3 event space onto non-PMUv3 hardware.
 104          */
 105         int             (*map_pmuv3_event)(unsigned int eventsel);
 106         DECLARE_BITMAP(cntr_mask, ARMPMU_MAX_HWEVENTS);
 107         bool            secure_access; /* 32-bit ARM only */
 108         struct platform_device  *plat_device;
 109         struct pmu_hw_events    __percpu *hw_events;
 110         struct hlist_node       node;
 111         struct notifier_block   cpu_pm_nb;
 112         /* the attr_groups array must be NULL-terminated */
 113         const struct attribute_group *attr_groups[ARMPMU_NR_ATTR_GROUPS + 1];
 114
 115         /* PMUv3 only */
 116         int             pmuver;
 117         u64             reg_pmmir;
 118 #define ARMV8_PMUV3_MAX_COMMON_EVENTS           0x40
 119         DECLARE_BITMAP(pmceid_bitmap, ARMV8_PMUV3_MAX_COMMON_EVENTS);
 120 #define ARMV8_PMUV3_EXT_COMMON_EVENT_BASE       0x4000
 121         DECLARE_BITMAP(pmceid_ext_bitmap, ARMV8_PMUV3_MAX_COMMON_EVENTS);
 122
 123         /* Only to be used by ACPI probing code */
 124         unsigned long acpi_cpuid;
 125 };
 126
 127 #define to_arm_pmu(p) (container_of(p, struct arm_pmu, pmu))
 128
 129 u64 armpmu_event_update(struct perf_event *event);
 130
 131 int armpmu_event_set_period(struct perf_event *event);
 132
 133 int armpmu_map_event(struct perf_event *event,
 134                      const unsigned (*event_map)[PERF_COUNT_HW_MAX],
 135                      const unsigned (*cache_map)[PERF_COUNT_HW_CACHE_MAX]
 136                                                 [PERF_COUNT_HW_CACHE_OP_MAX]
 137                                                 [PERF_COUNT_HW_CACHE_RESULT_MAX],
 138                      u32 raw_event_mask);
 139
 140 typedef int (*armpmu_init_fn)(struct arm_pmu *);
 141
 142 struct pmu_probe_info {
 143         unsigned int cpuid;
 144         unsigned int mask;
 145         armpmu_init_fn init;
 146 };
 147
 148 #define PMU_PROBE(_cpuid, _mask, _fn)   \
 149 {                                       \
 150         .cpuid = (_cpuid),              \
 151         .mask = (_mask),                \
 152         .init = (_fn),                  \
 153 }
 154
 155 #define ARM_PMU_PROBE(_cpuid, _fn) \
 156         PMU_PROBE(_cpuid, ARM_CPU_PART_MASK, _fn)
 157
 158 #define ARM_PMU_XSCALE_MASK     ((0xff << 24) | ARM_CPU_XSCALE_ARCH_MASK)
 159
 160 #define XSCALE_PMU_PROBE(_version, _fn) \
 161         PMU_PROBE(ARM_CPU_IMP_INTEL << 24 | _version, ARM_PMU_XSCALE_MASK, _fn)
 162
 163 int arm_pmu_device_probe(struct platform_device *pdev,
 164                          const struct of_device_id *of_table,
 165                          const struct pmu_probe_info *probe_table);
 166
 167 #ifdef CONFIG_ACPI
 168 int arm_pmu_acpi_probe(armpmu_init_fn init_fn);
 169 #else
 170 static inline int arm_pmu_acpi_probe(armpmu_init_fn init_fn) { return 0; }
 171 #endif
 172
 173 #ifdef CONFIG_KVM
 174 void kvm_host_pmu_init(struct arm_pmu *pmu);
 175 #else
 176 #define kvm_host_pmu_init(x)    do { } while(0)
 177 #endif
 178
 179 bool arm_pmu_irq_is_nmi(void);
 180
 181 /* Internal functions only for core arm_pmu code */
 182 struct arm_pmu *armpmu_alloc(void);
 183 void armpmu_free(struct arm_pmu *pmu);
 184 int armpmu_register(struct arm_pmu *pmu);
 185 int armpmu_request_irq(int irq, int cpu);
 186 void armpmu_free_irq(int irq, int cpu);
 187
 188 #define ARMV8_PMU_PDEV_NAME "armv8-pmu"
 189
 190 #endif /* CONFIG_ARM_PMU */
 191
 192 #define ARMV8_SPE_PDEV_NAME "arm,spe-v1"
 193 #define ARMV8_TRBE_PDEV_NAME "arm,trbe"
 194
 195 /* Why does everything I do descend into this? */
 196 #define __GEN_PMU_FORMAT_ATTR(cfg, lo, hi)                              \
 197         (lo) == (hi) ? #cfg ":" #lo "\n" : #cfg ":" #lo "-" #hi
 198
 199 #define _GEN_PMU_FORMAT_ATTR(cfg, lo, hi)                               \
 200         __GEN_PMU_FORMAT_ATTR(cfg, lo, hi)
 201
 202 #define GEN_PMU_FORMAT_ATTR(name)                                       \
 203         PMU_FORMAT_ATTR(name,                                           \
 204         _GEN_PMU_FORMAT_ATTR(ATTR_CFG_FLD_##name##_CFG,                 \
 205                              ATTR_CFG_FLD_##name##_LO,                  \
 206                              ATTR_CFG_FLD_##name##_HI))
 207
 208 #define _ATTR_CFG_GET_FLD(attr, cfg, lo, hi)                            \
 209         ((((attr)->cfg) >> lo) & GENMASK_ULL(hi - lo, 0))
 210
 211 #define ATTR_CFG_GET_FLD(attr, name)                                    \
 212         _ATTR_CFG_GET_FLD(attr,                                         \
 213                           ATTR_CFG_FLD_##name##_CFG,                    \
 214                           ATTR_CFG_FLD_##name##_LO,                     \
 215                           ATTR_CFG_FLD_##name##_HI)
 216
 217 #endif /* __ARM_PMU_H__ */