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 14
#include <linux/module.h>
#include <linux/device.h>
#include <linux/err.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 23
#include <net/netlink.h>
#include <net/genetlink.h>
24
#include <linux/suspend.h>
Z
Zhang Rui 已提交
25

26 27 28
#define CREATE_TRACE_POINTS
#include <trace/events/thermal.h>

29
#include "thermal_core.h"
30
#include "thermal_hwmon.h"
31

32
MODULE_AUTHOR("Zhang Rui");
Z
Zhang Rui 已提交
33
MODULE_DESCRIPTION("Generic thermal management sysfs support");
34
MODULE_LICENSE("GPL v2");
Z
Zhang Rui 已提交
35

36 37
static DEFINE_IDA(thermal_tz_ida);
static DEFINE_IDA(thermal_cdev_ida);
Z
Zhang Rui 已提交
38 39 40

static LIST_HEAD(thermal_tz_list);
static LIST_HEAD(thermal_cdev_list);
41 42
static LIST_HEAD(thermal_governor_list);

Z
Zhang Rui 已提交
43
static DEFINE_MUTEX(thermal_list_lock);
44
static DEFINE_MUTEX(thermal_governor_lock);
45
static DEFINE_MUTEX(poweroff_lock);
46

47
static atomic_t in_suspend;
48
static bool power_off_triggered;
49

Z
Zhang Rui 已提交
50 51
static struct thermal_governor *def_governor;

52 53 54 55 56 57 58
/*
 * 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.
 */

59 60 61 62
static struct thermal_governor *__find_governor(const char *name)
{
	struct thermal_governor *pos;

Z
Zhang Rui 已提交
63 64 65
	if (!name || !name[0])
		return def_governor;

66
	list_for_each_entry(pos, &thermal_governor_list, governor_list)
67
		if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
68 69 70 71 72
			return pos;

	return NULL;
}

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 119 120 121 122 123 124
/**
 * 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;
}

125 126 127 128 129 130 131 132 133 134 135 136
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;
137
	if (!__find_governor(governor->name)) {
138 139
		bool match_default;

140 141
		err = 0;
		list_add(&governor->governor_list, &thermal_governor_list);
142 143 144 145 146
		match_default = !strncmp(governor->name,
					 DEFAULT_THERMAL_GOVERNOR,
					 THERMAL_NAME_LENGTH);

		if (!def_governor && match_default)
Z
Zhang Rui 已提交
147
			def_governor = governor;
148 149 150 151 152
	}

	mutex_lock(&thermal_list_lock);

	list_for_each_entry(pos, &thermal_tz_list, node) {
Z
Zhang Rui 已提交
153 154 155 156
		/*
		 * only thermal zones with specified tz->tzp->governor_name
		 * may run with tz->govenor unset
		 */
157 158
		if (pos->governor)
			continue;
Z
Zhang Rui 已提交
159 160 161

		name = pos->tzp->governor_name;

162 163 164 165 166 167 168 169 170
		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);
		}
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
	}

	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);

188
	if (!__find_governor(governor->name))
189 190 191 192 193
		goto exit;

	mutex_lock(&thermal_list_lock);

	list_for_each_entry(pos, &thermal_tz_list, node) {
194
		if (!strncasecmp(pos->governor->name, governor->name,
195
				 THERMAL_NAME_LENGTH))
196
			thermal_set_governor(pos, NULL);
197 198 199 200 201 202
	}

	mutex_unlock(&thermal_list_lock);
	list_del(&governor->governor_list);
exit:
	mutex_unlock(&thermal_governor_lock);
203 204
}

205 206
int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
				   char *policy)
207
{
208 209
	struct thermal_governor *gov;
	int ret = -EINVAL;
210

211
	mutex_lock(&thermal_governor_lock);
212 213
	mutex_lock(&tz->lock);

214 215 216
	gov = __find_governor(strim(policy));
	if (!gov)
		goto exit;
217

218
	ret = thermal_set_governor(tz, gov);
219

220 221 222
exit:
	mutex_unlock(&tz->lock);
	mutex_unlock(&thermal_governor_lock);
223

224
	return ret;
225 226
}

227
int thermal_build_list_of_policies(char *buf)
228
{
229 230 231
	struct thermal_governor *pos;
	ssize_t count = 0;
	ssize_t size = PAGE_SIZE;
232

233
	mutex_lock(&thermal_governor_lock);
234

235 236 237
	list_for_each_entry(pos, &thermal_governor_list, governor_list) {
		size = PAGE_SIZE - count;
		count += scnprintf(buf + count, size, "%s ", pos->name);
238
	}
239
	count += scnprintf(buf + count, size, "\n");
240

241
	mutex_unlock(&thermal_governor_lock);
242

243
	return count;
244 245
}

