1 /*
2  * Performance event support - PowerPC classic/server specific definitions.
3  *
4  * Copyright 2008-2009 Paul Mackerras, IBM Corporation.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11 
12 #include <linux/types.h>
13 #include <asm/hw_irq.h>
14 #include <linux/device.h>
15 #include <uapi/asm/perf_event.h>
16 
17 /* Update perf_event_print_debug() if this changes */
18 #define MAX_HWEVENTS		8
19 #define MAX_EVENT_ALTERNATIVES	8
20 #define MAX_LIMITED_HWCOUNTERS	2
21 
22 struct perf_event;
23 
24 /*
25  * This struct provides the constants and functions needed to
26  * describe the PMU on a particular POWER-family CPU.
27  */
28 struct power_pmu {
29 	const char	*name;
30 	int		n_counter;
31 	int		max_alternatives;
32 	unsigned long	add_fields;
33 	unsigned long	test_adder;
34 	int		(*compute_mmcr)(u64 events[], int n_ev,
35 				unsigned int hwc[], unsigned long mmcr[],
36 				struct perf_event *pevents[]);
37 	int		(*get_constraint)(u64 event_id, unsigned long *mskp,
38 				unsigned long *valp);
39 	int		(*get_alternatives)(u64 event_id, unsigned int flags,
40 				u64 alt[]);
41 	void		(*get_mem_data_src)(union perf_mem_data_src *dsrc,
42 				u32 flags, struct pt_regs *regs);
43 	void		(*get_mem_weight)(u64 *weight);
44 	unsigned long	group_constraint_mask;
45 	unsigned long	group_constraint_val;
46 	u64             (*bhrb_filter_map)(u64 branch_sample_type);
47 	void            (*config_bhrb)(u64 pmu_bhrb_filter);
48 	void		(*disable_pmc)(unsigned int pmc, unsigned long mmcr[]);
49 	int		(*limited_pmc_event)(u64 event_id);
50 	u32		flags;
51 	const struct attribute_group	**attr_groups;
52 	int		n_generic;
53 	int		*generic_events;
54 	int		(*cache_events)[PERF_COUNT_HW_CACHE_MAX]
55 			       [PERF_COUNT_HW_CACHE_OP_MAX]
56 			       [PERF_COUNT_HW_CACHE_RESULT_MAX];
57 
58 	int		n_blacklist_ev;
59 	int 		*blacklist_ev;
60 	/* BHRB entries in the PMU */
61 	int		bhrb_nr;
62 };
63 
64 /*
65  * Values for power_pmu.flags
66  */
67 #define PPMU_LIMITED_PMC5_6	0x00000001 /* PMC5/6 have limited function */
68 #define PPMU_ALT_SIPR		0x00000002 /* uses alternate posn for SIPR/HV */
69 #define PPMU_NO_SIPR		0x00000004 /* no SIPR/HV in MMCRA at all */
70 #define PPMU_NO_CONT_SAMPLING	0x00000008 /* no continuous sampling */
71 #define PPMU_SIAR_VALID		0x00000010 /* Processor has SIAR Valid bit */
72 #define PPMU_HAS_SSLOT		0x00000020 /* Has sampled slot in MMCRA */
73 #define PPMU_HAS_SIER		0x00000040 /* Has SIER */
74 #define PPMU_ARCH_207S		0x00000080 /* PMC is architecture v2.07S */
75 #define PPMU_NO_SIAR		0x00000100 /* Do not use SIAR */
76 
77 /*
78  * Values for flags to get_alternatives()
79  */
80 #define PPMU_LIMITED_PMC_OK	1	/* can put this on a limited PMC */
81 #define PPMU_LIMITED_PMC_REQD	2	/* have to put this on a limited PMC */
82 #define PPMU_ONLY_COUNT_RUN	4	/* only counting in run state */
83 
84 extern int register_power_pmu(struct power_pmu *);
85 
86 struct pt_regs;
87 extern unsigned long perf_misc_flags(struct pt_regs *regs);
88 extern unsigned long perf_instruction_pointer(struct pt_regs *regs);
89 extern unsigned long int read_bhrb(int n);
90 
91 /*
92  * Only override the default definitions in include/linux/perf_event.h
93  * if we have hardware PMU support.
94  */
95 #ifdef CONFIG_PPC_PERF_CTRS
96 #define perf_misc_flags(regs)	perf_misc_flags(regs)
97 #endif
98 
99 /*
100  * The power_pmu.get_constraint function returns a 32/64-bit value and
101  * a 32/64-bit mask that express the constraints between this event_id and
102  * other events.
103  *
104  * The value and mask are divided up into (non-overlapping) bitfields
105  * of three different types:
106  *
107  * Select field: this expresses the constraint that some set of bits
108  * in MMCR* needs to be set to a specific value for this event_id.  For a
109  * select field, the mask contains 1s in every bit of the field, and
110  * the value contains a unique value for each possible setting of the
111  * MMCR* bits.  The constraint checking code will ensure that two events
112  * that set the same field in their masks have the same value in their
113  * value dwords.
114  *
115  * Add field: this expresses the constraint that there can be at most
116  * N events in a particular class.  A field of k bits can be used for
117  * N <= 2^(k-1) - 1.  The mask has the most significant bit of the field
118  * set (and the other bits 0), and the value has only the least significant
119  * bit of the field set.  In addition, the 'add_fields' and 'test_adder'
120  * in the struct power_pmu for this processor come into play.  The
121  * add_fields value contains 1 in the LSB of the field, and the
122  * test_adder contains 2^(k-1) - 1 - N in the field.
123  *
124  * NAND field: this expresses the constraint that you may not have events
125  * in all of a set of classes.  (For example, on PPC970, you can't select
126  * events from the FPU, ISU and IDU simultaneously, although any two are
127  * possible.)  For N classes, the field is N+1 bits wide, and each class
128  * is assigned one bit from the least-significant N bits.  The mask has
129  * only the most-significant bit set, and the value has only the bit
130  * for the event_id's class set.  The test_adder has the least significant
131  * bit set in the field.
132  *
133  * If an event_id is not subject to the constraint expressed by a particular
134  * field, then it will have 0 in both the mask and value for that field.
135  */
136 
137 extern ssize_t power_events_sysfs_show(struct device *dev,
138 				struct device_attribute *attr, char *page);
139 
140 /*
141  * EVENT_VAR() is same as PMU_EVENT_VAR with a suffix.
142  *
143  * Having a suffix allows us to have aliases in sysfs - eg: the generic
144  * event 'cpu-cycles' can have two entries in sysfs: 'cpu-cycles' and
145  * 'PM_CYC' where the latter is the name by which the event is known in
146  * POWER CPU specification.
147  *
148  * Similarly, some hardware and cache events use the same event code. Eg.
149  * on POWER8, both "cache-references" and "L1-dcache-loads" events refer
150  * to the same event, PM_LD_REF_L1.  The suffix, allows us to have two
151  * sysfs objects for the same event and thus two entries/aliases in sysfs.
152  */
153 #define	EVENT_VAR(_id, _suffix)		event_attr_##_id##_suffix
154 #define	EVENT_PTR(_id, _suffix)		&EVENT_VAR(_id, _suffix).attr.attr
155 
156 #define	EVENT_ATTR(_name, _id, _suffix)					\
157 	PMU_EVENT_ATTR(_name, EVENT_VAR(_id, _suffix), _id,		\
158 			power_events_sysfs_show)
159 
160 #define	GENERIC_EVENT_ATTR(_name, _id)	EVENT_ATTR(_name, _id, _g)
161 #define	GENERIC_EVENT_PTR(_id)		EVENT_PTR(_id, _g)
162 
163 #define	CACHE_EVENT_ATTR(_name, _id)	EVENT_ATTR(_name, _id, _c)
164 #define	CACHE_EVENT_PTR(_id)		EVENT_PTR(_id, _c)
165 
166 #define	POWER_EVENT_ATTR(_name, _id)	EVENT_ATTR(_name, _id, _p)
167 #define	POWER_EVENT_PTR(_id)		EVENT_PTR(_id, _p)
168