thermal_core.c 43.0 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Z
Zhang Rui 已提交
2 3 4 5 6 7 8 9
/*
 *  thermal.c - Generic Thermal Management Sysfs support.
 *
 *  Copyright (C) 2008 Intel Corp
 *  Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
 *  Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
 */

10 11
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

Z
Zhang Rui 已提交
12 13
#include <linux/device.h>
#include <linux/err.h>
14
#include <linux/export.h>
15
#include <linux/slab.h>
Z
Zhang Rui 已提交
16 17 18
#include <linux/kdev_t.h>
#include <linux/idr.h>
#include <linux/thermal.h>
19
#include <linux/reboot.h>
20
#include <linux/string.h>
21
#include <linux/of.h>
22
#include <linux/suspend.h>
Z
Zhang Rui 已提交
23

24 25 26
#define CREATE_TRACE_POINTS
#include <trace/events/thermal.h>

27
#include "thermal_core.h"
28
#include "thermal_hwmon.h"
29

30 31
static DEFINE_IDA(thermal_tz_ida);
static DEFINE_IDA(thermal_cdev_ida);
Z
Zhang Rui 已提交
32 33 34

static LIST_HEAD(thermal_tz_list);
static LIST_HEAD(thermal_cdev_list);
35 36
static LIST_HEAD(thermal_governor_list);

Z
Zhang Rui 已提交
37
static DEFINE_MUTEX(thermal_list_lock);
38
static DEFINE_MUTEX(thermal_governor_lock);
39
static DEFINE_MUTEX(poweroff_lock);
40

41
static atomic_t in_suspend;
42
static bool power_off_triggered;
43

Z
Zhang Rui 已提交
44 45
static struct thermal_governor *def_governor;

46 47 48 49 50 51 52
/*
 * Governor section: set of functions to handle thermal governors
 *
 * Functions to help in the life cycle of thermal governors within
 * the thermal core and by the thermal governor code.
 */

53 54 55 56
static struct thermal_governor *__find_governor(const char *name)
{
	struct thermal_governor *pos;

Z
Zhang Rui 已提交
57 58 59
	if (!name || !name[0])
		return def_governor;

60
	list_for_each_entry(pos, &thermal_governor_list, governor_list)
61
		if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
62 63 64 65 66
			return pos;

	return NULL;
}

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/**
 * bind_previous_governor() - bind the previous governor of the thermal zone
 * @tz:		a valid pointer to a struct thermal_zone_device
 * @failed_gov_name:	the name of the governor that failed to register
 *
 * Register the previous governor of the thermal zone after a new
 * governor has failed to be bound.
 */
static void bind_previous_governor(struct thermal_zone_device *tz,
				   const char *failed_gov_name)
{
	if (tz->governor && tz->governor->bind_to_tz) {
		if (tz->governor->bind_to_tz(tz)) {
			dev_err(&tz->device,
				"governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
				failed_gov_name, tz->governor->name, tz->type);
			tz->governor = NULL;
		}
	}
}

/**
 * thermal_set_governor() - Switch to another governor
 * @tz:		a valid pointer to a struct thermal_zone_device
 * @new_gov:	pointer to the new governor
 *
 * Change the governor of thermal zone @tz.
 *
 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
 */
static int thermal_set_governor(struct thermal_zone_device *tz,
				struct thermal_governor *new_gov)
{
	int ret = 0;

	if (tz->governor && tz->governor->unbind_from_tz)
		tz->governor->unbind_from_tz(tz);

	if (new_gov && new_gov->bind_to_tz) {
		ret = new_gov->bind_to_tz(tz);
		if (ret) {
			bind_previous_governor(tz, new_gov->name);

			return ret;
		}
	}

	tz->governor = new_gov;

	return ret;
}

119 120 121 122 123 124 125 126 127 128 129 130
int thermal_register_governor(struct thermal_governor *governor)
{
	int err;
	const char *name;
	struct thermal_zone_device *pos;

	if (!governor)
		return -EINVAL;

	mutex_lock(&thermal_governor_lock);

	err = -EBUSY;
131
	if (!__find_governor(governor->name)) {
132 133
		bool match_default;

134 135
		err = 0;
		list_add(&governor->governor_list, &thermal_governor_list);
136 137 138 139 140
		match_default = !strncmp(governor->name,
					 DEFAULT_THERMAL_GOVERNOR,
					 THERMAL_NAME_LENGTH);

		if (!def_governor && match_default)
Z
Zhang Rui 已提交
141
			def_governor = governor;
142 143 144 145 146
	}

	mutex_lock(&thermal_list_lock);

	list_for_each_entry(pos, &thermal_tz_list, node) {
Z
Zhang Rui 已提交
147 148 149 150
		/*
		 * only thermal zones with specified tz->tzp->governor_name
		 * may run with tz->govenor unset
		 */
151 152
		if (pos->governor)
			continue;
Z
Zhang Rui 已提交
153 154 155

		name = pos->tzp->governor_name;

156 157 158 159 160 161 162 163 164
		if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
			int ret;

			ret = thermal_set_governor(pos, governor);
			if (ret)
				dev_err(&pos->device,
					"Failed to set governor %s for thermal zone %s: %d\n",
					governor->name, pos->type, ret);
		}
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
	}

	mutex_unlock(&thermal_list_lock);
	mutex_unlock(&thermal_governor_lock);

	return err;
}

void thermal_unregister_governor(struct thermal_governor *governor)
{
	struct thermal_zone_device *pos;

	if (!governor)
		return;

	mutex_lock(&thermal_governor_lock);

182
	if (!__find_governor(governor->name))
183 184 185 186 187
		goto exit;

	mutex_lock(&thermal_list_lock);

	list_for_each_entry(pos, &thermal_tz_list, node) {
188
		if (!strncasecmp(pos->governor->name, governor->name,
189
				 THERMAL_NAME_LENGTH))
190
			thermal_set_governor(pos, NULL);
191 192 193 194 195 196
	}

	mutex_unlock(&thermal_list_lock);
	list_del(&governor->governor_list);
exit:
	mutex_unlock(&thermal_governor_lock);
197 198
}

199 200
int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
				   char *policy)
201
{
202 203
	struct thermal_governor *gov;
	int ret = -EINVAL;
204

205
	mutex_lock(&thermal_governor_lock);
206 207
	mutex_lock(&tz->lock);

208 209 210
	gov = __find_governor(strim(policy));
	if (!gov)
		goto exit;
211

212
	ret = thermal_set_governor(tz, gov);
213

214 215 216
exit:
	mutex_unlock(&tz->lock);
	mutex_unlock(&thermal_governor_lock);
217

218
	return ret;
219 220
}

221
int thermal_build_list_of_policies(char *buf)
222
{
223 224 225
	struct thermal_governor *pos;
	ssize_t count = 0;
	ssize_t size = PAGE_SIZE;
226

227
	mutex_lock(&thermal_governor_lock);
228

229 230 231
	list_for_each_entry(pos, &thermal_governor_list, governor_list) {
		size = PAGE_SIZE - count;
		count += scnprintf(buf + count, size, "%s ", pos->name);
232
	}
233
	count += scnprintf(buf + count, size, "\n");
234

235
	mutex_unlock(&thermal_governor_lock);
236

237
	return count;
238 239
}

