net: genetlink: Move initialization to core_initcall
[linux-2.6-block.git] / drivers / thermal / thermal_core.c
CommitLineData
7e3c0381 1// SPDX-License-Identifier: GPL-2.0
203d3d4a
ZR
2/*
3 * thermal.c - Generic Thermal Management Sysfs support.
4 *
5 * Copyright (C) 2008 Intel Corp
6 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
7 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
203d3d4a
ZR
8 */
9
c5a01dd5
JP
10#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11
203d3d4a
ZR
12#include <linux/device.h>
13#include <linux/err.h>
3f0cfea3 14#include <linux/export.h>
5a0e3ad6 15#include <linux/slab.h>
203d3d4a
ZR
16#include <linux/kdev_t.h>
17#include <linux/idr.h>
18#include <linux/thermal.h>
b1569e99 19#include <linux/reboot.h>
42a5bf50 20#include <linux/string.h>
a116b5d4 21#include <linux/of.h>
ff140fea 22#include <linux/suspend.h>
203d3d4a 23
100a8fdb
PA
24#define CREATE_TRACE_POINTS
25#include <trace/events/thermal.h>
26
71350db4 27#include "thermal_core.h"
0dd88793 28#include "thermal_hwmon.h"
71350db4 29
b31ef828
MW
30static DEFINE_IDA(thermal_tz_ida);
31static DEFINE_IDA(thermal_cdev_ida);
203d3d4a
ZR
32
33static LIST_HEAD(thermal_tz_list);
34static LIST_HEAD(thermal_cdev_list);
a4a15485
D
35static LIST_HEAD(thermal_governor_list);
36
203d3d4a 37static DEFINE_MUTEX(thermal_list_lock);
a4a15485 38static DEFINE_MUTEX(thermal_governor_lock);
e441fd68 39static DEFINE_MUTEX(poweroff_lock);
a4a15485 40
ff140fea 41static atomic_t in_suspend;
e441fd68 42static bool power_off_triggered;
ff140fea 43
f2234bcd
ZR
44static struct thermal_governor *def_governor;
45
1b4f4849
EV
46/*
47 * Governor section: set of functions to handle thermal governors
48 *
49 * Functions to help in the life cycle of thermal governors within
50 * the thermal core and by the thermal governor code.
51 */
52
a4a15485
D
53static struct thermal_governor *__find_governor(const char *name)
54{
55 struct thermal_governor *pos;
56
f2234bcd
ZR
57 if (!name || !name[0])
58 return def_governor;
59
a4a15485 60 list_for_each_entry(pos, &thermal_governor_list, governor_list)
484ac2f3 61 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
a4a15485
D
62 return pos;
63
64 return NULL;
65}
66
e33df1d2
JM
67/**
68 * bind_previous_governor() - bind the previous governor of the thermal zone
69 * @tz: a valid pointer to a struct thermal_zone_device
70 * @failed_gov_name: the name of the governor that failed to register
71 *
72 * Register the previous governor of the thermal zone after a new
73 * governor has failed to be bound.
74 */
75static void bind_previous_governor(struct thermal_zone_device *tz,
76 const char *failed_gov_name)
77{
78 if (tz->governor && tz->governor->bind_to_tz) {
79 if (tz->governor->bind_to_tz(tz)) {
80 dev_err(&tz->device,
81 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
82 failed_gov_name, tz->governor->name, tz->type);
83 tz->governor = NULL;
84 }
85 }
86}
87
88/**
89 * thermal_set_governor() - Switch to another governor
90 * @tz: a valid pointer to a struct thermal_zone_device
91 * @new_gov: pointer to the new governor
92 *
93 * Change the governor of thermal zone @tz.
94 *
95 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
96 */
97static int thermal_set_governor(struct thermal_zone_device *tz,
98 struct thermal_governor *new_gov)
99{
100 int ret = 0;
101
102 if (tz->governor && tz->governor->unbind_from_tz)
103 tz->governor->unbind_from_tz(tz);
104
105 if (new_gov && new_gov->bind_to_tz) {
106 ret = new_gov->bind_to_tz(tz);
107 if (ret) {
108 bind_previous_governor(tz, new_gov->name);
109
110 return ret;
111 }
112 }
113
114 tz->governor = new_gov;
115
116 return ret;
117}
118
a4a15485
D
119int thermal_register_governor(struct thermal_governor *governor)
120{
121 int err;
122 const char *name;
123 struct thermal_zone_device *pos;
124
125 if (!governor)
126 return -EINVAL;
127
128 mutex_lock(&thermal_governor_lock);
129
130 err = -EBUSY;
5027ba36 131 if (!__find_governor(governor->name)) {
eb7be329
EV
132 bool match_default;
133
a4a15485
D
134 err = 0;
135 list_add(&governor->governor_list, &thermal_governor_list);
eb7be329
EV
136 match_default = !strncmp(governor->name,
137 DEFAULT_THERMAL_GOVERNOR,
138 THERMAL_NAME_LENGTH);
139
140 if (!def_governor && match_default)
f2234bcd 141 def_governor = governor;
a4a15485
D
142 }
143
144 mutex_lock(&thermal_list_lock);
145
146 list_for_each_entry(pos, &thermal_tz_list, node) {
f2234bcd
ZR
147 /*
148 * only thermal zones with specified tz->tzp->governor_name
149 * may run with tz->govenor unset
150 */
a4a15485
D
151 if (pos->governor)
152 continue;
f2234bcd
ZR
153
154 name = pos->tzp->governor_name;
155
e33df1d2
JM
156 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
157 int ret;
158
159 ret = thermal_set_governor(pos, governor);
160 if (ret)
161 dev_err(&pos->device,
162 "Failed to set governor %s for thermal zone %s: %d\n",
163 governor->name, pos->type, ret);
164 }
a4a15485
D
165 }
166
167 mutex_unlock(&thermal_list_lock);
168 mutex_unlock(&thermal_governor_lock);
169
170 return err;
171}
a4a15485
D
172
173void thermal_unregister_governor(struct thermal_governor *governor)
174{
175 struct thermal_zone_device *pos;
176
177 if (!governor)
178 return;
179
180 mutex_lock(&thermal_governor_lock);
181
5027ba36 182 if (!__find_governor(governor->name))
a4a15485
D
183 goto exit;
184
185 mutex_lock(&thermal_list_lock);
186
187 list_for_each_entry(pos, &thermal_tz_list, node) {
484ac2f3 188 if (!strncasecmp(pos->governor->name, governor->name,
eb7be329 189 THERMAL_NAME_LENGTH))
e33df1d2 190 thermal_set_governor(pos, NULL);
a4a15485
D
191 }
192
193 mutex_unlock(&thermal_list_lock);
194 list_del(&governor->governor_list);
195exit:
196 mutex_unlock(&thermal_governor_lock);
9b4298a0 197}
9b4298a0 198
1b4f4849
EV
199int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
200 char *policy)
9b4298a0 201{
1b4f4849
EV
202 struct thermal_governor *gov;
203 int ret = -EINVAL;
9b4298a0 204
1b4f4849 205 mutex_lock(&thermal_governor_lock);
9b4298a0 206 mutex_lock(&tz->lock);
9b4298a0 207
1b4f4849
EV
208 gov = __find_governor(strim(policy));
209 if (!gov)
210 goto exit;
9b4298a0 211
1b4f4849 212 ret = thermal_set_governor(tz, gov);
9b4298a0 213
1b4f4849
EV
214exit:
215 mutex_unlock(&tz->lock);
216 mutex_unlock(&thermal_governor_lock);
9b4298a0 217
55cdf0a2
DL
218 thermal_notify_tz_gov_change(tz->id, policy);
219
1b4f4849 220 return ret;
7e8ee1e9
D
221}
222
1b4f4849 223int thermal_build_list_of_policies(char *buf)
7e8ee1e9 224{
1b4f4849
EV
225 struct thermal_governor *pos;
226 ssize_t count = 0;
227 ssize_t size = PAGE_SIZE;
7e8ee1e9 228
1b4f4849 229 mutex_lock(&thermal_governor_lock);
a8892d83 230
1b4f4849
EV
231 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
232 size = PAGE_SIZE - count;
233 count += scnprintf(buf + count, size, "%s ", pos->name);
7e8ee1e9 234 }
1b4f4849 235 count += scnprintf(buf + count, size, "\n");
7e8ee1e9 236
1b4f4849 237 mutex_unlock(&thermal_governor_lock);
7e8ee1e9 238
1b4f4849 239 return count;
7e8ee1e9
D
240}
241
57c5b2ec 242static void __init thermal_unregister_governors(void)
7e8ee1e9 243{
57c5b2ec
DL
244 struct thermal_governor **governor;
245
246 for_each_governor_table(governor)
247 thermal_unregister_governor(*governor);
248}
7e8ee1e9 249
57c5b2ec
DL
250static int __init thermal_register_governors(void)
251{
252 int ret = 0;
253 struct thermal_governor **governor;
7e8ee1e9 254
57c5b2ec
DL
255 for_each_governor_table(governor) {
256 ret = thermal_register_governor(*governor);
257 if (ret) {
258 pr_err("Failed to register governor: '%s'",
259 (*governor)->name);
260 break;
261 }
7e8ee1e9 262
57c5b2ec
DL
263 pr_info("Registered thermal governor '%s'",
264 (*governor)->name);
265 }
7e8ee1e9 266
57c5b2ec
DL
267 if (ret) {
268 struct thermal_governor **gov;
7e8ee1e9 269
57c5b2ec
DL
270 for_each_governor_table(gov) {
271 if (gov == governor)
272 break;
273 thermal_unregister_governor(*gov);
274 }
275 }
7e8ee1e9 276
57c5b2ec 277 return ret;
7e8ee1e9
D
278}
279
8772e185
EV
280/*
281 * Zone update section: main control loop applied to each zone while monitoring
282 *
283 * in polling mode. The monitoring is done using a workqueue.
284 * Same update may be done on a zone by calling thermal_zone_device_update().
285 *
286 * An update means:
287 * - Non-critical trips will invoke the governor responsible for that zone;
288 * - Hot trips will produce a notification to userspace;
289 * - Critical trip point will cause a system shutdown.
290 */
0c01ebbf
D
291static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
292 int delay)
293{
294 if (delay > 1000)
c2b59d27
JG
295 mod_delayed_work(system_freezable_power_efficient_wq,
296 &tz->poll_queue,
0c01ebbf
D
297 round_jiffies(msecs_to_jiffies(delay)));
298 else if (delay)
c2b59d27
JG
299 mod_delayed_work(system_freezable_power_efficient_wq,
300 &tz->poll_queue,
0c01ebbf
D
301 msecs_to_jiffies(delay));
302 else
163b00cd 303 cancel_delayed_work(&tz->poll_queue);
0c01ebbf
D
304}
305
b56bdff7
AP
306static inline bool should_stop_polling(struct thermal_zone_device *tz)
307{
308 return !thermal_zone_device_is_enabled(tz);
309}
310
0c01ebbf
D
311static void monitor_thermal_zone(struct thermal_zone_device *tz)
312{
b56bdff7
AP
313 bool stop;
314
315 stop = should_stop_polling(tz);
316
0c01ebbf
D
317 mutex_lock(&tz->lock);
318
b56bdff7 319 if (!stop && tz->passive)
0c01ebbf 320 thermal_zone_device_set_polling(tz, tz->passive_delay);
b56bdff7 321 else if (!stop && tz->polling_delay)
0c01ebbf
D
322 thermal_zone_device_set_polling(tz, tz->polling_delay);
323 else
324 thermal_zone_device_set_polling(tz, 0);
325
326 mutex_unlock(&tz->lock);
327}
328
5be52fcc 329static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
0c01ebbf 330{
f2234bcd
ZR
331 tz->governor ? tz->governor->throttle(tz, trip) :
332 def_governor->throttle(tz, trip);
0c01ebbf
D
333}
334
ef1d87e0
K
335/**
336 * thermal_emergency_poweroff_func - emergency poweroff work after a known delay
337 * @work: work_struct associated with the emergency poweroff function
338 *
339 * This function is called in very critical situations to force
340 * a kernel poweroff after a configurable timeout value.
341 */
342static void thermal_emergency_poweroff_func(struct work_struct *work)
343{
344 /*
345 * We have reached here after the emergency thermal shutdown
346 * Waiting period has expired. This means orderly_poweroff has
347 * not been able to shut off the system for some reason.
348 * Try to shut down the system immediately using kernel_power_off
349 * if populated
350 */
351 WARN(1, "Attempting kernel_power_off: Temperature too high\n");
352 kernel_power_off();
353
354 /*
355 * Worst of the worst case trigger emergency restart
356 */
357 WARN(1, "Attempting emergency_restart: Temperature too high\n");
358 emergency_restart();
359}
360
361static DECLARE_DELAYED_WORK(thermal_emergency_poweroff_work,
362 thermal_emergency_poweroff_func);
363
364/**
365 * thermal_emergency_poweroff - Trigger an emergency system poweroff
366 *
367 * This may be called from any critical situation to trigger a system shutdown
368 * after a known period of time. By default this is not scheduled.
369 */
c4b379d0 370static void thermal_emergency_poweroff(void)
ef1d87e0
K
371{
372 int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
373 /*
374 * poweroff_delay_ms must be a carefully profiled positive value.
375 * Its a must for thermal_emergency_poweroff_work to be scheduled
376 */
377 if (poweroff_delay_ms <= 0)
378 return;
379 schedule_delayed_work(&thermal_emergency_poweroff_work,
380 msecs_to_jiffies(poweroff_delay_ms));
381}
382
0c01ebbf 383static void handle_critical_trips(struct thermal_zone_device *tz,
eb7be329 384 int trip, enum thermal_trip_type trip_type)
0c01ebbf 385{
17e8351a 386 int trip_temp;
0c01ebbf
D
387
388 tz->ops->get_trip_temp(tz, trip, &trip_temp);
389
390 /* If we have not crossed the trip_temp, we do not care. */
84ffe3ec 391 if (trip_temp <= 0 || tz->temperature < trip_temp)
0c01ebbf
D
392 return;
393
208cd822
PA
394 trace_thermal_zone_trip(tz, trip, trip_type);
395
0c01ebbf
D
396 if (tz->ops->notify)
397 tz->ops->notify(tz, trip, trip_type);
398
399 if (trip_type == THERMAL_TRIP_CRITICAL) {
923e0b1e 400 dev_emerg(&tz->device,
039f6cf5 401 "critical temperature reached (%d C), shutting down\n",
923e0b1e 402 tz->temperature / 1000);
e441fd68
K
403 mutex_lock(&poweroff_lock);
404 if (!power_off_triggered) {
ef1d87e0
K
405 /*
406 * Queue a backup emergency shutdown in the event of
407 * orderly_poweroff failure
408 */
409 thermal_emergency_poweroff();
e441fd68
K
410 orderly_poweroff(true);
411 power_off_triggered = true;
412 }
413 mutex_unlock(&poweroff_lock);
0c01ebbf
D
414 }
415}
416
417static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
418{
419 enum thermal_trip_type type;
55cdf0a2 420 int trip_temp, hyst = 0;
0c01ebbf 421
81ad4276
ZR
422 /* Ignore disabled trip points */
423 if (test_bit(trip, &tz->trips_disabled))
424 return;
425
55cdf0a2 426 tz->ops->get_trip_temp(tz, trip, &trip_temp);
0c01ebbf 427 tz->ops->get_trip_type(tz, trip, &type);
55cdf0a2
DL
428 if (tz->ops->get_trip_hyst)
429 tz->ops->get_trip_hyst(tz, trip, &hyst);
430
431 if (tz->last_temperature != THERMAL_TEMP_INVALID) {
432 if (tz->last_temperature < trip_temp &&
433 tz->temperature >= trip_temp)
434 thermal_notify_tz_trip_up(tz->id, trip);
435 if (tz->last_temperature >= trip_temp &&
436 tz->temperature < (trip_temp - hyst))
437 thermal_notify_tz_trip_down(tz->id, trip);
438 }
0c01ebbf
D
439
440 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
441 handle_critical_trips(tz, trip, type);
442 else
5be52fcc 443 handle_non_critical_trips(tz, trip);
0c01ebbf
D
444 /*
445 * Alright, we handled this trip successfully.
446 * So, start monitoring again.
447 */
448 monitor_thermal_zone(tz);
449}
450
451static void update_temperature(struct thermal_zone_device *tz)
452{
17e8351a 453 int temp, ret;
0c01ebbf 454
e6e238c3 455 ret = thermal_zone_get_temp(tz, &temp);
0c01ebbf 456 if (ret) {
7e497a73
HG
457 if (ret != -EAGAIN)
458 dev_warn(&tz->device,
459 "failed to read out thermal zone (%d)\n",
460 ret);
e6e238c3 461 return;
0c01ebbf
D
462 }
463
e6e238c3 464 mutex_lock(&tz->lock);
0c01ebbf
D
465 tz->last_temperature = tz->temperature;
466 tz->temperature = temp;
0c01ebbf 467 mutex_unlock(&tz->lock);
06475b55 468
100a8fdb 469 trace_thermal_temperature(tz);
55cdf0a2
DL
470
471 thermal_genl_sampling_temp(tz->id, temp);
bb431ba2
ZR
472}
473
964f4843 474static void thermal_zone_device_init(struct thermal_zone_device *tz)
bb431ba2
ZR
475{
476 struct thermal_instance *pos;
bb431ba2 477 tz->temperature = THERMAL_TEMP_INVALID;
bb431ba2
ZR
478 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
479 pos->initialized = false;
0c01ebbf
D
480}
481
964f4843
WW
482static void thermal_zone_device_reset(struct thermal_zone_device *tz)
483{
484 tz->passive = 0;
485 thermal_zone_device_init(tz);
486}
487
ac5d9ecc
AP
488static int thermal_zone_device_set_mode(struct thermal_zone_device *tz,
489 enum thermal_device_mode mode)
490{
491 int ret = 0;
492
493 mutex_lock(&tz->lock);
494
495 /* do nothing if mode isn't changing */
496 if (mode == tz->mode) {
497 mutex_unlock(&tz->lock);
498
499 return ret;
500 }
501
f5e50bf4
AP
502 if (tz->ops->change_mode)
503 ret = tz->ops->change_mode(tz, mode);
ac5d9ecc
AP
504
505 if (!ret)
506 tz->mode = mode;
507
508 mutex_unlock(&tz->lock);
509
510 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
511
512 return ret;
513}
514
515int thermal_zone_device_enable(struct thermal_zone_device *tz)
516{
517 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
518}
519EXPORT_SYMBOL_GPL(thermal_zone_device_enable);
520
521int thermal_zone_device_disable(struct thermal_zone_device *tz)
522{
523 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
524}
525EXPORT_SYMBOL_GPL(thermal_zone_device_disable);
526
527int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
528{
529 enum thermal_device_mode mode;
530
531 mutex_lock(&tz->lock);
532
533 mode = tz->mode;
534
535 mutex_unlock(&tz->lock);
536
537 return mode == THERMAL_DEVICE_ENABLED;
538}
ac5d9ecc 539
0e70f466
SP
540void thermal_zone_device_update(struct thermal_zone_device *tz,
541 enum thermal_notify_event event)
0c01ebbf
D
542{
543 int count;
544
b56bdff7
AP
545 if (should_stop_polling(tz))
546 return;
547
ff140fea
ZR
548 if (atomic_read(&in_suspend))
549 return;
550
81bd4e1c
EV
551 if (!tz->ops->get_temp)
552 return;
553
0c01ebbf
D
554 update_temperature(tz);
555
060c034a
SH
556 thermal_zone_set_trips(tz);
557
0e70f466
SP
558 tz->notify_event = event;
559
0c01ebbf
D
560 for (count = 0; count < tz->trips; count++)
561 handle_thermal_trip(tz, count);
562}
910cb1e3 563EXPORT_SYMBOL_GPL(thermal_zone_device_update);
0c01ebbf 564
106339ab
EV
565/**
566 * thermal_notify_framework - Sensor drivers use this API to notify framework
567 * @tz: thermal zone device
568 * @trip: indicates which trip point has been crossed
569 *
570 * This function handles the trip events from sensor drivers. It starts
571 * throttling the cooling devices according to the policy configured.
572 * For CRITICAL and HOT trip points, this notifies the respective drivers,
573 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
574 * The throttling policy is based on the configured platform data; if no
575 * platform data is provided, this uses the step_wise throttling policy.
576 */
577void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
578{
579 handle_thermal_trip(tz, trip);
580}
581EXPORT_SYMBOL_GPL(thermal_notify_framework);
582
0c01ebbf
D
583static void thermal_zone_device_check(struct work_struct *work)
584{
585 struct thermal_zone_device *tz = container_of(work, struct
586 thermal_zone_device,
587 poll_queue.work);
0e70f466 588 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
0c01ebbf
D
589}
590
712afbdf
EV
591/*
592 * Power actor section: interface to power actors to estimate power
593 *
594 * Set of functions used to interact to cooling devices that know
595 * how to estimate their devices power consumption.
596 */
9f38271c 597
35b11d2e
JM
598/**
599 * power_actor_get_max_power() - get the maximum power that a cdev can consume
600 * @cdev: pointer to &thermal_cooling_device
601 * @tz: a valid thermal zone device pointer
602 * @max_power: pointer in which to store the maximum power
603 *
604 * Calculate the maximum power consumption in milliwats that the
605 * cooling device can currently consume and store it in @max_power.
606 *
607 * Return: 0 on success, -EINVAL if @cdev doesn't support the
608 * power_actor API or -E* on other error.
609 */
610int power_actor_get_max_power(struct thermal_cooling_device *cdev,
611 struct thermal_zone_device *tz, u32 *max_power)
612{
613 if (!cdev_is_power_actor(cdev))
614 return -EINVAL;
615
616 return cdev->ops->state2power(cdev, tz, 0, max_power);
617}
618
c973c3bc
JM
619/**
620 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
621 * @cdev: pointer to &thermal_cooling_device
622 * @tz: a valid thermal zone device pointer
623 * @min_power: pointer in which to store the minimum power
624 *
625 * Calculate the minimum power consumption in milliwatts that the
626 * cooling device can currently consume and store it in @min_power.
627 *
628 * Return: 0 on success, -EINVAL if @cdev doesn't support the
629 * power_actor API or -E* on other error.
630 */
631int power_actor_get_min_power(struct thermal_cooling_device *cdev,
632 struct thermal_zone_device *tz, u32 *min_power)
633{
634 unsigned long max_state;
635 int ret;
636
637 if (!cdev_is_power_actor(cdev))
638 return -EINVAL;
639
640 ret = cdev->ops->get_max_state(cdev, &max_state);
641 if (ret)
642 return ret;
643
644 return cdev->ops->state2power(cdev, tz, max_state, min_power);
645}
646
35b11d2e 647/**
1a7e7cc0 648 * power_actor_set_power() - limit the maximum power a cooling device consumes
35b11d2e
JM
649 * @cdev: pointer to &thermal_cooling_device
650 * @instance: thermal instance to update
651 * @power: the power in milliwatts
652 *
1a7e7cc0
EV
653 * Set the cooling device to consume at most @power milliwatts. The limit is
654 * expected to be a cap at the maximum power consumption.
35b11d2e
JM
655 *
656 * Return: 0 on success, -EINVAL if the cooling device does not
657 * implement the power actor API or -E* for other failures.
658 */
659int power_actor_set_power(struct thermal_cooling_device *cdev,
660 struct thermal_instance *instance, u32 power)
661{
662 unsigned long state;
663 int ret;
664
665 if (!cdev_is_power_actor(cdev))
666 return -EINVAL;
667
668 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
669 if (ret)
670 return ret;
671
672 instance->target = state;
d0b7306d 673 mutex_lock(&cdev->lock);
35b11d2e 674 cdev->updated = false;
d0b7306d 675 mutex_unlock(&cdev->lock);
35b11d2e
JM
676 thermal_cdev_update(cdev);
677
678 return 0;
679}
680
3d0055d2
EV
681void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
682 const char *cdev_type, size_t size)
203d3d4a 683{
3d0055d2 684 struct thermal_cooling_device *cdev = NULL;
203d3d4a 685
3d0055d2
EV
686 mutex_lock(&thermal_list_lock);
687 list_for_each_entry(cdev, &thermal_cdev_list, node) {
688 /* skip non matching cdevs */
689 if (strncmp(cdev_type, cdev->type, size))
690 continue;
691
692 /* re binding the exception matching the type pattern */
693 thermal_zone_bind_cooling_device(tz, THERMAL_TRIPS_NONE, cdev,
694 THERMAL_NO_LIMIT,
695 THERMAL_NO_LIMIT,
696 THERMAL_WEIGHT_DEFAULT);
697 }
698 mutex_unlock(&thermal_list_lock);
203d3d4a
ZR
699}
700
3d44a509
DL
701int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
702 void *data)
703{
704 struct thermal_governor *gov;
705 int ret = 0;
706
707 mutex_lock(&thermal_governor_lock);
708 list_for_each_entry(gov, &thermal_governor_list, governor_list) {
709 ret = cb(gov, data);
710 if (ret)
711 break;
712 }
713 mutex_unlock(&thermal_governor_lock);
714
715 return ret;
716}
717
718int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
719 void *), void *data)
720{
721 struct thermal_cooling_device *cdev;
722 int ret = 0;
723
724 mutex_lock(&thermal_list_lock);
725 list_for_each_entry(cdev, &thermal_cdev_list, node) {
726 ret = cb(cdev, data);
727 if (ret)
728 break;
729 }
730 mutex_unlock(&thermal_list_lock);
731
732 return ret;
733}
734
735int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
736 void *data)
737{
738 struct thermal_zone_device *tz;
739 int ret = 0;
740
741 mutex_lock(&thermal_list_lock);
742 list_for_each_entry(tz, &thermal_tz_list, node) {
743 ret = cb(tz, data);
744 if (ret)
745 break;
746 }
747 mutex_unlock(&thermal_list_lock);
748
749 return ret;
750}
751
329b064f
DL
752struct thermal_zone_device *thermal_zone_get_by_id(int id)
753{
754 struct thermal_zone_device *tz = NULL;
755
756 mutex_lock(&thermal_list_lock);
757 list_for_each_entry(tz, &thermal_tz_list, node) {
758 if (tz->id == id)
759 break;
760 }
761 mutex_unlock(&thermal_list_lock);
762
763 return tz;
764}
765
3d0055d2
EV
766void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
767 const char *cdev_type, size_t size)
203d3d4a 768{
3d0055d2 769 struct thermal_cooling_device *cdev = NULL;
203d3d4a 770
3d0055d2
EV
771 mutex_lock(&thermal_list_lock);
772 list_for_each_entry(cdev, &thermal_cdev_list, node) {
773 /* skip non matching cdevs */
774 if (strncmp(cdev_type, cdev->type, size))
775 continue;
776 /* unbinding the exception matching the type pattern */
777 thermal_zone_unbind_cooling_device(tz, THERMAL_TRIPS_NONE,
778 cdev);
779 }
780 mutex_unlock(&thermal_list_lock);
203d3d4a
ZR
781}
782
81193e2e
EV
783/*
784 * Device management section: cooling devices, zones devices, and binding
785 *
786 * Set of functions provided by the thermal core for:
787 * - cooling devices lifecycle: registration, unregistration,
788 * binding, and unbinding.
789 * - thermal zone devices lifecycle: registration, unregistration,
790 * binding, and unbinding.
791 */
203d3d4a
ZR
792
793/**
d2e4eb83
EV
794 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
795 * @tz: pointer to struct thermal_zone_device
203d3d4a
ZR
796 * @trip: indicates which trip point the cooling devices is
797 * associated with in this thermal zone.
d2e4eb83
EV
798 * @cdev: pointer to struct thermal_cooling_device
799 * @upper: the Maximum cooling state for this trip point.
800 * THERMAL_NO_LIMIT means no upper limit,
801 * and the cooling device can be in max_state.
802 * @lower: the Minimum cooling state can be used for this trip point.
803 * THERMAL_NO_LIMIT means no lower limit,
804 * and the cooling device can be in cooling state 0.
6cd9e9f6
KS
805 * @weight: The weight of the cooling device to be bound to the
806 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
807 * default value
543a9561 808 *
d2e4eb83
EV
809 * This interface function bind a thermal cooling device to the certain trip
810 * point of a thermal zone device.
543a9561 811 * This function is usually called in the thermal zone device .bind callback.
d2e4eb83
EV
812 *
813 * Return: 0 on success, the proper error value otherwise.
203d3d4a
ZR
814 */
815int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
816 int trip,
9d99842f 817 struct thermal_cooling_device *cdev,
6cd9e9f6
KS
818 unsigned long upper, unsigned long lower,
819 unsigned int weight)
203d3d4a 820{
b81b6ba3
ZR
821 struct thermal_instance *dev;
822 struct thermal_instance *pos;
c7516709
TS
823 struct thermal_zone_device *pos1;
824 struct thermal_cooling_device *pos2;
74051ba5 825 unsigned long max_state;
9a3031dc 826 int result, ret;
203d3d4a 827
543a9561 828 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
203d3d4a
ZR
829 return -EINVAL;
830
c7516709
TS
831 list_for_each_entry(pos1, &thermal_tz_list, node) {
832 if (pos1 == tz)
833 break;
834 }
835 list_for_each_entry(pos2, &thermal_cdev_list, node) {
836 if (pos2 == cdev)
837 break;
838 }
839
840 if (tz != pos1 || cdev != pos2)
203d3d4a
ZR
841 return -EINVAL;
842
9a3031dc
LM
843 ret = cdev->ops->get_max_state(cdev, &max_state);
844 if (ret)
845 return ret;
9d99842f
ZR
846
847 /* lower default 0, upper default max_state */
848 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
849 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
850
851 if (lower > upper || upper > max_state)
852 return -EINVAL;
853
95e3ed15 854 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
203d3d4a
ZR
855 if (!dev)
856 return -ENOMEM;
857 dev->tz = tz;
858 dev->cdev = cdev;
859 dev->trip = trip;
9d99842f
ZR
860 dev->upper = upper;
861 dev->lower = lower;
ce119f83 862 dev->target = THERMAL_NO_TARGET;
6cd9e9f6 863 dev->weight = weight;
74051ba5 864
b31ef828
MW
865 result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
866 if (result < 0)
203d3d4a
ZR
867 goto free_mem;
868
b31ef828 869 dev->id = result;
203d3d4a
ZR
870 sprintf(dev->name, "cdev%d", dev->id);
871 result =
872 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
873 if (result)
b31ef828 874 goto release_ida;
203d3d4a
ZR
875
876 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
975f8c56 877 sysfs_attr_init(&dev->attr.attr);
203d3d4a
ZR
878 dev->attr.attr.name = dev->attr_name;
879 dev->attr.attr.mode = 0444;
33e678d4 880 dev->attr.show = trip_point_show;
203d3d4a
ZR
881 result = device_create_file(&tz->device, &dev->attr);
882 if (result)
883 goto remove_symbol_link;
884
db916513
JM
885 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
886 sysfs_attr_init(&dev->weight_attr.attr);
887 dev->weight_attr.attr.name = dev->weight_attr_name;
888 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
33e678d4
VK
889 dev->weight_attr.show = weight_show;
890 dev->weight_attr.store = weight_store;
db916513
JM
891 result = device_create_file(&tz->device, &dev->weight_attr);
892 if (result)
893 goto remove_trip_file;
894
203d3d4a 895 mutex_lock(&tz->lock);
f4a821ce 896 mutex_lock(&cdev->lock);
cddf31b3 897 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
b659a30d
EV
898 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
899 result = -EEXIST;
900 break;
901 }
b5e4ae62 902 if (!result) {
cddf31b3 903 list_add_tail(&dev->tz_node, &tz->thermal_instances);
b5e4ae62 904 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
4511f716 905 atomic_set(&tz->need_update, 1);
b5e4ae62 906 }
f4a821ce 907 mutex_unlock(&cdev->lock);
203d3d4a
ZR
908 mutex_unlock(&tz->lock);
909
910 if (!result)
911 return 0;
912
db916513
JM
913 device_remove_file(&tz->device, &dev->weight_attr);
914remove_trip_file:
203d3d4a 915 device_remove_file(&tz->device, &dev->attr);
caca8b80 916remove_symbol_link:
203d3d4a 917 sysfs_remove_link(&tz->device.kobj, dev->name);
b31ef828
MW
918release_ida:
919 ida_simple_remove(&tz->ida, dev->id);
caca8b80 920free_mem:
203d3d4a
ZR
921 kfree(dev);
922 return result;
923}
910cb1e3 924EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
203d3d4a
ZR
925
926/**
9892e5dc
EV
927 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
928 * thermal zone.
929 * @tz: pointer to a struct thermal_zone_device.
203d3d4a
ZR
930 * @trip: indicates which trip point the cooling devices is
931 * associated with in this thermal zone.
9892e5dc 932 * @cdev: pointer to a struct thermal_cooling_device.
543a9561 933 *
9892e5dc
EV
934 * This interface function unbind a thermal cooling device from the certain
935 * trip point of a thermal zone device.
543a9561 936 * This function is usually called in the thermal zone device .unbind callback.
9892e5dc
EV
937 *
938 * Return: 0 on success, the proper error value otherwise.
203d3d4a
ZR
939 */
940int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
941 int trip,
942 struct thermal_cooling_device *cdev)
943{
b81b6ba3 944 struct thermal_instance *pos, *next;
203d3d4a
ZR
945
946 mutex_lock(&tz->lock);
f4a821ce 947 mutex_lock(&cdev->lock);
cddf31b3 948 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
543a9561 949 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
cddf31b3 950 list_del(&pos->tz_node);
b5e4ae62 951 list_del(&pos->cdev_node);
f4a821ce 952 mutex_unlock(&cdev->lock);
203d3d4a
ZR
953 mutex_unlock(&tz->lock);
954 goto unbind;
955 }
956 }
f4a821ce 957 mutex_unlock(&cdev->lock);
203d3d4a
ZR
958 mutex_unlock(&tz->lock);
959
960 return -ENODEV;
961
caca8b80 962unbind:
528464ea 963 device_remove_file(&tz->device, &pos->weight_attr);
203d3d4a
ZR
964 device_remove_file(&tz->device, &pos->attr);
965 sysfs_remove_link(&tz->device.kobj, pos->name);
b31ef828 966 ida_simple_remove(&tz->ida, pos->id);
203d3d4a
ZR
967 kfree(pos);
968 return 0;
969}
910cb1e3 970EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
203d3d4a
ZR
971
972static void thermal_release(struct device *dev)
973{
974 struct thermal_zone_device *tz;
975 struct thermal_cooling_device *cdev;
976
caca8b80
JP
977 if (!strncmp(dev_name(dev), "thermal_zone",
978 sizeof("thermal_zone") - 1)) {
203d3d4a 979 tz = to_thermal_zone(dev);
6a6cd25b 980 thermal_zone_destroy_device_groups(tz);
203d3d4a 981 kfree(tz);
b659a30d
EV
982 } else if (!strncmp(dev_name(dev), "cooling_device",
983 sizeof("cooling_device") - 1)) {
203d3d4a
ZR
984 cdev = to_cooling_device(dev);
985 kfree(cdev);
986 }
987}
988
989static struct class thermal_class = {
990 .name = "thermal",
991 .dev_release = thermal_release,
992};
993
4b0d3c2d
EV
994static inline
995void print_bind_err_msg(struct thermal_zone_device *tz,
996 struct thermal_cooling_device *cdev, int ret)
f502ab84
EV
997{
998 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
999 tz->type, cdev->type, ret);
1000}
1001
1002static void __bind(struct thermal_zone_device *tz, int mask,
1003 struct thermal_cooling_device *cdev,
1004 unsigned long *limits,
1005 unsigned int weight)
1006{
1007 int i, ret;
1008
1009 for (i = 0; i < tz->trips; i++) {
1010 if (mask & (1 << i)) {
1011 unsigned long upper, lower;
1012
1013 upper = THERMAL_NO_LIMIT;
1014 lower = THERMAL_NO_LIMIT;
1015 if (limits) {
1016 lower = limits[i * 2];
1017 upper = limits[i * 2 + 1];
1018 }
1019 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
1020 upper, lower,
1021 weight);
1022 if (ret)
1023 print_bind_err_msg(tz, cdev, ret);
1024 }
1025 }
1026}
1027
949aad83
EV
1028static void bind_cdev(struct thermal_cooling_device *cdev)
1029{
1030 int i, ret;
1031 const struct thermal_zone_params *tzp;
1032 struct thermal_zone_device *pos = NULL;
1033
1034 mutex_lock(&thermal_list_lock);
1035
1036 list_for_each_entry(pos, &thermal_tz_list, node) {
1037 if (!pos->tzp && !pos->ops->bind)
1038 continue;
1039
1040 if (pos->ops->bind) {
1041 ret = pos->ops->bind(pos, cdev);
1042 if (ret)
1043 print_bind_err_msg(pos, cdev, ret);
1044 continue;
1045 }
1046
1047 tzp = pos->tzp;
1048 if (!tzp || !tzp->tbp)
1049 continue;
1050
1051 for (i = 0; i < tzp->num_tbps; i++) {
1052 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1053 continue;
1054 if (tzp->tbp[i].match(pos, cdev))
1055 continue;
1056 tzp->tbp[i].cdev = cdev;
1057 __bind(pos, tzp->tbp[i].trip_mask, cdev,
1058 tzp->tbp[i].binding_limits,
1059 tzp->tbp[i].weight);
1060 }
1061 }
1062
1063 mutex_unlock(&thermal_list_lock);
1064}
1065
203d3d4a 1066/**
a116b5d4
EV
1067 * __thermal_cooling_device_register() - register a new thermal cooling device
1068 * @np: a pointer to a device tree node.
203d3d4a
ZR
1069 * @type: the thermal cooling device type.
1070 * @devdata: device private data.
1071 * @ops: standard thermal cooling devices callbacks.
3a6eccb3
EV
1072 *
1073 * This interface function adds a new thermal cooling device (fan/processor/...)
1074 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1075 * to all the thermal zone devices registered at the same time.
a116b5d4
EV
1076 * It also gives the opportunity to link the cooling device to a device tree
1077 * node, so that it can be bound to a thermal zone created out of device tree.
3a6eccb3
EV
1078 *
1079 * Return: a pointer to the created struct thermal_cooling_device or an
1080 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
203d3d4a 1081 */
a116b5d4
EV
1082static struct thermal_cooling_device *
1083__thermal_cooling_device_register(struct device_node *np,
f991de53 1084 const char *type, void *devdata,
a116b5d4 1085 const struct thermal_cooling_device_ops *ops)
203d3d4a
ZR
1086{
1087 struct thermal_cooling_device *cdev;
4511f716 1088 struct thermal_zone_device *pos = NULL;
203d3d4a
ZR
1089 int result;
1090
204dd1d3 1091 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
3e6fda5c 1092 return ERR_PTR(-EINVAL);
203d3d4a
ZR
1093
1094 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
543a9561 1095 !ops->set_cur_state)
3e6fda5c 1096 return ERR_PTR(-EINVAL);
203d3d4a 1097
95e3ed15 1098 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
203d3d4a 1099 if (!cdev)
3e6fda5c 1100 return ERR_PTR(-ENOMEM);
203d3d4a 1101
b31ef828
MW
1102 result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
1103 if (result < 0) {
203d3d4a 1104 kfree(cdev);
3e6fda5c 1105 return ERR_PTR(result);
203d3d4a
ZR
1106 }
1107
b31ef828 1108 cdev->id = result;
c7a8b9d9 1109 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
f4a821ce 1110 mutex_init(&cdev->lock);
b5e4ae62 1111 INIT_LIST_HEAD(&cdev->thermal_instances);
a116b5d4 1112 cdev->np = np;
203d3d4a 1113 cdev->ops = ops;
5ca0cce5 1114 cdev->updated = false;
203d3d4a
ZR
1115 cdev->device.class = &thermal_class;
1116 cdev->devdata = devdata;
8ea22951 1117 thermal_cooling_device_setup_sysfs(cdev);
354655ea 1118 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
203d3d4a
ZR
1119 result = device_register(&cdev->device);
1120 if (result) {
b31ef828 1121 ida_simple_remove(&thermal_cdev_ida, cdev->id);
adc8749b 1122 put_device(&cdev->device);
3e6fda5c 1123 return ERR_PTR(result);
203d3d4a
ZR
1124 }
1125
7e8ee1e9 1126 /* Add 'this' new cdev to the global cdev list */
203d3d4a
ZR
1127 mutex_lock(&thermal_list_lock);
1128 list_add(&cdev->node, &thermal_cdev_list);
203d3d4a
ZR
1129 mutex_unlock(&thermal_list_lock);
1130
7e8ee1e9
D
1131 /* Update binding information for 'this' new cdev */
1132 bind_cdev(cdev);
1133
4511f716
CY
1134 mutex_lock(&thermal_list_lock);
1135 list_for_each_entry(pos, &thermal_tz_list, node)
1136 if (atomic_cmpxchg(&pos->need_update, 1, 0))
0e70f466
SP
1137 thermal_zone_device_update(pos,
1138 THERMAL_EVENT_UNSPECIFIED);
4511f716
CY
1139 mutex_unlock(&thermal_list_lock);
1140
7e8ee1e9 1141 return cdev;
203d3d4a 1142}
a116b5d4
EV
1143
1144/**
1145 * thermal_cooling_device_register() - register a new thermal cooling device
1146 * @type: the thermal cooling device type.
1147 * @devdata: device private data.
1148 * @ops: standard thermal cooling devices callbacks.
1149 *
1150 * This interface function adds a new thermal cooling device (fan/processor/...)
1151 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1152 * to all the thermal zone devices registered at the same time.
1153 *
1154 * Return: a pointer to the created struct thermal_cooling_device or an
1155 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1156 */
1157struct thermal_cooling_device *
f991de53 1158thermal_cooling_device_register(const char *type, void *devdata,
a116b5d4
EV
1159 const struct thermal_cooling_device_ops *ops)
1160{
1161 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1162}
910cb1e3 1163EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
203d3d4a 1164
a116b5d4
EV
1165/**
1166 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1167 * @np: a pointer to a device tree node.
1168 * @type: the thermal cooling device type.
1169 * @devdata: device private data.
1170 * @ops: standard thermal cooling devices callbacks.
1171 *
1172 * This function will register a cooling device with device tree node reference.
1173 * This interface function adds a new thermal cooling device (fan/processor/...)
1174 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1175 * to all the thermal zone devices registered at the same time.
1176 *
1177 * Return: a pointer to the created struct thermal_cooling_device or an
1178 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1179 */
1180struct thermal_cooling_device *
1181thermal_of_cooling_device_register(struct device_node *np,
f991de53 1182 const char *type, void *devdata,
a116b5d4
EV
1183 const struct thermal_cooling_device_ops *ops)
1184{
1185 return __thermal_cooling_device_register(np, type, devdata, ops);
1186}
1187EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1188
b4ab114c
GR
1189static void thermal_cooling_device_release(struct device *dev, void *res)
1190{
1191 thermal_cooling_device_unregister(
1192 *(struct thermal_cooling_device **)res);
1193}
1194
1195/**
1196 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
1197 * device
1198 * @dev: a valid struct device pointer of a sensor device.
1199 * @np: a pointer to a device tree node.
1200 * @type: the thermal cooling device type.
1201 * @devdata: device private data.
1202 * @ops: standard thermal cooling devices callbacks.
1203 *
1204 * This function will register a cooling device with device tree node reference.
1205 * This interface function adds a new thermal cooling device (fan/processor/...)
1206 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1207 * to all the thermal zone devices registered at the same time.
1208 *
1209 * Return: a pointer to the created struct thermal_cooling_device or an
1210 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1211 */
1212struct thermal_cooling_device *
1213devm_thermal_of_cooling_device_register(struct device *dev,
1214 struct device_node *np,
1215 char *type, void *devdata,
1216 const struct thermal_cooling_device_ops *ops)
1217{
1218 struct thermal_cooling_device **ptr, *tcd;
1219
1220 ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
1221 GFP_KERNEL);
1222 if (!ptr)
1223 return ERR_PTR(-ENOMEM);
1224
1225 tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1226 if (IS_ERR(tcd)) {
1227 devres_free(ptr);
1228 return tcd;
1229 }
1230
1231 *ptr = tcd;
1232 devres_add(dev, ptr);
1233
1234 return tcd;
1235}
1236EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1237
f11997fa
EV
1238static void __unbind(struct thermal_zone_device *tz, int mask,
1239 struct thermal_cooling_device *cdev)
1240{
1241 int i;
1242
1243 for (i = 0; i < tz->trips; i++)
1244 if (mask & (1 << i))
1245 thermal_zone_unbind_cooling_device(tz, i, cdev);
1246}
1247
203d3d4a 1248/**
38e7b549 1249 * thermal_cooling_device_unregister - removes a thermal cooling device
203d3d4a
ZR
1250 * @cdev: the thermal cooling device to remove.
1251 *
38e7b549
EV
1252 * thermal_cooling_device_unregister() must be called when a registered
1253 * thermal cooling device is no longer needed.
203d3d4a 1254 */
7e8ee1e9 1255void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
203d3d4a 1256{
7e8ee1e9
D
1257 int i;
1258 const struct thermal_zone_params *tzp;
203d3d4a
ZR
1259 struct thermal_zone_device *tz;
1260 struct thermal_cooling_device *pos = NULL;
1261
1262 if (!cdev)
1263 return;
1264
1265 mutex_lock(&thermal_list_lock);
1266 list_for_each_entry(pos, &thermal_cdev_list, node)
b659a30d
EV
1267 if (pos == cdev)
1268 break;
203d3d4a
ZR
1269 if (pos != cdev) {
1270 /* thermal cooling device not found */
1271 mutex_unlock(&thermal_list_lock);
1272 return;
1273 }
1274 list_del(&cdev->node);
7e8ee1e9
D
1275
1276 /* Unbind all thermal zones associated with 'this' cdev */
203d3d4a 1277 list_for_each_entry(tz, &thermal_tz_list, node) {
7e8ee1e9
D
1278 if (tz->ops->unbind) {
1279 tz->ops->unbind(tz, cdev);
1280 continue;
1281 }
1282
1283 if (!tz->tzp || !tz->tzp->tbp)
203d3d4a 1284 continue;
7e8ee1e9
D
1285
1286 tzp = tz->tzp;
1287 for (i = 0; i < tzp->num_tbps; i++) {
1288 if (tzp->tbp[i].cdev == cdev) {
1289 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1290 tzp->tbp[i].cdev = NULL;
1291 }
1292 }
203d3d4a 1293 }
7e8ee1e9 1294
203d3d4a 1295 mutex_unlock(&thermal_list_lock);
7e8ee1e9 1296
b31ef828 1297 ida_simple_remove(&thermal_cdev_ida, cdev->id);
3c587768 1298 device_del(&cdev->device);
8ea22951 1299 thermal_cooling_device_destroy_sysfs(cdev);
3c587768 1300 put_device(&cdev->device);
203d3d4a 1301}
910cb1e3 1302EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
203d3d4a 1303
90f5b5bb 1304static void bind_tz(struct thermal_zone_device *tz)
ce119f83 1305{
90f5b5bb
EV
1306 int i, ret;
1307 struct thermal_cooling_device *pos = NULL;
1308 const struct thermal_zone_params *tzp = tz->tzp;
ce119f83 1309
90f5b5bb 1310 if (!tzp && !tz->ops->bind)
ce119f83 1311 return;
c56f5c03 1312
90f5b5bb 1313 mutex_lock(&thermal_list_lock);
c56f5c03 1314
90f5b5bb
EV
1315 /* If there is ops->bind, try to use ops->bind */
1316 if (tz->ops->bind) {
1317 list_for_each_entry(pos, &thermal_cdev_list, node) {
1318 ret = tz->ops->bind(tz, pos);
1319 if (ret)
1320 print_bind_err_msg(tz, pos, ret);
27365a6c 1321 }
90f5b5bb 1322 goto exit;
27365a6c 1323 }
c56f5c03 1324
90f5b5bb
EV
1325 if (!tzp || !tzp->tbp)
1326 goto exit;
27365a6c 1327
90f5b5bb
EV
1328 list_for_each_entry(pos, &thermal_cdev_list, node) {
1329 for (i = 0; i < tzp->num_tbps; i++) {
1330 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1331 continue;
1332 if (tzp->tbp[i].match(tz, pos))
1333 continue;
1334 tzp->tbp[i].cdev = pos;
1335 __bind(tz, tzp->tbp[i].trip_mask, pos,
1336 tzp->tbp[i].binding_limits,
1337 tzp->tbp[i].weight);
27365a6c 1338 }
c56f5c03 1339 }
90f5b5bb
EV
1340exit:
1341 mutex_unlock(&thermal_list_lock);
c56f5c03
D
1342}
1343
203d3d4a 1344/**
a00e55f9 1345 * thermal_zone_device_register() - register a new thermal zone device
203d3d4a
ZR
1346 * @type: the thermal zone device type
1347 * @trips: the number of trip points the thermal zone support
c56f5c03 1348 * @mask: a bit string indicating the writeablility of trip points
203d3d4a
ZR
1349 * @devdata: private device data
1350 * @ops: standard thermal zone device callbacks
50125a9b 1351 * @tzp: thermal zone platform parameters
b1569e99
MG
1352 * @passive_delay: number of milliseconds to wait between polls when
1353 * performing passive cooling
1354 * @polling_delay: number of milliseconds to wait between polls when checking
1355 * whether trip points have been crossed (0 for interrupt
1356 * driven systems)
203d3d4a 1357 *
a00e55f9
EV
1358 * This interface function adds a new thermal zone device (sensor) to
1359 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1360 * thermal cooling devices registered at the same time.
203d3d4a 1361 * thermal_zone_device_unregister() must be called when the device is no
1b7ddb84 1362 * longer needed. The passive cooling depends on the .get_trend() return value.
a00e55f9
EV
1363 *
1364 * Return: a pointer to the created struct thermal_zone_device or an
1365 * in case of error, an ERR_PTR. Caller must check return value with
1366 * IS_ERR*() helpers.
203d3d4a 1367 */
eb7be329
EV
1368struct thermal_zone_device *
1369thermal_zone_device_register(const char *type, int trips, int mask,
1370 void *devdata, struct thermal_zone_device_ops *ops,
1371 struct thermal_zone_params *tzp, int passive_delay,
1372 int polling_delay)
203d3d4a
ZR
1373{
1374 struct thermal_zone_device *tz;
03a971a2 1375 enum thermal_trip_type trip_type;
81ad4276 1376 int trip_temp;
adc8749b 1377 int id;
203d3d4a
ZR
1378 int result;
1379 int count;
e33df1d2 1380 struct thermal_governor *governor;
203d3d4a 1381
67eed44b
AK
1382 if (!type || strlen(type) == 0) {
1383 pr_err("Error: No thermal zone type defined\n");
54fa38cc 1384 return ERR_PTR(-EINVAL);
67eed44b 1385 }
54fa38cc 1386
67eed44b
AK
1387 if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
1388 pr_err("Error: Thermal zone name (%s) too long, should be under %d chars\n",
1389 type, THERMAL_NAME_LENGTH);
3e6fda5c 1390 return ERR_PTR(-EINVAL);
67eed44b 1391 }
203d3d4a 1392
67eed44b
AK
1393 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
1394 pr_err("Error: Incorrect number of thermal trips\n");
3e6fda5c 1395 return ERR_PTR(-EINVAL);
67eed44b 1396 }
203d3d4a 1397
67eed44b
AK
1398 if (!ops) {
1399 pr_err("Error: Thermal zone device ops not defined\n");
3e6fda5c 1400 return ERR_PTR(-EINVAL);
67eed44b 1401 }
203d3d4a 1402
83720d0b 1403 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
6b2aa51d
EV
1404 return ERR_PTR(-EINVAL);
1405
95e3ed15 1406 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
203d3d4a 1407 if (!tz)
3e6fda5c 1408 return ERR_PTR(-ENOMEM);
203d3d4a 1409
2d374139 1410 INIT_LIST_HEAD(&tz->thermal_instances);
b31ef828 1411 ida_init(&tz->ida);
203d3d4a 1412 mutex_init(&tz->lock);
adc8749b
YH
1413 id = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
1414 if (id < 0) {
1415 result = id;
9d9ca1f9 1416 goto free_tz;
adc8749b 1417 }
203d3d4a 1418
adc8749b 1419 tz->id = id;
54fa38cc 1420 strlcpy(tz->type, type, sizeof(tz->type));
203d3d4a 1421 tz->ops = ops;
50125a9b 1422 tz->tzp = tzp;
203d3d4a
ZR
1423 tz->device.class = &thermal_class;
1424 tz->devdata = devdata;
1425 tz->trips = trips;
b1569e99
MG
1426 tz->passive_delay = passive_delay;
1427 tz->polling_delay = polling_delay;
1c600861 1428
4d0fe749 1429 /* sys I/F */
1c600861 1430 /* Add nodes that are always present via .groups */
4d0fe749
EV
1431 result = thermal_zone_create_device_groups(tz, mask);
1432 if (result)
9d9ca1f9 1433 goto remove_id;
4d0fe749 1434
4511f716
CY
1435 /* A new thermal zone needs to be updated anyway. */
1436 atomic_set(&tz->need_update, 1);
b1569e99 1437
354655ea 1438 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
203d3d4a 1439 result = device_register(&tz->device);
9d9ca1f9 1440 if (result)
adc8749b 1441 goto release_device;
203d3d4a 1442
203d3d4a 1443 for (count = 0; count < trips; count++) {
81ad4276
ZR
1444 if (tz->ops->get_trip_type(tz, count, &trip_type))
1445 set_bit(count, &tz->trips_disabled);
81ad4276
ZR
1446 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1447 set_bit(count, &tz->trips_disabled);
1448 /* Check for bogus trip points */
1449 if (trip_temp == 0)
1450 set_bit(count, &tz->trips_disabled);
203d3d4a
ZR
1451 }
1452
a4a15485
D
1453 /* Update 'this' zone's governor information */
1454 mutex_lock(&thermal_governor_lock);
1455
1456 if (tz->tzp)
e33df1d2 1457 governor = __find_governor(tz->tzp->governor_name);
a4a15485 1458 else
e33df1d2
JM
1459 governor = def_governor;
1460
1461 result = thermal_set_governor(tz, governor);
1462 if (result) {
1463 mutex_unlock(&thermal_governor_lock);
1464 goto unregister;
1465 }
a4a15485
D
1466
1467 mutex_unlock(&thermal_governor_lock);
1468
ccba4ffd
EV
1469 if (!tz->tzp || !tz->tzp->no_hwmon) {
1470 result = thermal_add_hwmon_sysfs(tz);
1471 if (result)
1472 goto unregister;
1473 }
e68b16ab 1474
203d3d4a
ZR
1475 mutex_lock(&thermal_list_lock);
1476 list_add_tail(&tz->node, &thermal_tz_list);
203d3d4a
ZR
1477 mutex_unlock(&thermal_list_lock);
1478
7e8ee1e9
D
1479 /* Bind cooling devices for this zone */
1480 bind_tz(tz);
1481
b659a30d 1482 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
b1569e99 1483
bb431ba2 1484 thermal_zone_device_reset(tz);
4511f716
CY
1485 /* Update the new thermal zone and mark it as already updated. */
1486 if (atomic_cmpxchg(&tz->need_update, 1, 0))
0e70f466 1487 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
b1569e99 1488
55cdf0a2
DL
1489 thermal_notify_tz_create(tz->id, tz->type);
1490
14015860 1491 return tz;
203d3d4a 1492
caca8b80 1493unregister:
adc8749b
YH
1494 device_del(&tz->device);
1495release_device:
1496 put_device(&tz->device);
1497 tz = NULL;
9d9ca1f9 1498remove_id:
adc8749b 1499 ida_simple_remove(&thermal_tz_ida, id);
9d9ca1f9
CJ
1500free_tz:
1501 kfree(tz);
1502 return ERR_PTR(result);
203d3d4a 1503}
910cb1e3 1504EXPORT_SYMBOL_GPL(thermal_zone_device_register);
203d3d4a
ZR
1505
1506/**
1507 * thermal_device_unregister - removes the registered thermal zone device
203d3d4a
ZR
1508 * @tz: the thermal zone device to remove
1509 */
1510void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1511{
7e8ee1e9
D
1512 int i;
1513 const struct thermal_zone_params *tzp;
203d3d4a
ZR
1514 struct thermal_cooling_device *cdev;
1515 struct thermal_zone_device *pos = NULL;
203d3d4a
ZR
1516
1517 if (!tz)
1518 return;
1519
7e8ee1e9
D
1520 tzp = tz->tzp;
1521
203d3d4a
ZR
1522 mutex_lock(&thermal_list_lock);
1523 list_for_each_entry(pos, &thermal_tz_list, node)
b659a30d
EV
1524 if (pos == tz)
1525 break;
203d3d4a
ZR
1526 if (pos != tz) {
1527 /* thermal zone device not found */
1528 mutex_unlock(&thermal_list_lock);
1529 return;
1530 }
1531 list_del(&tz->node);
7e8ee1e9
D
1532
1533 /* Unbind all cdevs associated with 'this' thermal zone */
1534 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1535 if (tz->ops->unbind) {
1536 tz->ops->unbind(tz, cdev);
1537 continue;
1538 }
1539
1540 if (!tzp || !tzp->tbp)
1541 break;
1542
1543 for (i = 0; i < tzp->num_tbps; i++) {
1544 if (tzp->tbp[i].cdev == cdev) {
1545 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1546 tzp->tbp[i].cdev = NULL;
1547 }
1548 }
1549 }
1550
203d3d4a
ZR
1551 mutex_unlock(&thermal_list_lock);
1552
163b00cd 1553 cancel_delayed_work_sync(&tz->poll_queue);
b1569e99 1554
e33df1d2 1555 thermal_set_governor(tz, NULL);
203d3d4a 1556
e68b16ab 1557 thermal_remove_hwmon_sysfs(tz);
b31ef828
MW
1558 ida_simple_remove(&thermal_tz_ida, tz->id);
1559 ida_destroy(&tz->ida);
203d3d4a
ZR
1560 mutex_destroy(&tz->lock);
1561 device_unregister(&tz->device);
55cdf0a2
DL
1562
1563 thermal_notify_tz_delete(tz->id);
203d3d4a 1564}
910cb1e3 1565EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
203d3d4a 1566
63c4d919
EV
1567/**
1568 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1569 * @name: thermal zone name to fetch the temperature
1570 *
1571 * When only one zone is found with the passed name, returns a reference to it.
1572 *
1573 * Return: On success returns a reference to an unique thermal zone with
1574 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1575 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1576 */
1577struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1578{
1579 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1580 unsigned int found = 0;
1581
1582 if (!name)
1583 goto exit;
1584
1585 mutex_lock(&thermal_list_lock);
1586 list_for_each_entry(pos, &thermal_tz_list, node)
484ac2f3 1587 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
63c4d919
EV
1588 found++;
1589 ref = pos;
1590 }
1591 mutex_unlock(&thermal_list_lock);
1592
1593 /* nothing has been found, thus an error code for it */
1594 if (found == 0)
1595 ref = ERR_PTR(-ENODEV);
1596 else if (found > 1)
1597 /* Success only when an unique zone is found */
1598 ref = ERR_PTR(-EEXIST);
1599
1600exit:
1601 return ref;
1602}
1603EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1604
ff140fea 1605static int thermal_pm_notify(struct notifier_block *nb,
eb7be329 1606 unsigned long mode, void *_unused)
ff140fea
ZR
1607{
1608 struct thermal_zone_device *tz;
1609
1610 switch (mode) {
1611 case PM_HIBERNATION_PREPARE:
1612 case PM_RESTORE_PREPARE:
1613 case PM_SUSPEND_PREPARE:
1614 atomic_set(&in_suspend, 1);
1615 break;
1616 case PM_POST_HIBERNATION:
1617 case PM_POST_RESTORE:
1618 case PM_POST_SUSPEND:
1619 atomic_set(&in_suspend, 0);
1620 list_for_each_entry(tz, &thermal_tz_list, node) {
7f4957be 1621 if (!thermal_zone_device_is_enabled(tz))
ff54bbd1
WW
1622 continue;
1623
964f4843 1624 thermal_zone_device_init(tz);
0e70f466
SP
1625 thermal_zone_device_update(tz,
1626 THERMAL_EVENT_UNSPECIFIED);
ff140fea
ZR
1627 }
1628 break;
1629 default:
1630 break;
1631 }
1632 return 0;
1633}
1634
1635static struct notifier_block thermal_pm_nb = {
1636 .notifier_call = thermal_pm_notify,
1637};
1638
203d3d4a
ZR
1639static int __init thermal_init(void)
1640{
80a26a5c
ZR
1641 int result;
1642
e441fd68 1643 mutex_init(&poweroff_lock);
80a26a5c
ZR
1644 result = thermal_register_governors();
1645 if (result)
1646 goto error;
203d3d4a
ZR
1647
1648 result = class_register(&thermal_class);
80a26a5c
ZR
1649 if (result)
1650 goto unregister_governors;
1651
4e5e4705
EV
1652 result = of_parse_thermal_zones();
1653 if (result)
f96c8e50 1654 goto unregister_class;
4e5e4705 1655
ff140fea
ZR
1656 result = register_pm_notifier(&thermal_pm_nb);
1657 if (result)
1658 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1659 result);
1660
80a26a5c
ZR
1661 return 0;
1662
80a26a5c
ZR
1663unregister_class:
1664 class_unregister(&thermal_class);
9d367e5e
LH
1665unregister_governors:
1666 thermal_unregister_governors();
80a26a5c 1667error:
b31ef828
MW
1668 ida_destroy(&thermal_tz_ida);
1669 ida_destroy(&thermal_cdev_ida);
80a26a5c
ZR
1670 mutex_destroy(&thermal_list_lock);
1671 mutex_destroy(&thermal_governor_lock);
e441fd68 1672 mutex_destroy(&poweroff_lock);
203d3d4a
ZR
1673 return result;
1674}
ae16a688 1675core_initcall(thermal_init);