Merge tag 'soundwire-6.6-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git...
[platform/kernel/linux-starfive.git] / drivers / thermal / thermal_core.c
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 "thermal_trace.h"
26
27 #include "thermal_core.h"
28 #include "thermal_hwmon.h"
29
30 static DEFINE_IDA(thermal_tz_ida);
31 static DEFINE_IDA(thermal_cdev_ida);
32
33 static LIST_HEAD(thermal_tz_list);
34 static LIST_HEAD(thermal_cdev_list);
35 static LIST_HEAD(thermal_governor_list);
36
37 static DEFINE_MUTEX(thermal_list_lock);
38 static DEFINE_MUTEX(thermal_governor_lock);
39
40 static atomic_t in_suspend;
41
42 static struct thermal_governor *def_governor;
43
44 /*
45  * Governor section: set of functions to handle thermal governors
46  *
47  * Functions to help in the life cycle of thermal governors within
48  * the thermal core and by the thermal governor code.
49  */
50
51 static struct thermal_governor *__find_governor(const char *name)
52 {
53         struct thermal_governor *pos;
54
55         if (!name || !name[0])
56                 return def_governor;
57
58         list_for_each_entry(pos, &thermal_governor_list, governor_list)
59                 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
60                         return pos;
61
62         return NULL;
63 }
64
65 /**
66  * bind_previous_governor() - bind the previous governor of the thermal zone
67  * @tz:         a valid pointer to a struct thermal_zone_device
68  * @failed_gov_name:    the name of the governor that failed to register
69  *
70  * Register the previous governor of the thermal zone after a new
71  * governor has failed to be bound.
72  */
73 static void bind_previous_governor(struct thermal_zone_device *tz,
74                                    const char *failed_gov_name)
75 {
76         if (tz->governor && tz->governor->bind_to_tz) {
77                 if (tz->governor->bind_to_tz(tz)) {
78                         dev_err(&tz->device,
79                                 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
80                                 failed_gov_name, tz->governor->name, tz->type);
81                         tz->governor = NULL;
82                 }
83         }
84 }
85
86 /**
87  * thermal_set_governor() - Switch to another governor
88  * @tz:         a valid pointer to a struct thermal_zone_device
89  * @new_gov:    pointer to the new governor
90  *
91  * Change the governor of thermal zone @tz.
92  *
93  * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
94  */
95 static int thermal_set_governor(struct thermal_zone_device *tz,
96                                 struct thermal_governor *new_gov)
97 {
98         int ret = 0;
99
100         if (tz->governor && tz->governor->unbind_from_tz)
101                 tz->governor->unbind_from_tz(tz);
102
103         if (new_gov && new_gov->bind_to_tz) {
104                 ret = new_gov->bind_to_tz(tz);
105                 if (ret) {
106                         bind_previous_governor(tz, new_gov->name);
107
108                         return ret;
109                 }
110         }
111
112         tz->governor = new_gov;
113
114         return ret;
115 }
116
117 int thermal_register_governor(struct thermal_governor *governor)
118 {
119         int err;
120         const char *name;
121         struct thermal_zone_device *pos;
122
123         if (!governor)
124                 return -EINVAL;
125
126         mutex_lock(&thermal_governor_lock);
127
128         err = -EBUSY;
129         if (!__find_governor(governor->name)) {
130                 bool match_default;
131
132                 err = 0;
133                 list_add(&governor->governor_list, &thermal_governor_list);
134                 match_default = !strncmp(governor->name,
135                                          DEFAULT_THERMAL_GOVERNOR,
136                                          THERMAL_NAME_LENGTH);
137
138                 if (!def_governor && match_default)
139                         def_governor = governor;
140         }
141
142         mutex_lock(&thermal_list_lock);
143
144         list_for_each_entry(pos, &thermal_tz_list, node) {
145                 /*
146                  * only thermal zones with specified tz->tzp->governor_name
147                  * may run with tz->govenor unset
148                  */
149                 if (pos->governor)
150                         continue;
151
152                 name = pos->tzp->governor_name;
153
154                 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
155                         int ret;
156
157                         ret = thermal_set_governor(pos, governor);
158                         if (ret)
159                                 dev_err(&pos->device,
160                                         "Failed to set governor %s for thermal zone %s: %d\n",
161                                         governor->name, pos->type, ret);
162                 }
163         }
164
165         mutex_unlock(&thermal_list_lock);
166         mutex_unlock(&thermal_governor_lock);
167
168         return err;
169 }
170
171 void thermal_unregister_governor(struct thermal_governor *governor)
172 {
173         struct thermal_zone_device *pos;
174
175         if (!governor)
176                 return;
177
178         mutex_lock(&thermal_governor_lock);
179
180         if (!__find_governor(governor->name))
181                 goto exit;
182
183         mutex_lock(&thermal_list_lock);
184
185         list_for_each_entry(pos, &thermal_tz_list, node) {
186                 if (!strncasecmp(pos->governor->name, governor->name,
187                                  THERMAL_NAME_LENGTH))
188                         thermal_set_governor(pos, NULL);
189         }
190
191         mutex_unlock(&thermal_list_lock);
192         list_del(&governor->governor_list);
193 exit:
194         mutex_unlock(&thermal_governor_lock);
195 }
196
197 int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
198                                    char *policy)
199 {
200         struct thermal_governor *gov;
201         int ret = -EINVAL;
202
203         mutex_lock(&thermal_governor_lock);
204         mutex_lock(&tz->lock);
205
206         if (!device_is_registered(&tz->device))
207                 goto exit;
208
209         gov = __find_governor(strim(policy));
210         if (!gov)
211                 goto exit;
212
213         ret = thermal_set_governor(tz, gov);
214
215 exit:
216         mutex_unlock(&tz->lock);
217         mutex_unlock(&thermal_governor_lock);
218
219         thermal_notify_tz_gov_change(tz->id, policy);
220
221         return ret;
222 }
223
224 int thermal_build_list_of_policies(char *buf)
225 {
226         struct thermal_governor *pos;
227         ssize_t count = 0;
228
229         mutex_lock(&thermal_governor_lock);
230
231         list_for_each_entry(pos, &thermal_governor_list, governor_list) {
232                 count += sysfs_emit_at(buf, count, "%s ", pos->name);
233         }
234         count += sysfs_emit_at(buf, count, "\n");
235
236         mutex_unlock(&thermal_governor_lock);
237
238         return count;
239 }
240
241 static void __init thermal_unregister_governors(void)
242 {
243         struct thermal_governor **governor;
244
245         for_each_governor_table(governor)
246                 thermal_unregister_governor(*governor);
247 }
248
249 static int __init thermal_register_governors(void)
250 {
251         int ret = 0;
252         struct thermal_governor **governor;
253
254         for_each_governor_table(governor) {
255                 ret = thermal_register_governor(*governor);
256                 if (ret) {
257                         pr_err("Failed to register governor: '%s'",
258                                (*governor)->name);
259                         break;
260                 }
261
262                 pr_info("Registered thermal governor '%s'",
263                         (*governor)->name);
264         }
265
266         if (ret) {
267                 struct thermal_governor **gov;
268
269                 for_each_governor_table(gov) {
270                         if (gov == governor)
271                                 break;
272                         thermal_unregister_governor(*gov);
273                 }
274         }
275
276         return ret;
277 }
278
279 /*
280  * Zone update section: main control loop applied to each zone while monitoring
281  *
282  * in polling mode. The monitoring is done using a workqueue.
283  * Same update may be done on a zone by calling thermal_zone_device_update().
284  *
285  * An update means:
286  * - Non-critical trips will invoke the governor responsible for that zone;
287  * - Hot trips will produce a notification to userspace;
288  * - Critical trip point will cause a system shutdown.
289  */
290 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
291                                             unsigned long delay)
292 {
293         if (delay)
294                 mod_delayed_work(system_freezable_power_efficient_wq,
295                                  &tz->poll_queue, delay);
296         else
297                 cancel_delayed_work(&tz->poll_queue);
298 }
299
300 static void monitor_thermal_zone(struct thermal_zone_device *tz)
301 {
302         if (tz->mode != THERMAL_DEVICE_ENABLED)
303                 thermal_zone_device_set_polling(tz, 0);
304         else if (tz->passive)
305                 thermal_zone_device_set_polling(tz, tz->passive_delay_jiffies);
306         else if (tz->polling_delay_jiffies)
307                 thermal_zone_device_set_polling(tz, tz->polling_delay_jiffies);
308 }
309
310 static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
311 {
312         tz->governor ? tz->governor->throttle(tz, trip) :
313                        def_governor->throttle(tz, trip);
314 }
315
316 void thermal_zone_device_critical(struct thermal_zone_device *tz)
317 {
318         /*
319          * poweroff_delay_ms must be a carefully profiled positive value.
320          * Its a must for forced_emergency_poweroff_work to be scheduled.
321          */
322         int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
323
324         dev_emerg(&tz->device, "%s: critical temperature reached, "
325                   "shutting down\n", tz->type);
326
327         hw_protection_shutdown("Temperature too high", poweroff_delay_ms);
328 }
329 EXPORT_SYMBOL(thermal_zone_device_critical);
330
331 static void handle_critical_trips(struct thermal_zone_device *tz,
332                                   int trip, int trip_temp, enum thermal_trip_type trip_type)
333 {
334         /* If we have not crossed the trip_temp, we do not care. */
335         if (trip_temp <= 0 || tz->temperature < trip_temp)
336                 return;
337
338         trace_thermal_zone_trip(tz, trip, trip_type);
339
340         if (trip_type == THERMAL_TRIP_HOT && tz->ops->hot)
341                 tz->ops->hot(tz);
342         else if (trip_type == THERMAL_TRIP_CRITICAL)
343                 tz->ops->critical(tz);
344 }
345
346 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip_id)
347 {
348         struct thermal_trip trip;
349
350         /* Ignore disabled trip points */
351         if (test_bit(trip_id, &tz->trips_disabled))
352                 return;
353
354         __thermal_zone_get_trip(tz, trip_id, &trip);
355
356         if (trip.temperature == THERMAL_TEMP_INVALID)
357                 return;
358
359         if (tz->last_temperature != THERMAL_TEMP_INVALID) {
360                 if (tz->last_temperature < trip.temperature &&
361                     tz->temperature >= trip.temperature)
362                         thermal_notify_tz_trip_up(tz->id, trip_id,
363                                                   tz->temperature);
364                 if (tz->last_temperature >= trip.temperature &&
365                     tz->temperature < (trip.temperature - trip.hysteresis))
366                         thermal_notify_tz_trip_down(tz->id, trip_id,
367                                                     tz->temperature);
368         }
369
370         if (trip.type == THERMAL_TRIP_CRITICAL || trip.type == THERMAL_TRIP_HOT)
371                 handle_critical_trips(tz, trip_id, trip.temperature, trip.type);
372         else
373                 handle_non_critical_trips(tz, trip_id);
374 }
375
376 static void update_temperature(struct thermal_zone_device *tz)
377 {
378         int temp, ret;
379
380         ret = __thermal_zone_get_temp(tz, &temp);
381         if (ret) {
382                 if (ret != -EAGAIN)
383                         dev_warn(&tz->device,
384                                  "failed to read out thermal zone (%d)\n",
385                                  ret);
386                 return;
387         }
388
389         tz->last_temperature = tz->temperature;
390         tz->temperature = temp;
391
392         trace_thermal_temperature(tz);
393
394         thermal_genl_sampling_temp(tz->id, temp);
395 }
396
397 static void thermal_zone_device_init(struct thermal_zone_device *tz)
398 {
399         struct thermal_instance *pos;
400         tz->temperature = THERMAL_TEMP_INVALID;
401         tz->prev_low_trip = -INT_MAX;
402         tz->prev_high_trip = INT_MAX;
403         list_for_each_entry(pos, &tz->thermal_instances, tz_node)
404                 pos->initialized = false;
405 }
406
407 void __thermal_zone_device_update(struct thermal_zone_device *tz,
408                                   enum thermal_notify_event event)
409 {
410         int count;
411
412         if (atomic_read(&in_suspend))
413                 return;
414
415         if (WARN_ONCE(!tz->ops->get_temp,
416                       "'%s' must not be called without 'get_temp' ops set\n",
417                       __func__))
418                 return;
419
420         if (!thermal_zone_device_is_enabled(tz))
421                 return;
422
423         update_temperature(tz);
424
425         __thermal_zone_set_trips(tz);
426
427         tz->notify_event = event;
428
429         for (count = 0; count < tz->num_trips; count++)
430                 handle_thermal_trip(tz, count);
431
432         monitor_thermal_zone(tz);
433 }
434
435 static int thermal_zone_device_set_mode(struct thermal_zone_device *tz,
436                                         enum thermal_device_mode mode)
437 {
438         int ret = 0;
439
440         mutex_lock(&tz->lock);
441
442         /* do nothing if mode isn't changing */
443         if (mode == tz->mode) {
444                 mutex_unlock(&tz->lock);
445
446                 return ret;
447         }
448
449         if (!device_is_registered(&tz->device)) {
450                 mutex_unlock(&tz->lock);
451
452                 return -ENODEV;
453         }
454
455         if (tz->ops->change_mode)
456                 ret = tz->ops->change_mode(tz, mode);
457
458         if (!ret)
459                 tz->mode = mode;
460
461         __thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
462
463         mutex_unlock(&tz->lock);
464
465         if (mode == THERMAL_DEVICE_ENABLED)
466                 thermal_notify_tz_enable(tz->id);
467         else
468                 thermal_notify_tz_disable(tz->id);
469
470         return ret;
471 }
472
473 int thermal_zone_device_enable(struct thermal_zone_device *tz)
474 {
475         return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
476 }
477 EXPORT_SYMBOL_GPL(thermal_zone_device_enable);
478
479 int thermal_zone_device_disable(struct thermal_zone_device *tz)
480 {
481         return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
482 }
483 EXPORT_SYMBOL_GPL(thermal_zone_device_disable);
484
485 int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
486 {
487         lockdep_assert_held(&tz->lock);
488
489         return tz->mode == THERMAL_DEVICE_ENABLED;
490 }
491
492 void thermal_zone_device_update(struct thermal_zone_device *tz,
493                                 enum thermal_notify_event event)
494 {
495         mutex_lock(&tz->lock);
496         if (device_is_registered(&tz->device))
497                 __thermal_zone_device_update(tz, event);
498         mutex_unlock(&tz->lock);
499 }
500 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
501
502 /**
503  * thermal_zone_device_exec - Run a callback under the zone lock.
504  * @tz: Thermal zone.
505  * @cb: Callback to run.
506  * @data: Data to pass to the callback.
507  */
508 void thermal_zone_device_exec(struct thermal_zone_device *tz,
509                               void (*cb)(struct thermal_zone_device *,
510                                          unsigned long),
511                               unsigned long data)
512 {
513         mutex_lock(&tz->lock);
514
515         cb(tz, data);
516
517         mutex_unlock(&tz->lock);
518 }
519 EXPORT_SYMBOL_GPL(thermal_zone_device_exec);
520
521 static void thermal_zone_device_check(struct work_struct *work)
522 {
523         struct thermal_zone_device *tz = container_of(work, struct
524                                                       thermal_zone_device,
525                                                       poll_queue.work);
526         thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
527 }
528
529 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
530                               void *data)
531 {
532         struct thermal_governor *gov;
533         int ret = 0;
534
535         mutex_lock(&thermal_governor_lock);
536         list_for_each_entry(gov, &thermal_governor_list, governor_list) {
537                 ret = cb(gov, data);
538                 if (ret)
539                         break;
540         }
541         mutex_unlock(&thermal_governor_lock);
542
543         return ret;
544 }
545
546 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
547                                               void *), void *data)
548 {
549         struct thermal_cooling_device *cdev;
550         int ret = 0;
551
552         mutex_lock(&thermal_list_lock);
553         list_for_each_entry(cdev, &thermal_cdev_list, node) {
554                 ret = cb(cdev, data);
555                 if (ret)
556                         break;
557         }
558         mutex_unlock(&thermal_list_lock);
559
560         return ret;
561 }
562
563 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
564                           void *data)
565 {
566         struct thermal_zone_device *tz;
567         int ret = 0;
568
569         mutex_lock(&thermal_list_lock);
570         list_for_each_entry(tz, &thermal_tz_list, node) {
571                 ret = cb(tz, data);
572                 if (ret)
573                         break;
574         }
575         mutex_unlock(&thermal_list_lock);
576
577         return ret;
578 }
579
580 struct thermal_zone_device *thermal_zone_get_by_id(int id)
581 {
582         struct thermal_zone_device *tz, *match = NULL;
583
584         mutex_lock(&thermal_list_lock);
585         list_for_each_entry(tz, &thermal_tz_list, node) {
586                 if (tz->id == id) {
587                         match = tz;
588                         break;
589                 }
590         }
591         mutex_unlock(&thermal_list_lock);
592
593         return match;
594 }
595
596 /*
597  * Device management section: cooling devices, zones devices, and binding
598  *
599  * Set of functions provided by the thermal core for:
600  * - cooling devices lifecycle: registration, unregistration,
601  *                              binding, and unbinding.
602  * - thermal zone devices lifecycle: registration, unregistration,
603  *                                   binding, and unbinding.
604  */
605
606 /**
607  * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
608  * @tz:         pointer to struct thermal_zone_device
609  * @trip:       indicates which trip point the cooling devices is
610  *              associated with in this thermal zone.
611  * @cdev:       pointer to struct thermal_cooling_device
612  * @upper:      the Maximum cooling state for this trip point.
613  *              THERMAL_NO_LIMIT means no upper limit,
614  *              and the cooling device can be in max_state.
615  * @lower:      the Minimum cooling state can be used for this trip point.
616  *              THERMAL_NO_LIMIT means no lower limit,
617  *              and the cooling device can be in cooling state 0.
618  * @weight:     The weight of the cooling device to be bound to the
619  *              thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
620  *              default value
621  *
622  * This interface function bind a thermal cooling device to the certain trip
623  * point of a thermal zone device.
624  * This function is usually called in the thermal zone device .bind callback.
625  *
626  * Return: 0 on success, the proper error value otherwise.
627  */
628 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
629                                      int trip,
630                                      struct thermal_cooling_device *cdev,
631                                      unsigned long upper, unsigned long lower,
632                                      unsigned int weight)
633 {
634         struct thermal_instance *dev;
635         struct thermal_instance *pos;
636         struct thermal_zone_device *pos1;
637         struct thermal_cooling_device *pos2;
638         bool upper_no_limit;
639         int result;
640
641         if (trip >= tz->num_trips || trip < 0)
642                 return -EINVAL;
643
644         list_for_each_entry(pos1, &thermal_tz_list, node) {
645                 if (pos1 == tz)
646                         break;
647         }
648         list_for_each_entry(pos2, &thermal_cdev_list, node) {
649                 if (pos2 == cdev)
650                         break;
651         }
652
653         if (tz != pos1 || cdev != pos2)
654                 return -EINVAL;
655
656         /* lower default 0, upper default max_state */
657         lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
658
659         if (upper == THERMAL_NO_LIMIT) {
660                 upper = cdev->max_state;
661                 upper_no_limit = true;
662         } else {
663                 upper_no_limit = false;
664         }
665
666         if (lower > upper || upper > cdev->max_state)
667                 return -EINVAL;
668
669         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
670         if (!dev)
671                 return -ENOMEM;
672         dev->tz = tz;
673         dev->cdev = cdev;
674         dev->trip = trip;
675         dev->upper = upper;
676         dev->upper_no_limit = upper_no_limit;
677         dev->lower = lower;
678         dev->target = THERMAL_NO_TARGET;
679         dev->weight = weight;
680
681         result = ida_alloc(&tz->ida, GFP_KERNEL);
682         if (result < 0)
683                 goto free_mem;
684
685         dev->id = result;
686         sprintf(dev->name, "cdev%d", dev->id);
687         result =
688             sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
689         if (result)
690                 goto release_ida;
691
692         sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
693         sysfs_attr_init(&dev->attr.attr);
694         dev->attr.attr.name = dev->attr_name;
695         dev->attr.attr.mode = 0444;
696         dev->attr.show = trip_point_show;
697         result = device_create_file(&tz->device, &dev->attr);
698         if (result)
699                 goto remove_symbol_link;
700
701         sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
702         sysfs_attr_init(&dev->weight_attr.attr);
703         dev->weight_attr.attr.name = dev->weight_attr_name;
704         dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
705         dev->weight_attr.show = weight_show;
706         dev->weight_attr.store = weight_store;
707         result = device_create_file(&tz->device, &dev->weight_attr);
708         if (result)
709                 goto remove_trip_file;
710
711         mutex_lock(&tz->lock);
712         mutex_lock(&cdev->lock);
713         list_for_each_entry(pos, &tz->thermal_instances, tz_node)
714                 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
715                         result = -EEXIST;
716                         break;
717                 }
718         if (!result) {
719                 list_add_tail(&dev->tz_node, &tz->thermal_instances);
720                 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
721                 atomic_set(&tz->need_update, 1);
722         }
723         mutex_unlock(&cdev->lock);
724         mutex_unlock(&tz->lock);
725
726         if (!result)
727                 return 0;
728
729         device_remove_file(&tz->device, &dev->weight_attr);
730 remove_trip_file:
731         device_remove_file(&tz->device, &dev->attr);
732 remove_symbol_link:
733         sysfs_remove_link(&tz->device.kobj, dev->name);
734 release_ida:
735         ida_free(&tz->ida, dev->id);
736 free_mem:
737         kfree(dev);
738         return result;
739 }
740 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
741
742 /**
743  * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
744  *                                        thermal zone.
745  * @tz:         pointer to a struct thermal_zone_device.
746  * @trip:       indicates which trip point the cooling devices is
747  *              associated with in this thermal zone.
748  * @cdev:       pointer to a struct thermal_cooling_device.
749  *
750  * This interface function unbind a thermal cooling device from the certain
751  * trip point of a thermal zone device.
752  * This function is usually called in the thermal zone device .unbind callback.
753  *
754  * Return: 0 on success, the proper error value otherwise.
755  */
756 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
757                                        int trip,
758                                        struct thermal_cooling_device *cdev)
759 {
760         struct thermal_instance *pos, *next;
761
762         mutex_lock(&tz->lock);
763         mutex_lock(&cdev->lock);
764         list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
765                 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
766                         list_del(&pos->tz_node);
767                         list_del(&pos->cdev_node);
768                         mutex_unlock(&cdev->lock);
769                         mutex_unlock(&tz->lock);
770                         goto unbind;
771                 }
772         }
773         mutex_unlock(&cdev->lock);
774         mutex_unlock(&tz->lock);
775
776         return -ENODEV;
777
778 unbind:
779         device_remove_file(&tz->device, &pos->weight_attr);
780         device_remove_file(&tz->device, &pos->attr);
781         sysfs_remove_link(&tz->device.kobj, pos->name);
782         ida_free(&tz->ida, pos->id);
783         kfree(pos);
784         return 0;
785 }
786 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
787
788 static void thermal_release(struct device *dev)
789 {
790         struct thermal_zone_device *tz;
791         struct thermal_cooling_device *cdev;
792
793         if (!strncmp(dev_name(dev), "thermal_zone",
794                      sizeof("thermal_zone") - 1)) {
795                 tz = to_thermal_zone(dev);
796                 thermal_zone_destroy_device_groups(tz);
797                 mutex_destroy(&tz->lock);
798                 kfree(tz);
799         } else if (!strncmp(dev_name(dev), "cooling_device",
800                             sizeof("cooling_device") - 1)) {
801                 cdev = to_cooling_device(dev);
802                 thermal_cooling_device_destroy_sysfs(cdev);
803                 kfree(cdev->type);
804                 ida_free(&thermal_cdev_ida, cdev->id);
805                 kfree(cdev);
806         }
807 }
808
809 static struct class *thermal_class;
810
811 static inline
812 void print_bind_err_msg(struct thermal_zone_device *tz,
813                         struct thermal_cooling_device *cdev, int ret)
814 {
815         dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
816                 tz->type, cdev->type, ret);
817 }
818
819 static void bind_cdev(struct thermal_cooling_device *cdev)
820 {
821         int ret;
822         struct thermal_zone_device *pos = NULL;
823
824         list_for_each_entry(pos, &thermal_tz_list, node) {
825                 if (pos->ops->bind) {
826                         ret = pos->ops->bind(pos, cdev);
827                         if (ret)
828                                 print_bind_err_msg(pos, cdev, ret);
829                 }
830         }
831 }
832
833 /**
834  * __thermal_cooling_device_register() - register a new thermal cooling device
835  * @np:         a pointer to a device tree node.
836  * @type:       the thermal cooling device type.
837  * @devdata:    device private data.
838  * @ops:                standard thermal cooling devices callbacks.
839  *
840  * This interface function adds a new thermal cooling device (fan/processor/...)
841  * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
842  * to all the thermal zone devices registered at the same time.
843  * It also gives the opportunity to link the cooling device to a device tree
844  * node, so that it can be bound to a thermal zone created out of device tree.
845  *
846  * Return: a pointer to the created struct thermal_cooling_device or an
847  * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
848  */
849 static struct thermal_cooling_device *
850 __thermal_cooling_device_register(struct device_node *np,
851                                   const char *type, void *devdata,
852                                   const struct thermal_cooling_device_ops *ops)
853 {
854         struct thermal_cooling_device *cdev;
855         struct thermal_zone_device *pos = NULL;
856         int id, ret;
857
858         if (!ops || !ops->get_max_state || !ops->get_cur_state ||
859             !ops->set_cur_state)
860                 return ERR_PTR(-EINVAL);
861
862         if (!thermal_class)
863                 return ERR_PTR(-ENODEV);
864
865         cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
866         if (!cdev)
867                 return ERR_PTR(-ENOMEM);
868
869         ret = ida_alloc(&thermal_cdev_ida, GFP_KERNEL);
870         if (ret < 0)
871                 goto out_kfree_cdev;
872         cdev->id = ret;
873         id = ret;
874
875         cdev->type = kstrdup(type ? type : "", GFP_KERNEL);
876         if (!cdev->type) {
877                 ret = -ENOMEM;
878                 goto out_ida_remove;
879         }
880
881         mutex_init(&cdev->lock);
882         INIT_LIST_HEAD(&cdev->thermal_instances);
883         cdev->np = np;
884         cdev->ops = ops;
885         cdev->updated = false;
886         cdev->device.class = thermal_class;
887         cdev->devdata = devdata;
888
889         ret = cdev->ops->get_max_state(cdev, &cdev->max_state);
890         if (ret)
891                 goto out_cdev_type;
892
893         thermal_cooling_device_setup_sysfs(cdev);
894
895         ret = dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
896         if (ret)
897                 goto out_cooling_dev;
898
899         ret = device_register(&cdev->device);
900         if (ret) {
901                 /* thermal_release() handles rest of the cleanup */
902                 put_device(&cdev->device);
903                 return ERR_PTR(ret);
904         }
905
906         /* Add 'this' new cdev to the global cdev list */
907         mutex_lock(&thermal_list_lock);
908
909         list_add(&cdev->node, &thermal_cdev_list);
910
911         /* Update binding information for 'this' new cdev */
912         bind_cdev(cdev);
913
914         list_for_each_entry(pos, &thermal_tz_list, node)
915                 if (atomic_cmpxchg(&pos->need_update, 1, 0))
916                         thermal_zone_device_update(pos,
917                                                    THERMAL_EVENT_UNSPECIFIED);
918
919         mutex_unlock(&thermal_list_lock);
920
921         return cdev;
922
923 out_cooling_dev:
924         thermal_cooling_device_destroy_sysfs(cdev);
925 out_cdev_type:
926         kfree(cdev->type);
927 out_ida_remove:
928         ida_free(&thermal_cdev_ida, id);
929 out_kfree_cdev:
930         kfree(cdev);
931         return ERR_PTR(ret);
932 }
933
934 /**
935  * thermal_cooling_device_register() - register a new thermal cooling device
936  * @type:       the thermal cooling device type.
937  * @devdata:    device private data.
938  * @ops:                standard thermal cooling devices callbacks.
939  *
940  * This interface function adds a new thermal cooling device (fan/processor/...)
941  * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
942  * to all the thermal zone devices registered at the same time.
943  *
944  * Return: a pointer to the created struct thermal_cooling_device or an
945  * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
946  */
947 struct thermal_cooling_device *
948 thermal_cooling_device_register(const char *type, void *devdata,
949                                 const struct thermal_cooling_device_ops *ops)
950 {
951         return __thermal_cooling_device_register(NULL, type, devdata, ops);
952 }
953 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
954
955 /**
956  * thermal_of_cooling_device_register() - register an OF thermal cooling device
957  * @np:         a pointer to a device tree node.
958  * @type:       the thermal cooling device type.
959  * @devdata:    device private data.
960  * @ops:                standard thermal cooling devices callbacks.
961  *
962  * This function will register a cooling device with device tree node reference.
963  * This interface function adds a new thermal cooling device (fan/processor/...)
964  * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
965  * to all the thermal zone devices registered at the same time.
966  *
967  * Return: a pointer to the created struct thermal_cooling_device or an
968  * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
969  */
970 struct thermal_cooling_device *
971 thermal_of_cooling_device_register(struct device_node *np,
972                                    const char *type, void *devdata,
973                                    const struct thermal_cooling_device_ops *ops)
974 {
975         return __thermal_cooling_device_register(np, type, devdata, ops);
976 }
977 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
978
979 static void thermal_cooling_device_release(struct device *dev, void *res)
980 {
981         thermal_cooling_device_unregister(
982                                 *(struct thermal_cooling_device **)res);
983 }
984
985 /**
986  * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
987  *                                             device
988  * @dev:        a valid struct device pointer of a sensor device.
989  * @np:         a pointer to a device tree node.
990  * @type:       the thermal cooling device type.
991  * @devdata:    device private data.
992  * @ops:        standard thermal cooling devices callbacks.
993  *
994  * This function will register a cooling device with device tree node reference.
995  * This interface function adds a new thermal cooling device (fan/processor/...)
996  * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
997  * to all the thermal zone devices registered at the same time.
998  *
999  * Return: a pointer to the created struct thermal_cooling_device or an
1000  * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1001  */
1002 struct thermal_cooling_device *
1003 devm_thermal_of_cooling_device_register(struct device *dev,
1004                                 struct device_node *np,
1005                                 char *type, void *devdata,
1006                                 const struct thermal_cooling_device_ops *ops)
1007 {
1008         struct thermal_cooling_device **ptr, *tcd;
1009
1010         ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
1011                            GFP_KERNEL);
1012         if (!ptr)
1013                 return ERR_PTR(-ENOMEM);
1014
1015         tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1016         if (IS_ERR(tcd)) {
1017                 devres_free(ptr);
1018                 return tcd;
1019         }
1020
1021         *ptr = tcd;
1022         devres_add(dev, ptr);
1023
1024         return tcd;
1025 }
1026 EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1027
1028 static bool thermal_cooling_device_present(struct thermal_cooling_device *cdev)
1029 {
1030         struct thermal_cooling_device *pos = NULL;
1031
1032         list_for_each_entry(pos, &thermal_cdev_list, node) {
1033                 if (pos == cdev)
1034                         return true;
1035         }
1036
1037         return false;
1038 }
1039
1040 /**
1041  * thermal_cooling_device_update - Update a cooling device object
1042  * @cdev: Target cooling device.
1043  *
1044  * Update @cdev to reflect a change of the underlying hardware or platform.
1045  *
1046  * Must be called when the maximum cooling state of @cdev becomes invalid and so
1047  * its .get_max_state() callback needs to be run to produce the new maximum
1048  * cooling state value.
1049  */
1050 void thermal_cooling_device_update(struct thermal_cooling_device *cdev)
1051 {
1052         struct thermal_instance *ti;
1053         unsigned long state;
1054
1055         if (IS_ERR_OR_NULL(cdev))
1056                 return;
1057
1058         /*
1059          * Hold thermal_list_lock throughout the update to prevent the device
1060          * from going away while being updated.
1061          */
1062         mutex_lock(&thermal_list_lock);
1063
1064         if (!thermal_cooling_device_present(cdev))
1065                 goto unlock_list;
1066
1067         /*
1068          * Update under the cdev lock to prevent the state from being set beyond
1069          * the new limit concurrently.
1070          */
1071         mutex_lock(&cdev->lock);
1072
1073         if (cdev->ops->get_max_state(cdev, &cdev->max_state))
1074                 goto unlock;
1075
1076         thermal_cooling_device_stats_reinit(cdev);
1077
1078         list_for_each_entry(ti, &cdev->thermal_instances, cdev_node) {
1079                 if (ti->upper == cdev->max_state)
1080                         continue;
1081
1082                 if (ti->upper < cdev->max_state) {
1083                         if (ti->upper_no_limit)
1084                                 ti->upper = cdev->max_state;
1085
1086                         continue;
1087                 }
1088
1089                 ti->upper = cdev->max_state;
1090                 if (ti->lower > ti->upper)
1091                         ti->lower = ti->upper;
1092
1093                 if (ti->target == THERMAL_NO_TARGET)
1094                         continue;
1095
1096                 if (ti->target > ti->upper)
1097                         ti->target = ti->upper;
1098         }
1099
1100         if (cdev->ops->get_cur_state(cdev, &state) || state > cdev->max_state)
1101                 goto unlock;
1102
1103         thermal_cooling_device_stats_update(cdev, state);
1104
1105 unlock:
1106         mutex_unlock(&cdev->lock);
1107
1108 unlock_list:
1109         mutex_unlock(&thermal_list_lock);
1110 }
1111 EXPORT_SYMBOL_GPL(thermal_cooling_device_update);
1112
1113 /**
1114  * thermal_cooling_device_unregister - removes a thermal cooling device
1115  * @cdev:       the thermal cooling device to remove.
1116  *
1117  * thermal_cooling_device_unregister() must be called when a registered
1118  * thermal cooling device is no longer needed.
1119  */
1120 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1121 {
1122         struct thermal_zone_device *tz;
1123
1124         if (!cdev)
1125                 return;
1126
1127         mutex_lock(&thermal_list_lock);
1128
1129         if (!thermal_cooling_device_present(cdev)) {
1130                 mutex_unlock(&thermal_list_lock);
1131                 return;
1132         }
1133
1134         list_del(&cdev->node);
1135
1136         /* Unbind all thermal zones associated with 'this' cdev */
1137         list_for_each_entry(tz, &thermal_tz_list, node) {
1138                 if (tz->ops->unbind)
1139                         tz->ops->unbind(tz, cdev);
1140         }
1141
1142         mutex_unlock(&thermal_list_lock);
1143
1144         device_unregister(&cdev->device);
1145 }
1146 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1147
1148 static void bind_tz(struct thermal_zone_device *tz)
1149 {
1150         int ret;
1151         struct thermal_cooling_device *pos = NULL;
1152
1153         if (!tz->ops->bind)
1154                 return;
1155
1156         mutex_lock(&thermal_list_lock);
1157
1158         list_for_each_entry(pos, &thermal_cdev_list, node) {
1159                 ret = tz->ops->bind(tz, pos);
1160                 if (ret)
1161                         print_bind_err_msg(tz, pos, ret);
1162         }
1163
1164         mutex_unlock(&thermal_list_lock);
1165 }
1166
1167 static void thermal_set_delay_jiffies(unsigned long *delay_jiffies, int delay_ms)
1168 {
1169         *delay_jiffies = msecs_to_jiffies(delay_ms);
1170         if (delay_ms > 1000)
1171                 *delay_jiffies = round_jiffies(*delay_jiffies);
1172 }
1173
1174 int thermal_zone_get_crit_temp(struct thermal_zone_device *tz, int *temp)
1175 {
1176         int i, ret = -EINVAL;
1177
1178         if (tz->ops->get_crit_temp)
1179                 return tz->ops->get_crit_temp(tz, temp);
1180
1181         if (!tz->trips)
1182                 return -EINVAL;
1183
1184         mutex_lock(&tz->lock);
1185
1186         for (i = 0; i < tz->num_trips; i++) {
1187                 if (tz->trips[i].type == THERMAL_TRIP_CRITICAL) {
1188                         *temp = tz->trips[i].temperature;
1189                         ret = 0;
1190                         break;
1191                 }
1192         }
1193
1194         mutex_unlock(&tz->lock);
1195
1196         return ret;
1197 }
1198 EXPORT_SYMBOL_GPL(thermal_zone_get_crit_temp);
1199
1200 /**
1201  * thermal_zone_device_register_with_trips() - register a new thermal zone device
1202  * @type:       the thermal zone device type
1203  * @trips:      a pointer to an array of thermal trips
1204  * @num_trips:  the number of trip points the thermal zone support
1205  * @mask:       a bit string indicating the writeablility of trip points
1206  * @devdata:    private device data
1207  * @ops:        standard thermal zone device callbacks
1208  * @tzp:        thermal zone platform parameters
1209  * @passive_delay: number of milliseconds to wait between polls when
1210  *                 performing passive cooling
1211  * @polling_delay: number of milliseconds to wait between polls when checking
1212  *                 whether trip points have been crossed (0 for interrupt
1213  *                 driven systems)
1214  *
1215  * This interface function adds a new thermal zone device (sensor) to
1216  * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1217  * thermal cooling devices registered at the same time.
1218  * thermal_zone_device_unregister() must be called when the device is no
1219  * longer needed. The passive cooling depends on the .get_trend() return value.
1220  *
1221  * Return: a pointer to the created struct thermal_zone_device or an
1222  * in case of error, an ERR_PTR. Caller must check return value with
1223  * IS_ERR*() helpers.
1224  */
1225 struct thermal_zone_device *
1226 thermal_zone_device_register_with_trips(const char *type, struct thermal_trip *trips, int num_trips, int mask,
1227                                         void *devdata, struct thermal_zone_device_ops *ops,
1228                                         const struct thermal_zone_params *tzp, int passive_delay,
1229                                         int polling_delay)
1230 {
1231         struct thermal_zone_device *tz;
1232         int id;
1233         int result;
1234         int count;
1235         struct thermal_governor *governor;
1236
1237         if (!type || strlen(type) == 0) {
1238                 pr_err("No thermal zone type defined\n");
1239                 return ERR_PTR(-EINVAL);
1240         }
1241
1242         if (strlen(type) >= THERMAL_NAME_LENGTH) {
1243                 pr_err("Thermal zone name (%s) too long, should be under %d chars\n",
1244                        type, THERMAL_NAME_LENGTH);
1245                 return ERR_PTR(-EINVAL);
1246         }
1247
1248         /*
1249          * Max trip count can't exceed 31 as the "mask >> num_trips" condition.
1250          * For example, shifting by 32 will result in compiler warning:
1251          * warning: right shift count >= width of type [-Wshift-count- overflow]
1252          *
1253          * Also "mask >> num_trips" will always be true with 32 bit shift.
1254          * E.g. mask = 0x80000000 for trip id 31 to be RW. Then
1255          * mask >> 32 = 0x80000000
1256          * This will result in failure for the below condition.
1257          *
1258          * Check will be true when the bit 31 of the mask is set.
1259          * 32 bit shift will cause overflow of 4 byte integer.
1260          */
1261         if (num_trips > (BITS_PER_TYPE(int) - 1) || num_trips < 0 || mask >> num_trips) {
1262                 pr_err("Incorrect number of thermal trips\n");
1263                 return ERR_PTR(-EINVAL);
1264         }
1265
1266         if (!ops) {
1267                 pr_err("Thermal zone device ops not defined\n");
1268                 return ERR_PTR(-EINVAL);
1269         }
1270
1271         if (num_trips > 0 && !trips)
1272                 return ERR_PTR(-EINVAL);
1273
1274         if (!thermal_class)
1275                 return ERR_PTR(-ENODEV);
1276
1277         tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1278         if (!tz)
1279                 return ERR_PTR(-ENOMEM);
1280
1281         if (tzp) {
1282                 tz->tzp = kmemdup(tzp, sizeof(*tzp), GFP_KERNEL);
1283                 if (!tz->tzp) {
1284                         result = -ENOMEM;
1285                         goto free_tz;
1286                 }
1287         }
1288
1289         INIT_LIST_HEAD(&tz->thermal_instances);
1290         ida_init(&tz->ida);
1291         mutex_init(&tz->lock);
1292         id = ida_alloc(&thermal_tz_ida, GFP_KERNEL);
1293         if (id < 0) {
1294                 result = id;
1295                 goto free_tzp;
1296         }
1297
1298         tz->id = id;
1299         strscpy(tz->type, type, sizeof(tz->type));
1300
1301         if (!ops->critical)
1302                 ops->critical = thermal_zone_device_critical;
1303
1304         tz->ops = ops;
1305         tz->device.class = thermal_class;
1306         tz->devdata = devdata;
1307         tz->trips = trips;
1308         tz->num_trips = num_trips;
1309
1310         thermal_set_delay_jiffies(&tz->passive_delay_jiffies, passive_delay);
1311         thermal_set_delay_jiffies(&tz->polling_delay_jiffies, polling_delay);
1312
1313         /* sys I/F */
1314         /* Add nodes that are always present via .groups */
1315         result = thermal_zone_create_device_groups(tz, mask);
1316         if (result)
1317                 goto remove_id;
1318
1319         /* A new thermal zone needs to be updated anyway. */
1320         atomic_set(&tz->need_update, 1);
1321
1322         result = dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1323         if (result) {
1324                 thermal_zone_destroy_device_groups(tz);
1325                 goto remove_id;
1326         }
1327         result = device_register(&tz->device);
1328         if (result)
1329                 goto release_device;
1330
1331         for (count = 0; count < num_trips; count++) {
1332                 struct thermal_trip trip;
1333
1334                 result = thermal_zone_get_trip(tz, count, &trip);
1335                 if (result || !trip.temperature)
1336                         set_bit(count, &tz->trips_disabled);
1337         }
1338
1339         /* Update 'this' zone's governor information */
1340         mutex_lock(&thermal_governor_lock);
1341
1342         if (tz->tzp)
1343                 governor = __find_governor(tz->tzp->governor_name);
1344         else
1345                 governor = def_governor;
1346
1347         result = thermal_set_governor(tz, governor);
1348         if (result) {
1349                 mutex_unlock(&thermal_governor_lock);
1350                 goto unregister;
1351         }
1352
1353         mutex_unlock(&thermal_governor_lock);
1354
1355         if (!tz->tzp || !tz->tzp->no_hwmon) {
1356                 result = thermal_add_hwmon_sysfs(tz);
1357                 if (result)
1358                         goto unregister;
1359         }
1360
1361         mutex_lock(&thermal_list_lock);
1362         list_add_tail(&tz->node, &thermal_tz_list);
1363         mutex_unlock(&thermal_list_lock);
1364
1365         /* Bind cooling devices for this zone */
1366         bind_tz(tz);
1367
1368         INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1369
1370         thermal_zone_device_init(tz);
1371         /* Update the new thermal zone and mark it as already updated. */
1372         if (atomic_cmpxchg(&tz->need_update, 1, 0))
1373                 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1374
1375         thermal_notify_tz_create(tz->id, tz->type);
1376
1377         return tz;
1378
1379 unregister:
1380         device_del(&tz->device);
1381 release_device:
1382         put_device(&tz->device);
1383         tz = NULL;
1384 remove_id:
1385         ida_free(&thermal_tz_ida, id);
1386 free_tzp:
1387         kfree(tz->tzp);
1388 free_tz:
1389         kfree(tz);
1390         return ERR_PTR(result);
1391 }
1392 EXPORT_SYMBOL_GPL(thermal_zone_device_register_with_trips);
1393
1394 struct thermal_zone_device *thermal_tripless_zone_device_register(
1395                                         const char *type,
1396                                         void *devdata,
1397                                         struct thermal_zone_device_ops *ops,
1398                                         const struct thermal_zone_params *tzp)
1399 {
1400         return thermal_zone_device_register_with_trips(type, NULL, 0, 0, devdata,
1401                                                        ops, tzp, 0, 0);
1402 }
1403 EXPORT_SYMBOL_GPL(thermal_tripless_zone_device_register);
1404
1405 void *thermal_zone_device_priv(struct thermal_zone_device *tzd)
1406 {
1407         return tzd->devdata;
1408 }
1409 EXPORT_SYMBOL_GPL(thermal_zone_device_priv);
1410
1411 const char *thermal_zone_device_type(struct thermal_zone_device *tzd)
1412 {
1413         return tzd->type;
1414 }
1415 EXPORT_SYMBOL_GPL(thermal_zone_device_type);
1416
1417 int thermal_zone_device_id(struct thermal_zone_device *tzd)
1418 {
1419         return tzd->id;
1420 }
1421 EXPORT_SYMBOL_GPL(thermal_zone_device_id);
1422
1423 struct device *thermal_zone_device(struct thermal_zone_device *tzd)
1424 {
1425         return &tzd->device;
1426 }
1427 EXPORT_SYMBOL_GPL(thermal_zone_device);
1428
1429 /**
1430  * thermal_zone_device_unregister - removes the registered thermal zone device
1431  * @tz: the thermal zone device to remove
1432  */
1433 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1434 {
1435         int tz_id;
1436         struct thermal_cooling_device *cdev;
1437         struct thermal_zone_device *pos = NULL;
1438
1439         if (!tz)
1440                 return;
1441
1442         tz_id = tz->id;
1443
1444         mutex_lock(&thermal_list_lock);
1445         list_for_each_entry(pos, &thermal_tz_list, node)
1446                 if (pos == tz)
1447                         break;
1448         if (pos != tz) {
1449                 /* thermal zone device not found */
1450                 mutex_unlock(&thermal_list_lock);
1451                 return;
1452         }
1453         list_del(&tz->node);
1454
1455         /* Unbind all cdevs associated with 'this' thermal zone */
1456         list_for_each_entry(cdev, &thermal_cdev_list, node)
1457                 if (tz->ops->unbind)
1458                         tz->ops->unbind(tz, cdev);
1459
1460         mutex_unlock(&thermal_list_lock);
1461
1462         cancel_delayed_work_sync(&tz->poll_queue);
1463
1464         thermal_set_governor(tz, NULL);
1465
1466         thermal_remove_hwmon_sysfs(tz);
1467         ida_free(&thermal_tz_ida, tz->id);
1468         ida_destroy(&tz->ida);
1469
1470         mutex_lock(&tz->lock);
1471         device_del(&tz->device);
1472         mutex_unlock(&tz->lock);
1473
1474         kfree(tz->tzp);
1475
1476         put_device(&tz->device);
1477
1478         thermal_notify_tz_delete(tz_id);
1479 }
1480 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1481
1482 /**
1483  * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1484  * @name: thermal zone name to fetch the temperature
1485  *
1486  * When only one zone is found with the passed name, returns a reference to it.
1487  *
1488  * Return: On success returns a reference to an unique thermal zone with
1489  * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1490  * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1491  */
1492 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1493 {
1494         struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1495         unsigned int found = 0;
1496
1497         if (!name)
1498                 goto exit;
1499
1500         mutex_lock(&thermal_list_lock);
1501         list_for_each_entry(pos, &thermal_tz_list, node)
1502                 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1503                         found++;
1504                         ref = pos;
1505                 }
1506         mutex_unlock(&thermal_list_lock);
1507
1508         /* nothing has been found, thus an error code for it */
1509         if (found == 0)
1510                 ref = ERR_PTR(-ENODEV);
1511         else if (found > 1)
1512         /* Success only when an unique zone is found */
1513                 ref = ERR_PTR(-EEXIST);
1514
1515 exit:
1516         return ref;
1517 }
1518 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1519
1520 static int thermal_pm_notify(struct notifier_block *nb,
1521                              unsigned long mode, void *_unused)
1522 {
1523         struct thermal_zone_device *tz;
1524
1525         switch (mode) {
1526         case PM_HIBERNATION_PREPARE:
1527         case PM_RESTORE_PREPARE:
1528         case PM_SUSPEND_PREPARE:
1529                 atomic_set(&in_suspend, 1);
1530                 break;
1531         case PM_POST_HIBERNATION:
1532         case PM_POST_RESTORE:
1533         case PM_POST_SUSPEND:
1534                 atomic_set(&in_suspend, 0);
1535                 list_for_each_entry(tz, &thermal_tz_list, node) {
1536                         thermal_zone_device_init(tz);
1537                         thermal_zone_device_update(tz,
1538                                                    THERMAL_EVENT_UNSPECIFIED);
1539                 }
1540                 break;
1541         default:
1542                 break;
1543         }
1544         return 0;
1545 }
1546
1547 static struct notifier_block thermal_pm_nb = {
1548         .notifier_call = thermal_pm_notify,
1549 };
1550
1551 static int __init thermal_init(void)
1552 {
1553         int result;
1554
1555         result = thermal_netlink_init();
1556         if (result)
1557                 goto error;
1558
1559         result = thermal_register_governors();
1560         if (result)
1561                 goto unregister_netlink;
1562
1563         thermal_class = kzalloc(sizeof(*thermal_class), GFP_KERNEL);
1564         if (!thermal_class) {
1565                 result = -ENOMEM;
1566                 goto unregister_governors;
1567         }
1568
1569         thermal_class->name = "thermal";
1570         thermal_class->dev_release = thermal_release;
1571
1572         result = class_register(thermal_class);
1573         if (result) {
1574                 kfree(thermal_class);
1575                 thermal_class = NULL;
1576                 goto unregister_governors;
1577         }
1578
1579         result = register_pm_notifier(&thermal_pm_nb);
1580         if (result)
1581                 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1582                         result);
1583
1584         return 0;
1585
1586 unregister_governors:
1587         thermal_unregister_governors();
1588 unregister_netlink:
1589         thermal_netlink_exit();
1590 error:
1591         mutex_destroy(&thermal_list_lock);
1592         mutex_destroy(&thermal_governor_lock);
1593         return result;
1594 }
1595 postcore_initcall(thermal_init);