240
static void __init thermal_unregister_governors(void)
241
{
242 243 244 245 246
	struct thermal_governor **governor;

	for_each_governor_table(governor)
		thermal_unregister_governor(*governor);
}
247

248 249 250 251
static int __init thermal_register_governors(void)
{
	int ret = 0;
	struct thermal_governor **governor;
252

253 254 255 256 257 258 259
	for_each_governor_table(governor) {
		ret = thermal_register_governor(*governor);
		if (ret) {
			pr_err("Failed to register governor: '%s'",
			       (*governor)->name);
			break;
		}
260

261 262 263
		pr_info("Registered thermal governor '%s'",
			(*governor)->name);
	}
264

265 266
	if (ret) {
		struct thermal_governor **gov;
267

268 269 270 271 272 273
		for_each_governor_table(gov) {
			if (gov == governor)
				break;
			thermal_unregister_governor(*gov);
		}
	}
274

275
	return ret;
276 277
}

278 279 280 281 282 283 284 285 286 287 288
/*
 * Zone update section: main control loop applied to each zone while monitoring
 *
 * in polling mode. The monitoring is done using a workqueue.
 * Same update may be done on a zone by calling thermal_zone_device_update().
 *
 * An update means:
 * - Non-critical trips will invoke the governor responsible for that zone;
 * - Hot trips will produce a notification to userspace;
 * - Critical trip point will cause a system shutdown.
 */
289 290 291 292
static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
					    int delay)
{
	if (delay > 1000)
293 294
		mod_delayed_work(system_freezable_power_efficient_wq,
				 &tz->poll_queue,
295 296
				 round_jiffies(msecs_to_jiffies(delay)));
	else if (delay)
297 298
		mod_delayed_work(system_freezable_power_efficient_wq,
				 &tz->poll_queue,
299 300
				 msecs_to_jiffies(delay));
	else
301
		cancel_delayed_work(&tz->poll_queue);
302 303
}

304 305 306 307 308
static inline bool should_stop_polling(struct thermal_zone_device *tz)
{
	return !thermal_zone_device_is_enabled(tz);
}

309 310
static void monitor_thermal_zone(struct thermal_zone_device *tz)
{
311 312 313 314
	bool stop;

	stop = should_stop_polling(tz);

315 316
	mutex_lock(&tz->lock);

317
	if (!stop && tz->passive)
318
		thermal_zone_device_set_polling(tz, tz->passive_delay);
319
	else if (!stop && tz->polling_delay)
320 321 322 323 324 325 326
		thermal_zone_device_set_polling(tz, tz->polling_delay);
	else
		thermal_zone_device_set_polling(tz, 0);

	mutex_unlock(&tz->lock);
}

327
static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
328
{
Z
Zhang Rui 已提交
329 330
	tz->governor ? tz->governor->throttle(tz, trip) :
		       def_governor->throttle(tz, trip);
331 332
}

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/**
 * thermal_emergency_poweroff_func - emergency poweroff work after a known delay
 * @work: work_struct associated with the emergency poweroff function
 *
 * This function is called in very critical situations to force
 * a kernel poweroff after a configurable timeout value.
 */
static void thermal_emergency_poweroff_func(struct work_struct *work)
{
	/*
	 * We have reached here after the emergency thermal shutdown
	 * Waiting period has expired. This means orderly_poweroff has
	 * not been able to shut off the system for some reason.
	 * Try to shut down the system immediately using kernel_power_off
	 * if populated
	 */
	WARN(1, "Attempting kernel_power_off: Temperature too high\n");
	kernel_power_off();

	/*
	 * Worst of the worst case trigger emergency restart
	 */
	WARN(1, "Attempting emergency_restart: Temperature too high\n");
	emergency_restart();
}

static DECLARE_DELAYED_WORK(thermal_emergency_poweroff_work,
			    thermal_emergency_poweroff_func);

/**
 * thermal_emergency_poweroff - Trigger an emergency system poweroff
 *
 * This may be called from any critical situation to trigger a system shutdown
 * after a known period of time. By default this is not scheduled.
 */
368
static void thermal_emergency_poweroff(void)
369 370 371 372 373 374 375 376 377 378 379 380
{
	int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
	/*
	 * poweroff_delay_ms must be a carefully profiled positive value.
	 * Its a must for thermal_emergency_poweroff_work to be scheduled
	 */
	if (poweroff_delay_ms <= 0)
		return;
	schedule_delayed_work(&thermal_emergency_poweroff_work,
			      msecs_to_jiffies(poweroff_delay_ms));
}

381
static void handle_critical_trips(struct thermal_zone_device *tz,
382
				  int trip, enum thermal_trip_type trip_type)
383
{
384
	int trip_temp;
385 386 387 388

	tz->ops->get_trip_temp(tz, trip, &trip_temp);

	/* If we have not crossed the trip_temp, we do not care. */
389
	if (trip_temp <= 0 || tz->temperature < trip_temp)
390 391
		return;

392 393
	trace_thermal_zone_trip(tz, trip, trip_type);

394 395 396 397
	if (tz->ops->notify)
		tz->ops->notify(tz, trip, trip_type);

	if (trip_type == THERMAL_TRIP_CRITICAL) {
398
		dev_emerg(&tz->device,
399
			  "critical temperature reached (%d C), shutting down\n",
400
			  tz->temperature / 1000);
401 402
		mutex_lock(&poweroff_lock);
		if (!power_off_triggered) {
403 404 405 406 407
			/*
			 * Queue a backup emergency shutdown in the event of
			 * orderly_poweroff failure
			 */
			thermal_emergency_poweroff();
408 409 410 411
			orderly_poweroff(true);
			power_off_triggered = true;
		}
		mutex_unlock(&poweroff_lock);
412 413 414 415 416 417 418
	}
}

static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
{
	enum thermal_trip_type type;

Z
Zhang Rui 已提交
419 420 421 422
	/* Ignore disabled trip points */
	if (test_bit(trip, &tz->trips_disabled))
		return;

423 424 425 426 427
	tz->ops->get_trip_type(tz, trip, &type);

	if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
		handle_critical_trips(tz, trip, type);
	else
428
		handle_non_critical_trips(tz, trip);
429 430 431 432 433 434 435 436 437
	/*
	 * Alright, we handled this trip successfully.
	 * So, start monitoring again.
	 */
	monitor_thermal_zone(tz);
}

static void update_temperature(struct thermal_zone_device *tz)
{
438
	int temp, ret;
439

440
	ret = thermal_zone_get_temp(tz, &temp);
441
	if (ret) {
442 443 444 445
		if (ret != -EAGAIN)
			dev_warn(&tz->device,
				 "failed to read out thermal zone (%d)\n",
				 ret);
446
		return;
447 448
	}

449
	mutex_lock(&tz->lock);
450 451 452
	tz->last_temperature = tz->temperature;
	tz->temperature = temp;
	mutex_unlock(&tz->lock);
453

454
	trace_thermal_temperature(tz);
455 456
}