246
static void __init thermal_unregister_governors(void)
247
{
248 249 250 251 252
	struct thermal_governor **governor;

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

254 255 256 257
static int __init thermal_register_governors(void)
{
	int ret = 0;
	struct thermal_governor **governor;
258

259 260 261 262 263 264 265
	for_each_governor_table(governor) {
		ret = thermal_register_governor(*governor);
		if (ret) {
			pr_err("Failed to register governor: '%s'",
			       (*governor)->name);
			break;
		}
266

267 268 269
		pr_info("Registered thermal governor '%s'",
			(*governor)->name);
	}
270

271 272
	if (ret) {
		struct thermal_governor **gov;
273

274 275 276 277 278 279
		for_each_governor_table(gov) {
			if (gov == governor)
				break;
			thermal_unregister_governor(*gov);
		}
	}
280

281
	return ret;
282 283
}

284 285 286 287 288 289 290 291 292 293 294
/*
 * 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.
 */
295 296 297 298
static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
					    int delay)
{
	if (delay > 1000)
299 300
		mod_delayed_work(system_freezable_power_efficient_wq,
				 &tz->poll_queue,
301 302
				 round_jiffies(msecs_to_jiffies(delay)));
	else if (delay)
303 304
		mod_delayed_work(system_freezable_power_efficient_wq,
				 &tz->poll_queue,
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
				 msecs_to_jiffies(delay));
	else
		cancel_delayed_work(&tz->poll_queue);
}

static void monitor_thermal_zone(struct thermal_zone_device *tz)
{
	mutex_lock(&tz->lock);

	if (tz->passive)
		thermal_zone_device_set_polling(tz, tz->passive_delay);
	else if (tz->polling_delay)
		thermal_zone_device_set_polling(tz, tz->polling_delay);
	else
		thermal_zone_device_set_polling(tz, 0);

	mutex_unlock(&tz->lock);
}

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

330 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
/**
 * 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.
 */
365
static void thermal_emergency_poweroff(void)
366 367 368 369 370 371 372 373 374 375 376 377
{
	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));
}

378
static void handle_critical_trips(struct thermal_zone_device *tz,
379
				  int trip, enum thermal_trip_type trip_type)
380
{
381
	int trip_temp;
382 383 384 385

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

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

389 390
	trace_thermal_zone_trip(tz, trip, trip_type);

391 392 393 394
	if (tz->ops->notify)
		tz->ops->notify(tz, trip, trip_type);

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

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

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

420 421 422 423 424
	tz->ops->get_trip_type(tz, trip, &type);

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

static void update_temperature(struct thermal_zone_device *tz)
{
435
	int temp, ret;
436

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

446
	mutex_lock(&tz->lock);
447 448 449
	tz->last_temperature = tz->temperature;
	tz->temperature = temp;
	mutex_unlock(&tz->lock);
450

451
	trace_thermal_temperature(tz);
452 453 454 455 456 457 458 459
	if (tz->last_temperature == THERMAL_TEMP_INVALID)
		dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
			tz->temperature);
	else
		dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
			tz->last_temperature, tz->temperature);
}

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

468 469 470 471 472 473
static void thermal_zone_device_reset(struct thermal_zone_device *tz)
{
	tz->passive = 0;
	thermal_zone_device_init(tz);
}

474 475
void thermal_zone_device_update(struct thermal_zone_device *tz,
				enum thermal_notify_event event)
476 477 478
{
	int count;

479 480 481
	if (atomic_read(&in_suspend))
		return;

482 483 484
	if (!tz->ops->get_temp)
		return;

485 486
	update_temperature(tz);

487 488
	thermal_zone_set_trips(tz);

489 490
	tz->notify_event = event;

491 492 493
	for (count = 0; count < tz->trips; count++)
		handle_thermal_trip(tz, count);
}
494
EXPORT_SYMBOL_GPL(thermal_zone_device_update);
495

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
/**
 * 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);

514 515 516 517 518
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);
519
	thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
520 521
}

522 523 524 525 526 527
/*
 * 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.
 */
528

