Loading...
1// SPDX-License-Identifier: GPL-2.0
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>
8 */
9
10#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11
12#include <linux/device.h>
13#include <linux/err.h>
14#include <linux/export.h>
15#include <linux/slab.h>
16#include <linux/kdev_t.h>
17#include <linux/idr.h>
18#include <linux/thermal.h>
19#include <linux/reboot.h>
20#include <linux/string.h>
21#include <linux/of.h>
22#include <linux/suspend.h>
23
24#define CREATE_TRACE_POINTS
25#include <trace/events/thermal.h>
26
27#include "thermal_core.h"
28#include "thermal_hwmon.h"
29
30static DEFINE_IDA(thermal_tz_ida);
31static DEFINE_IDA(thermal_cdev_ida);
32
33static LIST_HEAD(thermal_tz_list);
34static LIST_HEAD(thermal_cdev_list);
35static LIST_HEAD(thermal_governor_list);
36
37static DEFINE_MUTEX(thermal_list_lock);
38static DEFINE_MUTEX(thermal_governor_lock);
39static DEFINE_MUTEX(poweroff_lock);
40
41static atomic_t in_suspend;
42static bool power_off_triggered;
43
44static struct thermal_governor *def_governor;
45
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
53static struct thermal_governor *__find_governor(const char *name)
54{
55 struct thermal_governor *pos;
56
57 if (!name || !name[0])
58 return def_governor;
59
60 list_for_each_entry(pos, &thermal_governor_list, governor_list)
61 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
62 return pos;
63
64 return NULL;
65}
66
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
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;
131 if (!__find_governor(governor->name)) {
132 bool match_default;
133
134 err = 0;
135 list_add(&governor->governor_list, &thermal_governor_list);
136 match_default = !strncmp(governor->name,
137 DEFAULT_THERMAL_GOVERNOR,
138 THERMAL_NAME_LENGTH);
139
140 if (!def_governor && match_default)
141 def_governor = governor;
142 }
143
144 mutex_lock(&thermal_list_lock);
145
146 list_for_each_entry(pos, &thermal_tz_list, node) {
147 /*
148 * only thermal zones with specified tz->tzp->governor_name
149 * may run with tz->govenor unset
150 */
151 if (pos->governor)
152 continue;
153
154 name = pos->tzp->governor_name;
155
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 }
165 }
166
167 mutex_unlock(&thermal_list_lock);
168 mutex_unlock(&thermal_governor_lock);
169
170 return err;
171}
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
182 if (!__find_governor(governor->name))
183 goto exit;
184
185 mutex_lock(&thermal_list_lock);
186
187 list_for_each_entry(pos, &thermal_tz_list, node) {
188 if (!strncasecmp(pos->governor->name, governor->name,
189 THERMAL_NAME_LENGTH))
190 thermal_set_governor(pos, NULL);
191 }
192
193 mutex_unlock(&thermal_list_lock);
194 list_del(&governor->governor_list);
195exit:
196 mutex_unlock(&thermal_governor_lock);
197}
198
199int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
200 char *policy)
201{
202 struct thermal_governor *gov;
203 int ret = -EINVAL;
204
205 mutex_lock(&thermal_governor_lock);
206 mutex_lock(&tz->lock);
207
208 gov = __find_governor(strim(policy));
209 if (!gov)
210 goto exit;
211
212 ret = thermal_set_governor(tz, gov);
213
214exit:
215 mutex_unlock(&tz->lock);
216 mutex_unlock(&thermal_governor_lock);
217
218 thermal_notify_tz_gov_change(tz->id, policy);
219
220 return ret;
221}
222
223int thermal_build_list_of_policies(char *buf)
224{
225 struct thermal_governor *pos;
226 ssize_t count = 0;
227 ssize_t size = PAGE_SIZE;
228
229 mutex_lock(&thermal_governor_lock);
230
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);
234 }
235 count += scnprintf(buf + count, size, "\n");
236
237 mutex_unlock(&thermal_governor_lock);
238
239 return count;
240}
241
242static void __init thermal_unregister_governors(void)
243{
244 struct thermal_governor **governor;
245
246 for_each_governor_table(governor)
247 thermal_unregister_governor(*governor);
248}
249
250static int __init thermal_register_governors(void)
251{
252 int ret = 0;
253 struct thermal_governor **governor;
254
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 }
262
263 pr_info("Registered thermal governor '%s'",
264 (*governor)->name);
265 }
266
267 if (ret) {
268 struct thermal_governor **gov;
269
270 for_each_governor_table(gov) {
271 if (gov == governor)
272 break;
273 thermal_unregister_governor(*gov);
274 }
275 }
276
277 return ret;
278}
279
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 */
291static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
292 int delay)
293{
294 if (delay > 1000)
295 mod_delayed_work(system_freezable_power_efficient_wq,
296 &tz->poll_queue,
297 round_jiffies(msecs_to_jiffies(delay)));
298 else if (delay)
299 mod_delayed_work(system_freezable_power_efficient_wq,
300 &tz->poll_queue,
301 msecs_to_jiffies(delay));
302 else
303 cancel_delayed_work(&tz->poll_queue);
304}
305
306static inline bool should_stop_polling(struct thermal_zone_device *tz)
307{
308 return !thermal_zone_device_is_enabled(tz);
309}
310
311static void monitor_thermal_zone(struct thermal_zone_device *tz)
312{
313 bool stop;
314
315 stop = should_stop_polling(tz);
316
317 mutex_lock(&tz->lock);
318
319 if (!stop && tz->passive)
320 thermal_zone_device_set_polling(tz, tz->passive_delay);
321 else if (!stop && tz->polling_delay)
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
329static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
330{
331 tz->governor ? tz->governor->throttle(tz, trip) :
332 def_governor->throttle(tz, trip);
333}
334
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 */
370static void thermal_emergency_poweroff(void)
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
383static void handle_critical_trips(struct thermal_zone_device *tz,
384 int trip, enum thermal_trip_type trip_type)
385{
386 int trip_temp;
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. */
391 if (trip_temp <= 0 || tz->temperature < trip_temp)
392 return;
393
394 trace_thermal_zone_trip(tz, trip, trip_type);
395
396 if (tz->ops->notify)
397 tz->ops->notify(tz, trip, trip_type);
398
399 if (trip_type == THERMAL_TRIP_CRITICAL) {
400 dev_emerg(&tz->device,
401 "critical temperature reached (%d C), shutting down\n",
402 tz->temperature / 1000);
403 mutex_lock(&poweroff_lock);
404 if (!power_off_triggered) {
405 /*
406 * Queue a backup emergency shutdown in the event of
407 * orderly_poweroff failure
408 */
409 thermal_emergency_poweroff();
410 orderly_poweroff(true);
411 power_off_triggered = true;
412 }
413 mutex_unlock(&poweroff_lock);
414 }
415}
416
417static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
418{
419 enum thermal_trip_type type;
420 int trip_temp, hyst = 0;
421
422 /* Ignore disabled trip points */
423 if (test_bit(trip, &tz->trips_disabled))
424 return;
425
426 tz->ops->get_trip_temp(tz, trip, &trip_temp);
427 tz->ops->get_trip_type(tz, trip, &type);
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 }
439
440 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
441 handle_critical_trips(tz, trip, type);
442 else
443 handle_non_critical_trips(tz, trip);
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{
453 int temp, ret;
454
455 ret = thermal_zone_get_temp(tz, &temp);
456 if (ret) {
457 if (ret != -EAGAIN)
458 dev_warn(&tz->device,
459 "failed to read out thermal zone (%d)\n",
460 ret);
461 return;
462 }
463
464 mutex_lock(&tz->lock);
465 tz->last_temperature = tz->temperature;
466 tz->temperature = temp;
467 mutex_unlock(&tz->lock);
468
469 trace_thermal_temperature(tz);
470
471 thermal_genl_sampling_temp(tz->id, temp);
472}
473
474static void thermal_zone_device_init(struct thermal_zone_device *tz)
475{
476 struct thermal_instance *pos;
477 tz->temperature = THERMAL_TEMP_INVALID;
478 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
479 pos->initialized = false;
480}
481
482static void thermal_zone_device_reset(struct thermal_zone_device *tz)
483{
484 tz->passive = 0;
485 thermal_zone_device_init(tz);
486}
487
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
502 if (tz->ops->change_mode)
503 ret = tz->ops->change_mode(tz, mode);
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 if (mode == THERMAL_DEVICE_ENABLED)
513 thermal_notify_tz_enable(tz->id);
514 else
515 thermal_notify_tz_disable(tz->id);
516
517 return ret;
518}
519
520int thermal_zone_device_enable(struct thermal_zone_device *tz)
521{
522 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
523}
524EXPORT_SYMBOL_GPL(thermal_zone_device_enable);
525
526int thermal_zone_device_disable(struct thermal_zone_device *tz)
527{
528 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
529}
530EXPORT_SYMBOL_GPL(thermal_zone_device_disable);
531
532int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
533{
534 enum thermal_device_mode mode;
535
536 mutex_lock(&tz->lock);
537
538 mode = tz->mode;
539
540 mutex_unlock(&tz->lock);
541
542 return mode == THERMAL_DEVICE_ENABLED;
543}
544
545void thermal_zone_device_update(struct thermal_zone_device *tz,
546 enum thermal_notify_event event)
547{
548 int count;
549
550 if (should_stop_polling(tz))
551 return;
552
553 if (atomic_read(&in_suspend))
554 return;
555
556 if (!tz->ops->get_temp)
557 return;
558
559 update_temperature(tz);
560
561 thermal_zone_set_trips(tz);
562
563 tz->notify_event = event;
564
565 for (count = 0; count < tz->trips; count++)
566 handle_thermal_trip(tz, count);
567}
568EXPORT_SYMBOL_GPL(thermal_zone_device_update);
569
570/**
571 * thermal_notify_framework - Sensor drivers use this API to notify framework
572 * @tz: thermal zone device
573 * @trip: indicates which trip point has been crossed
574 *
575 * This function handles the trip events from sensor drivers. It starts
576 * throttling the cooling devices according to the policy configured.
577 * For CRITICAL and HOT trip points, this notifies the respective drivers,
578 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
579 * The throttling policy is based on the configured platform data; if no
580 * platform data is provided, this uses the step_wise throttling policy.
581 */
582void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
583{
584 handle_thermal_trip(tz, trip);
585}
586EXPORT_SYMBOL_GPL(thermal_notify_framework);
587
588static void thermal_zone_device_check(struct work_struct *work)
589{
590 struct thermal_zone_device *tz = container_of(work, struct
591 thermal_zone_device,
592 poll_queue.work);
593 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
594}
595
596/*
597 * Power actor section: interface to power actors to estimate power
598 *
599 * Set of functions used to interact to cooling devices that know
600 * how to estimate their devices power consumption.
601 */
602
603/**
604 * power_actor_get_max_power() - get the maximum power that a cdev can consume
605 * @cdev: pointer to &thermal_cooling_device
606 * @tz: a valid thermal zone device pointer
607 * @max_power: pointer in which to store the maximum power
608 *
609 * Calculate the maximum power consumption in milliwats that the
610 * cooling device can currently consume and store it in @max_power.
611 *
612 * Return: 0 on success, -EINVAL if @cdev doesn't support the
613 * power_actor API or -E* on other error.
614 */
615int power_actor_get_max_power(struct thermal_cooling_device *cdev,
616 struct thermal_zone_device *tz, u32 *max_power)
617{
618 if (!cdev_is_power_actor(cdev))
619 return -EINVAL;
620
621 return cdev->ops->state2power(cdev, tz, 0, max_power);
622}
623
624/**
625 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
626 * @cdev: pointer to &thermal_cooling_device
627 * @tz: a valid thermal zone device pointer
628 * @min_power: pointer in which to store the minimum power
629 *
630 * Calculate the minimum power consumption in milliwatts that the
631 * cooling device can currently consume and store it in @min_power.
632 *
633 * Return: 0 on success, -EINVAL if @cdev doesn't support the
634 * power_actor API or -E* on other error.
635 */
636int power_actor_get_min_power(struct thermal_cooling_device *cdev,
637 struct thermal_zone_device *tz, u32 *min_power)
638{
639 unsigned long max_state;
640 int ret;
641
642 if (!cdev_is_power_actor(cdev))
643 return -EINVAL;
644
645 ret = cdev->ops->get_max_state(cdev, &max_state);
646 if (ret)
647 return ret;
648
649 return cdev->ops->state2power(cdev, tz, max_state, min_power);
650}
651
652/**
653 * power_actor_set_power() - limit the maximum power a cooling device consumes
654 * @cdev: pointer to &thermal_cooling_device
655 * @instance: thermal instance to update
656 * @power: the power in milliwatts
657 *
658 * Set the cooling device to consume at most @power milliwatts. The limit is
659 * expected to be a cap at the maximum power consumption.
660 *
661 * Return: 0 on success, -EINVAL if the cooling device does not
662 * implement the power actor API or -E* for other failures.
663 */
664int power_actor_set_power(struct thermal_cooling_device *cdev,
665 struct thermal_instance *instance, u32 power)
666{
667 unsigned long state;
668 int ret;
669
670 if (!cdev_is_power_actor(cdev))
671 return -EINVAL;
672
673 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
674 if (ret)
675 return ret;
676
677 instance->target = state;
678 mutex_lock(&cdev->lock);
679 cdev->updated = false;
680 mutex_unlock(&cdev->lock);
681 thermal_cdev_update(cdev);
682
683 return 0;
684}
685
686void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
687 const char *cdev_type, size_t size)
688{
689 struct thermal_cooling_device *cdev = NULL;
690
691 mutex_lock(&thermal_list_lock);
692 list_for_each_entry(cdev, &thermal_cdev_list, node) {
693 /* skip non matching cdevs */
694 if (strncmp(cdev_type, cdev->type, size))
695 continue;
696
697 /* re binding the exception matching the type pattern */
698 thermal_zone_bind_cooling_device(tz, THERMAL_TRIPS_NONE, cdev,
699 THERMAL_NO_LIMIT,
700 THERMAL_NO_LIMIT,
701 THERMAL_WEIGHT_DEFAULT);
702 }
703 mutex_unlock(&thermal_list_lock);
704}
705
706int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
707 void *data)
708{
709 struct thermal_governor *gov;
710 int ret = 0;
711
712 mutex_lock(&thermal_governor_lock);
713 list_for_each_entry(gov, &thermal_governor_list, governor_list) {
714 ret = cb(gov, data);
715 if (ret)
716 break;
717 }
718 mutex_unlock(&thermal_governor_lock);
719
720 return ret;
721}
722
723int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
724 void *), void *data)
725{
726 struct thermal_cooling_device *cdev;
727 int ret = 0;
728
729 mutex_lock(&thermal_list_lock);
730 list_for_each_entry(cdev, &thermal_cdev_list, node) {
731 ret = cb(cdev, data);
732 if (ret)
733 break;
734 }
735 mutex_unlock(&thermal_list_lock);
736
737 return ret;
738}
739
740int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
741 void *data)
742{
743 struct thermal_zone_device *tz;
744 int ret = 0;
745
746 mutex_lock(&thermal_list_lock);
747 list_for_each_entry(tz, &thermal_tz_list, node) {
748 ret = cb(tz, data);
749 if (ret)
750 break;
751 }
752 mutex_unlock(&thermal_list_lock);
753
754 return ret;
755}
756
757struct thermal_zone_device *thermal_zone_get_by_id(int id)
758{
759 struct thermal_zone_device *tz, *match = NULL;
760
761 mutex_lock(&thermal_list_lock);
762 list_for_each_entry(tz, &thermal_tz_list, node) {
763 if (tz->id == id) {
764 match = tz;
765 break;
766 }
767 }
768 mutex_unlock(&thermal_list_lock);
769
770 return match;
771}
772
773void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
774 const char *cdev_type, size_t size)
775{
776 struct thermal_cooling_device *cdev = NULL;
777
778 mutex_lock(&thermal_list_lock);
779 list_for_each_entry(cdev, &thermal_cdev_list, node) {
780 /* skip non matching cdevs */
781 if (strncmp(cdev_type, cdev->type, size))
782 continue;
783 /* unbinding the exception matching the type pattern */
784 thermal_zone_unbind_cooling_device(tz, THERMAL_TRIPS_NONE,
785 cdev);
786 }
787 mutex_unlock(&thermal_list_lock);
788}
789
790/*
791 * Device management section: cooling devices, zones devices, and binding
792 *
793 * Set of functions provided by the thermal core for:
794 * - cooling devices lifecycle: registration, unregistration,
795 * binding, and unbinding.
796 * - thermal zone devices lifecycle: registration, unregistration,
797 * binding, and unbinding.
798 */
799
800/**
801 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
802 * @tz: pointer to struct thermal_zone_device
803 * @trip: indicates which trip point the cooling devices is
804 * associated with in this thermal zone.
805 * @cdev: pointer to struct thermal_cooling_device
806 * @upper: the Maximum cooling state for this trip point.
807 * THERMAL_NO_LIMIT means no upper limit,
808 * and the cooling device can be in max_state.
809 * @lower: the Minimum cooling state can be used for this trip point.
810 * THERMAL_NO_LIMIT means no lower limit,
811 * and the cooling device can be in cooling state 0.
812 * @weight: The weight of the cooling device to be bound to the
813 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
814 * default value
815 *
816 * This interface function bind a thermal cooling device to the certain trip
817 * point of a thermal zone device.
818 * This function is usually called in the thermal zone device .bind callback.
819 *
820 * Return: 0 on success, the proper error value otherwise.
821 */
822int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
823 int trip,
824 struct thermal_cooling_device *cdev,
825 unsigned long upper, unsigned long lower,
826 unsigned int weight)
827{
828 struct thermal_instance *dev;
829 struct thermal_instance *pos;
830 struct thermal_zone_device *pos1;
831 struct thermal_cooling_device *pos2;
832 unsigned long max_state;
833 int result, ret;
834
835 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
836 return -EINVAL;
837
838 list_for_each_entry(pos1, &thermal_tz_list, node) {
839 if (pos1 == tz)
840 break;
841 }
842 list_for_each_entry(pos2, &thermal_cdev_list, node) {
843 if (pos2 == cdev)
844 break;
845 }
846
847 if (tz != pos1 || cdev != pos2)
848 return -EINVAL;
849
850 ret = cdev->ops->get_max_state(cdev, &max_state);
851 if (ret)
852 return ret;
853
854 /* lower default 0, upper default max_state */
855 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
856 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
857
858 if (lower > upper || upper > max_state)
859 return -EINVAL;
860
861 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
862 if (!dev)
863 return -ENOMEM;
864 dev->tz = tz;
865 dev->cdev = cdev;
866 dev->trip = trip;
867 dev->upper = upper;
868 dev->lower = lower;
869 dev->target = THERMAL_NO_TARGET;
870 dev->weight = weight;
871
872 result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
873 if (result < 0)
874 goto free_mem;
875
876 dev->id = result;
877 sprintf(dev->name, "cdev%d", dev->id);
878 result =
879 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
880 if (result)
881 goto release_ida;
882
883 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
884 sysfs_attr_init(&dev->attr.attr);
885 dev->attr.attr.name = dev->attr_name;
886 dev->attr.attr.mode = 0444;
887 dev->attr.show = trip_point_show;
888 result = device_create_file(&tz->device, &dev->attr);
889 if (result)
890 goto remove_symbol_link;
891
892 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
893 sysfs_attr_init(&dev->weight_attr.attr);
894 dev->weight_attr.attr.name = dev->weight_attr_name;
895 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
896 dev->weight_attr.show = weight_show;
897 dev->weight_attr.store = weight_store;
898 result = device_create_file(&tz->device, &dev->weight_attr);
899 if (result)
900 goto remove_trip_file;
901
902 mutex_lock(&tz->lock);
903 mutex_lock(&cdev->lock);
904 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
905 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
906 result = -EEXIST;
907 break;
908 }
909 if (!result) {
910 list_add_tail(&dev->tz_node, &tz->thermal_instances);
911 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
912 atomic_set(&tz->need_update, 1);
913 }
914 mutex_unlock(&cdev->lock);
915 mutex_unlock(&tz->lock);
916
917 if (!result)
918 return 0;
919
920 device_remove_file(&tz->device, &dev->weight_attr);
921remove_trip_file:
922 device_remove_file(&tz->device, &dev->attr);
923remove_symbol_link:
924 sysfs_remove_link(&tz->device.kobj, dev->name);
925release_ida:
926 ida_simple_remove(&tz->ida, dev->id);
927free_mem:
928 kfree(dev);
929 return result;
930}
931EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
932
933/**
934 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
935 * thermal zone.
936 * @tz: pointer to a struct thermal_zone_device.
937 * @trip: indicates which trip point the cooling devices is
938 * associated with in this thermal zone.
939 * @cdev: pointer to a struct thermal_cooling_device.
940 *
941 * This interface function unbind a thermal cooling device from the certain
942 * trip point of a thermal zone device.
943 * This function is usually called in the thermal zone device .unbind callback.
944 *
945 * Return: 0 on success, the proper error value otherwise.
946 */
947int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
948 int trip,
949 struct thermal_cooling_device *cdev)
950{
951 struct thermal_instance *pos, *next;
952
953 mutex_lock(&tz->lock);
954 mutex_lock(&cdev->lock);
955 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
956 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
957 list_del(&pos->tz_node);
958 list_del(&pos->cdev_node);
959 mutex_unlock(&cdev->lock);
960 mutex_unlock(&tz->lock);
961 goto unbind;
962 }
963 }
964 mutex_unlock(&cdev->lock);
965 mutex_unlock(&tz->lock);
966
967 return -ENODEV;
968
969unbind:
970 device_remove_file(&tz->device, &pos->weight_attr);
971 device_remove_file(&tz->device, &pos->attr);
972 sysfs_remove_link(&tz->device.kobj, pos->name);
973 ida_simple_remove(&tz->ida, pos->id);
974 kfree(pos);
975 return 0;
976}
977EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
978
979static void thermal_release(struct device *dev)
980{
981 struct thermal_zone_device *tz;
982 struct thermal_cooling_device *cdev;
983
984 if (!strncmp(dev_name(dev), "thermal_zone",
985 sizeof("thermal_zone") - 1)) {
986 tz = to_thermal_zone(dev);
987 thermal_zone_destroy_device_groups(tz);
988 kfree(tz);
989 } else if (!strncmp(dev_name(dev), "cooling_device",
990 sizeof("cooling_device") - 1)) {
991 cdev = to_cooling_device(dev);
992 kfree(cdev);
993 }
994}
995
996static struct class thermal_class = {
997 .name = "thermal",
998 .dev_release = thermal_release,
999};
1000
1001static inline
1002void print_bind_err_msg(struct thermal_zone_device *tz,
1003 struct thermal_cooling_device *cdev, int ret)
1004{
1005 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
1006 tz->type, cdev->type, ret);
1007}
1008
1009static void __bind(struct thermal_zone_device *tz, int mask,
1010 struct thermal_cooling_device *cdev,
1011 unsigned long *limits,
1012 unsigned int weight)
1013{
1014 int i, ret;
1015
1016 for (i = 0; i < tz->trips; i++) {
1017 if (mask & (1 << i)) {
1018 unsigned long upper, lower;
1019
1020 upper = THERMAL_NO_LIMIT;
1021 lower = THERMAL_NO_LIMIT;
1022 if (limits) {
1023 lower = limits[i * 2];
1024 upper = limits[i * 2 + 1];
1025 }
1026 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
1027 upper, lower,
1028 weight);
1029 if (ret)
1030 print_bind_err_msg(tz, cdev, ret);
1031 }
1032 }
1033}
1034
1035static void bind_cdev(struct thermal_cooling_device *cdev)
1036{
1037 int i, ret;
1038 const struct thermal_zone_params *tzp;
1039 struct thermal_zone_device *pos = NULL;
1040
1041 mutex_lock(&thermal_list_lock);
1042
1043 list_for_each_entry(pos, &thermal_tz_list, node) {
1044 if (!pos->tzp && !pos->ops->bind)
1045 continue;
1046
1047 if (pos->ops->bind) {
1048 ret = pos->ops->bind(pos, cdev);
1049 if (ret)
1050 print_bind_err_msg(pos, cdev, ret);
1051 continue;
1052 }
1053
1054 tzp = pos->tzp;
1055 if (!tzp || !tzp->tbp)
1056 continue;
1057
1058 for (i = 0; i < tzp->num_tbps; i++) {
1059 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1060 continue;
1061 if (tzp->tbp[i].match(pos, cdev))
1062 continue;
1063 tzp->tbp[i].cdev = cdev;
1064 __bind(pos, tzp->tbp[i].trip_mask, cdev,
1065 tzp->tbp[i].binding_limits,
1066 tzp->tbp[i].weight);
1067 }
1068 }
1069
1070 mutex_unlock(&thermal_list_lock);
1071}
1072
1073/**
1074 * __thermal_cooling_device_register() - register a new thermal cooling device
1075 * @np: a pointer to a device tree node.
1076 * @type: the thermal cooling device type.
1077 * @devdata: device private data.
1078 * @ops: standard thermal cooling devices callbacks.
1079 *
1080 * This interface function adds a new thermal cooling device (fan/processor/...)
1081 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1082 * to all the thermal zone devices registered at the same time.
1083 * It also gives the opportunity to link the cooling device to a device tree
1084 * node, so that it can be bound to a thermal zone created out of device tree.
1085 *
1086 * Return: a pointer to the created struct thermal_cooling_device or an
1087 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1088 */
1089static struct thermal_cooling_device *
1090__thermal_cooling_device_register(struct device_node *np,
1091 const char *type, void *devdata,
1092 const struct thermal_cooling_device_ops *ops)
1093{
1094 struct thermal_cooling_device *cdev;
1095 struct thermal_zone_device *pos = NULL;
1096 int result;
1097
1098 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1099 return ERR_PTR(-EINVAL);
1100
1101 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1102 !ops->set_cur_state)
1103 return ERR_PTR(-EINVAL);
1104
1105 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
1106 if (!cdev)
1107 return ERR_PTR(-ENOMEM);
1108
1109 result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
1110 if (result < 0) {
1111 kfree(cdev);
1112 return ERR_PTR(result);
1113 }
1114
1115 cdev->id = result;
1116 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1117 mutex_init(&cdev->lock);
1118 INIT_LIST_HEAD(&cdev->thermal_instances);
1119 cdev->np = np;
1120 cdev->ops = ops;
1121 cdev->updated = false;
1122 cdev->device.class = &thermal_class;
1123 cdev->devdata = devdata;
1124 thermal_cooling_device_setup_sysfs(cdev);
1125 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1126 result = device_register(&cdev->device);
1127 if (result) {
1128 ida_simple_remove(&thermal_cdev_ida, cdev->id);
1129 put_device(&cdev->device);
1130 return ERR_PTR(result);
1131 }
1132
1133 /* Add 'this' new cdev to the global cdev list */
1134 mutex_lock(&thermal_list_lock);
1135 list_add(&cdev->node, &thermal_cdev_list);
1136 mutex_unlock(&thermal_list_lock);
1137
1138 /* Update binding information for 'this' new cdev */
1139 bind_cdev(cdev);
1140
1141 mutex_lock(&thermal_list_lock);
1142 list_for_each_entry(pos, &thermal_tz_list, node)
1143 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1144 thermal_zone_device_update(pos,
1145 THERMAL_EVENT_UNSPECIFIED);
1146 mutex_unlock(&thermal_list_lock);
1147
1148 return cdev;
1149}
1150
1151/**
1152 * thermal_cooling_device_register() - register a new thermal cooling device
1153 * @type: the thermal cooling device type.
1154 * @devdata: device private data.
1155 * @ops: standard thermal cooling devices callbacks.
1156 *
1157 * This interface function adds a new thermal cooling device (fan/processor/...)
1158 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1159 * to all the thermal zone devices registered at the same time.
1160 *
1161 * Return: a pointer to the created struct thermal_cooling_device or an
1162 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1163 */
1164struct thermal_cooling_device *
1165thermal_cooling_device_register(const char *type, void *devdata,
1166 const struct thermal_cooling_device_ops *ops)
1167{
1168 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1169}
1170EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1171
1172/**
1173 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1174 * @np: a pointer to a device tree node.
1175 * @type: the thermal cooling device type.
1176 * @devdata: device private data.
1177 * @ops: standard thermal cooling devices callbacks.
1178 *
1179 * This function will register a cooling device with device tree node reference.
1180 * This interface function adds a new thermal cooling device (fan/processor/...)
1181 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1182 * to all the thermal zone devices registered at the same time.
1183 *
1184 * Return: a pointer to the created struct thermal_cooling_device or an
1185 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1186 */
1187struct thermal_cooling_device *
1188thermal_of_cooling_device_register(struct device_node *np,
1189 const char *type, void *devdata,
1190 const struct thermal_cooling_device_ops *ops)
1191{
1192 return __thermal_cooling_device_register(np, type, devdata, ops);
1193}
1194EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1195
1196static void thermal_cooling_device_release(struct device *dev, void *res)
1197{
1198 thermal_cooling_device_unregister(
1199 *(struct thermal_cooling_device **)res);
1200}
1201
1202/**
1203 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
1204 * device
1205 * @dev: a valid struct device pointer of a sensor device.
1206 * @np: a pointer to a device tree node.
1207 * @type: the thermal cooling device type.
1208 * @devdata: device private data.
1209 * @ops: standard thermal cooling devices callbacks.
1210 *
1211 * This function will register a cooling device with device tree node reference.
1212 * This interface function adds a new thermal cooling device (fan/processor/...)
1213 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1214 * to all the thermal zone devices registered at the same time.
1215 *
1216 * Return: a pointer to the created struct thermal_cooling_device or an
1217 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1218 */
1219struct thermal_cooling_device *
1220devm_thermal_of_cooling_device_register(struct device *dev,
1221 struct device_node *np,
1222 char *type, void *devdata,
1223 const struct thermal_cooling_device_ops *ops)
1224{
1225 struct thermal_cooling_device **ptr, *tcd;
1226
1227 ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
1228 GFP_KERNEL);
1229 if (!ptr)
1230 return ERR_PTR(-ENOMEM);
1231
1232 tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1233 if (IS_ERR(tcd)) {
1234 devres_free(ptr);
1235 return tcd;
1236 }
1237
1238 *ptr = tcd;
1239 devres_add(dev, ptr);
1240
1241 return tcd;
1242}
1243EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1244
1245static void __unbind(struct thermal_zone_device *tz, int mask,
1246 struct thermal_cooling_device *cdev)
1247{
1248 int i;
1249
1250 for (i = 0; i < tz->trips; i++)
1251 if (mask & (1 << i))
1252 thermal_zone_unbind_cooling_device(tz, i, cdev);
1253}
1254
1255/**
1256 * thermal_cooling_device_unregister - removes a thermal cooling device
1257 * @cdev: the thermal cooling device to remove.
1258 *
1259 * thermal_cooling_device_unregister() must be called when a registered
1260 * thermal cooling device is no longer needed.
1261 */
1262void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1263{
1264 int i;
1265 const struct thermal_zone_params *tzp;
1266 struct thermal_zone_device *tz;
1267 struct thermal_cooling_device *pos = NULL;
1268
1269 if (!cdev)
1270 return;
1271
1272 mutex_lock(&thermal_list_lock);
1273 list_for_each_entry(pos, &thermal_cdev_list, node)
1274 if (pos == cdev)
1275 break;
1276 if (pos != cdev) {
1277 /* thermal cooling device not found */
1278 mutex_unlock(&thermal_list_lock);
1279 return;
1280 }
1281 list_del(&cdev->node);
1282
1283 /* Unbind all thermal zones associated with 'this' cdev */
1284 list_for_each_entry(tz, &thermal_tz_list, node) {
1285 if (tz->ops->unbind) {
1286 tz->ops->unbind(tz, cdev);
1287 continue;
1288 }
1289
1290 if (!tz->tzp || !tz->tzp->tbp)
1291 continue;
1292
1293 tzp = tz->tzp;
1294 for (i = 0; i < tzp->num_tbps; i++) {
1295 if (tzp->tbp[i].cdev == cdev) {
1296 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1297 tzp->tbp[i].cdev = NULL;
1298 }
1299 }
1300 }
1301
1302 mutex_unlock(&thermal_list_lock);
1303
1304 ida_simple_remove(&thermal_cdev_ida, cdev->id);
1305 device_del(&cdev->device);
1306 thermal_cooling_device_destroy_sysfs(cdev);
1307 put_device(&cdev->device);
1308}
1309EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1310
1311static void bind_tz(struct thermal_zone_device *tz)
1312{
1313 int i, ret;
1314 struct thermal_cooling_device *pos = NULL;
1315 const struct thermal_zone_params *tzp = tz->tzp;
1316
1317 if (!tzp && !tz->ops->bind)
1318 return;
1319
1320 mutex_lock(&thermal_list_lock);
1321
1322 /* If there is ops->bind, try to use ops->bind */
1323 if (tz->ops->bind) {
1324 list_for_each_entry(pos, &thermal_cdev_list, node) {
1325 ret = tz->ops->bind(tz, pos);
1326 if (ret)
1327 print_bind_err_msg(tz, pos, ret);
1328 }
1329 goto exit;
1330 }
1331
1332 if (!tzp || !tzp->tbp)
1333 goto exit;
1334
1335 list_for_each_entry(pos, &thermal_cdev_list, node) {
1336 for (i = 0; i < tzp->num_tbps; i++) {
1337 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1338 continue;
1339 if (tzp->tbp[i].match(tz, pos))
1340 continue;
1341 tzp->tbp[i].cdev = pos;
1342 __bind(tz, tzp->tbp[i].trip_mask, pos,
1343 tzp->tbp[i].binding_limits,
1344 tzp->tbp[i].weight);
1345 }
1346 }
1347exit:
1348 mutex_unlock(&thermal_list_lock);
1349}
1350
1351/**
1352 * thermal_zone_device_register() - register a new thermal zone device
1353 * @type: the thermal zone device type
1354 * @trips: the number of trip points the thermal zone support
1355 * @mask: a bit string indicating the writeablility of trip points
1356 * @devdata: private device data
1357 * @ops: standard thermal zone device callbacks
1358 * @tzp: thermal zone platform parameters
1359 * @passive_delay: number of milliseconds to wait between polls when
1360 * performing passive cooling
1361 * @polling_delay: number of milliseconds to wait between polls when checking
1362 * whether trip points have been crossed (0 for interrupt
1363 * driven systems)
1364 *
1365 * This interface function adds a new thermal zone device (sensor) to
1366 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1367 * thermal cooling devices registered at the same time.
1368 * thermal_zone_device_unregister() must be called when the device is no
1369 * longer needed. The passive cooling depends on the .get_trend() return value.
1370 *
1371 * Return: a pointer to the created struct thermal_zone_device or an
1372 * in case of error, an ERR_PTR. Caller must check return value with
1373 * IS_ERR*() helpers.
1374 */
1375struct thermal_zone_device *
1376thermal_zone_device_register(const char *type, int trips, int mask,
1377 void *devdata, struct thermal_zone_device_ops *ops,
1378 struct thermal_zone_params *tzp, int passive_delay,
1379 int polling_delay)
1380{
1381 struct thermal_zone_device *tz;
1382 enum thermal_trip_type trip_type;
1383 int trip_temp;
1384 int id;
1385 int result;
1386 int count;
1387 struct thermal_governor *governor;
1388
1389 if (!type || strlen(type) == 0) {
1390 pr_err("Error: No thermal zone type defined\n");
1391 return ERR_PTR(-EINVAL);
1392 }
1393
1394 if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
1395 pr_err("Error: Thermal zone name (%s) too long, should be under %d chars\n",
1396 type, THERMAL_NAME_LENGTH);
1397 return ERR_PTR(-EINVAL);
1398 }
1399
1400 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
1401 pr_err("Error: Incorrect number of thermal trips\n");
1402 return ERR_PTR(-EINVAL);
1403 }
1404
1405 if (!ops) {
1406 pr_err("Error: Thermal zone device ops not defined\n");
1407 return ERR_PTR(-EINVAL);
1408 }
1409
1410 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1411 return ERR_PTR(-EINVAL);
1412
1413 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1414 if (!tz)
1415 return ERR_PTR(-ENOMEM);
1416
1417 INIT_LIST_HEAD(&tz->thermal_instances);
1418 ida_init(&tz->ida);
1419 mutex_init(&tz->lock);
1420 id = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
1421 if (id < 0) {
1422 result = id;
1423 goto free_tz;
1424 }
1425
1426 tz->id = id;
1427 strlcpy(tz->type, type, sizeof(tz->type));
1428 tz->ops = ops;
1429 tz->tzp = tzp;
1430 tz->device.class = &thermal_class;
1431 tz->devdata = devdata;
1432 tz->trips = trips;
1433 tz->passive_delay = passive_delay;
1434 tz->polling_delay = polling_delay;
1435
1436 /* sys I/F */
1437 /* Add nodes that are always present via .groups */
1438 result = thermal_zone_create_device_groups(tz, mask);
1439 if (result)
1440 goto remove_id;
1441
1442 /* A new thermal zone needs to be updated anyway. */
1443 atomic_set(&tz->need_update, 1);
1444
1445 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1446 result = device_register(&tz->device);
1447 if (result)
1448 goto release_device;
1449
1450 for (count = 0; count < trips; count++) {
1451 if (tz->ops->get_trip_type(tz, count, &trip_type))
1452 set_bit(count, &tz->trips_disabled);
1453 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1454 set_bit(count, &tz->trips_disabled);
1455 /* Check for bogus trip points */
1456 if (trip_temp == 0)
1457 set_bit(count, &tz->trips_disabled);
1458 }
1459
1460 /* Update 'this' zone's governor information */
1461 mutex_lock(&thermal_governor_lock);
1462
1463 if (tz->tzp)
1464 governor = __find_governor(tz->tzp->governor_name);
1465 else
1466 governor = def_governor;
1467
1468 result = thermal_set_governor(tz, governor);
1469 if (result) {
1470 mutex_unlock(&thermal_governor_lock);
1471 goto unregister;
1472 }
1473
1474 mutex_unlock(&thermal_governor_lock);
1475
1476 if (!tz->tzp || !tz->tzp->no_hwmon) {
1477 result = thermal_add_hwmon_sysfs(tz);
1478 if (result)
1479 goto unregister;
1480 }
1481
1482 mutex_lock(&thermal_list_lock);
1483 list_add_tail(&tz->node, &thermal_tz_list);
1484 mutex_unlock(&thermal_list_lock);
1485
1486 /* Bind cooling devices for this zone */
1487 bind_tz(tz);
1488
1489 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1490
1491 thermal_zone_device_reset(tz);
1492 /* Update the new thermal zone and mark it as already updated. */
1493 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1494 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1495
1496 thermal_notify_tz_create(tz->id, tz->type);
1497
1498 return tz;
1499
1500unregister:
1501 device_del(&tz->device);
1502release_device:
1503 put_device(&tz->device);
1504 tz = NULL;
1505remove_id:
1506 ida_simple_remove(&thermal_tz_ida, id);
1507free_tz:
1508 kfree(tz);
1509 return ERR_PTR(result);
1510}
1511EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1512
1513/**
1514 * thermal_device_unregister - removes the registered thermal zone device
1515 * @tz: the thermal zone device to remove
1516 */
1517void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1518{
1519 int i, tz_id;
1520 const struct thermal_zone_params *tzp;
1521 struct thermal_cooling_device *cdev;
1522 struct thermal_zone_device *pos = NULL;
1523
1524 if (!tz)
1525 return;
1526
1527 tzp = tz->tzp;
1528 tz_id = tz->id;
1529
1530 mutex_lock(&thermal_list_lock);
1531 list_for_each_entry(pos, &thermal_tz_list, node)
1532 if (pos == tz)
1533 break;
1534 if (pos != tz) {
1535 /* thermal zone device not found */
1536 mutex_unlock(&thermal_list_lock);
1537 return;
1538 }
1539 list_del(&tz->node);
1540
1541 /* Unbind all cdevs associated with 'this' thermal zone */
1542 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1543 if (tz->ops->unbind) {
1544 tz->ops->unbind(tz, cdev);
1545 continue;
1546 }
1547
1548 if (!tzp || !tzp->tbp)
1549 break;
1550
1551 for (i = 0; i < tzp->num_tbps; i++) {
1552 if (tzp->tbp[i].cdev == cdev) {
1553 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1554 tzp->tbp[i].cdev = NULL;
1555 }
1556 }
1557 }
1558
1559 mutex_unlock(&thermal_list_lock);
1560
1561 cancel_delayed_work_sync(&tz->poll_queue);
1562
1563 thermal_set_governor(tz, NULL);
1564
1565 thermal_remove_hwmon_sysfs(tz);
1566 ida_simple_remove(&thermal_tz_ida, tz->id);
1567 ida_destroy(&tz->ida);
1568 mutex_destroy(&tz->lock);
1569 device_unregister(&tz->device);
1570
1571 thermal_notify_tz_delete(tz_id);
1572}
1573EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1574
1575/**
1576 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1577 * @name: thermal zone name to fetch the temperature
1578 *
1579 * When only one zone is found with the passed name, returns a reference to it.
1580 *
1581 * Return: On success returns a reference to an unique thermal zone with
1582 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1583 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1584 */
1585struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1586{
1587 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1588 unsigned int found = 0;
1589
1590 if (!name)
1591 goto exit;
1592
1593 mutex_lock(&thermal_list_lock);
1594 list_for_each_entry(pos, &thermal_tz_list, node)
1595 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1596 found++;
1597 ref = pos;
1598 }
1599 mutex_unlock(&thermal_list_lock);
1600
1601 /* nothing has been found, thus an error code for it */
1602 if (found == 0)
1603 ref = ERR_PTR(-ENODEV);
1604 else if (found > 1)
1605 /* Success only when an unique zone is found */
1606 ref = ERR_PTR(-EEXIST);
1607
1608exit:
1609 return ref;
1610}
1611EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1612
1613static int thermal_pm_notify(struct notifier_block *nb,
1614 unsigned long mode, void *_unused)
1615{
1616 struct thermal_zone_device *tz;
1617
1618 switch (mode) {
1619 case PM_HIBERNATION_PREPARE:
1620 case PM_RESTORE_PREPARE:
1621 case PM_SUSPEND_PREPARE:
1622 atomic_set(&in_suspend, 1);
1623 break;
1624 case PM_POST_HIBERNATION:
1625 case PM_POST_RESTORE:
1626 case PM_POST_SUSPEND:
1627 atomic_set(&in_suspend, 0);
1628 list_for_each_entry(tz, &thermal_tz_list, node) {
1629 if (!thermal_zone_device_is_enabled(tz))
1630 continue;
1631
1632 thermal_zone_device_init(tz);
1633 thermal_zone_device_update(tz,
1634 THERMAL_EVENT_UNSPECIFIED);
1635 }
1636 break;
1637 default:
1638 break;
1639 }
1640 return 0;
1641}
1642
1643static struct notifier_block thermal_pm_nb = {
1644 .notifier_call = thermal_pm_notify,
1645};
1646
1647static int __init thermal_init(void)
1648{
1649 int result;
1650
1651 result = thermal_netlink_init();
1652 if (result)
1653 goto error;
1654
1655 mutex_init(&poweroff_lock);
1656 result = thermal_register_governors();
1657 if (result)
1658 goto error;
1659
1660 result = class_register(&thermal_class);
1661 if (result)
1662 goto unregister_governors;
1663
1664 result = of_parse_thermal_zones();
1665 if (result)
1666 goto unregister_class;
1667
1668 result = register_pm_notifier(&thermal_pm_nb);
1669 if (result)
1670 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1671 result);
1672
1673 return 0;
1674
1675unregister_class:
1676 class_unregister(&thermal_class);
1677unregister_governors:
1678 thermal_unregister_governors();
1679error:
1680 ida_destroy(&thermal_tz_ida);
1681 ida_destroy(&thermal_cdev_ida);
1682 mutex_destroy(&thermal_list_lock);
1683 mutex_destroy(&thermal_governor_lock);
1684 mutex_destroy(&poweroff_lock);
1685 return result;
1686}
1687postcore_initcall(thermal_init);
1/*
2 * thermal.c - Generic Thermal Management Sysfs support.
3 *
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
7 *
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25
26#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27
28#include <linux/module.h>
29#include <linux/device.h>
30#include <linux/err.h>
31#include <linux/slab.h>
32#include <linux/kdev_t.h>
33#include <linux/idr.h>
34#include <linux/thermal.h>
35#include <linux/reboot.h>
36#include <linux/string.h>
37#include <linux/of.h>
38#include <net/netlink.h>
39#include <net/genetlink.h>
40#include <linux/suspend.h>
41
42#define CREATE_TRACE_POINTS
43#include <trace/events/thermal.h>
44
45#include "thermal_core.h"
46#include "thermal_hwmon.h"
47
48MODULE_AUTHOR("Zhang Rui");
49MODULE_DESCRIPTION("Generic thermal management sysfs support");
50MODULE_LICENSE("GPL v2");
51
52static DEFINE_IDR(thermal_tz_idr);
53static DEFINE_IDR(thermal_cdev_idr);
54static DEFINE_MUTEX(thermal_idr_lock);
55
56static LIST_HEAD(thermal_tz_list);
57static LIST_HEAD(thermal_cdev_list);
58static LIST_HEAD(thermal_governor_list);
59
60static DEFINE_MUTEX(thermal_list_lock);
61static DEFINE_MUTEX(thermal_governor_lock);
62
63static atomic_t in_suspend;
64
65static struct thermal_governor *def_governor;
66
67static struct thermal_governor *__find_governor(const char *name)
68{
69 struct thermal_governor *pos;
70
71 if (!name || !name[0])
72 return def_governor;
73
74 list_for_each_entry(pos, &thermal_governor_list, governor_list)
75 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
76 return pos;
77
78 return NULL;
79}
80
81/**
82 * bind_previous_governor() - bind the previous governor of the thermal zone
83 * @tz: a valid pointer to a struct thermal_zone_device
84 * @failed_gov_name: the name of the governor that failed to register
85 *
86 * Register the previous governor of the thermal zone after a new
87 * governor has failed to be bound.
88 */
89static void bind_previous_governor(struct thermal_zone_device *tz,
90 const char *failed_gov_name)
91{
92 if (tz->governor && tz->governor->bind_to_tz) {
93 if (tz->governor->bind_to_tz(tz)) {
94 dev_err(&tz->device,
95 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
96 failed_gov_name, tz->governor->name, tz->type);
97 tz->governor = NULL;
98 }
99 }
100}
101
102/**
103 * thermal_set_governor() - Switch to another governor
104 * @tz: a valid pointer to a struct thermal_zone_device
105 * @new_gov: pointer to the new governor
106 *
107 * Change the governor of thermal zone @tz.
108 *
109 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
110 */
111static int thermal_set_governor(struct thermal_zone_device *tz,
112 struct thermal_governor *new_gov)
113{
114 int ret = 0;
115
116 if (tz->governor && tz->governor->unbind_from_tz)
117 tz->governor->unbind_from_tz(tz);
118
119 if (new_gov && new_gov->bind_to_tz) {
120 ret = new_gov->bind_to_tz(tz);
121 if (ret) {
122 bind_previous_governor(tz, new_gov->name);
123
124 return ret;
125 }
126 }
127
128 tz->governor = new_gov;
129
130 return ret;
131}
132
133int thermal_register_governor(struct thermal_governor *governor)
134{
135 int err;
136 const char *name;
137 struct thermal_zone_device *pos;
138
139 if (!governor)
140 return -EINVAL;
141
142 mutex_lock(&thermal_governor_lock);
143
144 err = -EBUSY;
145 if (__find_governor(governor->name) == NULL) {
146 err = 0;
147 list_add(&governor->governor_list, &thermal_governor_list);
148 if (!def_governor && !strncmp(governor->name,
149 DEFAULT_THERMAL_GOVERNOR, THERMAL_NAME_LENGTH))
150 def_governor = governor;
151 }
152
153 mutex_lock(&thermal_list_lock);
154
155 list_for_each_entry(pos, &thermal_tz_list, node) {
156 /*
157 * only thermal zones with specified tz->tzp->governor_name
158 * may run with tz->govenor unset
159 */
160 if (pos->governor)
161 continue;
162
163 name = pos->tzp->governor_name;
164
165 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
166 int ret;
167
168 ret = thermal_set_governor(pos, governor);
169 if (ret)
170 dev_err(&pos->device,
171 "Failed to set governor %s for thermal zone %s: %d\n",
172 governor->name, pos->type, ret);
173 }
174 }
175
176 mutex_unlock(&thermal_list_lock);
177 mutex_unlock(&thermal_governor_lock);
178
179 return err;
180}
181
182void thermal_unregister_governor(struct thermal_governor *governor)
183{
184 struct thermal_zone_device *pos;
185
186 if (!governor)
187 return;
188
189 mutex_lock(&thermal_governor_lock);
190
191 if (__find_governor(governor->name) == NULL)
192 goto exit;
193
194 mutex_lock(&thermal_list_lock);
195
196 list_for_each_entry(pos, &thermal_tz_list, node) {
197 if (!strncasecmp(pos->governor->name, governor->name,
198 THERMAL_NAME_LENGTH))
199 thermal_set_governor(pos, NULL);
200 }
201
202 mutex_unlock(&thermal_list_lock);
203 list_del(&governor->governor_list);
204exit:
205 mutex_unlock(&thermal_governor_lock);
206 return;
207}
208
209static int get_idr(struct idr *idr, struct mutex *lock, int *id)
210{
211 int ret;
212
213 if (lock)
214 mutex_lock(lock);
215 ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL);
216 if (lock)
217 mutex_unlock(lock);
218 if (unlikely(ret < 0))
219 return ret;
220 *id = ret;
221 return 0;
222}
223
224static void release_idr(struct idr *idr, struct mutex *lock, int id)
225{
226 if (lock)
227 mutex_lock(lock);
228 idr_remove(idr, id);
229 if (lock)
230 mutex_unlock(lock);
231}
232
233int get_tz_trend(struct thermal_zone_device *tz, int trip)
234{
235 enum thermal_trend trend;
236
237 if (tz->emul_temperature || !tz->ops->get_trend ||
238 tz->ops->get_trend(tz, trip, &trend)) {
239 if (tz->temperature > tz->last_temperature)
240 trend = THERMAL_TREND_RAISING;
241 else if (tz->temperature < tz->last_temperature)
242 trend = THERMAL_TREND_DROPPING;
243 else
244 trend = THERMAL_TREND_STABLE;
245 }
246
247 return trend;
248}
249EXPORT_SYMBOL(get_tz_trend);
250
251struct thermal_instance *get_thermal_instance(struct thermal_zone_device *tz,
252 struct thermal_cooling_device *cdev, int trip)
253{
254 struct thermal_instance *pos = NULL;
255 struct thermal_instance *target_instance = NULL;
256
257 mutex_lock(&tz->lock);
258 mutex_lock(&cdev->lock);
259
260 list_for_each_entry(pos, &tz->thermal_instances, tz_node) {
261 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
262 target_instance = pos;
263 break;
264 }
265 }
266
267 mutex_unlock(&cdev->lock);
268 mutex_unlock(&tz->lock);
269
270 return target_instance;
271}
272EXPORT_SYMBOL(get_thermal_instance);
273
274static void print_bind_err_msg(struct thermal_zone_device *tz,
275 struct thermal_cooling_device *cdev, int ret)
276{
277 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
278 tz->type, cdev->type, ret);
279}
280
281static void __bind(struct thermal_zone_device *tz, int mask,
282 struct thermal_cooling_device *cdev,
283 unsigned long *limits,
284 unsigned int weight)
285{
286 int i, ret;
287
288 for (i = 0; i < tz->trips; i++) {
289 if (mask & (1 << i)) {
290 unsigned long upper, lower;
291
292 upper = THERMAL_NO_LIMIT;
293 lower = THERMAL_NO_LIMIT;
294 if (limits) {
295 lower = limits[i * 2];
296 upper = limits[i * 2 + 1];
297 }
298 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
299 upper, lower,
300 weight);
301 if (ret)
302 print_bind_err_msg(tz, cdev, ret);
303 }
304 }
305}
306
307static void __unbind(struct thermal_zone_device *tz, int mask,
308 struct thermal_cooling_device *cdev)
309{
310 int i;
311
312 for (i = 0; i < tz->trips; i++)
313 if (mask & (1 << i))
314 thermal_zone_unbind_cooling_device(tz, i, cdev);
315}
316
317static void bind_cdev(struct thermal_cooling_device *cdev)
318{
319 int i, ret;
320 const struct thermal_zone_params *tzp;
321 struct thermal_zone_device *pos = NULL;
322
323 mutex_lock(&thermal_list_lock);
324
325 list_for_each_entry(pos, &thermal_tz_list, node) {
326 if (!pos->tzp && !pos->ops->bind)
327 continue;
328
329 if (pos->ops->bind) {
330 ret = pos->ops->bind(pos, cdev);
331 if (ret)
332 print_bind_err_msg(pos, cdev, ret);
333 continue;
334 }
335
336 tzp = pos->tzp;
337 if (!tzp || !tzp->tbp)
338 continue;
339
340 for (i = 0; i < tzp->num_tbps; i++) {
341 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
342 continue;
343 if (tzp->tbp[i].match(pos, cdev))
344 continue;
345 tzp->tbp[i].cdev = cdev;
346 __bind(pos, tzp->tbp[i].trip_mask, cdev,
347 tzp->tbp[i].binding_limits,
348 tzp->tbp[i].weight);
349 }
350 }
351
352 mutex_unlock(&thermal_list_lock);
353}
354
355static void bind_tz(struct thermal_zone_device *tz)
356{
357 int i, ret;
358 struct thermal_cooling_device *pos = NULL;
359 const struct thermal_zone_params *tzp = tz->tzp;
360
361 if (!tzp && !tz->ops->bind)
362 return;
363
364 mutex_lock(&thermal_list_lock);
365
366 /* If there is ops->bind, try to use ops->bind */
367 if (tz->ops->bind) {
368 list_for_each_entry(pos, &thermal_cdev_list, node) {
369 ret = tz->ops->bind(tz, pos);
370 if (ret)
371 print_bind_err_msg(tz, pos, ret);
372 }
373 goto exit;
374 }
375
376 if (!tzp || !tzp->tbp)
377 goto exit;
378
379 list_for_each_entry(pos, &thermal_cdev_list, node) {
380 for (i = 0; i < tzp->num_tbps; i++) {
381 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
382 continue;
383 if (tzp->tbp[i].match(tz, pos))
384 continue;
385 tzp->tbp[i].cdev = pos;
386 __bind(tz, tzp->tbp[i].trip_mask, pos,
387 tzp->tbp[i].binding_limits,
388 tzp->tbp[i].weight);
389 }
390 }
391exit:
392 mutex_unlock(&thermal_list_lock);
393}
394
395static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
396 int delay)
397{
398 if (delay > 1000)
399 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
400 round_jiffies(msecs_to_jiffies(delay)));
401 else if (delay)
402 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
403 msecs_to_jiffies(delay));
404 else
405 cancel_delayed_work(&tz->poll_queue);
406}
407
408static void monitor_thermal_zone(struct thermal_zone_device *tz)
409{
410 mutex_lock(&tz->lock);
411
412 if (tz->passive)
413 thermal_zone_device_set_polling(tz, tz->passive_delay);
414 else if (tz->polling_delay)
415 thermal_zone_device_set_polling(tz, tz->polling_delay);
416 else
417 thermal_zone_device_set_polling(tz, 0);
418
419 mutex_unlock(&tz->lock);
420}
421
422static void handle_non_critical_trips(struct thermal_zone_device *tz,
423 int trip, enum thermal_trip_type trip_type)
424{
425 tz->governor ? tz->governor->throttle(tz, trip) :
426 def_governor->throttle(tz, trip);
427}
428
429static void handle_critical_trips(struct thermal_zone_device *tz,
430 int trip, enum thermal_trip_type trip_type)
431{
432 int trip_temp;
433
434 tz->ops->get_trip_temp(tz, trip, &trip_temp);
435
436 /* If we have not crossed the trip_temp, we do not care. */
437 if (trip_temp <= 0 || tz->temperature < trip_temp)
438 return;
439
440 trace_thermal_zone_trip(tz, trip, trip_type);
441
442 if (tz->ops->notify)
443 tz->ops->notify(tz, trip, trip_type);
444
445 if (trip_type == THERMAL_TRIP_CRITICAL) {
446 dev_emerg(&tz->device,
447 "critical temperature reached(%d C),shutting down\n",
448 tz->temperature / 1000);
449 orderly_poweroff(true);
450 }
451}
452
453static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
454{
455 enum thermal_trip_type type;
456
457 /* Ignore disabled trip points */
458 if (test_bit(trip, &tz->trips_disabled))
459 return;
460
461 tz->ops->get_trip_type(tz, trip, &type);
462
463 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
464 handle_critical_trips(tz, trip, type);
465 else
466 handle_non_critical_trips(tz, trip, type);
467 /*
468 * Alright, we handled this trip successfully.
469 * So, start monitoring again.
470 */
471 monitor_thermal_zone(tz);
472}
473
474/**
475 * thermal_zone_get_temp() - returns the temperature of a thermal zone
476 * @tz: a valid pointer to a struct thermal_zone_device
477 * @temp: a valid pointer to where to store the resulting temperature.
478 *
479 * When a valid thermal zone reference is passed, it will fetch its
480 * temperature and fill @temp.
481 *
482 * Return: On success returns 0, an error code otherwise
483 */
484int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
485{
486 int ret = -EINVAL;
487 int count;
488 int crit_temp = INT_MAX;
489 enum thermal_trip_type type;
490
491 if (!tz || IS_ERR(tz) || !tz->ops->get_temp)
492 goto exit;
493
494 mutex_lock(&tz->lock);
495
496 ret = tz->ops->get_temp(tz, temp);
497
498 if (IS_ENABLED(CONFIG_THERMAL_EMULATION) && tz->emul_temperature) {
499 for (count = 0; count < tz->trips; count++) {
500 ret = tz->ops->get_trip_type(tz, count, &type);
501 if (!ret && type == THERMAL_TRIP_CRITICAL) {
502 ret = tz->ops->get_trip_temp(tz, count,
503 &crit_temp);
504 break;
505 }
506 }
507
508 /*
509 * Only allow emulating a temperature when the real temperature
510 * is below the critical temperature so that the emulation code
511 * cannot hide critical conditions.
512 */
513 if (!ret && *temp < crit_temp)
514 *temp = tz->emul_temperature;
515 }
516
517 mutex_unlock(&tz->lock);
518exit:
519 return ret;
520}
521EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
522
523static void update_temperature(struct thermal_zone_device *tz)
524{
525 int temp, ret;
526
527 ret = thermal_zone_get_temp(tz, &temp);
528 if (ret) {
529 if (ret != -EAGAIN)
530 dev_warn(&tz->device,
531 "failed to read out thermal zone (%d)\n",
532 ret);
533 return;
534 }
535
536 mutex_lock(&tz->lock);
537 tz->last_temperature = tz->temperature;
538 tz->temperature = temp;
539 mutex_unlock(&tz->lock);
540
541 trace_thermal_temperature(tz);
542 if (tz->last_temperature == THERMAL_TEMP_INVALID)
543 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
544 tz->temperature);
545 else
546 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
547 tz->last_temperature, tz->temperature);
548}
549
550static void thermal_zone_device_reset(struct thermal_zone_device *tz)
551{
552 struct thermal_instance *pos;
553
554 tz->temperature = THERMAL_TEMP_INVALID;
555 tz->passive = 0;
556 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
557 pos->initialized = false;
558}
559
560void thermal_zone_device_update(struct thermal_zone_device *tz)
561{
562 int count;
563
564 if (atomic_read(&in_suspend))
565 return;
566
567 if (!tz->ops->get_temp)
568 return;
569
570 update_temperature(tz);
571
572 for (count = 0; count < tz->trips; count++)
573 handle_thermal_trip(tz, count);
574}
575EXPORT_SYMBOL_GPL(thermal_zone_device_update);
576
577static void thermal_zone_device_check(struct work_struct *work)
578{
579 struct thermal_zone_device *tz = container_of(work, struct
580 thermal_zone_device,
581 poll_queue.work);
582 thermal_zone_device_update(tz);
583}
584
585/* sys I/F for thermal zone */
586
587#define to_thermal_zone(_dev) \
588 container_of(_dev, struct thermal_zone_device, device)
589
590static ssize_t
591type_show(struct device *dev, struct device_attribute *attr, char *buf)
592{
593 struct thermal_zone_device *tz = to_thermal_zone(dev);
594
595 return sprintf(buf, "%s\n", tz->type);
596}
597
598static ssize_t
599temp_show(struct device *dev, struct device_attribute *attr, char *buf)
600{
601 struct thermal_zone_device *tz = to_thermal_zone(dev);
602 int temperature, ret;
603
604 ret = thermal_zone_get_temp(tz, &temperature);
605
606 if (ret)
607 return ret;
608
609 return sprintf(buf, "%d\n", temperature);
610}
611
612static ssize_t
613mode_show(struct device *dev, struct device_attribute *attr, char *buf)
614{
615 struct thermal_zone_device *tz = to_thermal_zone(dev);
616 enum thermal_device_mode mode;
617 int result;
618
619 if (!tz->ops->get_mode)
620 return -EPERM;
621
622 result = tz->ops->get_mode(tz, &mode);
623 if (result)
624 return result;
625
626 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
627 : "disabled");
628}
629
630static ssize_t
631mode_store(struct device *dev, struct device_attribute *attr,
632 const char *buf, size_t count)
633{
634 struct thermal_zone_device *tz = to_thermal_zone(dev);
635 int result;
636
637 if (!tz->ops->set_mode)
638 return -EPERM;
639
640 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
641 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
642 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
643 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
644 else
645 result = -EINVAL;
646
647 if (result)
648 return result;
649
650 return count;
651}
652
653static ssize_t
654trip_point_type_show(struct device *dev, struct device_attribute *attr,
655 char *buf)
656{
657 struct thermal_zone_device *tz = to_thermal_zone(dev);
658 enum thermal_trip_type type;
659 int trip, result;
660
661 if (!tz->ops->get_trip_type)
662 return -EPERM;
663
664 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
665 return -EINVAL;
666
667 result = tz->ops->get_trip_type(tz, trip, &type);
668 if (result)
669 return result;
670
671 switch (type) {
672 case THERMAL_TRIP_CRITICAL:
673 return sprintf(buf, "critical\n");
674 case THERMAL_TRIP_HOT:
675 return sprintf(buf, "hot\n");
676 case THERMAL_TRIP_PASSIVE:
677 return sprintf(buf, "passive\n");
678 case THERMAL_TRIP_ACTIVE:
679 return sprintf(buf, "active\n");
680 default:
681 return sprintf(buf, "unknown\n");
682 }
683}
684
685static ssize_t
686trip_point_temp_store(struct device *dev, struct device_attribute *attr,
687 const char *buf, size_t count)
688{
689 struct thermal_zone_device *tz = to_thermal_zone(dev);
690 int trip, ret;
691 int temperature;
692
693 if (!tz->ops->set_trip_temp)
694 return -EPERM;
695
696 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
697 return -EINVAL;
698
699 if (kstrtoint(buf, 10, &temperature))
700 return -EINVAL;
701
702 ret = tz->ops->set_trip_temp(tz, trip, temperature);
703 if (ret)
704 return ret;
705
706 thermal_zone_device_update(tz);
707
708 return count;
709}
710
711static ssize_t
712trip_point_temp_show(struct device *dev, struct device_attribute *attr,
713 char *buf)
714{
715 struct thermal_zone_device *tz = to_thermal_zone(dev);
716 int trip, ret;
717 int temperature;
718
719 if (!tz->ops->get_trip_temp)
720 return -EPERM;
721
722 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
723 return -EINVAL;
724
725 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
726
727 if (ret)
728 return ret;
729
730 return sprintf(buf, "%d\n", temperature);
731}
732
733static ssize_t
734trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
735 const char *buf, size_t count)
736{
737 struct thermal_zone_device *tz = to_thermal_zone(dev);
738 int trip, ret;
739 int temperature;
740
741 if (!tz->ops->set_trip_hyst)
742 return -EPERM;
743
744 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
745 return -EINVAL;
746
747 if (kstrtoint(buf, 10, &temperature))
748 return -EINVAL;
749
750 /*
751 * We are not doing any check on the 'temperature' value
752 * here. The driver implementing 'set_trip_hyst' has to
753 * take care of this.
754 */
755 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
756
757 return ret ? ret : count;
758}
759
760static ssize_t
761trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
762 char *buf)
763{
764 struct thermal_zone_device *tz = to_thermal_zone(dev);
765 int trip, ret;
766 int temperature;
767
768 if (!tz->ops->get_trip_hyst)
769 return -EPERM;
770
771 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
772 return -EINVAL;
773
774 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
775
776 return ret ? ret : sprintf(buf, "%d\n", temperature);
777}
778
779static ssize_t
780passive_store(struct device *dev, struct device_attribute *attr,
781 const char *buf, size_t count)
782{
783 struct thermal_zone_device *tz = to_thermal_zone(dev);
784 struct thermal_cooling_device *cdev = NULL;
785 int state;
786
787 if (!sscanf(buf, "%d\n", &state))
788 return -EINVAL;
789
790 /* sanity check: values below 1000 millicelcius don't make sense
791 * and can cause the system to go into a thermal heart attack
792 */
793 if (state && state < 1000)
794 return -EINVAL;
795
796 if (state && !tz->forced_passive) {
797 mutex_lock(&thermal_list_lock);
798 list_for_each_entry(cdev, &thermal_cdev_list, node) {
799 if (!strncmp("Processor", cdev->type,
800 sizeof("Processor")))
801 thermal_zone_bind_cooling_device(tz,
802 THERMAL_TRIPS_NONE, cdev,
803 THERMAL_NO_LIMIT,
804 THERMAL_NO_LIMIT,
805 THERMAL_WEIGHT_DEFAULT);
806 }
807 mutex_unlock(&thermal_list_lock);
808 if (!tz->passive_delay)
809 tz->passive_delay = 1000;
810 } else if (!state && tz->forced_passive) {
811 mutex_lock(&thermal_list_lock);
812 list_for_each_entry(cdev, &thermal_cdev_list, node) {
813 if (!strncmp("Processor", cdev->type,
814 sizeof("Processor")))
815 thermal_zone_unbind_cooling_device(tz,
816 THERMAL_TRIPS_NONE,
817 cdev);
818 }
819 mutex_unlock(&thermal_list_lock);
820 tz->passive_delay = 0;
821 }
822
823 tz->forced_passive = state;
824
825 thermal_zone_device_update(tz);
826
827 return count;
828}
829
830static ssize_t
831passive_show(struct device *dev, struct device_attribute *attr,
832 char *buf)
833{
834 struct thermal_zone_device *tz = to_thermal_zone(dev);
835
836 return sprintf(buf, "%d\n", tz->forced_passive);
837}
838
839static ssize_t
840policy_store(struct device *dev, struct device_attribute *attr,
841 const char *buf, size_t count)
842{
843 int ret = -EINVAL;
844 struct thermal_zone_device *tz = to_thermal_zone(dev);
845 struct thermal_governor *gov;
846 char name[THERMAL_NAME_LENGTH];
847
848 snprintf(name, sizeof(name), "%s", buf);
849
850 mutex_lock(&thermal_governor_lock);
851 mutex_lock(&tz->lock);
852
853 gov = __find_governor(strim(name));
854 if (!gov)
855 goto exit;
856
857 ret = thermal_set_governor(tz, gov);
858 if (!ret)
859 ret = count;
860
861exit:
862 mutex_unlock(&tz->lock);
863 mutex_unlock(&thermal_governor_lock);
864 return ret;
865}
866
867static ssize_t
868policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
869{
870 struct thermal_zone_device *tz = to_thermal_zone(dev);
871
872 return sprintf(buf, "%s\n", tz->governor->name);
873}
874
875static ssize_t
876available_policies_show(struct device *dev, struct device_attribute *devattr,
877 char *buf)
878{
879 struct thermal_governor *pos;
880 ssize_t count = 0;
881 ssize_t size = PAGE_SIZE;
882
883 mutex_lock(&thermal_governor_lock);
884
885 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
886 size = PAGE_SIZE - count;
887 count += scnprintf(buf + count, size, "%s ", pos->name);
888 }
889 count += scnprintf(buf + count, size, "\n");
890
891 mutex_unlock(&thermal_governor_lock);
892
893 return count;
894}
895
896static ssize_t
897emul_temp_store(struct device *dev, struct device_attribute *attr,
898 const char *buf, size_t count)
899{
900 struct thermal_zone_device *tz = to_thermal_zone(dev);
901 int ret = 0;
902 int temperature;
903
904 if (kstrtoint(buf, 10, &temperature))
905 return -EINVAL;
906
907 if (!tz->ops->set_emul_temp) {
908 mutex_lock(&tz->lock);
909 tz->emul_temperature = temperature;
910 mutex_unlock(&tz->lock);
911 } else {
912 ret = tz->ops->set_emul_temp(tz, temperature);
913 }
914
915 if (!ret)
916 thermal_zone_device_update(tz);
917
918 return ret ? ret : count;
919}
920static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
921
922static ssize_t
923sustainable_power_show(struct device *dev, struct device_attribute *devattr,
924 char *buf)
925{
926 struct thermal_zone_device *tz = to_thermal_zone(dev);
927
928 if (tz->tzp)
929 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
930 else
931 return -EIO;
932}
933
934static ssize_t
935sustainable_power_store(struct device *dev, struct device_attribute *devattr,
936 const char *buf, size_t count)
937{
938 struct thermal_zone_device *tz = to_thermal_zone(dev);
939 u32 sustainable_power;
940
941 if (!tz->tzp)
942 return -EIO;
943
944 if (kstrtou32(buf, 10, &sustainable_power))
945 return -EINVAL;
946
947 tz->tzp->sustainable_power = sustainable_power;
948
949 return count;
950}
951static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
952 sustainable_power_store);
953
954#define create_s32_tzp_attr(name) \
955 static ssize_t \
956 name##_show(struct device *dev, struct device_attribute *devattr, \
957 char *buf) \
958 { \
959 struct thermal_zone_device *tz = to_thermal_zone(dev); \
960 \
961 if (tz->tzp) \
962 return sprintf(buf, "%d\n", tz->tzp->name); \
963 else \
964 return -EIO; \
965 } \
966 \
967 static ssize_t \
968 name##_store(struct device *dev, struct device_attribute *devattr, \
969 const char *buf, size_t count) \
970 { \
971 struct thermal_zone_device *tz = to_thermal_zone(dev); \
972 s32 value; \
973 \
974 if (!tz->tzp) \
975 return -EIO; \
976 \
977 if (kstrtos32(buf, 10, &value)) \
978 return -EINVAL; \
979 \
980 tz->tzp->name = value; \
981 \
982 return count; \
983 } \
984 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
985
986create_s32_tzp_attr(k_po);
987create_s32_tzp_attr(k_pu);
988create_s32_tzp_attr(k_i);
989create_s32_tzp_attr(k_d);
990create_s32_tzp_attr(integral_cutoff);
991create_s32_tzp_attr(slope);
992create_s32_tzp_attr(offset);
993#undef create_s32_tzp_attr
994
995static struct device_attribute *dev_tzp_attrs[] = {
996 &dev_attr_sustainable_power,
997 &dev_attr_k_po,
998 &dev_attr_k_pu,
999 &dev_attr_k_i,
1000 &dev_attr_k_d,
1001 &dev_attr_integral_cutoff,
1002 &dev_attr_slope,
1003 &dev_attr_offset,
1004};
1005
1006static int create_tzp_attrs(struct device *dev)
1007{
1008 int i;
1009
1010 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
1011 int ret;
1012 struct device_attribute *dev_attr = dev_tzp_attrs[i];
1013
1014 ret = device_create_file(dev, dev_attr);
1015 if (ret)
1016 return ret;
1017 }
1018
1019 return 0;
1020}
1021
1022/**
1023 * power_actor_get_max_power() - get the maximum power that a cdev can consume
1024 * @cdev: pointer to &thermal_cooling_device
1025 * @tz: a valid thermal zone device pointer
1026 * @max_power: pointer in which to store the maximum power
1027 *
1028 * Calculate the maximum power consumption in milliwats that the
1029 * cooling device can currently consume and store it in @max_power.
1030 *
1031 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1032 * power_actor API or -E* on other error.
1033 */
1034int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1035 struct thermal_zone_device *tz, u32 *max_power)
1036{
1037 if (!cdev_is_power_actor(cdev))
1038 return -EINVAL;
1039
1040 return cdev->ops->state2power(cdev, tz, 0, max_power);
1041}
1042
1043/**
1044 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
1045 * @cdev: pointer to &thermal_cooling_device
1046 * @tz: a valid thermal zone device pointer
1047 * @min_power: pointer in which to store the minimum power
1048 *
1049 * Calculate the minimum power consumption in milliwatts that the
1050 * cooling device can currently consume and store it in @min_power.
1051 *
1052 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1053 * power_actor API or -E* on other error.
1054 */
1055int power_actor_get_min_power(struct thermal_cooling_device *cdev,
1056 struct thermal_zone_device *tz, u32 *min_power)
1057{
1058 unsigned long max_state;
1059 int ret;
1060
1061 if (!cdev_is_power_actor(cdev))
1062 return -EINVAL;
1063
1064 ret = cdev->ops->get_max_state(cdev, &max_state);
1065 if (ret)
1066 return ret;
1067
1068 return cdev->ops->state2power(cdev, tz, max_state, min_power);
1069}
1070
1071/**
1072 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1073 * @cdev: pointer to &thermal_cooling_device
1074 * @instance: thermal instance to update
1075 * @power: the power in milliwatts
1076 *
1077 * Set the cooling device to consume at most @power milliwatts.
1078 *
1079 * Return: 0 on success, -EINVAL if the cooling device does not
1080 * implement the power actor API or -E* for other failures.
1081 */
1082int power_actor_set_power(struct thermal_cooling_device *cdev,
1083 struct thermal_instance *instance, u32 power)
1084{
1085 unsigned long state;
1086 int ret;
1087
1088 if (!cdev_is_power_actor(cdev))
1089 return -EINVAL;
1090
1091 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1092 if (ret)
1093 return ret;
1094
1095 instance->target = state;
1096 cdev->updated = false;
1097 thermal_cdev_update(cdev);
1098
1099 return 0;
1100}
1101
1102static DEVICE_ATTR(type, 0444, type_show, NULL);
1103static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1104static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1105static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1106static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1107static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1108
1109/* sys I/F for cooling device */
1110#define to_cooling_device(_dev) \
1111 container_of(_dev, struct thermal_cooling_device, device)
1112
1113static ssize_t
1114thermal_cooling_device_type_show(struct device *dev,
1115 struct device_attribute *attr, char *buf)
1116{
1117 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1118
1119 return sprintf(buf, "%s\n", cdev->type);
1120}
1121
1122static ssize_t
1123thermal_cooling_device_max_state_show(struct device *dev,
1124 struct device_attribute *attr, char *buf)
1125{
1126 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1127 unsigned long state;
1128 int ret;
1129
1130 ret = cdev->ops->get_max_state(cdev, &state);
1131 if (ret)
1132 return ret;
1133 return sprintf(buf, "%ld\n", state);
1134}
1135
1136static ssize_t
1137thermal_cooling_device_cur_state_show(struct device *dev,
1138 struct device_attribute *attr, char *buf)
1139{
1140 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1141 unsigned long state;
1142 int ret;
1143
1144 ret = cdev->ops->get_cur_state(cdev, &state);
1145 if (ret)
1146 return ret;
1147 return sprintf(buf, "%ld\n", state);
1148}
1149
1150static ssize_t
1151thermal_cooling_device_cur_state_store(struct device *dev,
1152 struct device_attribute *attr,
1153 const char *buf, size_t count)
1154{
1155 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1156 unsigned long state;
1157 int result;
1158
1159 if (!sscanf(buf, "%ld\n", &state))
1160 return -EINVAL;
1161
1162 if ((long)state < 0)
1163 return -EINVAL;
1164
1165 result = cdev->ops->set_cur_state(cdev, state);
1166 if (result)
1167 return result;
1168 return count;
1169}
1170
1171static struct device_attribute dev_attr_cdev_type =
1172__ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1173static DEVICE_ATTR(max_state, 0444,
1174 thermal_cooling_device_max_state_show, NULL);
1175static DEVICE_ATTR(cur_state, 0644,
1176 thermal_cooling_device_cur_state_show,
1177 thermal_cooling_device_cur_state_store);
1178
1179static ssize_t
1180thermal_cooling_device_trip_point_show(struct device *dev,
1181 struct device_attribute *attr, char *buf)
1182{
1183 struct thermal_instance *instance;
1184
1185 instance =
1186 container_of(attr, struct thermal_instance, attr);
1187
1188 if (instance->trip == THERMAL_TRIPS_NONE)
1189 return sprintf(buf, "-1\n");
1190 else
1191 return sprintf(buf, "%d\n", instance->trip);
1192}
1193
1194static struct attribute *cooling_device_attrs[] = {
1195 &dev_attr_cdev_type.attr,
1196 &dev_attr_max_state.attr,
1197 &dev_attr_cur_state.attr,
1198 NULL,
1199};
1200
1201static const struct attribute_group cooling_device_attr_group = {
1202 .attrs = cooling_device_attrs,
1203};
1204
1205static const struct attribute_group *cooling_device_attr_groups[] = {
1206 &cooling_device_attr_group,
1207 NULL,
1208};
1209
1210static ssize_t
1211thermal_cooling_device_weight_show(struct device *dev,
1212 struct device_attribute *attr, char *buf)
1213{
1214 struct thermal_instance *instance;
1215
1216 instance = container_of(attr, struct thermal_instance, weight_attr);
1217
1218 return sprintf(buf, "%d\n", instance->weight);
1219}
1220
1221static ssize_t
1222thermal_cooling_device_weight_store(struct device *dev,
1223 struct device_attribute *attr,
1224 const char *buf, size_t count)
1225{
1226 struct thermal_instance *instance;
1227 int ret, weight;
1228
1229 ret = kstrtoint(buf, 0, &weight);
1230 if (ret)
1231 return ret;
1232
1233 instance = container_of(attr, struct thermal_instance, weight_attr);
1234 instance->weight = weight;
1235
1236 return count;
1237}
1238/* Device management */
1239
1240/**
1241 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1242 * @tz: pointer to struct thermal_zone_device
1243 * @trip: indicates which trip point the cooling devices is
1244 * associated with in this thermal zone.
1245 * @cdev: pointer to struct thermal_cooling_device
1246 * @upper: the Maximum cooling state for this trip point.
1247 * THERMAL_NO_LIMIT means no upper limit,
1248 * and the cooling device can be in max_state.
1249 * @lower: the Minimum cooling state can be used for this trip point.
1250 * THERMAL_NO_LIMIT means no lower limit,
1251 * and the cooling device can be in cooling state 0.
1252 * @weight: The weight of the cooling device to be bound to the
1253 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1254 * default value
1255 *
1256 * This interface function bind a thermal cooling device to the certain trip
1257 * point of a thermal zone device.
1258 * This function is usually called in the thermal zone device .bind callback.
1259 *
1260 * Return: 0 on success, the proper error value otherwise.
1261 */
1262int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1263 int trip,
1264 struct thermal_cooling_device *cdev,
1265 unsigned long upper, unsigned long lower,
1266 unsigned int weight)
1267{
1268 struct thermal_instance *dev;
1269 struct thermal_instance *pos;
1270 struct thermal_zone_device *pos1;
1271 struct thermal_cooling_device *pos2;
1272 unsigned long max_state;
1273 int result, ret;
1274
1275 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1276 return -EINVAL;
1277
1278 list_for_each_entry(pos1, &thermal_tz_list, node) {
1279 if (pos1 == tz)
1280 break;
1281 }
1282 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1283 if (pos2 == cdev)
1284 break;
1285 }
1286
1287 if (tz != pos1 || cdev != pos2)
1288 return -EINVAL;
1289
1290 ret = cdev->ops->get_max_state(cdev, &max_state);
1291 if (ret)
1292 return ret;
1293
1294 /* lower default 0, upper default max_state */
1295 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1296 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1297
1298 if (lower > upper || upper > max_state)
1299 return -EINVAL;
1300
1301 dev =
1302 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1303 if (!dev)
1304 return -ENOMEM;
1305 dev->tz = tz;
1306 dev->cdev = cdev;
1307 dev->trip = trip;
1308 dev->upper = upper;
1309 dev->lower = lower;
1310 dev->target = THERMAL_NO_TARGET;
1311 dev->weight = weight;
1312
1313 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1314 if (result)
1315 goto free_mem;
1316
1317 sprintf(dev->name, "cdev%d", dev->id);
1318 result =
1319 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1320 if (result)
1321 goto release_idr;
1322
1323 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1324 sysfs_attr_init(&dev->attr.attr);
1325 dev->attr.attr.name = dev->attr_name;
1326 dev->attr.attr.mode = 0444;
1327 dev->attr.show = thermal_cooling_device_trip_point_show;
1328 result = device_create_file(&tz->device, &dev->attr);
1329 if (result)
1330 goto remove_symbol_link;
1331
1332 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1333 sysfs_attr_init(&dev->weight_attr.attr);
1334 dev->weight_attr.attr.name = dev->weight_attr_name;
1335 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1336 dev->weight_attr.show = thermal_cooling_device_weight_show;
1337 dev->weight_attr.store = thermal_cooling_device_weight_store;
1338 result = device_create_file(&tz->device, &dev->weight_attr);
1339 if (result)
1340 goto remove_trip_file;
1341
1342 mutex_lock(&tz->lock);
1343 mutex_lock(&cdev->lock);
1344 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1345 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1346 result = -EEXIST;
1347 break;
1348 }
1349 if (!result) {
1350 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1351 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1352 atomic_set(&tz->need_update, 1);
1353 }
1354 mutex_unlock(&cdev->lock);
1355 mutex_unlock(&tz->lock);
1356
1357 if (!result)
1358 return 0;
1359
1360 device_remove_file(&tz->device, &dev->weight_attr);
1361remove_trip_file:
1362 device_remove_file(&tz->device, &dev->attr);
1363remove_symbol_link:
1364 sysfs_remove_link(&tz->device.kobj, dev->name);
1365release_idr:
1366 release_idr(&tz->idr, &tz->lock, dev->id);
1367free_mem:
1368 kfree(dev);
1369 return result;
1370}
1371EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1372
1373/**
1374 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1375 * thermal zone.
1376 * @tz: pointer to a struct thermal_zone_device.
1377 * @trip: indicates which trip point the cooling devices is
1378 * associated with in this thermal zone.
1379 * @cdev: pointer to a struct thermal_cooling_device.
1380 *
1381 * This interface function unbind a thermal cooling device from the certain
1382 * trip point of a thermal zone device.
1383 * This function is usually called in the thermal zone device .unbind callback.
1384 *
1385 * Return: 0 on success, the proper error value otherwise.
1386 */
1387int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1388 int trip,
1389 struct thermal_cooling_device *cdev)
1390{
1391 struct thermal_instance *pos, *next;
1392
1393 mutex_lock(&tz->lock);
1394 mutex_lock(&cdev->lock);
1395 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1396 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1397 list_del(&pos->tz_node);
1398 list_del(&pos->cdev_node);
1399 mutex_unlock(&cdev->lock);
1400 mutex_unlock(&tz->lock);
1401 goto unbind;
1402 }
1403 }
1404 mutex_unlock(&cdev->lock);
1405 mutex_unlock(&tz->lock);
1406
1407 return -ENODEV;
1408
1409unbind:
1410 device_remove_file(&tz->device, &pos->weight_attr);
1411 device_remove_file(&tz->device, &pos->attr);
1412 sysfs_remove_link(&tz->device.kobj, pos->name);
1413 release_idr(&tz->idr, &tz->lock, pos->id);
1414 kfree(pos);
1415 return 0;
1416}
1417EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1418
1419static void thermal_release(struct device *dev)
1420{
1421 struct thermal_zone_device *tz;
1422 struct thermal_cooling_device *cdev;
1423
1424 if (!strncmp(dev_name(dev), "thermal_zone",
1425 sizeof("thermal_zone") - 1)) {
1426 tz = to_thermal_zone(dev);
1427 kfree(tz);
1428 } else if(!strncmp(dev_name(dev), "cooling_device",
1429 sizeof("cooling_device") - 1)){
1430 cdev = to_cooling_device(dev);
1431 kfree(cdev);
1432 }
1433}
1434
1435static struct class thermal_class = {
1436 .name = "thermal",
1437 .dev_release = thermal_release,
1438};
1439
1440/**
1441 * __thermal_cooling_device_register() - register a new thermal cooling device
1442 * @np: a pointer to a device tree node.
1443 * @type: the thermal cooling device type.
1444 * @devdata: device private data.
1445 * @ops: standard thermal cooling devices callbacks.
1446 *
1447 * This interface function adds a new thermal cooling device (fan/processor/...)
1448 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1449 * to all the thermal zone devices registered at the same time.
1450 * It also gives the opportunity to link the cooling device to a device tree
1451 * node, so that it can be bound to a thermal zone created out of device tree.
1452 *
1453 * Return: a pointer to the created struct thermal_cooling_device or an
1454 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1455 */
1456static struct thermal_cooling_device *
1457__thermal_cooling_device_register(struct device_node *np,
1458 char *type, void *devdata,
1459 const struct thermal_cooling_device_ops *ops)
1460{
1461 struct thermal_cooling_device *cdev;
1462 struct thermal_zone_device *pos = NULL;
1463 int result;
1464
1465 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1466 return ERR_PTR(-EINVAL);
1467
1468 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1469 !ops->set_cur_state)
1470 return ERR_PTR(-EINVAL);
1471
1472 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1473 if (!cdev)
1474 return ERR_PTR(-ENOMEM);
1475
1476 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1477 if (result) {
1478 kfree(cdev);
1479 return ERR_PTR(result);
1480 }
1481
1482 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1483 mutex_init(&cdev->lock);
1484 INIT_LIST_HEAD(&cdev->thermal_instances);
1485 cdev->np = np;
1486 cdev->ops = ops;
1487 cdev->updated = false;
1488 cdev->device.class = &thermal_class;
1489 cdev->device.groups = cooling_device_attr_groups;
1490 cdev->devdata = devdata;
1491 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1492 result = device_register(&cdev->device);
1493 if (result) {
1494 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1495 kfree(cdev);
1496 return ERR_PTR(result);
1497 }
1498
1499 /* Add 'this' new cdev to the global cdev list */
1500 mutex_lock(&thermal_list_lock);
1501 list_add(&cdev->node, &thermal_cdev_list);
1502 mutex_unlock(&thermal_list_lock);
1503
1504 /* Update binding information for 'this' new cdev */
1505 bind_cdev(cdev);
1506
1507 mutex_lock(&thermal_list_lock);
1508 list_for_each_entry(pos, &thermal_tz_list, node)
1509 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1510 thermal_zone_device_update(pos);
1511 mutex_unlock(&thermal_list_lock);
1512
1513 return cdev;
1514}
1515
1516/**
1517 * thermal_cooling_device_register() - register a new thermal cooling device
1518 * @type: the thermal cooling device type.
1519 * @devdata: device private data.
1520 * @ops: standard thermal cooling devices callbacks.
1521 *
1522 * This interface function adds a new thermal cooling device (fan/processor/...)
1523 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1524 * to all the thermal zone devices registered at the same time.
1525 *
1526 * Return: a pointer to the created struct thermal_cooling_device or an
1527 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1528 */
1529struct thermal_cooling_device *
1530thermal_cooling_device_register(char *type, void *devdata,
1531 const struct thermal_cooling_device_ops *ops)
1532{
1533 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1534}
1535EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1536
1537/**
1538 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1539 * @np: a pointer to a device tree node.
1540 * @type: the thermal cooling device type.
1541 * @devdata: device private data.
1542 * @ops: standard thermal cooling devices callbacks.
1543 *
1544 * This function will register a cooling device with device tree node reference.
1545 * This interface function adds a new thermal cooling device (fan/processor/...)
1546 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1547 * to all the thermal zone devices registered at the same time.
1548 *
1549 * Return: a pointer to the created struct thermal_cooling_device or an
1550 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1551 */
1552struct thermal_cooling_device *
1553thermal_of_cooling_device_register(struct device_node *np,
1554 char *type, void *devdata,
1555 const struct thermal_cooling_device_ops *ops)
1556{
1557 return __thermal_cooling_device_register(np, type, devdata, ops);
1558}
1559EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1560
1561/**
1562 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1563 * @cdev: the thermal cooling device to remove.
1564 *
1565 * thermal_cooling_device_unregister() must be called when the device is no
1566 * longer needed.
1567 */
1568void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1569{
1570 int i;
1571 const struct thermal_zone_params *tzp;
1572 struct thermal_zone_device *tz;
1573 struct thermal_cooling_device *pos = NULL;
1574
1575 if (!cdev)
1576 return;
1577
1578 mutex_lock(&thermal_list_lock);
1579 list_for_each_entry(pos, &thermal_cdev_list, node)
1580 if (pos == cdev)
1581 break;
1582 if (pos != cdev) {
1583 /* thermal cooling device not found */
1584 mutex_unlock(&thermal_list_lock);
1585 return;
1586 }
1587 list_del(&cdev->node);
1588
1589 /* Unbind all thermal zones associated with 'this' cdev */
1590 list_for_each_entry(tz, &thermal_tz_list, node) {
1591 if (tz->ops->unbind) {
1592 tz->ops->unbind(tz, cdev);
1593 continue;
1594 }
1595
1596 if (!tz->tzp || !tz->tzp->tbp)
1597 continue;
1598
1599 tzp = tz->tzp;
1600 for (i = 0; i < tzp->num_tbps; i++) {
1601 if (tzp->tbp[i].cdev == cdev) {
1602 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1603 tzp->tbp[i].cdev = NULL;
1604 }
1605 }
1606 }
1607
1608 mutex_unlock(&thermal_list_lock);
1609
1610 if (cdev->type[0])
1611 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1612 device_remove_file(&cdev->device, &dev_attr_max_state);
1613 device_remove_file(&cdev->device, &dev_attr_cur_state);
1614
1615 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1616 device_unregister(&cdev->device);
1617 return;
1618}
1619EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1620
1621void thermal_cdev_update(struct thermal_cooling_device *cdev)
1622{
1623 struct thermal_instance *instance;
1624 unsigned long target = 0;
1625
1626 /* cooling device is updated*/
1627 if (cdev->updated)
1628 return;
1629
1630 mutex_lock(&cdev->lock);
1631 /* Make sure cdev enters the deepest cooling state */
1632 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1633 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1634 instance->tz->id, instance->target);
1635 if (instance->target == THERMAL_NO_TARGET)
1636 continue;
1637 if (instance->target > target)
1638 target = instance->target;
1639 }
1640 mutex_unlock(&cdev->lock);
1641 cdev->ops->set_cur_state(cdev, target);
1642 cdev->updated = true;
1643 trace_cdev_update(cdev, target);
1644 dev_dbg(&cdev->device, "set to state %lu\n", target);
1645}
1646EXPORT_SYMBOL(thermal_cdev_update);
1647
1648/**
1649 * thermal_notify_framework - Sensor drivers use this API to notify framework
1650 * @tz: thermal zone device
1651 * @trip: indicates which trip point has been crossed
1652 *
1653 * This function handles the trip events from sensor drivers. It starts
1654 * throttling the cooling devices according to the policy configured.
1655 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1656 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1657 * The throttling policy is based on the configured platform data; if no
1658 * platform data is provided, this uses the step_wise throttling policy.
1659 */
1660void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1661{
1662 handle_thermal_trip(tz, trip);
1663}
1664EXPORT_SYMBOL_GPL(thermal_notify_framework);
1665
1666/**
1667 * create_trip_attrs() - create attributes for trip points
1668 * @tz: the thermal zone device
1669 * @mask: Writeable trip point bitmap.
1670 *
1671 * helper function to instantiate sysfs entries for every trip
1672 * point and its properties of a struct thermal_zone_device.
1673 *
1674 * Return: 0 on success, the proper error value otherwise.
1675 */
1676static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1677{
1678 int indx;
1679 int size = sizeof(struct thermal_attr) * tz->trips;
1680
1681 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1682 if (!tz->trip_type_attrs)
1683 return -ENOMEM;
1684
1685 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1686 if (!tz->trip_temp_attrs) {
1687 kfree(tz->trip_type_attrs);
1688 return -ENOMEM;
1689 }
1690
1691 if (tz->ops->get_trip_hyst) {
1692 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1693 if (!tz->trip_hyst_attrs) {
1694 kfree(tz->trip_type_attrs);
1695 kfree(tz->trip_temp_attrs);
1696 return -ENOMEM;
1697 }
1698 }
1699
1700
1701 for (indx = 0; indx < tz->trips; indx++) {
1702 /* create trip type attribute */
1703 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1704 "trip_point_%d_type", indx);
1705
1706 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1707 tz->trip_type_attrs[indx].attr.attr.name =
1708 tz->trip_type_attrs[indx].name;
1709 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1710 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1711
1712 device_create_file(&tz->device,
1713 &tz->trip_type_attrs[indx].attr);
1714
1715 /* create trip temp attribute */
1716 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1717 "trip_point_%d_temp", indx);
1718
1719 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1720 tz->trip_temp_attrs[indx].attr.attr.name =
1721 tz->trip_temp_attrs[indx].name;
1722 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1723 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1724 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1725 mask & (1 << indx)) {
1726 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1727 tz->trip_temp_attrs[indx].attr.store =
1728 trip_point_temp_store;
1729 }
1730
1731 device_create_file(&tz->device,
1732 &tz->trip_temp_attrs[indx].attr);
1733
1734 /* create Optional trip hyst attribute */
1735 if (!tz->ops->get_trip_hyst)
1736 continue;
1737 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1738 "trip_point_%d_hyst", indx);
1739
1740 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1741 tz->trip_hyst_attrs[indx].attr.attr.name =
1742 tz->trip_hyst_attrs[indx].name;
1743 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1744 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1745 if (tz->ops->set_trip_hyst) {
1746 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1747 tz->trip_hyst_attrs[indx].attr.store =
1748 trip_point_hyst_store;
1749 }
1750
1751 device_create_file(&tz->device,
1752 &tz->trip_hyst_attrs[indx].attr);
1753 }
1754 return 0;
1755}
1756
1757static void remove_trip_attrs(struct thermal_zone_device *tz)
1758{
1759 int indx;
1760
1761 for (indx = 0; indx < tz->trips; indx++) {
1762 device_remove_file(&tz->device,
1763 &tz->trip_type_attrs[indx].attr);
1764 device_remove_file(&tz->device,
1765 &tz->trip_temp_attrs[indx].attr);
1766 if (tz->ops->get_trip_hyst)
1767 device_remove_file(&tz->device,
1768 &tz->trip_hyst_attrs[indx].attr);
1769 }
1770 kfree(tz->trip_type_attrs);
1771 kfree(tz->trip_temp_attrs);
1772 kfree(tz->trip_hyst_attrs);
1773}
1774
1775/**
1776 * thermal_zone_device_register() - register a new thermal zone device
1777 * @type: the thermal zone device type
1778 * @trips: the number of trip points the thermal zone support
1779 * @mask: a bit string indicating the writeablility of trip points
1780 * @devdata: private device data
1781 * @ops: standard thermal zone device callbacks
1782 * @tzp: thermal zone platform parameters
1783 * @passive_delay: number of milliseconds to wait between polls when
1784 * performing passive cooling
1785 * @polling_delay: number of milliseconds to wait between polls when checking
1786 * whether trip points have been crossed (0 for interrupt
1787 * driven systems)
1788 *
1789 * This interface function adds a new thermal zone device (sensor) to
1790 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1791 * thermal cooling devices registered at the same time.
1792 * thermal_zone_device_unregister() must be called when the device is no
1793 * longer needed. The passive cooling depends on the .get_trend() return value.
1794 *
1795 * Return: a pointer to the created struct thermal_zone_device or an
1796 * in case of error, an ERR_PTR. Caller must check return value with
1797 * IS_ERR*() helpers.
1798 */
1799struct thermal_zone_device *thermal_zone_device_register(const char *type,
1800 int trips, int mask, void *devdata,
1801 struct thermal_zone_device_ops *ops,
1802 struct thermal_zone_params *tzp,
1803 int passive_delay, int polling_delay)
1804{
1805 struct thermal_zone_device *tz;
1806 enum thermal_trip_type trip_type;
1807 int trip_temp;
1808 int result;
1809 int count;
1810 int passive = 0;
1811 struct thermal_governor *governor;
1812
1813 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1814 return ERR_PTR(-EINVAL);
1815
1816 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1817 return ERR_PTR(-EINVAL);
1818
1819 if (!ops)
1820 return ERR_PTR(-EINVAL);
1821
1822 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1823 return ERR_PTR(-EINVAL);
1824
1825 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1826 if (!tz)
1827 return ERR_PTR(-ENOMEM);
1828
1829 INIT_LIST_HEAD(&tz->thermal_instances);
1830 idr_init(&tz->idr);
1831 mutex_init(&tz->lock);
1832 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1833 if (result) {
1834 kfree(tz);
1835 return ERR_PTR(result);
1836 }
1837
1838 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1839 tz->ops = ops;
1840 tz->tzp = tzp;
1841 tz->device.class = &thermal_class;
1842 tz->devdata = devdata;
1843 tz->trips = trips;
1844 tz->passive_delay = passive_delay;
1845 tz->polling_delay = polling_delay;
1846 /* A new thermal zone needs to be updated anyway. */
1847 atomic_set(&tz->need_update, 1);
1848
1849 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1850 result = device_register(&tz->device);
1851 if (result) {
1852 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1853 kfree(tz);
1854 return ERR_PTR(result);
1855 }
1856
1857 /* sys I/F */
1858 if (type) {
1859 result = device_create_file(&tz->device, &dev_attr_type);
1860 if (result)
1861 goto unregister;
1862 }
1863
1864 result = device_create_file(&tz->device, &dev_attr_temp);
1865 if (result)
1866 goto unregister;
1867
1868 if (ops->get_mode) {
1869 result = device_create_file(&tz->device, &dev_attr_mode);
1870 if (result)
1871 goto unregister;
1872 }
1873
1874 result = create_trip_attrs(tz, mask);
1875 if (result)
1876 goto unregister;
1877
1878 for (count = 0; count < trips; count++) {
1879 if (tz->ops->get_trip_type(tz, count, &trip_type))
1880 set_bit(count, &tz->trips_disabled);
1881 if (trip_type == THERMAL_TRIP_PASSIVE)
1882 passive = 1;
1883 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1884 set_bit(count, &tz->trips_disabled);
1885 /* Check for bogus trip points */
1886 if (trip_temp == 0)
1887 set_bit(count, &tz->trips_disabled);
1888 }
1889
1890 if (!passive) {
1891 result = device_create_file(&tz->device, &dev_attr_passive);
1892 if (result)
1893 goto unregister;
1894 }
1895
1896 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1897 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1898 if (result)
1899 goto unregister;
1900 }
1901
1902 /* Create policy attribute */
1903 result = device_create_file(&tz->device, &dev_attr_policy);
1904 if (result)
1905 goto unregister;
1906
1907 /* Add thermal zone params */
1908 result = create_tzp_attrs(&tz->device);
1909 if (result)
1910 goto unregister;
1911
1912 /* Create available_policies attribute */
1913 result = device_create_file(&tz->device, &dev_attr_available_policies);
1914 if (result)
1915 goto unregister;
1916
1917 /* Update 'this' zone's governor information */
1918 mutex_lock(&thermal_governor_lock);
1919
1920 if (tz->tzp)
1921 governor = __find_governor(tz->tzp->governor_name);
1922 else
1923 governor = def_governor;
1924
1925 result = thermal_set_governor(tz, governor);
1926 if (result) {
1927 mutex_unlock(&thermal_governor_lock);
1928 goto unregister;
1929 }
1930
1931 mutex_unlock(&thermal_governor_lock);
1932
1933 if (!tz->tzp || !tz->tzp->no_hwmon) {
1934 result = thermal_add_hwmon_sysfs(tz);
1935 if (result)
1936 goto unregister;
1937 }
1938
1939 mutex_lock(&thermal_list_lock);
1940 list_add_tail(&tz->node, &thermal_tz_list);
1941 mutex_unlock(&thermal_list_lock);
1942
1943 /* Bind cooling devices for this zone */
1944 bind_tz(tz);
1945
1946 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1947
1948 thermal_zone_device_reset(tz);
1949 /* Update the new thermal zone and mark it as already updated. */
1950 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1951 thermal_zone_device_update(tz);
1952
1953 return tz;
1954
1955unregister:
1956 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1957 device_unregister(&tz->device);
1958 return ERR_PTR(result);
1959}
1960EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1961
1962/**
1963 * thermal_device_unregister - removes the registered thermal zone device
1964 * @tz: the thermal zone device to remove
1965 */
1966void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1967{
1968 int i;
1969 const struct thermal_zone_params *tzp;
1970 struct thermal_cooling_device *cdev;
1971 struct thermal_zone_device *pos = NULL;
1972
1973 if (!tz)
1974 return;
1975
1976 tzp = tz->tzp;
1977
1978 mutex_lock(&thermal_list_lock);
1979 list_for_each_entry(pos, &thermal_tz_list, node)
1980 if (pos == tz)
1981 break;
1982 if (pos != tz) {
1983 /* thermal zone device not found */
1984 mutex_unlock(&thermal_list_lock);
1985 return;
1986 }
1987 list_del(&tz->node);
1988
1989 /* Unbind all cdevs associated with 'this' thermal zone */
1990 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1991 if (tz->ops->unbind) {
1992 tz->ops->unbind(tz, cdev);
1993 continue;
1994 }
1995
1996 if (!tzp || !tzp->tbp)
1997 break;
1998
1999 for (i = 0; i < tzp->num_tbps; i++) {
2000 if (tzp->tbp[i].cdev == cdev) {
2001 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
2002 tzp->tbp[i].cdev = NULL;
2003 }
2004 }
2005 }
2006
2007 mutex_unlock(&thermal_list_lock);
2008
2009 thermal_zone_device_set_polling(tz, 0);
2010
2011 if (tz->type[0])
2012 device_remove_file(&tz->device, &dev_attr_type);
2013 device_remove_file(&tz->device, &dev_attr_temp);
2014 if (tz->ops->get_mode)
2015 device_remove_file(&tz->device, &dev_attr_mode);
2016 device_remove_file(&tz->device, &dev_attr_policy);
2017 device_remove_file(&tz->device, &dev_attr_available_policies);
2018 remove_trip_attrs(tz);
2019 thermal_set_governor(tz, NULL);
2020
2021 thermal_remove_hwmon_sysfs(tz);
2022 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2023 idr_destroy(&tz->idr);
2024 mutex_destroy(&tz->lock);
2025 device_unregister(&tz->device);
2026 return;
2027}
2028EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
2029
2030/**
2031 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
2032 * @name: thermal zone name to fetch the temperature
2033 *
2034 * When only one zone is found with the passed name, returns a reference to it.
2035 *
2036 * Return: On success returns a reference to an unique thermal zone with
2037 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
2038 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
2039 */
2040struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
2041{
2042 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
2043 unsigned int found = 0;
2044
2045 if (!name)
2046 goto exit;
2047
2048 mutex_lock(&thermal_list_lock);
2049 list_for_each_entry(pos, &thermal_tz_list, node)
2050 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
2051 found++;
2052 ref = pos;
2053 }
2054 mutex_unlock(&thermal_list_lock);
2055
2056 /* nothing has been found, thus an error code for it */
2057 if (found == 0)
2058 ref = ERR_PTR(-ENODEV);
2059 else if (found > 1)
2060 /* Success only when an unique zone is found */
2061 ref = ERR_PTR(-EEXIST);
2062
2063exit:
2064 return ref;
2065}
2066EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
2067
2068#ifdef CONFIG_NET
2069static const struct genl_multicast_group thermal_event_mcgrps[] = {
2070 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
2071};
2072
2073static struct genl_family thermal_event_genl_family = {
2074 .id = GENL_ID_GENERATE,
2075 .name = THERMAL_GENL_FAMILY_NAME,
2076 .version = THERMAL_GENL_VERSION,
2077 .maxattr = THERMAL_GENL_ATTR_MAX,
2078 .mcgrps = thermal_event_mcgrps,
2079 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2080};
2081
2082int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2083 enum events event)
2084{
2085 struct sk_buff *skb;
2086 struct nlattr *attr;
2087 struct thermal_genl_event *thermal_event;
2088 void *msg_header;
2089 int size;
2090 int result;
2091 static unsigned int thermal_event_seqnum;
2092
2093 if (!tz)
2094 return -EINVAL;
2095
2096 /* allocate memory */
2097 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2098 nla_total_size(0);
2099
2100 skb = genlmsg_new(size, GFP_ATOMIC);
2101 if (!skb)
2102 return -ENOMEM;
2103
2104 /* add the genetlink message header */
2105 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2106 &thermal_event_genl_family, 0,
2107 THERMAL_GENL_CMD_EVENT);
2108 if (!msg_header) {
2109 nlmsg_free(skb);
2110 return -ENOMEM;
2111 }
2112
2113 /* fill the data */
2114 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2115 sizeof(struct thermal_genl_event));
2116
2117 if (!attr) {
2118 nlmsg_free(skb);
2119 return -EINVAL;
2120 }
2121
2122 thermal_event = nla_data(attr);
2123 if (!thermal_event) {
2124 nlmsg_free(skb);
2125 return -EINVAL;
2126 }
2127
2128 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2129
2130 thermal_event->orig = tz->id;
2131 thermal_event->event = event;
2132
2133 /* send multicast genetlink message */
2134 genlmsg_end(skb, msg_header);
2135
2136 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2137 0, GFP_ATOMIC);
2138 if (result)
2139 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2140
2141 return result;
2142}
2143EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2144
2145static int genetlink_init(void)
2146{
2147 return genl_register_family(&thermal_event_genl_family);
2148}
2149
2150static void genetlink_exit(void)
2151{
2152 genl_unregister_family(&thermal_event_genl_family);
2153}
2154#else /* !CONFIG_NET */
2155static inline int genetlink_init(void) { return 0; }
2156static inline void genetlink_exit(void) {}
2157#endif /* !CONFIG_NET */
2158
2159static int __init thermal_register_governors(void)
2160{
2161 int result;
2162
2163 result = thermal_gov_step_wise_register();
2164 if (result)
2165 return result;
2166
2167 result = thermal_gov_fair_share_register();
2168 if (result)
2169 return result;
2170
2171 result = thermal_gov_bang_bang_register();
2172 if (result)
2173 return result;
2174
2175 result = thermal_gov_user_space_register();
2176 if (result)
2177 return result;
2178
2179 return thermal_gov_power_allocator_register();
2180}
2181
2182static void thermal_unregister_governors(void)
2183{
2184 thermal_gov_step_wise_unregister();
2185 thermal_gov_fair_share_unregister();
2186 thermal_gov_bang_bang_unregister();
2187 thermal_gov_user_space_unregister();
2188 thermal_gov_power_allocator_unregister();
2189}
2190
2191static int thermal_pm_notify(struct notifier_block *nb,
2192 unsigned long mode, void *_unused)
2193{
2194 struct thermal_zone_device *tz;
2195
2196 switch (mode) {
2197 case PM_HIBERNATION_PREPARE:
2198 case PM_RESTORE_PREPARE:
2199 case PM_SUSPEND_PREPARE:
2200 atomic_set(&in_suspend, 1);
2201 break;
2202 case PM_POST_HIBERNATION:
2203 case PM_POST_RESTORE:
2204 case PM_POST_SUSPEND:
2205 atomic_set(&in_suspend, 0);
2206 list_for_each_entry(tz, &thermal_tz_list, node) {
2207 thermal_zone_device_reset(tz);
2208 thermal_zone_device_update(tz);
2209 }
2210 break;
2211 default:
2212 break;
2213 }
2214 return 0;
2215}
2216
2217static struct notifier_block thermal_pm_nb = {
2218 .notifier_call = thermal_pm_notify,
2219};
2220
2221static int __init thermal_init(void)
2222{
2223 int result;
2224
2225 result = thermal_register_governors();
2226 if (result)
2227 goto error;
2228
2229 result = class_register(&thermal_class);
2230 if (result)
2231 goto unregister_governors;
2232
2233 result = genetlink_init();
2234 if (result)
2235 goto unregister_class;
2236
2237 result = of_parse_thermal_zones();
2238 if (result)
2239 goto exit_netlink;
2240
2241 result = register_pm_notifier(&thermal_pm_nb);
2242 if (result)
2243 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
2244 result);
2245
2246 return 0;
2247
2248exit_netlink:
2249 genetlink_exit();
2250unregister_class:
2251 class_unregister(&thermal_class);
2252unregister_governors:
2253 thermal_unregister_governors();
2254error:
2255 idr_destroy(&thermal_tz_idr);
2256 idr_destroy(&thermal_cdev_idr);
2257 mutex_destroy(&thermal_idr_lock);
2258 mutex_destroy(&thermal_list_lock);
2259 mutex_destroy(&thermal_governor_lock);
2260 return result;
2261}
2262
2263static void __exit thermal_exit(void)
2264{
2265 unregister_pm_notifier(&thermal_pm_nb);
2266 of_thermal_destroy_zones();
2267 genetlink_exit();
2268 class_unregister(&thermal_class);
2269 thermal_unregister_governors();
2270 idr_destroy(&thermal_tz_idr);
2271 idr_destroy(&thermal_cdev_idr);
2272 mutex_destroy(&thermal_idr_lock);
2273 mutex_destroy(&thermal_list_lock);
2274 mutex_destroy(&thermal_governor_lock);
2275}
2276
2277fs_initcall(thermal_init);
2278module_exit(thermal_exit);