xref: /linux/drivers/platform/x86/intel/pmt/class.h (revision eacaf5ae747f7dead6cc268de17a7382d79031fc)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _INTEL_PMT_CLASS_H
3 #define _INTEL_PMT_CLASS_H
4 
5 #include <linux/intel_vsec.h>
6 #include <linux/xarray.h>
7 #include <linux/types.h>
8 #include <linux/bits.h>
9 #include <linux/err.h>
10 #include <linux/io.h>
11 
12 #include "telemetry.h"
13 
14 /* PMT access types */
15 #define ACCESS_BARID		2
16 #define ACCESS_LOCAL		3
17 
18 /* PMT discovery base address/offset register layout */
19 #define GET_BIR(v)		((v) & GENMASK(2, 0))
20 #define GET_ADDRESS(v)		((v) & GENMASK(31, 3))
21 
22 struct device;
23 struct pci_dev;
24 extern struct class intel_pmt_class;
25 
26 struct telem_endpoint {
27 	struct device		*dev;
28 	struct telem_header	header;
29 	struct pmt_callbacks	*cb;
30 	void __iomem		*base;
31 	bool			present;
32 	struct kref		kref;
33 };
34 
35 struct intel_pmt_header {
36 	u32	base_offset;
37 	u32	size;
38 	u32	guid;
39 	u8	access_type;
40 	u8	telem_type;
41 };
42 
43 struct intel_pmt_entry {
44 	struct telem_endpoint	*ep;
45 	struct pci_dev		*pcidev;
46 	struct intel_pmt_header	header;
47 	u32			disc_header[PMT_DISC_DWORDS];
48 	struct bin_attribute	pmt_bin_attr;
49 	const struct attribute_group *attr_grp;
50 	struct kobject		*kobj;
51 	void __iomem		*disc_table;
52 	void __iomem		*base;
53 	struct pmt_callbacks	*cb;
54 	unsigned long		base_addr;
55 	size_t			size;
56 	u64			feature_flags;
57 	u32			guid;
58 	u32			num_rmids; /* Number of Resource Monitoring IDs */
59 	int			devid;
60 };
61 
62 struct intel_pmt_namespace {
63 	const char *name;
64 	struct xarray *xa;
65 	int (*pmt_header_decode)(struct intel_pmt_entry *entry,
66 				 struct device *dev);
67 	int (*pmt_pre_decode)(struct intel_vsec_device *ivdev,
68 			      struct intel_pmt_entry *entry);
69 	int (*pmt_post_decode)(struct intel_vsec_device *ivdev,
70 			       struct intel_pmt_entry *entry);
71 	int (*pmt_add_endpoint)(struct intel_vsec_device *ivdev,
72 				struct intel_pmt_entry *entry);
73 };
74 
75 int pmt_telem_read_mmio(struct device *dev, struct pmt_callbacks *cb, u32 guid, void *buf,
76 			void __iomem *addr, loff_t off, u32 count);
77 bool intel_pmt_is_early_client_hw(struct device *dev);
78 int intel_pmt_dev_create(struct intel_pmt_entry *entry,
79 			 struct intel_pmt_namespace *ns,
80 			 struct intel_vsec_device *dev, int idx);
81 void intel_pmt_dev_destroy(struct intel_pmt_entry *entry,
82 			   struct intel_pmt_namespace *ns);
83 #if IS_ENABLED(CONFIG_INTEL_PMT_DISCOVERY)
84 void intel_pmt_get_features(struct intel_pmt_entry *entry);
85 #else
86 static inline void intel_pmt_get_features(struct intel_pmt_entry *entry) {}
87 #endif
88 
89 #endif
90