529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
/**
 * 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);
}

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
/**
 * 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);
}

578
/**
579
 * power_actor_set_power() - limit the maximum power a cooling device consumes
580 581 582 583
 * @cdev:	pointer to &thermal_cooling_device
 * @instance:	thermal instance to update
 * @power:	the power in milliwatts
 *
584 585
 * Set the cooling device to consume at most @power milliwatts. The limit is
 * expected to be a cap at the maximum power consumption.
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
 *
 * 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;
604
	mutex_lock(&cdev->lock);
605
	cdev->updated = false;
606
	mutex_unlock(&cdev->lock);
607 608 609 610 611
	thermal_cdev_update(cdev);

	return 0;
}

612 613
void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
					  const char *cdev_type, size_t size)
Z
Zhang Rui 已提交
614
{
615
	struct thermal_cooling_device *cdev = NULL;
Z
Zhang Rui 已提交
616

617 618 619 620 621 622 623 624 625 626 627 628 629
	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 已提交
630 631
}

632 633
void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
					  const char *cdev_type, size_t size)
Z
Zhang Rui 已提交
634
{
635
	struct thermal_cooling_device *cdev = NULL;
Z
Zhang Rui 已提交
636

637 638 639 640 641 642 643 644 645 646
	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 已提交
647 648
}

649 650 651 652 653 654 655 656 657
/*
 * 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 已提交
658 659

/**
660 661
 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
 * @tz:		pointer to struct thermal_zone_device
Z
Zhang Rui 已提交
662 663
 * @trip:	indicates which trip point the cooling devices is
 *		associated with in this thermal zone.
664 665 666 667 668 669 670
 * @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.
671 672 673
 * @weight:	The weight of the cooling device to be bound to the
 *		thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
 *		default value
674
 *
675 676
 * This interface function bind a thermal cooling device to the certain trip
 * point of a thermal zone device.
677
 * This function is usually called in the thermal zone device .bind callback.
678 679
 *
 * Return: 0 on success, the proper error value otherwise.
Z
Zhang Rui 已提交
680 681 682
 */
int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
				     int trip,
Z
Zhang Rui 已提交
683
				     struct thermal_cooling_device *cdev,
684 685
				     unsigned long upper, unsigned long lower,
				     unsigned int weight)
Z
Zhang Rui 已提交
686
{
687 688
	struct thermal_instance *dev;
	struct thermal_instance *pos;
689 690
	struct thermal_zone_device *pos1;
	struct thermal_cooling_device *pos2;
691
	unsigned long max_state;
692
	int result, ret;
Z
Zhang Rui 已提交
693

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

697 698 699 700 701 702 703 704 705 706
	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 已提交
707 708
		return -EINVAL;

709 710 711
	ret = cdev->ops->get_max_state(cdev, &max_state);
	if (ret)
		return ret;
Z
Zhang Rui 已提交
712 713 714 715 716 717 718 719

	/* 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;

720
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Z
Zhang Rui 已提交
721 722 723 724 725
	if (!dev)
		return -ENOMEM;
	dev->tz = tz;
	dev->cdev = cdev;
	dev->trip = trip;
Z
Zhang Rui 已提交
726 727
	dev->upper = upper;
	dev->lower = lower;
728
	dev->target = THERMAL_NO_TARGET;
729
	dev->weight = weight;
730

731 732
	result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
	if (result < 0)
Z
Zhang Rui 已提交
733 734
		goto free_mem;

735
	dev->id = result;
Z
Zhang Rui 已提交
736 737 738 739
	sprintf(dev->name, "cdev%d", dev->id);
	result =
	    sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
	if (result)
740
		goto release_ida;
Z
Zhang Rui 已提交
741 742

	sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
743
	sysfs_attr_init(&dev->attr.attr);
Z
Zhang Rui 已提交
744 745
	dev->attr.attr.name = dev->attr_name;
	dev->attr.attr.mode = 0444;
746
	dev->attr.show = trip_point_show;
Z
Zhang Rui 已提交
747 748 749 750
	result = device_create_file(&tz->device, &dev->attr);
	if (result)
		goto remove_symbol_link;

J
Javi Merino 已提交
751 752 753 754
	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;
755 756
	dev->weight_attr.show = weight_show;
	dev->weight_attr.store = weight_store;
J
Javi Merino 已提交
757 758 759 760
	result = device_create_file(&tz->device, &dev->weight_attr);
	if (result)
		goto remove_trip_file;

Z
Zhang Rui 已提交
761
	mutex_lock(&tz->lock);
762
	mutex_lock(&cdev->lock);
763
	list_for_each_entry(pos, &tz->thermal_instances, tz_node)
764 765 766 767
		if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
			result = -EEXIST;
			break;
		}
768
	if (!result) {
769
		list_add_tail(&dev->tz_node, &tz->thermal_instances);
770
		list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
771
		atomic_set(&tz->need_update, 1);
772
	}
773
	mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
774 775 776 777 778
	mutex_unlock(&tz->lock);

	if (!result)
		return 0;

J
Javi Merino 已提交
779 780
	device_remove_file(&tz->device, &dev->weight_attr);
remove_trip_file:
Z
Zhang Rui 已提交
781
	device_remove_file(&tz->device, &dev->attr);
J
Joe Perches 已提交
782
remove_symbol_link:
Z
Zhang Rui 已提交
783
	sysfs_remove_link(&tz->device.kobj, dev->name);
784 785
release_ida:
	ida_simple_remove(&tz->ida, dev->id);
J
Joe Perches 已提交
786
free_mem:
Z
Zhang Rui 已提交
787 788 789
	kfree(dev);
	return result;
}
790
EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
Z
Zhang Rui 已提交
791 792

/**
793 794 795
 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
 *					  thermal zone.
 * @tz:		pointer to a struct thermal_zone_device.
Z
Zhang Rui 已提交
796 797
 * @trip:	indicates which trip point the cooling devices is
 *		associated with in this thermal zone.
798
 * @cdev:	pointer to a struct thermal_cooling_device.
799
 *
800 801
 * This interface function unbind a thermal cooling device from the certain
 * trip point of a thermal zone device.
802
 * This function is usually called in the thermal zone device .unbind callback.
803 804
 *
 * Return: 0 on success, the proper error value otherwise.
Z
Zhang Rui 已提交
805 806 807 808 809
 */
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
				       int trip,
				       struct thermal_cooling_device *cdev)
{
810
	struct thermal_instance *pos, *next;
Z
Zhang Rui 已提交
811 812