457
static void thermal_zone_device_init(struct thermal_zone_device *tz)
458 459 460 461 462
{
	struct thermal_instance *pos;
	tz->temperature = THERMAL_TEMP_INVALID;
	list_for_each_entry(pos, &tz->thermal_instances, tz_node)
		pos->initialized = false;
463 464
}

465 466 467 468 469 470
static void thermal_zone_device_reset(struct thermal_zone_device *tz)
{
	tz->passive = 0;
	thermal_zone_device_init(tz);
}

471 472 473 474 475 476 477 478 479 480 481 482 483 484
static int thermal_zone_device_set_mode(struct thermal_zone_device *tz,
					enum thermal_device_mode mode)
{
	int ret = 0;

	mutex_lock(&tz->lock);

	/* do nothing if mode isn't changing */
	if (mode == tz->mode) {
		mutex_unlock(&tz->lock);

		return ret;
	}

485 486
	if (tz->ops->change_mode)
		ret = tz->ops->change_mode(tz, mode);
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522

	if (!ret)
		tz->mode = mode;

	mutex_unlock(&tz->lock);

	thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);

	return ret;
}

int thermal_zone_device_enable(struct thermal_zone_device *tz)
{
	return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
}
EXPORT_SYMBOL_GPL(thermal_zone_device_enable);

int thermal_zone_device_disable(struct thermal_zone_device *tz)
{
	return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
}
EXPORT_SYMBOL_GPL(thermal_zone_device_disable);

int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
{
	enum thermal_device_mode mode;

	mutex_lock(&tz->lock);

	mode = tz->mode;

	mutex_unlock(&tz->lock);

	return mode == THERMAL_DEVICE_ENABLED;
}

523 524
void thermal_zone_device_update(struct thermal_zone_device *tz,
				enum thermal_notify_event event)
525 526 527
{
	int count;

528 529 530
	if (should_stop_polling(tz))
		return;

531 532 533
	if (atomic_read(&in_suspend))
		return;

534 535 536
	if (!tz->ops->get_temp)
		return;

537 538
	update_temperature(tz);

539 540
	thermal_zone_set_trips(tz);

541 542
	tz->notify_event = event;

543 544 545
	for (count = 0; count < tz->trips; count++)
		handle_thermal_trip(tz, count);
}
546
EXPORT_SYMBOL_GPL(thermal_zone_device_update);
547

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * thermal_notify_framework - Sensor drivers use this API to notify framework
 * @tz:		thermal zone device
 * @trip:	indicates which trip point has been crossed
 *
 * This function handles the trip events from sensor drivers. It starts
 * throttling the cooling devices according to the policy configured.
 * For CRITICAL and HOT trip points, this notifies the respective drivers,
 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
 * The throttling policy is based on the configured platform data; if no
 * platform data is provided, this uses the step_wise throttling policy.
 */
void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
{
	handle_thermal_trip(tz, trip);
}
EXPORT_SYMBOL_GPL(thermal_notify_framework);

566 567 568 569 570
static void thermal_zone_device_check(struct work_struct *work)
{
	struct thermal_zone_device *tz = container_of(work, struct
						      thermal_zone_device,
						      poll_queue.work);
571
	thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
572 573
}

574 575 576 577 578 579
/*
 * Power actor section: interface to power actors to estimate power
 *
 * Set of functions used to interact to cooling devices that know
 * how to estimate their devices power consumption.
 */
580

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
/**
 * power_actor_get_max_power() - get the maximum power that a cdev can consume
 * @cdev:	pointer to &thermal_cooling_device
 * @tz:		a valid thermal zone device pointer
 * @max_power:	pointer in which to store the maximum power
 *
 * Calculate the maximum power consumption in milliwats that the
 * cooling device can currently consume and store it in @max_power.
 *
 * Return: 0 on success, -EINVAL if @cdev doesn't support the
 * power_actor API or -E* on other error.
 */
int power_actor_get_max_power(struct thermal_cooling_device *cdev,
			      struct thermal_zone_device *tz, u32 *max_power)
{
	if (!cdev_is_power_actor(cdev))
		return -EINVAL;

	return cdev->ops->state2power(cdev, tz, 0, max_power);
}

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
/**
 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
 * @cdev:	pointer to &thermal_cooling_device
 * @tz:		a valid thermal zone device pointer
 * @min_power:	pointer in which to store the minimum power
 *
 * Calculate the minimum power consumption in milliwatts that the
 * cooling device can currently consume and store it in @min_power.
 *
 * Return: 0 on success, -EINVAL if @cdev doesn't support the
 * power_actor API or -E* on other error.
 */
int power_actor_get_min_power(struct thermal_cooling_device *cdev,
			      struct thermal_zone_device *tz, u32 *min_power)
{
	unsigned long max_state;
	int ret;

	if (!cdev_is_power_actor(cdev))
		return -EINVAL;

	ret = cdev->ops->get_max_state(cdev, &max_state);
	if (ret)
		return ret;

	return cdev->ops->state2power(cdev, tz, max_state, min_power);
}

630
/**
631
 * power_actor_set_power() - limit the maximum power a cooling device consumes
632 633 634 635
 * @cdev:	pointer to &thermal_cooling_device
 * @instance:	thermal instance to update
 * @power:	the power in milliwatts
 *
636 637
 * Set the cooling device to consume at most @power milliwatts. The limit is
 * expected to be a cap at the maximum power consumption.
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
 *
 * Return: 0 on success, -EINVAL if the cooling device does not
 * implement the power actor API or -E* for other failures.
 */
int power_actor_set_power(struct thermal_cooling_device *cdev,
			  struct thermal_instance *instance, u32 power)
{
	unsigned long state;
	int ret;

	if (!cdev_is_power_actor(cdev))
		return -EINVAL;

	ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
	if (ret)
		return ret;

	instance->target = state;
656
	mutex_lock(&cdev->lock);
657
	cdev->updated = false;
658
	mutex_unlock(&cdev->lock);
659 660 661 662 663
	thermal_cdev_update(cdev);

	return 0;
}

664 665
void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
					  const char *cdev_type, size_t size)
Z
Zhang Rui 已提交
666
{
667
	struct thermal_cooling_device *cdev = NULL;
Z
Zhang Rui 已提交
668

669 670 671 672 673 674 675 676 677 678 679 680 681
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(cdev, &thermal_cdev_list, node) {
		/* skip non matching cdevs */
		if (strncmp(cdev_type, cdev->type, size))
			continue;

		/* re binding the exception matching the type pattern */
		thermal_zone_bind_cooling_device(tz, THERMAL_TRIPS_NONE, cdev,
						 THERMAL_NO_LIMIT,
						 THERMAL_NO_LIMIT,
						 THERMAL_WEIGHT_DEFAULT);
	}
	mutex_unlock(&thermal_list_lock);
Z
Zhang Rui 已提交
682 683
}

684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
			      void *data)
{
	struct thermal_governor *gov;
	int ret = 0;

	mutex_lock(&thermal_governor_lock);
	list_for_each_entry(gov, &thermal_governor_list, governor_list) {
		ret = cb(gov, data);
		if (ret)
			break;
	}
	mutex_unlock(&thermal_governor_lock);

	return ret;
}

