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 
16 #define MAX_HWEVENTS		8
17 #define MAX_EVENT_ALTERNATIVES	8
18 #define MAX_LIMITED_HWCOUNTERS	2
19 
20 /*
21  * This struct provides the constants and functions needed to
22  * describe the PMU on a particular POWER-family CPU.
23  */
24 struct power_pmu {
25 	const char	*name;
26 	int		n_counter;
27 	int		max_alternatives;
28 	unsigned long	add_fields;
29 	unsigned long	test_adder;
30 	int		(*compute_mmcr)(u64 events[], int n_ev,
31 				unsigned int hwc[], unsigned long mmcr[]);
32 	int		(*get_constraint)(u64 event_id, unsigned long *mskp,
33 				unsigned long *valp);
34 	int		(*get_alternatives)(u64 event_id, unsigned int flags,
35 				u64 alt[]);
36 	u64             (*bhrb_filter_map)(u64 branch_sample_type);
37 	void            (*config_bhrb)(u64 pmu_bhrb_filter);
38 	void		(*disable_pmc)(unsigned int pmc, unsigned long mmcr[]);
39 	int		(*limited_pmc_event)(u64 event_id);
40 	u32		flags;
41 	const struct attribute_group	**attr_groups;
42 	int		n_generic;
43 	int		*generic_events;
44 	int		(*cache_events)[PERF_COUNT_HW_CACHE_MAX]
45 			       [PERF_COUNT_HW_CACHE_OP_MAX]
46 			       [PERF_COUNT_HW_CACHE_RESULT_MAX];
47 
48 	/* BHRB entries in the PMU */
49 	int		bhrb_nr;
50 };
51 
52 /*
53  * Values for power_pmu.flags
54  */
55 #define PPMU_LIMITED_PMC5_6	0x00000001 /* PMC5/6 have limited function */
56 #define PPMU_ALT_SIPR		0x00000002 /* uses alternate posn for SIPR/HV */
57 #define PPMU_NO_SIPR		0x00000004 /* no SIPR/HV in MMCRA at all */
58 #define PPMU_NO_CONT_SAMPLING	0x00000008 /* no continuous sampling */
59 #define PPMU_SIAR_VALID		0x00000010 /* Processor has SIAR Valid bit */
60 #define PPMU_HAS_SSLOT		0x00000020 /* Has sampled slot in MMCRA */
61 #define PPMU_HAS_SIER		0x00000040 /* Has SIER */
62 #define PPMU_BHRB		0x00000080 /* has BHRB feature enabled */
63 
64 /*
65  * Values for flags to get_alternatives()
66  */
67 #define PPMU_LIMITED_PMC_OK	1	/* can put this on a limited PMC */
68 #define PPMU_LIMITED_PMC_REQD	2	/* have to put this on a limited PMC */
69 #define PPMU_ONLY_COUNT_RUN	4	/* only counting in run state */
70 
71 extern int register_power_pmu(struct power_pmu *);
72 
73 struct pt_regs;
74 extern unsigned long perf_misc_flags(struct pt_regs *regs);
75 extern unsigned long perf_instruction_pointer(struct pt_regs *regs);
76 extern unsigned long int read_bhrb(int n);
77 
78 /*
79  * Only override the default definitions in include/linux/perf_event.h
80  * if we have hardware PMU support.
81  */
82 #ifdef CONFIG_PPC_PERF_CTRS
83 #define perf_misc_flags(regs)	perf_misc_flags(regs)
84 #endif
85 
86 /*
87  * The power_pmu.get_constraint function returns a 32/64-bit value and
88  * a 32/64-bit mask that express the constraints between this event_id and
89  * other events.
90  *
91  * The value and mask are divided up into (non-overlapping) bitfields
92  * of three different types:
93  *
94  * Select field: this expresses the constraint that some set of bits
95  * in MMCR* needs to be set to a specific value for this event_id.  For a
96  * select field, the mask contains 1s in every bit of the field, and
97  * the value contains a unique value for each possible setting of the
98  * MMCR* bits.  The constraint checking code will ensure that two events
99  * that set the same field in their masks have the same value in their
100  * value dwords.
101  *
102  * Add field: this expresses the constraint that there can be at most
103  * N events in a particular class.  A field of k bits can be used for
104  * N <= 2^(k-1) - 1.  The mask has the most significant bit of the field
105  * set (and the other bits 0), and the value has only the least significant
106  * bit of the field set.  In addition, the 'add_fields' and 'test_adder'
107  * in the struct power_pmu for this processor come into play.  The
108  * add_fields value contains 1 in the LSB of the field, and the
109  * test_adder contains 2^(k-1) - 1 - N in the field.
110  *
111  * NAND field: this expresses the constraint that you may not have events
112  * in all of a set of classes.  (For example, on PPC970, you can't select
113  * events from the FPU, ISU and IDU simultaneously, although any two are
114  * possible.)  For N classes, the field is N+1 bits wide, and each class
115  * is assigned one bit from the least-significant N bits.  The mask has
116  * only the most-significant bit set, and the value has only the bit
117  * for the event_id's class set.  The test_adder has the least significant
118  * bit set in the field.
119  *
120  * If an event_id is not subject to the constraint expressed by a particular
121  * field, then it will have 0 in both the mask and value for that field.
122  */
123 
124 extern ssize_t power_events_sysfs_show(struct device *dev,
125 				struct device_attribute *attr, char *page);
126 
127 /*
128  * EVENT_VAR() is same as PMU_EVENT_VAR with a suffix.
129  *
130  * Having a suffix allows us to have aliases in sysfs - eg: the generic
131  * event 'cpu-cycles' can have two entries in sysfs: 'cpu-cycles' and
132  * 'PM_CYC' where the latter is the name by which the event is known in
133  * POWER CPU specification.
134  */
135 #define	EVENT_VAR(_id, _suffix)		event_attr_##_id##_suffix
136 #define	EVENT_PTR(_id, _suffix)		&EVENT_VAR(_id, _suffix).attr.attr
137 
138 #define	EVENT_ATTR(_name, _id, _suffix)					\
139 	PMU_EVENT_ATTR(_name, EVENT_VAR(_id, _suffix), PME_PM_##_id,	\
140 			power_events_sysfs_show)
141 
142 #define	GENERIC_EVENT_ATTR(_name, _id)	EVENT_ATTR(_name, _id, _g)
143 #define	GENERIC_EVENT_PTR(_id)		EVENT_PTR(_id, _g)
144 
145 #define	POWER_EVENT_ATTR(_name, _id)	EVENT_ATTR(PM_##_name, _id, _p)
146 #define	POWER_EVENT_PTR(_id)		EVENT_PTR(_id, _p)
147