	mutex_lock(&tz->lock);
813
	mutex_lock(&cdev->lock);
814
	list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
815
		if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
816
			list_del(&pos->tz_node);
817
			list_del(&pos->cdev_node);
818
			mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
819 820 821 822
			mutex_unlock(&tz->lock);
			goto unbind;
		}
	}
823
	mutex_unlock(&cdev->lock);
Z
Zhang Rui 已提交
824 825 826 827
	mutex_unlock(&tz->lock);

	return -ENODEV;

J
Joe Perches 已提交
828
unbind:
829
	device_remove_file(&tz->device, &pos->weight_attr);
Z
Zhang Rui 已提交
830 831
	device_remove_file(&tz->device, &pos->attr);
	sysfs_remove_link(&tz->device.kobj, pos->name);
832
	ida_simple_remove(&tz->ida, pos->id);
Z
Zhang Rui 已提交
833 834 835
	kfree(pos);
	return 0;
}
836
EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
Z
Zhang Rui 已提交
837 838 839 840 841 842

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

J
Joe Perches 已提交
843 844
	if (!strncmp(dev_name(dev), "thermal_zone",
		     sizeof("thermal_zone") - 1)) {
Z
Zhang Rui 已提交
845
		tz = to_thermal_zone(dev);
846
		thermal_zone_destroy_device_groups(tz);
Z
Zhang Rui 已提交
847
		kfree(tz);
848 849
	} else if (!strncmp(dev_name(dev), "cooling_device",
			    sizeof("cooling_device") - 1)) {
Z
Zhang Rui 已提交
850 851 852 853 854 855 856 857 858 859
		cdev = to_cooling_device(dev);
		kfree(cdev);
	}
}

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

860 861 862
static inline
void print_bind_err_msg(struct thermal_zone_device *tz,
			struct thermal_cooling_device *cdev, int ret)
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
{
	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);
		}
	}
}

894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
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 已提交
932
/**
933 934
 * __thermal_cooling_device_register() - register a new thermal cooling device
 * @np:		a pointer to a device tree node.
Z
Zhang Rui 已提交
935 936 937
 * @type:	the thermal cooling device type.
 * @devdata:	device private data.
 * @ops:		standard thermal cooling devices callbacks.
938 939 940 941
 *
 * 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.
942 943
 * 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.
944 945 946
 *
 * 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 已提交
947
 */
948 949
static struct thermal_cooling_device *
__thermal_cooling_device_register(struct device_node *np,
950
				  const char *type, void *devdata,
951
				  const struct thermal_cooling_device_ops *ops)