int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
					      void *), void *data)
{
	struct thermal_cooling_device *cdev;
	int ret = 0;

	mutex_lock(&thermal_list_lock);
	list_for_each_entry(cdev, &thermal_cdev_list, node) {
		ret = cb(cdev, data);
		if (ret)
			break;
	}
	mutex_unlock(&thermal_list_lock);

	return ret;
}

int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
			  void *data)
{
	struct thermal_zone_device *tz;
	int ret = 0;

	mutex_lock(&thermal_list_lock);
	list_for_each_entry(tz, &thermal_tz_list, node) {
		ret = cb(tz, data);
		if (ret)
			break;
	}
	mutex_unlock(&thermal_list_lock);

	return ret;
}

735 736 737 738 739 740 741 742 743 744 745 746 747 748
struct thermal_zone_device *thermal_zone_get_by_id(int id)
{
	struct thermal_zone_device *tz = NULL;

	mutex_lock(&thermal_list_lock);
	list_for_each_entry(tz, &thermal_tz_list, node) {
		if (tz->id == id)
			break;
	}
	mutex_unlock(&thermal_list_lock);

	return tz;
}

749 750
void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
					  const char *cdev_type, size_t size)
Z
Zhang Rui 已提交
751
{
752
	struct thermal_cooling_device *cdev = NULL;
Z
Zhang Rui 已提交
753

754 755 756 757 758 759 760 761 762 763
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(cdev, &thermal_cdev_list, node) {
		/* skip non matching cdevs */
		if (strncmp(cdev_type, cdev->type, size))
			continue;
		/* unbinding the exception matching the type pattern */
		thermal_zone_unbind_cooling_device(tz, THERMAL_TRIPS_NONE,
						   cdev);
	}
	mutex_unlock(&thermal_list_lock);
Z
Zhang Rui 已提交
764 765
}

766 767 768 769 770 771 772 773 774
/*
 * Device management section: cooling devices, zones devices, and binding
 *
 * Set of functions provided by the thermal core for:
 * - cooling devices lifecycle: registration, unregistration,
 *				binding, and unbinding.
 * - thermal zone devices lifecycle: registration, unregistration,
 *				     binding, and unbinding.
 */
Z
Zhang Rui 已提交
775 776

/**
777 778
 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
 * @tz:		pointer to struct thermal_zone_device
Z
Zhang Rui 已提交
779 780
 * @trip:	indicates which trip point the cooling devices is
 *		associated with in this thermal zone.
781 782 783 784 785 786 787
 * @cdev:	pointer to struct thermal_cooling_device
 * @upper:	the Maximum cooling state for this trip point.
 *		THERMAL_NO_LIMIT means no upper limit,
 *		and the cooling device can be in max_state.
 * @lower:	the Minimum cooling state can be used for this trip point.
 *		THERMAL_NO_LIMIT means no lower limit,
 *		and the cooling device can be in cooling state 0.
788 789 790
 * @weight:	The weight of the cooling device to be bound to the
 *		thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
 *		default value
791
 *
792 793
 * This interface function bind a thermal cooling device to the certain trip
 * point of a thermal zone device.
794
 * This function is usually called in the thermal zone device .bind callback.
795 796
 *
 * Return: 0 on success, the proper error value otherwise.
Z
Zhang Rui 已提交
797 798 799
 */
int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
				     int trip,
Z
Zhang Rui 已提交
800
				     struct thermal_cooling_device *cdev,
801 802
				     unsigned long upper, unsigned long lower,
				     unsigned int weight)
Z
Zhang Rui 已提交
803
{
804 805
	struct thermal_instance *dev;
	struct thermal_instance *pos;
806 807
	struct thermal_zone_device *pos1;
	struct thermal_cooling_device *pos2;
808
	unsigned long max_state;
809
	int result, ret;
Z
Zhang Rui 已提交
810

811
	if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
Z
Zhang Rui 已提交
812 813
		return -EINVAL;

814 815 816 817 818 819 820 821 822 823
	list_for_each_entry(pos1, &thermal_tz_list, node) {
		if (pos1 == tz)
			break;
	}
	list_for_each_entry(pos2, &thermal_cdev_list, node) {
		if (pos2 == cdev)
			break;
	}

	if (tz != pos1 || cdev != pos2)
Z
Zhang Rui 已提交
824 825
		return -EINVAL;

826 827 828
	ret = cdev->ops->get_max_state(cdev, &max_state);
	if (ret)
		return ret;
Z
Zhang Rui 已提交
829 830 831 832 833 834 835 836

	/* lower default 0, upper default max_state */
	lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
	upper = upper == THERMAL_NO_LIMIT ? max_state : upper;

	if (lower > upper || upper > max_state)
		return -EINVAL;

837
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Z
Zhang Rui 已提交
838 839 840 841 842
	if (!dev)
		return -ENOMEM;
	dev->tz = tz;
	dev->cdev = cdev;
	dev->trip = trip;
Z
Zhang Rui 已提交
843 844
	dev->upper = upper;
	dev->lower = lower;
845
	dev->target = THERMAL_NO_TARGET;
846
	dev->weight = weight;
847

848 849
	result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
	if (result < 0)
Z
Zhang Rui 已提交
850 851
		goto free_mem;

852
	dev->id = result;
Z
Zhang Rui 已提交
853 854 855 856
	sprintf(dev->name, "cdev%d", dev->id);
	result =
	    sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
	if (result)
857
		goto release_ida;
Z
Zhang Rui 已提交
858 859

	sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
860
	sysfs_attr_init(&dev->attr.attr);
Z
Zhang Rui 已提交
861 862
	dev->attr.attr.name = dev->attr_name;
	dev->attr.attr.mode = 0444;
863
	dev->attr.show = trip_point_show;
Z
Zhang Rui 已提交
864 865 866 867
	result = device_create_file(&tz->device, &dev->attr);
	if (result)
		goto remove_symbol_link;

J
Javi Merino 已提交
868 869 870 871
	sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
	sysfs_attr_init(&dev->weight_attr.attr);
	dev->weight_attr.attr.name = dev->weight_attr_name;
	dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
872 873
	dev->weight_attr.show = weight_show;
	dev->weight_attr.store = weight_store;
J
Javi Merino 已提交
874 875 876 877
	result = device_create_file(&tz->device, &dev->weight_attr);
	if (result)
		goto remove_trip_file;

Z
Zhang Rui 已提交
878
	mutex_lock(&tz->lock);
879
	mutex_lock(&cdev->lock);
880
	list_for_each_entry(pos, &tz->thermal_instances, tz_node)
881 882 883 884
		if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
			result = -EEXIST;
			break;
		}
885
	if (!result) {
886
		list_add_tail(&dev->tz_node, &tz->thermal_instances);
887
		list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
888
		atomic_set(&tz->need_update, 1);
889
	}
890
	mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
891 892 893 894 895
	mutex_unlock(&tz->lock);

	if (!result)
		return 0;

J
Javi Merino 已提交
896 897
	device_remove_file(&tz->device, &dev->weight_attr);
