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);
101 /**************************** Event encoding *********************************/
103 static int thermal_genl_event_tz_create(struct param *p)
105 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
106 nla_put_string(p->msg, THERMAL_GENL_ATTR_TZ_NAME, p->name))
112 static int thermal_genl_event_tz(struct param *p)
114 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id))
120 static int thermal_genl_event_tz_trip_up(struct param *p)
122 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
123 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id))
129 static int thermal_genl_event_tz_trip_add(struct param *p)
131 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
132 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id) ||
133 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_TYPE, p->trip_type) ||
134 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_TEMP, p->trip_temp) ||
135 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_HYST, p->trip_hyst))
141 static int thermal_genl_event_tz_trip_delete(struct param *p)
143 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
144 nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, p->trip_id))
150 static int thermal_genl_event_cdev_add(struct param *p)
152 if (nla_put_string(p->msg, THERMAL_GENL_ATTR_CDEV_NAME,
154 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID,
156 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_MAX_STATE,
163 static int thermal_genl_event_cdev_delete(struct param *p)
165 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID, p->cdev_id))
171 static int thermal_genl_event_cdev_state_update(struct param *p)
173 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_ID,
175 nla_put_u32(p->msg, THERMAL_GENL_ATTR_CDEV_CUR_STATE,
182 static int thermal_genl_event_gov_change(struct param *p)
184 if (nla_put_u32(p->msg, THERMAL_GENL_ATTR_TZ_ID, p->tz_id) ||
185 nla_put_string(p->msg, THERMAL_GENL_ATTR_GOV_NAME, p->name))
191 int thermal_genl_event_tz_delete(struct param *p)
192 __attribute__((alias("thermal_genl_event_tz")));
194 int thermal_genl_event_tz_enable(struct param *p)
195 __attribute__((alias("thermal_genl_event_tz")));
197 int thermal_genl_event_tz_disable(struct param *p)
198 __attribute__((alias("thermal_genl_event_tz")));
200 int thermal_genl_event_tz_trip_down(struct param *p)
201 __attribute__((alias("thermal_genl_event_tz_trip_up")));
203 int thermal_genl_event_tz_trip_change(struct param *p)
204 __attribute__((alias("thermal_genl_event_tz_trip_add")));
206 static cb_t event_cb[] = {
207 [THERMAL_GENL_EVENT_TZ_CREATE] = thermal_genl_event_tz_create,
208 [THERMAL_GENL_EVENT_TZ_DELETE] = thermal_genl_event_tz_delete,
209 [THERMAL_GENL_EVENT_TZ_ENABLE] = thermal_genl_event_tz_enable,
210 [THERMAL_GENL_EVENT_TZ_DISABLE] = thermal_genl_event_tz_disable,
211 [THERMAL_GENL_EVENT_TZ_TRIP_UP] = thermal_genl_event_tz_trip_up,
212 [THERMAL_GENL_EVENT_TZ_TRIP_DOWN] = thermal_genl_event_tz_trip_down,
213 [THERMAL_GENL_EVENT_TZ_TRIP_CHANGE] = thermal_genl_event_tz_trip_change,
214 [THERMAL_GENL_EVENT_TZ_TRIP_ADD] = thermal_genl_event_tz_trip_add,
215 [THERMAL_GENL_EVENT_TZ_TRIP_DELETE] = thermal_genl_event_tz_trip_delete,
216 [THERMAL_GENL_EVENT_CDEV_ADD] = thermal_genl_event_cdev_add,
217 [THERMAL_GENL_EVENT_CDEV_DELETE] = thermal_genl_event_cdev_delete,
218 [THERMAL_GENL_EVENT_CDEV_STATE_UPDATE] = thermal_genl_event_cdev_state_update,
219 [THERMAL_GENL_EVENT_TZ_GOV_CHANGE] = thermal_genl_event_gov_change,
223 * Generic netlink event encoding
225 static int thermal_genl_send_event(enum thermal_genl_event event,
232 msg = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
237 hdr = genlmsg_put(msg, 0, 0, &thermal_gnl_family, 0, event);
241 ret = event_cb[event](p);
245 genlmsg_end(msg, hdr);
247 genlmsg_multicast(&thermal_gnl_family, msg, 0, 1, GFP_KERNEL);
252 genlmsg_cancel(msg, hdr);
259 int thermal_notify_tz_create(int tz_id, const char *name)
261 struct param p = { .tz_id = tz_id, .name = name };
263 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_CREATE, &p);
266 int thermal_notify_tz_delete(int tz_id)
268 struct param p = { .tz_id = tz_id };
270 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_DELETE, &p);
273 int thermal_notify_tz_enable(int tz_id)
275 struct param p = { .tz_id = tz_id };
277 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_ENABLE, &p);
280 int thermal_notify_tz_disable(int tz_id)
282 struct param p = { .tz_id = tz_id };
284 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_DISABLE, &p);
287 int thermal_notify_tz_trip_down(int tz_id, int trip_id)
289 struct param p = { .tz_id = tz_id, .trip_id = trip_id };
291 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_DOWN, &p);
294 int thermal_notify_tz_trip_up(int tz_id, int trip_id)
296 struct param p = { .tz_id = tz_id, .trip_id = trip_id };
298 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_UP, &p);
301 int thermal_notify_tz_trip_add(int tz_id, int trip_id, int trip_type,
302 int trip_temp, int trip_hyst)
304 struct param p = { .tz_id = tz_id, .trip_id = trip_id,
305 .trip_type = trip_type, .trip_temp = trip_temp,
306 .trip_hyst = trip_hyst };
308 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_ADD, &p);
311 int thermal_notify_tz_trip_delete(int tz_id, int trip_id)
313 struct param p = { .tz_id = tz_id, .trip_id = trip_id };
315 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_DELETE, &p);
318 int thermal_notify_tz_trip_change(int tz_id, int trip_id, int trip_type,
319 int trip_temp, int trip_hyst)
321 struct param p = { .tz_id = tz_id, .trip_id = trip_id,
322 .trip_type = trip_type, .trip_temp = trip_temp,
323 .trip_hyst = trip_hyst };
325 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_TRIP_CHANGE, &p);
328 int thermal_notify_cdev_state_update(int cdev_id, int cdev_state)
330 struct param p = { .cdev_id = cdev_id, .cdev_state = cdev_state };
332 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_STATE_UPDATE, &p);
335 int thermal_notify_cdev_add(int cdev_id, const char *name, int cdev_max_state)
337 struct param p = { .cdev_id = cdev_id, .name = name,
338 .cdev_max_state = cdev_max_state };
340 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_ADD, &p);
343 int thermal_notify_cdev_delete(int cdev_id)
345 struct param p = { .cdev_id = cdev_id };
347 return thermal_genl_send_event(THERMAL_GENL_EVENT_CDEV_DELETE, &p);
350 int thermal_notify_tz_gov_change(int tz_id, const char *name)
352 struct param p = { .tz_id = tz_id, .name = name };
354 return thermal_genl_send_event(THERMAL_GENL_EVENT_TZ_GOV_CHANGE, &p);
357 /*************************** Command encoding ********************************/
359 static int __thermal_genl_cmd_tz_get_id(struct thermal_zone_device *tz,
362 struct sk_buff *msg = data;
364 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, tz->id) ||
365 nla_put_string(msg, THERMAL_GENL_ATTR_TZ_NAME, tz->type))
371 static int thermal_genl_cmd_tz_get_id(struct param *p)
373 struct sk_buff *msg = p->msg;
374 struct nlattr *start_tz;
377 start_tz = nla_nest_start(msg, THERMAL_GENL_ATTR_TZ);
381 ret = for_each_thermal_zone(__thermal_genl_cmd_tz_get_id, msg);
383 goto out_cancel_nest;
385 nla_nest_end(msg, start_tz);
390 nla_nest_cancel(msg, start_tz);
395 static int thermal_genl_cmd_tz_get_trip(struct param *p)
397 struct sk_buff *msg = p->msg;
398 struct thermal_zone_device *tz;
399 struct nlattr *start_trip;
402 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
405 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
407 tz = thermal_zone_get_by_id(id);
411 start_trip = nla_nest_start(msg, THERMAL_GENL_ATTR_TZ_TRIP);
415 mutex_lock(&tz->lock);
417 for (i = 0; i < tz->trips; i++) {
419 enum thermal_trip_type type;
422 tz->ops->get_trip_type(tz, i, &type);
423 tz->ops->get_trip_temp(tz, i, &temp);
424 tz->ops->get_trip_hyst(tz, i, &hyst);
426 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_ID, i) ||
427 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_TYPE, type) ||
428 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_TEMP, temp) ||
429 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TRIP_HYST, hyst))
430 goto out_cancel_nest;
433 mutex_unlock(&tz->lock);
435 nla_nest_end(msg, start_trip);
440 mutex_unlock(&tz->lock);
445 static int thermal_genl_cmd_tz_get_temp(struct param *p)
447 struct sk_buff *msg = p->msg;
448 struct thermal_zone_device *tz;
451 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
454 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
456 tz = thermal_zone_get_by_id(id);
460 ret = thermal_zone_get_temp(tz, &temp);
464 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, id) ||
465 nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_TEMP, temp))
471 static int thermal_genl_cmd_tz_get_gov(struct param *p)
473 struct sk_buff *msg = p->msg;
474 struct thermal_zone_device *tz;
477 if (!p->attrs[THERMAL_GENL_ATTR_TZ_ID])
480 id = nla_get_u32(p->attrs[THERMAL_GENL_ATTR_TZ_ID]);
482 tz = thermal_zone_get_by_id(id);
486 mutex_lock(&tz->lock);
488 if (nla_put_u32(msg, THERMAL_GENL_ATTR_TZ_ID, id) ||
489 nla_put_string(msg, THERMAL_GENL_ATTR_TZ_GOV_NAME,
493 mutex_unlock(&tz->lock);
498 static int __thermal_genl_cmd_cdev_get(struct thermal_cooling_device *cdev,
501 struct sk_buff *msg = data;
503 if (nla_put_u32(msg, THERMAL_GENL_ATTR_CDEV_ID, cdev->id))
506 if (nla_put_string(msg, THERMAL_GENL_ATTR_CDEV_NAME, cdev->type))
512 static int thermal_genl_cmd_cdev_get(struct param *p)
514 struct sk_buff *msg = p->msg;
515 struct nlattr *start_cdev;
518 start_cdev = nla_nest_start(msg, THERMAL_GENL_ATTR_CDEV);
522 ret = for_each_thermal_cooling_device(__thermal_genl_cmd_cdev_get, msg);
524 goto out_cancel_nest;
526 nla_nest_end(msg, start_cdev);
530 nla_nest_cancel(msg, start_cdev);
535 static cb_t cmd_cb[] = {
536 [THERMAL_GENL_CMD_TZ_GET_ID] = thermal_genl_cmd_tz_get_id,
537 [THERMAL_GENL_CMD_TZ_GET_TRIP] = thermal_genl_cmd_tz_get_trip,
538 [THERMAL_GENL_CMD_TZ_GET_TEMP] = thermal_genl_cmd_tz_get_temp,
539 [THERMAL_GENL_CMD_TZ_GET_GOV] = thermal_genl_cmd_tz_get_gov,
540 [THERMAL_GENL_CMD_CDEV_GET] = thermal_genl_cmd_cdev_get,
543 static int thermal_genl_cmd_dumpit(struct sk_buff *skb,
544 struct netlink_callback *cb)
546 struct param p = { .msg = skb };
547 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
548 int cmd = info->ops->cmd;
552 hdr = genlmsg_put(skb, 0, 0, &thermal_gnl_family, 0, cmd);
556 ret = cmd_cb[cmd](&p);
560 genlmsg_end(skb, hdr);
565 genlmsg_cancel(skb, hdr);
570 static int thermal_genl_cmd_doit(struct sk_buff *skb,
571 struct genl_info *info)
573 struct param p = { .attrs = info->attrs };
576 int cmd = info->genlhdr->cmd;
579 msg = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
584 hdr = genlmsg_put_reply(msg, info, &thermal_gnl_family, 0, cmd);
588 ret = cmd_cb[cmd](&p);
592 genlmsg_end(msg, hdr);
594 return genlmsg_reply(msg, info);
597 genlmsg_cancel(msg, hdr);
604 static const struct genl_ops thermal_genl_ops[] = {
606 .cmd = THERMAL_GENL_CMD_TZ_GET_ID,
607 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
608 .dumpit = thermal_genl_cmd_dumpit,
611 .cmd = THERMAL_GENL_CMD_TZ_GET_TRIP,
612 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
613 .doit = thermal_genl_cmd_doit,
616 .cmd = THERMAL_GENL_CMD_TZ_GET_TEMP,
617 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
618 .doit = thermal_genl_cmd_doit,
621 .cmd = THERMAL_GENL_CMD_TZ_GET_GOV,
622 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
623 .doit = thermal_genl_cmd_doit,
626 .cmd = THERMAL_GENL_CMD_CDEV_GET,
627 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
628 .dumpit = thermal_genl_cmd_dumpit,
632 static struct genl_family thermal_gnl_family __ro_after_init = {
634 .name = THERMAL_GENL_FAMILY_NAME,
635 .version = THERMAL_GENL_VERSION,
636 .maxattr = THERMAL_GENL_ATTR_MAX,
637 .policy = thermal_genl_policy,
638 .ops = thermal_genl_ops,
639 .n_ops = ARRAY_SIZE(thermal_genl_ops),
640 .mcgrps = thermal_genl_mcgrps,
641 .n_mcgrps = ARRAY_SIZE(thermal_genl_mcgrps),
644 int __init thermal_netlink_init(void)
646 return genl_register_family(&thermal_gnl_family);