1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright 2020 Linaro Limited
5 * Author: Daniel Lezcano <daniel.lezcano@linaro.org>
7 * Generic netlink for thermal management framework
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <net/genetlink.h>
12 #include <uapi/linux/thermal.h>
14 #include "thermal_core.h"
16 static const struct genl_multicast_group thermal_genl_mcgrps[] = {
17 { .name = THERMAL_GENL_SAMPLING_GROUP_NAME, },
18 { .name = THERMAL_GENL_EVENT_GROUP_NAME, },
21 static const struct nla_policy thermal_genl_policy[THERMAL_GENL_ATTR_MAX + 1] = {
23 [THERMAL_GENL_ATTR_TZ] = { .type = NLA_NESTED },
24 [THERMAL_GENL_ATTR_TZ_ID] = { .type = NLA_U32 },
25 [THERMAL_GENL_ATTR_TZ_TEMP] = { .type = NLA_U32 },
26 [THERMAL_GENL_ATTR_TZ_TRIP] = { .type = NLA_NESTED },
27 [THERMAL_GENL_ATTR_TZ_TRIP_ID] = { .type = NLA_U32 },
28 [THERMAL_GENL_ATTR_TZ_TRIP_TEMP] = { .type = NLA_U32 },
29 [THERMAL_GENL_ATTR_TZ_TRIP_TYPE] = { .type = NLA_U32 },
30 [THERMAL_GENL_ATTR_TZ_TRIP_HYST] = { .type = NLA_U32 },
31 [THERMAL_GENL_ATTR_TZ_MODE] = { .type = NLA_U32 },
32 [THERMAL_GENL_ATTR_TZ_CDEV_WEIGHT] = { .type = NLA_U32 },
33 [THERMAL_GENL_ATTR_TZ_NAME] = { .type = NLA_STRING,
34 .len = THERMAL_NAME_LENGTH },
36 [THERMAL_GENL_ATTR_TZ_GOV] = { .type = NLA_NESTED },
37 [THERMAL_GENL_ATTR_TZ_GOV_NAME] = { .type = NLA_STRING,
38 .len = THERMAL_NAME_LENGTH },
40 [THERMAL_GENL_ATTR_CDEV] = { .type = NLA_NESTED },
41 [THERMAL_GENL_ATTR_CDEV_ID] = { .type = NLA_U32 },
42 [THERMAL_GENL_ATTR_CDEV_CUR_STATE] = { .type = NLA_U32 },
43 [THERMAL_GENL_ATTR_CDEV_MAX_STATE] = { .type = NLA_U32 },
44 [THERMAL_GENL_ATTR_CDEV_NAME] = { .type = NLA_STRING,
45 .len = THERMAL_NAME_LENGTH },
49 struct nlattr **attrs;
63 typedef int (*cb_t)(struct param *);
65 static struct genl_family thermal_gnl_family;
67 /************************** Sampling encoding *******************************/
69 int thermal_genl_sampling_temp(int id, int temp)
74 skb = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
78 hdr = genlmsg_put(skb, 0, 0, &thermal_gnl_family, 0,
79 THERMAL_GENL_SAMPLING_TEMP);
83 if (nla_put_u32(skb, THERMAL_GENL_ATTR_TZ_ID, id))
86 if (nla_put_u32(skb, THERMAL_GENL_ATTR_TZ_TEMP, temp))
89 genlmsg_end(skb, hdr);
91 genlmsg_multicast(&thermal_gnl_family, skb, 0, 0, GFP_KERNEL);
95 genlmsg_cancel(skb, hdr);
102 /**************************** Event encoding *********************************/
104 static int thermal_genl_event_tz_create(struct param *p)
106 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
107 nla_put_string(p->msg, THERMAL_GENL_ATTR_TZ_NAME, p->name))
113 static int thermal_genl_event_tz(struct param *p)
115 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id))
121 static int thermal_genl_event_tz_trip_up(struct param *p)
123 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
124 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id) ||
125 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TEMP, p->temp))
131 static int thermal_genl_event_tz_trip_add(struct param *p)
133 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
134 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id) ||
135 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_TYPE, p->trip_type) ||
136 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_TEMP, p->trip_temp) ||
137 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_HYST, p->trip_hyst))
143 static int thermal_genl_event_tz_trip_delete(struct param *p)
145 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
146 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id))
152 static int thermal_genl_event_cdev_add(struct param *p)
154 if (nla_put_string(p->msg, THERMAL_GENL_ATTR_CDEV_NAME,
156 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID,
158 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_MAX_STATE,
165 static int thermal_genl_event_cdev_delete(struct param *p)
167 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID, p->cdev_id))
173 static int thermal_genl_event_cdev_state_update(struct param *p)
175 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID,
177 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_CUR_STATE,
184 static int thermal_genl_event_gov_change(struct param *p)
186 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
187 nla_put_string(p->msg, THERMAL_GENL_ATTR_GOV_NAME, p->name))
193 int thermal_genl_event_tz_delete(struct param *p)
194 __attribute__((alias("thermal_genl_event_tz")));
196 int thermal_genl_event_tz_enable(struct param *p)
197 __attribute__((alias("thermal_genl_event_tz")));
199 int thermal_genl_event_tz_disable(struct param *p)
200 __attribute__((alias("thermal_genl_event_tz")));
202 int thermal_genl_event_tz_trip_down(struct param *p)
203 __attribute__((alias("thermal_genl_event_tz_trip_up")));
205 int thermal_genl_event_tz_trip_change(struct param *p)
206 __attribute__((alias("thermal_genl_event_tz_trip_add")));
208 static cb_t event_cb[] = {
209 [THERMAL_GENL_EVENT_TZ_CREATE] = thermal_genl_event_tz_create,
210 [THERMAL_GENL_EVENT_TZ_DELETE] = thermal_genl_event_tz_delete,
211 [THERMAL_GENL_EVENT_TZ_ENABLE] = thermal_genl_event_tz_enable,
212 [THERMAL_GENL_EVENT_TZ_DISABLE] = thermal_genl_event_tz_disable,
213 [THERMAL_GENL_EVENT_TZ_TRIP_UP] = thermal_genl_event_tz_trip_up,
214 [THERMAL_GENL_EVENT_TZ_TRIP_DOWN] = thermal_genl_event_tz_trip_down,
215 [THERMAL_GENL_EVENT_TZ_TRIP_CHANGE] = thermal_genl_event_tz_trip_change,
216 [THERMAL_GENL_EVENT_TZ_TRIP_ADD] = thermal_genl_event_tz_trip_add,
217 [THERMAL_GENL_EVENT_TZ_TRIP_DELETE] = thermal_genl_event_tz_trip_delete,
218 [THERMAL_GENL_EVENT_CDEV_ADD] = thermal_genl_event_cdev_add,
219 [THERMAL_GENL_EVENT_CDEV_DELETE] = thermal_genl_event_cdev_delete,
220 [THERMAL_GENL_EVENT_CDEV_STATE_UPDATE] = thermal_genl_event_cdev_state_update,
221 [THERMAL_GENL_EVENT_TZ_GOV_CHANGE] = thermal_genl_event_gov_change,
225 * Generic netlink event encoding
227 static int thermal_genl_send_event(enum thermal_genl_event event,
234 msg = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
239 hdr = genlmsg_put(msg, 0, 0, &thermal_gnl_family, 0, event);
243 ret = event_cb[event](p);
247 genlmsg_end(msg, hdr);
249 genlmsg_multicast(&thermal_gnl_family, msg, 0, 1, GFP_KERNEL);
254 genlmsg_cancel(msg, hdr);
261 int thermal_notify_tz_create(int tz_id, const char *name)
263 struct param p = { .tz_id = tz_id, .name = name };
265 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_CREATE, &p);
268 int thermal_notify_tz_delete(int tz_id)
270 struct param p = { .tz_id = tz_id };
272 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_DELETE, &p);
275 int thermal_notify_tz_enable(int tz_id)
277 struct param p = { .tz_id = tz_id };
279 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_ENABLE, &p);
282 int thermal_notify_tz_disable(int tz_id)
284 struct param p = { .tz_id = tz_id };
286 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_DISABLE, &p);
289 int thermal_notify_tz_trip_down(int tz_id, int trip_id, int temp)
291 struct param p = { .tz_id = tz_id, .trip_id = trip_id, .temp = temp };
293 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_DOWN, &p);
296 int thermal_notify_tz_trip_up(int tz_id, int trip_id, int temp)
298 struct param p = { .tz_id = tz_id, .trip_id = trip_id, .temp = temp };
300 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_UP, &p);
303 int thermal_notify_tz_trip_add(int tz_id, int trip_id, int trip_type,
304 int trip_temp, int trip_hyst)
306 struct param p = { .tz_id = tz_id, .trip_id = trip_id,
307 .trip_type = trip_type, .trip_temp = trip_temp,
308 .trip_hyst = trip_hyst };
310 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_ADD, &p);
313 int thermal_notify_tz_trip_delete(int tz_id, int trip_id)
315 struct param p = { .tz_id = tz_id, .trip_id = trip_id };
317 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_DELETE, &p);
320 int thermal_notify_tz_trip_change(int tz_id, int trip_id, int trip_type,
321 int trip_temp, int trip_hyst)
323 struct param p = { .tz_id = tz_id, .trip_id = trip_id,
324 .trip_type = trip_type, .trip_temp = trip_temp,
325 .trip_hyst = trip_hyst };
327 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_CHANGE, &p);
330 int thermal_notify_cdev_state_update(int cdev_id, int cdev_state)
332 struct param p = { .cdev_id = cdev_id, .cdev_state = cdev_state };
334 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_STATE_UPDATE, &p);
337 int thermal_notify_cdev_add(int cdev_id, const char *name, int cdev_max_state)
339 struct param p = { .cdev_id = cdev_id, .name = name,
340 .cdev_max_state = cdev_max_state };
342 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_ADD, &p);
345 int thermal_notify_cdev_delete(int cdev_id)
347 struct param p = { .cdev_id = cdev_id };
349 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_DELETE, &p);
352 int thermal_notify_tz_gov_change(int tz_id, const char *name)
354 struct param p = { .tz_id = tz_id, .name = name };
356 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_GOV_CHANGE, &p);
359 /*************************** Command encoding ********************************/
361 static int __thermal_genl_cmd_tz_get_id(struct thermal_zone_device *tz,
364 struct sk_buff *msg = data;
366 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, tz->id) ||
367 nla_put_string(msg, THERMAL_GENL_ATTR_TZ_NAME, tz->type))
373 static int thermal_genl_cmd_tz_get_id(struct param *p)
375 struct sk_buff *msg = p->msg;
376 struct nlattr *start_tz;
379 start_tz = nla_nest_start(msg, THERMAL_GENL_ATTR_TZ);
383 ret = for_each_thermal_zone(__thermal_genl_cmd_tz_get_id, msg);
385 goto out_cancel_nest;
387 nla_nest_end(msg, start_tz);
392 nla_nest_cancel(msg, start_tz);
397 static int thermal_genl_cmd_tz_get_trip(struct param *p)
399 struct sk_buff *msg = p->msg;
400 struct thermal_zone_device *tz;
401 struct nlattr *start_trip;
404 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
407 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
409 tz = thermal_zone_get_by_id(id);
413 start_trip = nla_nest_start(msg, THERMAL_GENL_ATTR_TZ_TRIP);
417 mutex_lock(&tz->lock);
419 for (i = 0; i < tz->trips; i++) {
421 enum thermal_trip_type type;
424 tz->ops->get_trip_type(tz, i, &type);
425 tz->ops->get_trip_temp(tz, i, &temp);
426 if (tz->ops->get_trip_hyst)
427 tz->ops->get_trip_hyst(tz, i, &hyst);
429 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, i) ||
430 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_TYPE, type) ||
431 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_TEMP, temp) ||
432 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_HYST, hyst))
433 goto out_cancel_nest;
436 mutex_unlock(&tz->lock);
438 nla_nest_end(msg, start_trip);
443 mutex_unlock(&tz->lock);
448 static int thermal_genl_cmd_tz_get_temp(struct param *p)
450 struct sk_buff *msg = p->msg;
451 struct thermal_zone_device *tz;
454 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
457 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
459 tz = thermal_zone_get_by_id(id);
463 ret = thermal_zone_get_temp(tz, &temp);
467 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, id) ||
468 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TEMP, temp))
474 static int thermal_genl_cmd_tz_get_gov(struct param *p)
476 struct sk_buff *msg = p->msg;
477 struct thermal_zone_device *tz;
480 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
483 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
485 tz = thermal_zone_get_by_id(id);
489 mutex_lock(&tz->lock);
491 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, id) ||
492 nla_put_string(msg, THERMAL_GENL_ATTR_TZ_GOV_NAME,
496 mutex_unlock(&tz->lock);
501 static int __thermal_genl_cmd_cdev_get(struct thermal_cooling_device *cdev,
504 struct sk_buff *msg = data;
506 if (nla_put_u32(msg, THERMAL_GENL_ATTR_CDEV_ID, cdev->id))
509 if (nla_put_string(msg, THERMAL_GENL_ATTR_CDEV_NAME, cdev->type))
515 static int thermal_genl_cmd_cdev_get(struct param *p)
517 struct sk_buff *msg = p->msg;
518 struct nlattr *start_cdev;
521 start_cdev = nla_nest_start(msg, THERMAL_GENL_ATTR_CDEV);
525 ret = for_each_thermal_cooling_device(__thermal_genl_cmd_cdev_get, msg);
527 goto out_cancel_nest;
529 nla_nest_end(msg, start_cdev);
533 nla_nest_cancel(msg, start_cdev);
538 static cb_t cmd_cb[] = {
539 [THERMAL_GENL_CMD_TZ_GET_ID] = thermal_genl_cmd_tz_get_id,
540 [THERMAL_GENL_CMD_TZ_GET_TRIP] = thermal_genl_cmd_tz_get_trip,
541 [THERMAL_GENL_CMD_TZ_GET_TEMP] = thermal_genl_cmd_tz_get_temp,
542 [THERMAL_GENL_CMD_TZ_GET_GOV] = thermal_genl_cmd_tz_get_gov,
543 [THERMAL_GENL_CMD_CDEV_GET] = thermal_genl_cmd_cdev_get,
546 static int thermal_genl_cmd_dumpit(struct sk_buff *skb,
547 struct netlink_callback *cb)
549 struct param p = { .msg = skb };
550 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
551 int cmd = info->op.cmd;
555 hdr = genlmsg_put(skb, 0, 0, &thermal_gnl_family, 0, cmd);
559 ret = cmd_cb[cmd](&p);
563 genlmsg_end(skb, hdr);
568 genlmsg_cancel(skb, hdr);
573 static int thermal_genl_cmd_doit(struct sk_buff *skb,
574 struct genl_info *info)
576 struct param p = { .attrs = info->attrs };
579 int cmd = info->genlhdr->cmd;
582 msg = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
587 hdr = genlmsg_put_reply(msg, info, &thermal_gnl_family, 0, cmd);
591 ret = cmd_cb[cmd](&p);
595 genlmsg_end(msg, hdr);
597 return genlmsg_reply(msg, info);
600 genlmsg_cancel(msg, hdr);
607 static const struct genl_small_ops thermal_genl_ops[] = {
609 .cmd = THERMAL_GENL_CMD_TZ_GET_ID,
610 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
611 .dumpit = thermal_genl_cmd_dumpit,
614 .cmd = THERMAL_GENL_CMD_TZ_GET_TRIP,
615 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
616 .doit = thermal_genl_cmd_doit,
619 .cmd = THERMAL_GENL_CMD_TZ_GET_TEMP,
620 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
621 .doit = thermal_genl_cmd_doit,
624 .cmd = THERMAL_GENL_CMD_TZ_GET_GOV,
625 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
626 .doit = thermal_genl_cmd_doit,
629 .cmd = THERMAL_GENL_CMD_CDEV_GET,
630 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
631 .dumpit = thermal_genl_cmd_dumpit,
635 static struct genl_family thermal_gnl_family __ro_after_init = {
637 .name = THERMAL_GENL_FAMILY_NAME,
638 .version = THERMAL_GENL_VERSION,
639 .maxattr = THERMAL_GENL_ATTR_MAX,
640 .policy = thermal_genl_policy,
641 .small_ops = thermal_genl_ops,
642 .n_small_ops = ARRAY_SIZE(thermal_genl_ops),
643 .mcgrps = thermal_genl_mcgrps,
644 .n_mcgrps = ARRAY_SIZE(thermal_genl_mcgrps),
647 int __init thermal_netlink_init(void)
649 return genl_register_family(&thermal_gnl_family);