Z
Zhang Rui 已提交
952 953
{
	struct thermal_cooling_device *cdev;
954
	struct thermal_zone_device *pos = NULL;
Z
Zhang Rui 已提交
955 956
	int result;

957
	if (type && strlen(type) >= THERMAL_NAME_LENGTH)
958
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
959 960

	if (!ops || !ops->get_max_state || !ops->get_cur_state ||
961
	    !ops->set_cur_state)
962
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
963

964
	cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
Z
Zhang Rui 已提交
965
	if (!cdev)
966
		return ERR_PTR(-ENOMEM);
Z
Zhang Rui 已提交
967

968 969
	result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
	if (result < 0) {
Z
Zhang Rui 已提交
970
		kfree(cdev);
971
		return ERR_PTR(result);
Z
Zhang Rui 已提交
972 973
	}

974
	cdev->id = result;
975
	strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
976
	mutex_init(&cdev->lock);
977
	INIT_LIST_HEAD(&cdev->thermal_instances);
978
	cdev->np = np;
Z
Zhang Rui 已提交
979
	cdev->ops = ops;
980
	cdev->updated = false;
Z
Zhang Rui 已提交
981 982
	cdev->device.class = &thermal_class;
	cdev->devdata = devdata;
983
	thermal_cooling_device_setup_sysfs(cdev);
984
	dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
Z
Zhang Rui 已提交
985 986
	result = device_register(&cdev->device);
	if (result) {
987
		ida_simple_remove(&thermal_cdev_ida, cdev->id);
Z
Zhang Rui 已提交
988
		kfree(cdev);
989
		return ERR_PTR(result);
Z
Zhang Rui 已提交
990 991
	}

992
	/* Add 'this' new cdev to the global cdev list */
Z
Zhang Rui 已提交
993 994 995 996
	mutex_lock(&thermal_list_lock);
	list_add(&cdev->node, &thermal_cdev_list);
	mutex_unlock(&thermal_list_lock);

997 998 999
	/* Update binding information for 'this' new cdev */
	bind_cdev(cdev);

1000 1001 1002
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_tz_list, node)
		if (atomic_cmpxchg(&pos->need_update, 1, 0))
1003 1004
			thermal_zone_device_update(pos,
						   THERMAL_EVENT_UNSPECIFIED);
1005 1006
	mutex_unlock(&thermal_list_lock);

1007
	return cdev;
Z
Zhang Rui 已提交
1008
}
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

/**
 * 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 *
1024
thermal_cooling_device_register(const char *type, void *devdata,
1025 1026 1027 1028
				const struct thermal_cooling_device_ops *ops)
{
	return __thermal_cooling_device_register(NULL, type, devdata, ops);
}
1029
EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
Z
Zhang Rui 已提交
1030

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
/**
 * 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,
1048
				   const char *type, void *devdata,
1049 1050 1051 1052 1053 1054
				   const struct thermal_cooling_device_ops *ops)
{
	return __thermal_cooling_device_register(np, type, devdata, ops);
}
EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
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);

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
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 已提交
1114
/**
1115
 * thermal_cooling_device_unregister - removes a thermal cooling device
Z
Zhang Rui 已提交
1116 1117
 * @cdev:	the thermal cooling device to remove.
 *
1118 1119
 * thermal_cooling_device_unregister() must be called when a registered
 * thermal cooling device is no longer needed.
Z
Zhang Rui 已提交
1120
 */
1121
void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
Z
Zhang Rui 已提交
1122
{
1123 1124
	int i;
	const struct thermal_zone_params *tzp;
Z
Zhang Rui 已提交
1125 1126 1127 1128 1129 1130 1131 1132
	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)
1133 1134
		if (pos == cdev)
			break;
Z
Zhang Rui 已提交
1135 1136 1137 1138 1139 1140
	if (pos != cdev) {
		/* thermal cooling device not found */
		mutex_unlock(&thermal_list_lock);
		return;
	}
	list_del(&cdev->node);
1141 1142

	/* Unbind all thermal zones associated with 'this' cdev */
Z
Zhang Rui 已提交
1143
	list_for_each_entry(tz, &thermal_tz_list, node) {
1144 1145 1146 1147 1148 1149
		if (tz->ops->unbind) {
			tz->ops->unbind(tz, cdev);
			continue;
		}

		if (!tz->tzp || !tz->tzp->tbp)
Z
Zhang Rui 已提交
1150
			continue;
1151 1152 1153 1154 1155 1156 1157 1158

		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 已提交
1159
	}
1160

Z
Zhang Rui 已提交
1161
	mutex_unlock(&thermal_list_lock);
1162

1163
	ida_simple_remove(&thermal_cdev_ida, cdev->id);
