xref: /openbsd/sys/dev/pci/drm/i915/i915_pmu.h (revision e5dd7070)
1 /*
2  * SPDX-License-Identifier: MIT
3  *
4  * Copyright © 2017-2018 Intel Corporation
5  */
6 
7 #ifndef __I915_PMU_H__
8 #define __I915_PMU_H__
9 
10 #include <linux/hrtimer.h>
11 #include <linux/perf_event.h>
12 #include <linux/spinlock_types.h>
13 #include <uapi/drm/i915_drm.h>
14 
15 struct drm_i915_private;
16 
17 enum {
18 	__I915_SAMPLE_FREQ_ACT = 0,
19 	__I915_SAMPLE_FREQ_REQ,
20 	__I915_SAMPLE_RC6,
21 	__I915_SAMPLE_RC6_LAST_REPORTED,
22 	__I915_NUM_PMU_SAMPLERS
23 };
24 
25 /**
26  * How many different events we track in the global PMU mask.
27  *
28  * It is also used to know to needed number of event reference counters.
29  */
30 #define I915_PMU_MASK_BITS \
31 	((1 << I915_PMU_SAMPLE_BITS) + \
32 	 (I915_PMU_LAST + 1 - __I915_PMU_OTHER(0)))
33 
34 #define I915_ENGINE_SAMPLE_COUNT (I915_SAMPLE_SEMA + 1)
35 
36 struct i915_pmu_sample {
37 	u64 cur;
38 };
39 
40 struct i915_pmu {
41 	/**
42 	 * @cpuhp: Struct used for CPU hotplug handling.
43 	 */
44 	struct {
45 		struct hlist_node node;
46 #ifdef notyet
47 		enum cpuhp_state slot;
48 #endif
49 	} cpuhp;
50 	/**
51 	 * @base: PMU base.
52 	 */
53 	struct pmu base;
54 	/**
55 	 * @name: Name as registered with perf core.
56 	 */
57 	const char *name;
58 	/**
59 	 * @lock: Lock protecting enable mask and ref count handling.
60 	 */
61 	spinlock_t lock;
62 	/**
63 	 * @timer: Timer for internal i915 PMU sampling.
64 	 */
65 	struct hrtimer timer;
66 	/**
67 	 * @enable: Bitmask of all currently enabled events.
68 	 *
69 	 * Bits are derived from uAPI event numbers in a way that low 16 bits
70 	 * correspond to engine event _sample_ _type_ (I915_SAMPLE_QUEUED is
71 	 * bit 0), and higher bits correspond to other events (for instance
72 	 * I915_PMU_ACTUAL_FREQUENCY is bit 16 etc).
73 	 *
74 	 * In other words, low 16 bits are not per engine but per engine
75 	 * sampler type, while the upper bits are directly mapped to other
76 	 * event types.
77 	 */
78 	u64 enable;
79 
80 	/**
81 	 * @timer_last:
82 	 *
83 	 * Timestmap of the previous timer invocation.
84 	 */
85 	ktime_t timer_last;
86 
87 	/**
88 	 * @enable_count: Reference counts for the enabled events.
89 	 *
90 	 * Array indices are mapped in the same way as bits in the @enable field
91 	 * and they are used to control sampling on/off when multiple clients
92 	 * are using the PMU API.
93 	 */
94 	unsigned int enable_count[I915_PMU_MASK_BITS];
95 	/**
96 	 * @timer_enabled: Should the internal sampling timer be running.
97 	 */
98 	bool timer_enabled;
99 	/**
100 	 * @sample: Current and previous (raw) counters for sampling events.
101 	 *
102 	 * These counters are updated from the i915 PMU sampling timer.
103 	 *
104 	 * Only global counters are held here, while the per-engine ones are in
105 	 * struct intel_engine_cs.
106 	 */
107 	struct i915_pmu_sample sample[__I915_NUM_PMU_SAMPLERS];
108 	/**
109 	 * @sleep_last: Last time GT parked for RC6 estimation.
110 	 */
111 	ktime_t sleep_last;
112 	/**
113 	 * @events_attr_group: Device events attribute group.
114 	 */
115 	struct attribute_group events_attr_group;
116 	/**
117 	 * @i915_attr: Memory block holding device attributes.
118 	 */
119 	void *i915_attr;
120 	/**
121 	 * @pmu_attr: Memory block holding device attributes.
122 	 */
123 	void *pmu_attr;
124 };
125 
126 #ifdef CONFIG_PERF_EVENTS
127 void i915_pmu_register(struct drm_i915_private *i915);
128 void i915_pmu_unregister(struct drm_i915_private *i915);
129 void i915_pmu_gt_parked(struct drm_i915_private *i915);
130 void i915_pmu_gt_unparked(struct drm_i915_private *i915);
131 #else
132 static inline void i915_pmu_register(struct drm_i915_private *i915) {}
133 static inline void i915_pmu_unregister(struct drm_i915_private *i915) {}
134 static inline void i915_pmu_gt_parked(struct drm_i915_private *i915) {}
135 static inline void i915_pmu_gt_unparked(struct drm_i915_private *i915) {}
136 #endif
137 
138 #endif
139