remove_trip_file:
Z
Zhang Rui 已提交
898
	device_remove_file(&tz->device, &dev->attr);
J
Joe Perches 已提交
899
remove_symbol_link:
Z
Zhang Rui 已提交
900
	sysfs_remove_link(&tz->device.kobj, dev->name);
901 902
release_ida:
	ida_simple_remove(&tz->ida, dev->id);
J
Joe Perches 已提交
903
free_mem:
Z
Zhang Rui 已提交
904 905 906
	kfree(dev);
	return result;
}
907
EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
Z
Zhang Rui 已提交
908 909

/**
910 911 912
 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
 *					  thermal zone.
 * @tz:		pointer to a struct thermal_zone_device.
Z
Zhang Rui 已提交
913 914
 * @trip:	indicates which trip point the cooling devices is
 *		associated with in this thermal zone.
915
 * @cdev:	pointer to a struct thermal_cooling_device.
916
 *
917 918
 * This interface function unbind a thermal cooling device from the certain
 * trip point of a thermal zone device.
919
 * This function is usually called in the thermal zone device .unbind callback.
920 921
 *
 * Return: 0 on success, the proper error value otherwise.
Z
Zhang Rui 已提交
922 923 924 925 926
 */
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
				       int trip,
				       struct thermal_cooling_device *cdev)
{
927
	struct thermal_instance *pos, *next;
Z
Zhang Rui 已提交
928 929

	mutex_lock(&tz->lock);
930
	mutex_lock(&cdev->lock);
931
	list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
932
		if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
933
			list_del(&pos->tz_node);
934
			list_del(&pos->cdev_node);
935
			mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
936 937 938 939
			mutex_unlock(&tz->lock);
			goto unbind;
		}
	}
940
	mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
941 942 943 944
	mutex_unlock(&tz->lock);

	return -ENODEV;

J
Joe Perches 已提交
945
unbind:
946
	device_remove_file(&tz->device, &pos->weight_attr);
Z
Zhang Rui 已提交
947 948
	device_remove_file(&tz->device, &pos->attr);
	sysfs_remove_link(&tz->device.kobj, pos->name);
949
	ida_simple_remove(&tz->ida, pos->id);
Z
Zhang Rui 已提交
950 951 952
	kfree(pos);
	return 0;
}
953
EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
Z
Zhang Rui 已提交
954 955 956 957 958 959

static void thermal_release(struct device *dev)
{
	struct thermal_zone_device *tz;
	struct thermal_cooling_device *cdev;

J
Joe Perches 已提交
960 961
	if (!strncmp(dev_name(dev), "thermal_zone",
		     sizeof("thermal_zone") - 1)) {
Z
Zhang Rui 已提交
962
		tz = to_thermal_zone(dev);
963
		thermal_zone_destroy_device_groups(tz);
Z
Zhang Rui 已提交
964
		kfree(tz);
965 966
	} else if (!strncmp(dev_name(dev), "cooling_device",
			    sizeof("cooling_device") - 1)) {
Z
Zhang Rui 已提交
967 968 969 970 971 972 973 974 975 976
		cdev = to_cooling_device(dev);
		kfree(cdev);
	}
}

static struct class thermal_class = {
	.name = "thermal",
	.dev_release = thermal_release,
};

977 978 979
static inline
void print_bind_err_msg(struct thermal_zone_device *tz,
			struct thermal_cooling_device *cdev, int ret)
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
{
	dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
		tz->type, cdev->type, ret);
}

static void __bind(struct thermal_zone_device *tz, int mask,
		   struct thermal_cooling_device *cdev,
		   unsigned long *limits,
		   unsigned int weight)
{
	int i, ret;

	for (i = 0; i < tz->trips; i++) {
		if (mask & (1 << i)) {
			unsigned long upper, lower;

			upper = THERMAL_NO_LIMIT;
			lower = THERMAL_NO_LIMIT;
			if (limits) {
				lower = limits[i * 2];
				upper = limits[i * 2 + 1];
			}
			ret = thermal_zone_bind_cooling_device(tz, i, cdev,
							       upper, lower,
							       weight);
			if (ret)
				print_bind_err_msg(tz, cdev, ret);
		}
	}
}

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
static void bind_cdev(struct thermal_cooling_device *cdev)
{
	int i, ret;
	const struct thermal_zone_params *tzp;
	struct thermal_zone_device *pos = NULL;

	mutex_lock(&thermal_list_lock);

	list_for_each_entry(pos, &thermal_tz_list, node) {
		if (!pos->tzp && !pos->ops->bind)
			continue;

		if (pos->ops->bind) {
			ret = pos->ops->bind(pos, cdev);
			if (ret)
				print_bind_err_msg(pos, cdev, ret);
			continue;
		}

		tzp = pos->tzp;
		if (!tzp || !tzp->tbp)
			continue;

		for (i = 0; i < tzp->num_tbps; i++) {
			if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
				continue;
			if (tzp->tbp[i].match(pos, cdev))
				continue;
			tzp->tbp[i].cdev = cdev;
			__bind(pos, tzp->tbp[i].trip_mask, cdev,
			       tzp->tbp[i].binding_limits,
			       tzp->tbp[i].weight);
		}
	}

	mutex_unlock(&thermal_list_lock);
}

Z
Zhang Rui 已提交
1049
/**
1050 1051
 * __thermal_cooling_device_register() - register a new thermal cooling device
 * @np:		a pointer to a device tree node.
Z
Zhang Rui 已提交
1052 1053 1054
 * @type:	the thermal cooling device type.
 * @devdata:	device private data.
 * @ops:		standard thermal cooling devices callbacks.
1055 1056 1057 1058
 *
 * This interface function adds a new thermal cooling device (fan/processor/...)
 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
 * to all the thermal zone devices registered at the same time.
1059 1060
 * It also gives the opportunity to link the cooling device to a device tree
 * node, so that it can be bound to a thermal zone created out of device tree.
1061 1062 1063
 *
 * Return: a pointer to the created struct thermal_cooling_device or an
 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
Z
Zhang Rui 已提交
1064
 */
1065 1066
static struct thermal_cooling_device *
__thermal_cooling_device_register(struct device_node *np,
1067
				  const char *type, void *devdata,
1068
				  const struct thermal_cooling_device_ops *ops)
Z
Zhang Rui 已提交
1069 1070
{
	struct thermal_cooling_device *cdev;
1071
	struct thermal_zone_device *pos = NULL;
Z
Zhang Rui 已提交
1072 1073
	int result;

1074
	if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1075
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
1076 1077

	if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1078
	    !ops->set_cur_state)
1079
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
1080

1081
	cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
Z
Zhang Rui 已提交
1082
	if (!cdev)
1083
		return ERR_PTR(-ENOMEM);
Z
Zhang Rui 已提交
1084

1085 1086
	result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
	if (result < 0) {
Z
Zhang Rui 已提交
1087
		kfree(cdev);
1088
		return ERR_PTR(result);
Z
Zhang Rui 已提交
1089 1090
	}

1091
	cdev->id = result;
1092
	strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1093
	mutex_init(&cdev->lock);
1094
	INIT_LIST_HEAD(&cdev->thermal_instances);