1164
	device_del(&cdev->device);
1165
	thermal_cooling_device_destroy_sysfs(cdev);
1166
	put_device(&cdev->device);
Z
Zhang Rui 已提交
1167
}
1168
EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
Z
Zhang Rui 已提交
1169

1170
static void bind_tz(struct thermal_zone_device *tz)
1171
{
1172 1173 1174
	int i, ret;
	struct thermal_cooling_device *pos = NULL;
	const struct thermal_zone_params *tzp = tz->tzp;
1175

1176
	if (!tzp && !tz->ops->bind)
1177
		return;
1178

1179
	mutex_lock(&thermal_list_lock);
1180

1181 1182 1183 1184 1185 1186
	/* 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 已提交
1187
		}
1188
		goto exit;
D
Durgadoss R 已提交
1189
	}
1190

1191 1192
	if (!tzp || !tzp->tbp)
		goto exit;
D
Durgadoss R 已提交
1193

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
	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 已提交
1204
		}
1205
	}
1206 1207
exit:
	mutex_unlock(&thermal_list_lock);
1208 1209
}

Z
Zhang Rui 已提交
1210
/**
1211
 * thermal_zone_device_register() - register a new thermal zone device
Z
Zhang Rui 已提交
1212 1213
 * @type:	the thermal zone device type
 * @trips:	the number of trip points the thermal zone support
1214
 * @mask:	a bit string indicating the writeablility of trip points
Z
Zhang Rui 已提交
1215 1216
 * @devdata:	private device data
 * @ops:	standard thermal zone device callbacks
1217
 * @tzp:	thermal zone platform parameters
1218 1219 1220 1221 1222
 * @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 已提交
1223
 *
1224 1225 1226
 * 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 已提交
1227
 * thermal_zone_device_unregister() must be called when the device is no
1228
 * longer needed. The passive cooling depends on the .get_trend() return value.
1229 1230 1231 1232
 *
 * 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 已提交
1233
 */
1234 1235 1236 1237 1238
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 已提交
1239 1240
{
	struct thermal_zone_device *tz;
1241
	enum thermal_trip_type trip_type;
Z
Zhang Rui 已提交
1242
	int trip_temp;
Z
Zhang Rui 已提交
1243 1244
	int result;
	int count;
1245
	struct thermal_governor *governor;
Z
Zhang Rui 已提交
1246

1247 1248 1249
	if (!type || strlen(type) == 0)
		return ERR_PTR(-EINVAL);

1250
	if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1251
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
1252

1253
	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1254
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
1255

1256
	if (!ops)
1257
		return ERR_PTR(-EINVAL);
Z
Zhang Rui 已提交
1258

1259
	if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1260 1261
		return ERR_PTR(-EINVAL);

1262
	tz = kzalloc(sizeof(*tz), GFP_KERNEL);
Z
Zhang Rui 已提交
1263
	if (!tz)
1264
		return ERR_PTR(-ENOMEM);
Z
Zhang Rui 已提交
1265

1266
	INIT_LIST_HEAD(&tz->thermal_instances);
1267
	ida_init(&tz->ida);
Z
Zhang Rui 已提交
1268
	mutex_init(&tz->lock);
1269
	result = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
1270 1271
	if (result < 0)
		goto free_tz;
Z
Zhang Rui 已提交
1272

1273
	tz->id = result;
1274
	strlcpy(tz->type, type, sizeof(tz->type));
Z
Zhang Rui 已提交
1275
	tz->ops = ops;
1276
	tz->tzp = tzp;
Z
Zhang Rui 已提交
1277 1278 1279
	tz->device.class = &thermal_class;
	tz->devdata = devdata;
	tz->trips = trips;
1280 1281
	tz->passive_delay = passive_delay;
	tz->polling_delay = polling_delay;
1282

1283
	/* sys I/F */
1284
	/* Add nodes that are always present via .groups */
1285 1286
	result = thermal_zone_create_device_groups(tz, mask);
	if (result)
1287
		goto remove_id;
1288

1289 1290
	/* A new thermal zone needs to be updated anyway. */
	atomic_set(&tz->need_update, 1);
1291

1292
	dev_set_name(&tz->device, "thermal_zone%d", tz->id);
Z
Zhang Rui 已提交
1293
	result = device_register(&tz->device);
1294 1295
	if (result)
		goto remove_device_groups;
Z
Zhang Rui 已提交
1296 1297

	for (count = 0; count < trips; count++) {
Z
Zhang Rui 已提交
1298 1299 1300 1301 1302 1303 1304
		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 已提交
1305 1306
	}

1307 1308 1309 1310
	/* Update 'this' zone's governor information */
	mutex_lock(&thermal_governor_lock);

	if (tz->tzp)
1311
		governor = __find_governor(tz->tzp->governor_name);
1312
	else
1313 1314 1315 1316 1317 1318 1319
		governor = def_governor;

	result = thermal_set_governor(tz, governor);
	if (result) {
		mutex_unlock(&thermal_governor_lock);
		goto unregister;
	}
1320 1321 1322

	mutex_unlock(&thermal_governor_lock);

1323 1324 1325 1326 1327
	if (!tz->tzp || !tz->tzp->no_hwmon) {
		result = thermal_add_hwmon_sysfs(tz);
		if (result)
			goto unregister;
	}
Z
Zhang Rui 已提交
1328

Z
Zhang Rui 已提交
1329 1330 1331 1332
	mutex_lock(&thermal_list_lock);
	list_add_tail(&tz->node, &thermal_tz_list);
	mutex_unlock(&thermal_list_lock);

1333 1334 1335
	/* Bind cooling devices for this zone */
	bind_tz(tz);

1336
	INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1337

1338
	thermal_zone_device_reset(tz);
1339 1340
	/* Update the new thermal zone and mark it as already updated. */
	if (atomic_cmpxchg(&tz->need_update, 1, 0))
1341
		thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1342

1343
	return tz;
Z
Zhang Rui 已提交
1344

J
Joe Perches 已提交
1345
unregister:
1346
	ida_simple_remove(&thermal_tz_ida, tz->id);
Z
Zhang Rui 已提交
1347
	device_unregister(&tz->device);
1348
	return ERR_PTR(result);
1349 1350 1351 1352 1353 1354 1355 1356

remove_device_groups:
	thermal_zone_destroy_device_groups(tz);
remove_id:
	ida_simple_remove(&thermal_tz_ida, tz->id);
free_tz:
	kfree(tz);
	return ERR_PTR(result);
Z
Zhang Rui 已提交
1357
}
1358
EXPORT_SYMBOL_GPL(thermal_zone_device_register);
Z
Zhang Rui 已提交
1359 1360 1361 1362 1363 1364 1365

/**
 * 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)
{
1366 1367
	int i;
	const struct thermal_zone_params *tzp;
Z
Zhang Rui 已提交
1368 1369 1370 1371 1372 1373
	struct thermal_cooling_device *cdev;
	struct thermal_zone_device *pos = NULL;

	if (!tz)
		return;

1374 1375
	tzp = tz->tzp;

Z
Zhang Rui 已提交
1376 1377
	mutex_lock(&thermal_list_lock);
	list_for_each_entry(pos, &thermal_tz_list, node)
1378 1379
		if (pos == tz)
			break;
Z
Zhang Rui 已提交
1380 1381 1382 1383 1384 1385
	if (pos != tz) {
		/* thermal zone device not found */
		mutex_unlock(&thermal_list_lock);
		return;
	}
	list_del(&tz->node);
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404

	/* 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 已提交
1405 1406
	mutex_unlock(&thermal_list_lock);

1407 1408
	thermal_zone_device_set_polling(tz, 0);

1409
	thermal_set_governor(tz, NULL);
Z
Zhang Rui 已提交
1410

Z
Zhang Rui 已提交
1411
	thermal_remove_hwmon_sysfs(tz);
1412 1413
	ida_simple_remove(&thermal_tz_ida, tz->id);
	ida_destroy(&tz->ida);
Z
Zhang Rui 已提交
1414 1415 1416
	mutex_destroy(&tz->lock);
	device_unregister(&tz->device);
}
1417
EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
Z
Zhang Rui 已提交
1418

1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
/**
 * 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)
1439
		if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
			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);

1457
#ifdef CONFIG_NET
1458 1459 1460 1461
static const struct genl_multicast_group thermal_event_mcgrps[] = {
	{ .name = THERMAL_GENL_MCAST_GROUP_NAME, },
};

1462
static struct genl_family thermal_event_genl_family __ro_after_init = {
1463
	.module = THIS_MODULE,
1464 1465 1466
	.name = THERMAL_GENL_FAMILY_NAME,
	.version = THERMAL_GENL_VERSION,
	.maxattr = THERMAL_GENL_ATTR_MAX,
1467 1468
	.mcgrps = thermal_event_mcgrps,
	.n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
1469 1470
};

1471
int thermal_generate_netlink_event(struct thermal_zone_device *tz,
1472
				   enum events event)
1473 1474 1475 1476 1477 1478 1479
{
	struct sk_buff *skb;
	struct nlattr *attr;
	struct thermal_genl_event *thermal_event;
	void *msg_header;
	int size;
	int result;
1480
	static unsigned int thermal_event_seqnum;
1481

1482 1483 1484
	if (!tz)
		return -EINVAL;

1485
	/* allocate memory */
