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