1095
	cdev->np = np;
Z
Zhang Rui 已提交
1096
	cdev->ops = ops;
1097
	cdev->updated = false;
Z
Zhang Rui 已提交
1098 1099
	cdev->device.class = &thermal_class;
	cdev->devdata = devdata;
1100
	thermal_cooling_device_setup_sysfs(cdev);
1101
	dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
Z
Zhang Rui 已提交
1102 1103
	result = device_register(&cdev->device);
	if (result) {
1104
		ida_simple_remove(&thermal_cdev_ida, cdev->id);
1105
		put_device(&cdev->device);
1106
		return ERR_PTR(result);
Z
Zhang Rui 已提交
1107 1108
	}

1109
	/* Add 'this' new cdev to the global cdev list */
Z
Zhang Rui 已提交
1110 1111 1112 1113
	mutex_lock(&thermal_list_lock);
	list_add(&cdev->node, &thermal_cdev_list);
	mutex_unlock(&thermal_list_lock);

1114 1115 1116
	/* Update binding information for 'this' new cdev */
	bind_cdev(cdev);

1117 1118 1119
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_tz_list, node)
		if (atomic_cmpxchg(&pos->need_update, 1, 0))
1120 1121
			thermal_zone_device_update(pos,
						   THERMAL_EVENT_UNSPECIFIED);
1122 1123
	mutex_unlock(&thermal_list_lock);

1124
	return cdev;
Z
Zhang Rui 已提交
1125
}
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140

/**
 * thermal_cooling_device_register() - register a new thermal cooling device
 * @type:	the thermal cooling device type.
 * @devdata:	device private data.
 * @ops:		standard thermal cooling devices callbacks.
 *
 * This interface function adds a new thermal cooling device (fan/processor/...)
 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
 * to all the thermal zone devices registered at the same time.
 *
 * Return: a pointer to the created struct thermal_cooling_device or an
 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
 */
struct thermal_cooling_device *
1141
thermal_cooling_device_register(const char *type, void *devdata,
1142 1143 1144 1145
				const struct thermal_cooling_device_ops *ops)
{
	return __thermal_cooling_device_register(NULL, type, devdata, ops);
}
1146
EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
Z
Zhang Rui 已提交
1147

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
/**
 * thermal_of_cooling_device_register() - register an OF thermal cooling device
 * @np:		a pointer to a device tree node.
 * @type:	the thermal cooling device type.
 * @devdata:	device private data.
 * @ops:		standard thermal cooling devices callbacks.
 *
 * This function will register a cooling device with device tree node reference.
 * This interface function adds a new thermal cooling device (fan/processor/...)
 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
 * to all the thermal zone devices registered at the same time.
 *
 * Return: a pointer to the created struct thermal_cooling_device or an
 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
 */
struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np,
1165
				   const char *type, void *devdata,
1166 1167 1168 1169 1170 1171
				   const struct thermal_cooling_device_ops *ops)
{
	return __thermal_cooling_device_register(np, type, devdata, ops);
}
EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
static void thermal_cooling_device_release(struct device *dev, void *res)
{
	thermal_cooling_device_unregister(
				*(struct thermal_cooling_device **)res);
}

/**
 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
 *					       device
 * @dev:	a valid struct device pointer of a sensor device.
 * @np:		a pointer to a device tree node.
 * @type:	the thermal cooling device type.
 * @devdata:	device private data.
 * @ops:	standard thermal cooling devices callbacks.
 *
 * This function will register a cooling device with device tree node reference.
 * This interface function adds a new thermal cooling device (fan/processor/...)
 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
 * to all the thermal zone devices registered at the same time.
 *
 * Return: a pointer to the created struct thermal_cooling_device or an
 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
 */
struct thermal_cooling_device *
devm_thermal_of_cooling_device_register(struct device *dev,
				struct device_node *np,
				char *type, void *devdata,
				const struct thermal_cooling_device_ops *ops)
{
	struct thermal_cooling_device **ptr, *tcd;

	ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
			   GFP_KERNEL);
	if (!ptr)
		return ERR_PTR(-ENOMEM);

	tcd = __thermal_cooling_device_register(np, type, devdata, ops);
	if (IS_ERR(tcd)) {
		devres_free(ptr);
		return tcd;
	}

	*ptr = tcd;
	devres_add(dev, ptr);

	return tcd;
}
EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
static void __unbind(struct thermal_zone_device *tz, int mask,
		     struct thermal_cooling_device *cdev)
{
	int i;

	for (i = 0; i < tz->trips; i++)
		if (mask & (1 << i))
			thermal_zone_unbind_cooling_device(tz, i, cdev);
}

Z
Zhang Rui 已提交
1231
/**
1232
 * thermal_cooling_device_unregister - removes a thermal cooling device
Z
Zhang Rui 已提交
1233 1234
 * @cdev:	the thermal cooling device to remove.
 *
1235 1236
 * thermal_cooling_device_unregister() must be called when a registered
 * thermal cooling device is no longer needed.
Z
Zhang Rui 已提交
1237
 */
1238
void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
Z
Zhang Rui 已提交
1239
{
1240 1241
	int i;
	const struct thermal_zone_params *tzp;
Z
Zhang Rui 已提交
1242 1243 1244 1245 1246 1247 1248 1249
	struct thermal_zone_device *tz;
	struct thermal_cooling_device *pos = NULL;

	if (!cdev)
		return;

	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_cdev_list, node)
1250 1251
		if (pos == cdev)
			break;
Z
Zhang Rui 已提交
1252 1253 1254 1255 1256 1257
	if (pos != cdev) {
		/* thermal cooling device not found */
		mutex_unlock(&thermal_list_lock);
		return;
	}
	list_del(&cdev->node);
1258 1259

	/* Unbind all thermal zones associated with 'this' cdev */
Z
Zhang Rui 已提交
1260
	list_for_each_entry(tz, &thermal_tz_list, node) {
1261 1262 1263 1264 1265 1266
		if (tz->ops->unbind) {
			tz->ops->unbind(tz, cdev);
			continue;
		}

		if (!tz->tzp || !tz->tzp->tbp)
Z
Zhang Rui 已提交
1267
			continue;
1268 1269 1270 1271 1272 1273 1274 1275

		tzp = tz->tzp;
		for (i = 0; i < tzp->num_tbps; i++) {
			if (tzp->tbp[i].cdev == cdev) {
				__unbind(tz, tzp->tbp[i].trip_mask, cdev);
				tzp->tbp[i].cdev = NULL;
			}
		}
Z
Zhang Rui 已提交
1276
	}
1277

Z
Zhang Rui 已提交
1278
	mutex_unlock(&thermal_list_lock);
1279

1280
	ida_simple_remove(&thermal_cdev_ida, cdev->id);
1281
	device_del(&cdev->device);
1282
	thermal_cooling_device_destroy_sysfs(cdev);
1283
	put_device(&cdev->device);
Z
Zhang Rui 已提交
1284
}
1285
EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
Z
Zhang Rui 已提交
1286