1486 1487
	size = nla_total_size(sizeof(struct thermal_genl_event)) +
	       nla_total_size(0);
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502

	skb = genlmsg_new(size, GFP_ATOMIC);
	if (!skb)
		return -ENOMEM;

	/* add the genetlink message header */
	msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
				 &thermal_event_genl_family, 0,
				 THERMAL_GENL_CMD_EVENT);
	if (!msg_header) {
		nlmsg_free(skb);
		return -ENOMEM;
	}

	/* fill the data */
1503 1504
	attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
			   sizeof(struct thermal_genl_event));
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518

	if (!attr) {
		nlmsg_free(skb);
		return -EINVAL;
	}

	thermal_event = nla_data(attr);
	if (!thermal_event) {
		nlmsg_free(skb);
		return -EINVAL;
	}

	memset(thermal_event, 0, sizeof(struct thermal_genl_event));

1519
	thermal_event->orig = tz->id;
1520 1521 1522
	thermal_event->event = event;

	/* send multicast genetlink message */
1523
	genlmsg_end(skb, msg_header);
1524

1525
	result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
1526
				   0, GFP_ATOMIC);
1527
	if (result)
1528
		dev_err(&tz->device, "Failed to send netlink event:%d", result);
1529 1530 1531

	return result;
}
1532
EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
1533

