1
2
3
4
5
6
7#include <linux/device.h>
8#include <linux/types.h>
9
10#define SCMI_MAX_STR_SIZE 16
11#define SCMI_MAX_NUM_RATES 16
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27struct scmi_revision_info {
28 u16 major_ver;
29 u16 minor_ver;
30 u8 num_protocols;
31 u8 num_agents;
32 u32 impl_ver;
33 char vendor_id[SCMI_MAX_STR_SIZE];
34 char sub_vendor_id[SCMI_MAX_STR_SIZE];
35};
36
37struct scmi_clock_info {
38 char name[SCMI_MAX_STR_SIZE];
39 bool rate_discrete;
40 union {
41 struct {
42 int num_rates;
43 u64 rates[SCMI_MAX_NUM_RATES];
44 } list;
45 struct {
46 u64 min_rate;
47 u64 max_rate;
48 u64 step_size;
49 } range;
50 };
51};
52
53struct scmi_handle;
54
55
56
57
58
59
60
61
62
63
64
65
66struct scmi_clk_ops {
67 int (*count_get)(const struct scmi_handle *handle);
68
69 const struct scmi_clock_info *(*info_get)
70 (const struct scmi_handle *handle, u32 clk_id);
71 int (*rate_get)(const struct scmi_handle *handle, u32 clk_id,
72 u64 *rate);
73 int (*rate_set)(const struct scmi_handle *handle, u32 clk_id,
74 u32 config, u64 rate);
75 int (*enable)(const struct scmi_handle *handle, u32 clk_id);
76 int (*disable)(const struct scmi_handle *handle, u32 clk_id);
77};
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97struct scmi_perf_ops {
98 int (*limits_set)(const struct scmi_handle *handle, u32 domain,
99 u32 max_perf, u32 min_perf);
100 int (*limits_get)(const struct scmi_handle *handle, u32 domain,
101 u32 *max_perf, u32 *min_perf);
102 int (*level_set)(const struct scmi_handle *handle, u32 domain,
103 u32 level, bool poll);
104 int (*level_get)(const struct scmi_handle *handle, u32 domain,
105 u32 *level, bool poll);
106 int (*device_domain_id)(struct device *dev);
107 int (*transition_latency_get)(const struct scmi_handle *handle,
108 struct device *dev);
109 int (*device_opps_add)(const struct scmi_handle *handle,
110 struct device *dev);
111 int (*freq_set)(const struct scmi_handle *handle, u32 domain,
112 unsigned long rate, bool poll);
113 int (*freq_get)(const struct scmi_handle *handle, u32 domain,
114 unsigned long *rate, bool poll);
115 int (*est_power_get)(const struct scmi_handle *handle, u32 domain,
116 unsigned long *rate, unsigned long *power);
117};
118
119
120
121
122
123
124
125
126
127
128struct scmi_power_ops {
129 int (*num_domains_get)(const struct scmi_handle *handle);
130 char *(*name_get)(const struct scmi_handle *handle, u32 domain);
131#define SCMI_POWER_STATE_TYPE_SHIFT 30
132#define SCMI_POWER_STATE_ID_MASK (BIT(28) - 1)
133#define SCMI_POWER_STATE_PARAM(type, id) \
134 ((((type) & BIT(0)) << SCMI_POWER_STATE_TYPE_SHIFT) | \
135 ((id) & SCMI_POWER_STATE_ID_MASK))
136#define SCMI_POWER_STATE_GENERIC_ON SCMI_POWER_STATE_PARAM(0, 0)
137#define SCMI_POWER_STATE_GENERIC_OFF SCMI_POWER_STATE_PARAM(1, 0)
138 int (*state_set)(const struct scmi_handle *handle, u32 domain,
139 u32 state);
140 int (*state_get)(const struct scmi_handle *handle, u32 domain,
141 u32 *state);
142};
143
144struct scmi_sensor_info {
145 u32 id;
146 u8 type;
147 char name[SCMI_MAX_STR_SIZE];
148};
149
150
151
152
153
154enum scmi_sensor_class {
155 NONE = 0x0,
156 TEMPERATURE_C = 0x2,
157 VOLTAGE = 0x5,
158 CURRENT = 0x6,
159 POWER = 0x7,
160 ENERGY = 0x8,
161};
162
163
164
165
166
167
168
169
170
171
172
173
174struct scmi_sensor_ops {
175 int (*count_get)(const struct scmi_handle *handle);
176
177 const struct scmi_sensor_info *(*info_get)
178 (const struct scmi_handle *handle, u32 sensor_id);
179 int (*configuration_set)(const struct scmi_handle *handle,
180 u32 sensor_id);
181 int (*trip_point_set)(const struct scmi_handle *handle, u32 sensor_id,
182 u8 trip_id, u64 trip_value);
183 int (*reading_get)(const struct scmi_handle *handle, u32 sensor_id,
184 bool async, u64 *value);
185};
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205struct scmi_handle {
206 struct device *dev;
207 struct scmi_revision_info *version;
208 struct scmi_perf_ops *perf_ops;
209 struct scmi_clk_ops *clk_ops;
210 struct scmi_power_ops *power_ops;
211 struct scmi_sensor_ops *sensor_ops;
212
213 void *perf_priv;
214 void *clk_priv;
215 void *power_priv;
216 void *sensor_priv;
217};
218
219enum scmi_std_protocol {
220 SCMI_PROTOCOL_BASE = 0x10,
221 SCMI_PROTOCOL_POWER = 0x11,
222 SCMI_PROTOCOL_SYSTEM = 0x12,
223 SCMI_PROTOCOL_PERF = 0x13,
224 SCMI_PROTOCOL_CLOCK = 0x14,
225 SCMI_PROTOCOL_SENSOR = 0x15,
226};
227
228struct scmi_device {
229 u32 id;
230 u8 protocol_id;
231 struct device dev;
232 struct scmi_handle *handle;
233};
234
235#define to_scmi_dev(d) container_of(d, struct scmi_device, dev)
236
237struct scmi_device *
238scmi_device_create(struct device_node *np, struct device *parent, int protocol);
239void scmi_device_destroy(struct scmi_device *scmi_dev);
240
241struct scmi_device_id {
242 u8 protocol_id;
243};
244
245struct scmi_driver {
246 const char *name;
247 int (*probe)(struct scmi_device *sdev);
248 void (*remove)(struct scmi_device *sdev);
249 const struct scmi_device_id *id_table;
250
251 struct device_driver driver;
252};
253
254#define to_scmi_driver(d) container_of(d, struct scmi_driver, driver)
255
256#ifdef CONFIG_ARM_SCMI_PROTOCOL
257int scmi_driver_register(struct scmi_driver *driver,
258 struct module *owner, const char *mod_name);
259void scmi_driver_unregister(struct scmi_driver *driver);
260#else
261static inline int
262scmi_driver_register(struct scmi_driver *driver, struct module *owner,
263 const char *mod_name)
264{
265 return -EINVAL;
266}
267
268static inline void scmi_driver_unregister(struct scmi_driver *driver) {}
269#endif
270
271#define scmi_register(driver) \
272 scmi_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
273#define scmi_unregister(driver) \
274 scmi_driver_unregister(driver)
275
276
277
278
279
280
281
282
283
284#define module_scmi_driver(__scmi_driver) \
285 module_driver(__scmi_driver, scmi_register, scmi_unregister)
286
287typedef int (*scmi_prot_init_fn_t)(struct scmi_handle *);
288int scmi_protocol_register(int protocol_id, scmi_prot_init_fn_t fn);
289void scmi_protocol_unregister(int protocol_id);
290