1287
static void bind_tz(struct thermal_zone_device *tz)
1288
{
1289 1290 1291
	int i, ret;
	struct thermal_cooling_device *pos = NULL;
	const struct thermal_zone_params *tzp = tz->tzp;
1292

1293
	if (!tzp && !tz->ops->bind)
1294
		return;
1295

1296
	mutex_lock(&thermal_list_lock);
1297

1298 1299 1300 1301 1302 1303
	/* If there is ops->bind, try to use ops->bind */
	if (tz->ops->bind) {
		list_for_each_entry(pos, &thermal_cdev_list, node) {
			ret = tz->ops->bind(tz, pos);
			if (ret)
				print_bind_err_msg(tz, pos, ret);
D
Durgadoss R 已提交
1304
		}
1305
		goto exit;
D
Durgadoss R 已提交
1306
	}
1307

1308 1309
	if (!tzp || !tzp->tbp)
		goto exit;
D
Durgadoss R 已提交
1310

1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
	list_for_each_entry(pos, &thermal_cdev_list, node) {
		for (i = 0; i < tzp->num_tbps; i++) {
			if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
				continue;
			if (tzp->tbp[i].match(tz, pos))
				continue;
			tzp->tbp[i].cdev = pos;
			__bind(tz, tzp->tbp[i].trip_mask, pos,
			       tzp->tbp[i].binding_limits,
			       tzp->tbp[i].weight);
D
Durgadoss R 已提交
1321
		}
1322
	}
1323 1324
exit:
	mutex_unlock(&thermal_list_lock);
1325 1326
}

Z
Zhang Rui 已提交
1327
/**
1328
 * thermal_zone_device_register() - register a new thermal zone device
Z
Zhang Rui 已提交
1329 1330
 * @type:	the thermal zone device type
 * @trips:	the number of trip points the thermal zone support
1331
 * @mask:	a bit string indicating the writeablility of trip points
Z
Zhang Rui 已提交
1332 1333
 * @devdata:	private device data
 * @ops:	standard thermal zone device callbacks
1334
 * @tzp:	thermal zone platform parameters
1335 1336 1337 1338 1339
 * @passive_delay: number of milliseconds to wait between polls when
 *		   performing passive cooling
 * @polling_delay: number of milliseconds to wait between polls when checking
 *		   whether trip points have been crossed (0 for interrupt
 *		   driven systems)
Z
Zhang Rui 已提交
1340
 *
1341 1342 1343
 * This interface function adds a new thermal zone device (sensor) to
 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
 * thermal cooling devices registered at the same time.
Z
Zhang Rui 已提交
1344
 * thermal_zone_device_unregister() must be called when the device is no
1345
 * longer needed. The passive cooling depends on the .get_trend() return value.
1346 1347 1348 1349
 *
 * Return: a pointer to the created struct thermal_zone_device or an
 * in case of error, an ERR_PTR. Caller must check return value with
 * IS_ERR*() helpers.
Z
Zhang Rui 已提交
1350
 */
1351 1352 1353 1354 1355
struct thermal_zone_device *
thermal_zone_device_register(const char *type, int trips, int mask,
			     void *devdata, struct thermal_zone_device_ops *ops,
			     struct thermal_zone_params *tzp, int passive_delay,
			     int polling_delay)
Z
Zhang Rui 已提交
1356 1357
{
	struct thermal_zone_device *tz;
1358
	enum thermal_trip_type trip_type;
Z
Zhang Rui 已提交
1359
	int trip_temp;
1360
	int id;
Z
Zhang Rui 已提交
1361 1362
	int result;
	int count;
1363
	struct thermal_governor *governor;
Z
Zhang Rui 已提交
1364

A
Amit Kucheria 已提交
1365 1366
	if (!type || strlen(type) == 0) {
		pr_err("Error: No thermal zone type defined\n");
1367
		return ERR_PTR(-EINVAL);
A
Amit Kucheria 已提交
1368
	}
1369

A
Amit Kucheria 已提交
1370 1371 1372
	if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
		pr_err("Error: Thermal zone name (%s) too long, should be under %d chars\n",
		       type, THERMAL_NAME_LENGTH);
1373
		return ERR_PTR(-EINVAL);
A
Amit Kucheria 已提交
1374
	}
Z
Zhang Rui 已提交
1375

A
Amit Kucheria 已提交
1376 1377
	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
		pr_err("Error: Incorrect number of thermal trips\n");
1378
		return ERR_PTR(-EINVAL);
A
Amit Kucheria 已提交
1379
	}
Z
Zhang Rui 已提交
1380

A
Amit Kucheria 已提交
1381 1382
	if (!ops) {
		pr_err("Error: Thermal zone device ops not defined\n");
1383
		return ERR_PTR(-EINVAL);
A
Amit Kucheria 已提交
1384
	}
Z
Zhang Rui 已提交
1385

1386
	if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1387 1388
		return ERR_PTR(-EINVAL);

1389
	tz = kzalloc(sizeof(*tz), GFP_KERNEL);
Z
Zhang Rui 已提交
1390
	if (!tz)
1391
		return ERR_PTR(-ENOMEM);
Z
Zhang Rui 已提交
1392

1393
	INIT_LIST_HEAD(&tz->thermal_instances);
1394
	ida_init(&tz->ida);
Z
Zhang Rui 已提交
1395
	mutex_init(&tz->lock);
1396 1397 1398
	id = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
	if (id < 0) {
		result = id;
1399
		goto free_tz;
1400
	}
Z
Zhang Rui 已提交
1401

1402
	tz->id = id;
1403
	strlcpy(tz->type, type, sizeof(tz->type));
Z
Zhang Rui 已提交
1404
	tz->ops = ops;
1405
	tz->tzp = tzp;
Z
Zhang Rui 已提交
1406 1407 1408
	tz->device.class = &thermal_class;
	tz->devdata = devdata;
	tz->trips = trips;
1409 1410
	tz->passive_delay = passive_delay;
	tz->polling_delay = polling_delay;
1411

1412
	/* sys I/F */
1413
	/* Add nodes that are always present via .groups */
1414 1415
	result = thermal_zone_create_device_groups(tz, mask);
	if (result)
1416
		goto remove_id;
1417

1418 1419
	/* A new thermal zone needs to be updated anyway. */
	atomic_set(&tz->need_update, 1);
1420

1421
	dev_set_name(&tz->device, "thermal_zone%d", tz->id);
Z
Zhang Rui 已提交
1422
	result = device_register(&tz->device);
1423
	if (result)
1424
		goto release_device;
Z
Zhang Rui 已提交
1425 1426

	for (count = 0; count < trips; count++) {
Z
Zhang Rui 已提交
1427 1428 1429 1430 1431 1432 1433
		if (tz->ops->get_trip_type(tz, count, &trip_type))
			set_bit(count, &tz->trips_disabled);
		if (tz->ops->get_trip_temp(tz, count, &trip_temp))
			set_bit(count, &tz->trips_disabled);
		/* Check for bogus trip points */
		if (trip_temp == 0)
			set_bit(count, &tz->trips_disabled);
Z
Zhang Rui 已提交
1434 1435
	}

1436 1437 1438 1439
	/* Update 'this' zone's governor information */
	mutex_lock(&thermal_governor_lock);

	if (tz->tzp)