1534
static int __init genetlink_init(void)
1535
{
1536
	return genl_register_family(&thermal_event_genl_family);
1537 1538
}

1539 1540 1541 1542 1543 1544 1545 1546 1547
static void genetlink_exit(void)
{
	genl_unregister_family(&thermal_event_genl_family);
}
#else /* !CONFIG_NET */
static inline int genetlink_init(void) { return 0; }
static inline void genetlink_exit(void) {}
#endif /* !CONFIG_NET */

1548
static int thermal_pm_notify(struct notifier_block *nb,
1549
			     unsigned long mode, void *_unused)
1550 1551
{
	struct thermal_zone_device *tz;
1552
	enum thermal_device_mode tz_mode;
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564

	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) {
1565 1566 1567 1568 1569 1570 1571
			tz_mode = THERMAL_DEVICE_ENABLED;
			if (tz->ops->get_mode)
				tz->ops->get_mode(tz, &tz_mode);

			if (tz_mode == THERMAL_DEVICE_DISABLED)
				continue;

1572
			thermal_zone_device_init(tz);
1573 1574
			thermal_zone_device_update(tz,
						   THERMAL_EVENT_UNSPECIFIED);
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
		}
		break;
	default:
		break;
	}
	return 0;
}

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

Z
Zhang Rui 已提交
1587 1588
static int __init thermal_init(void)
{
1589 1590
	int result;

1591
	mutex_init(&poweroff_lock);
1592 1593 1594
	result = thermal_register_governors();
	if (result)
		goto error;
Z
Zhang Rui 已提交
1595 1596

	result = class_register(&thermal_class);
1597 1598 1599
	if (result)
		goto unregister_governors;

1600
	result = genetlink_init();
1601 1602 1603
	if (result)
		goto unregister_class;

1604 1605 1606 1607
	result = of_parse_thermal_zones();
	if (result)
		goto exit_netlink;

1608 1609 1610 1611 1612
	result = register_pm_notifier(&thermal_pm_nb);
	if (result)
		pr_warn("Thermal: Can not register suspend notifier, return %d\n",
			result);

1613 1614
	return 0;

1615 1616
exit_netlink:
	genetlink_exit();
1617 1618
unregister_class:
	class_unregister(&thermal_class);
1619 1620
unregister_governors:
	thermal_unregister_governors();
1621
error:
1622 1623
	ida_destroy(&thermal_tz_ida);
	ida_destroy(&thermal_cdev_ida);
1624 1625
	mutex_destroy(&thermal_list_lock);
	mutex_destroy(&thermal_governor_lock);
1626
	mutex_destroy(&poweroff_lock);
Z
Zhang Rui 已提交
1627 1628
	return result;
}
1629
fs_initcall(thermal_init);