1440
		governor = __find_governor(tz->tzp->governor_name);
1441
	else
1442 1443 1444 1445 1446 1447 1448
		governor = def_governor;

	result = thermal_set_governor(tz, governor);
	if (result) {
		mutex_unlock(&thermal_governor_lock);
		goto unregister;
	}
1449 1450 1451

	mutex_unlock(&thermal_governor_lock);

1452 1453 1454 1455 1456
	if (!tz->tzp || !tz->tzp->no_hwmon) {
		result = thermal_add_hwmon_sysfs(tz);
		if (result)
			goto unregister;
	}
Z
Zhang Rui 已提交
1457

Z
Zhang Rui 已提交
1458 1459 1460 1461
	mutex_lock(&thermal_list_lock);
	list_add_tail(&tz->node, &thermal_tz_list);
	mutex_unlock(&thermal_list_lock);

1462 1463 1464
	/* Bind cooling devices for this zone */
	bind_tz(tz);

1465
	INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1466

1467
	thermal_zone_device_reset(tz);
1468 1469
	/* Update the new thermal zone and mark it as already updated. */
	if (atomic_cmpxchg(&tz->need_update, 1, 0))
1470
		thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1471

1472
	return tz;
Z
Zhang Rui 已提交
1473

J
Joe Perches 已提交
1474
unregister:
1475 1476 1477 1478
	device_del(&tz->device);
release_device:
	put_device(&tz->device);
	tz = NULL;
1479
remove_id:
1480
	ida_simple_remove(&thermal_tz_ida, id);
1481 1482 1483
free_tz:
	kfree(tz);
	return ERR_PTR(result);
Z
Zhang Rui 已提交
1484
}
1485
EXPORT_SYMBOL_GPL(thermal_zone_device_register);
Z
Zhang Rui 已提交
1486 1487 1488 1489 1490 1491 1492

/**
 * thermal_device_unregister - removes the registered thermal zone device
 * @tz: the thermal zone device to remove
 */
void thermal_zone_device_unregister(struct thermal_zone_device *tz)
{
1493 1494
	int i;
	const struct thermal_zone_params *tzp;
Z
Zhang Rui 已提交
1495 1496 1497 1498 1499 1500
	struct thermal_cooling_device *cdev;
	struct thermal_zone_device *pos = NULL;

	if (!tz)
		return;

1501 1502
	tzp = tz->tzp;

Z
Zhang Rui 已提交
1503 1504
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_tz_list, node)
1505 1506
		if (pos == tz)
			break;
Z
Zhang Rui 已提交
1507 1508 1509 1510 1511 1512
	if (pos != tz) {
		/* thermal zone device not found */
		mutex_unlock(&thermal_list_lock);
		return;
	}
	list_del(&tz->node);
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531

	/* Unbind all cdevs associated with 'this' thermal zone */
	list_for_each_entry(cdev, &thermal_cdev_list, node) {
		if (tz->ops->unbind) {
			tz->ops->unbind(tz, cdev);
			continue;
		}

		if (!tzp || !tzp->tbp)
			break;

		for (i = 0; i < tzp->num_tbps; i++) {
			if (tzp->tbp[i].cdev == cdev) {
				__unbind(tz, tzp->tbp[i].trip_mask, cdev);
				tzp->tbp[i].cdev = NULL;
			}
		}
	}

Z
Zhang Rui 已提交
1532 1533
	mutex_unlock(&thermal_list_lock);

1534
	cancel_delayed_work_sync(&tz->poll_queue);
1535

1536
	thermal_set_governor(tz, NULL);
Z
Zhang Rui 已提交
1537

Z
Zhang Rui 已提交
1538
	thermal_remove_hwmon_sysfs(tz);
1539 1540
	ida_simple_remove(&thermal_tz_ida, tz->id);
	ida_destroy(&tz->ida);
Z
Zhang Rui 已提交
1541 1542 1543
	mutex_destroy(&tz->lock);
	device_unregister(&tz->device);
}
1544
EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
Z
Zhang Rui 已提交
1545

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
/**
 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
 * @name: thermal zone name to fetch the temperature
 *
 * When only one zone is found with the passed name, returns a reference to it.
 *
 * Return: On success returns a reference to an unique thermal zone with
 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
 */
struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
{
	struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
	unsigned int found = 0;

	if (!name)
		goto exit;

	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_tz_list, node)
1566
		if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
			found++;
			ref = pos;
		}
	mutex_unlock(&thermal_list_lock);

	/* nothing has been found, thus an error code for it */
	if (found == 0)
		ref = ERR_PTR(-ENODEV);
	else if (found > 1)
	/* Success only when an unique zone is found */
		ref = ERR_PTR(-EEXIST);

exit:
	return ref;
}
EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);

1584
static int thermal_pm_notify(struct notifier_block *nb,
1585
			     unsigned long mode, void *_unused)
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
{
	struct thermal_zone_device *tz;

	switch (mode) {
	case PM_HIBERNATION_PREPARE:
	case PM_RESTORE_PREPARE:
	case PM_SUSPEND_PREPARE:
		atomic_set(&in_suspend, 1);
		break;
	case PM_POST_HIBERNATION:
	case PM_POST_RESTORE:
	case PM_POST_SUSPEND:
		atomic_set(&in_suspend, 0);
		list_for_each_entry(tz, &thermal_tz_list, node) {
1600
			if (!thermal_zone_device_is_enabled(tz))
1601 1602
				continue;

1603
			thermal_zone_device_init(tz);
1604 1605
			thermal_zone_device_update(tz,
						   THERMAL_EVENT_UNSPECIFIED);
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
		}
		break;
	default:
		break;
	}
	return 0;
}

static struct notifier_block thermal_pm_nb = {
	.notifier_call = thermal_pm_notify,
};

Z
Zhang Rui 已提交
1618 1619
static int __init thermal_init(void)
{
1620 1621
	int result;

1622
	mutex_init(&poweroff_lock);
1623 1624 1625
	result = thermal_register_governors();
	if (result)
		goto error;
Z
Zhang Rui 已提交
1626 1627

	result = class_register(&thermal_class);
1628 1629 1630
	if (result)
		goto unregister_governors;

1631 1632
	result = of_parse_thermal_zones();
	if (result)
A
Amit Kucheria 已提交
1633
		goto unregister_class;
1634

1635 1636 1637 1638 1639
	result = register_pm_notifier(&thermal_pm_nb);
	if (result)
		pr_warn("Thermal: Can not register suspend notifier, return %d\n",
			result);

1640 1641 1642 1643
	return 0;

unregister_class:
	class_unregister(&thermal_class);
1644 1645
unregister_governors:
	thermal_unregister_governors();
1646
error:
1647 1648
	ida_destroy(&thermal_tz_ida);
	ida_destroy(&thermal_cdev_ida);
1649 1650
	mutex_destroy(&thermal_list_lock);
	mutex_destroy(&thermal_governor_lock);
1651
	mutex_destroy(&poweroff_lock);
Z
Zhang Rui 已提交
1652 1653
	return result;
}
1654
core_initcall(thermal_init);