thermal.h 16.5 KB
Newer Older
Z
Zhang Rui 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 *  thermal.h  ($Revision: 0 $)
 *
 *  Copyright (C) 2008  Intel Corp
 *  Copyright (C) 2008  Zhang Rui <rui.zhang@intel.com>
 *  Copyright (C) 2008  Sujith Thomas <sujith.thomas@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef __THERMAL_H__
#define __THERMAL_H__

28
#include <linux/of.h>
Z
Zhang Rui 已提交
29 30
#include <linux/idr.h>
#include <linux/device.h>
31
#include <linux/workqueue.h>
32
#include <uapi/linux/thermal.h>
Z
Zhang Rui 已提交
33

D
Durgadoss R 已提交
34 35 36
#define THERMAL_TRIPS_NONE	-1
#define THERMAL_MAX_TRIPS	12

37 38 39
/* invalid cooling state */
#define THERMAL_CSTATE_INVALID -1UL

D
Durgadoss R 已提交
40
/* No upper/lower limit requirement */
41
#define THERMAL_NO_LIMIT	((u32)~0)
D
Durgadoss R 已提交
42

43 44 45
/* Default weight of a bound cooling device */
#define THERMAL_WEIGHT_DEFAULT 0

D
Durgadoss R 已提交
46 47 48 49
/* Unit conversion macros */
#define KELVIN_TO_CELSIUS(t)	(long)(((long)t-2732 >= 0) ?	\
				((long)t-2732+5)/10 : ((long)t-2732-5)/10)
#define CELSIUS_TO_KELVIN(t)	((t)*10+2732)
50 51
#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
52 53
#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
D
Durgadoss R 已提交
54

Z
Zhang Rui 已提交
55 56 57 58 59 60 61
/* Default Thermal Governor */
#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
#define DEFAULT_THERMAL_GOVERNOR       "step_wise"
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
#define DEFAULT_THERMAL_GOVERNOR       "fair_share"
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
#define DEFAULT_THERMAL_GOVERNOR       "user_space"
62 63
#elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
#define DEFAULT_THERMAL_GOVERNOR       "power_allocator"
Z
Zhang Rui 已提交
64
#endif
65

Z
Zhang Rui 已提交
66 67
struct thermal_zone_device;
struct thermal_cooling_device;
68
struct thermal_instance;
Z
Zhang Rui 已提交
69

70 71 72 73 74 75 76 77 78 79 80 81
enum thermal_device_mode {
	THERMAL_DEVICE_DISABLED = 0,
	THERMAL_DEVICE_ENABLED,
};

enum thermal_trip_type {
	THERMAL_TRIP_ACTIVE = 0,
	THERMAL_TRIP_PASSIVE,
	THERMAL_TRIP_HOT,
	THERMAL_TRIP_CRITICAL,
};

82 83 84 85
enum thermal_trend {
	THERMAL_TREND_STABLE, /* temperature is stable */
	THERMAL_TREND_RAISING, /* temperature is raising */
	THERMAL_TREND_DROPPING, /* temperature is dropping */
86 87
	THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
	THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
88 89
};

Z
Zhang Rui 已提交
90 91 92 93 94
struct thermal_zone_device_ops {
	int (*bind) (struct thermal_zone_device *,
		     struct thermal_cooling_device *);
	int (*unbind) (struct thermal_zone_device *,
		       struct thermal_cooling_device *);
95 96 97 98 99 100 101 102 103
	int (*get_temp) (struct thermal_zone_device *, unsigned long *);
	int (*get_mode) (struct thermal_zone_device *,
			 enum thermal_device_mode *);
	int (*set_mode) (struct thermal_zone_device *,
		enum thermal_device_mode);
	int (*get_trip_type) (struct thermal_zone_device *, int,
		enum thermal_trip_type *);
	int (*get_trip_temp) (struct thermal_zone_device *, int,
			      unsigned long *);
104 105
	int (*set_trip_temp) (struct thermal_zone_device *, int,
			      unsigned long);
D
Durgadoss R 已提交
106 107 108 109
	int (*get_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long *);
	int (*set_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long);
110
	int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
111
	int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
112 113
	int (*get_trend) (struct thermal_zone_device *, int,
			  enum thermal_trend *);
114 115
	int (*notify) (struct thermal_zone_device *, int,
		       enum thermal_trip_type);
Z
Zhang Rui 已提交
116 117 118
};

struct thermal_cooling_device_ops {
119 120 121
	int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
	int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
	int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
122 123 124 125 126 127
	int (*get_requested_power)(struct thermal_cooling_device *,
				   struct thermal_zone_device *, u32 *);
	int (*state2power)(struct thermal_cooling_device *,
			   struct thermal_zone_device *, unsigned long, u32 *);
	int (*power2state)(struct thermal_cooling_device *,
			   struct thermal_zone_device *, u32, unsigned long *);
Z
Zhang Rui 已提交
128 129 130 131 132 133
};

struct thermal_cooling_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
134
	struct device_node *np;
Z
Zhang Rui 已提交
135
	void *devdata;
A
Alan Cox 已提交
136
	const struct thermal_cooling_device_ops *ops;
137
	bool updated; /* true if the cooling device does not need update */
138
	struct mutex lock; /* protect thermal_instances list */
139
	struct list_head thermal_instances;
Z
Zhang Rui 已提交
140 141 142
	struct list_head node;
};

143 144 145 146 147
struct thermal_attr {
	struct device_attribute attr;
	char name[THERMAL_NAME_LENGTH];
};

148 149 150 151 152 153 154 155 156 157 158
/**
 * struct thermal_zone_device - structure for a thermal zone
 * @id:		unique id number for each thermal zone
 * @type:	the thermal zone device type
 * @device:	&struct device for this thermal zone
 * @trip_temp_attrs:	attributes for trip points for sysfs: trip temperature
 * @trip_type_attrs:	attributes for trip points for sysfs: trip type
 * @trip_hyst_attrs:	attributes for trip points for sysfs: trip hysteresis
 * @devdata:	private pointer for device private data
 * @trips:	number of trip points the thermal zone supports
 * @passive_delay:	number of milliseconds to wait between polls when
159
 *			performing passive cooling.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
 * @polling_delay:	number of milliseconds to wait between polls when
 *			checking whether trip points have been crossed (0 for
 *			interrupt driven systems)
 * @temperature:	current temperature.  This is only for core code,
 *			drivers should use thermal_zone_get_temp() to get the
 *			current temperature
 * @last_temperature:	previous temperature read
 * @emul_temperature:	emulated temperature when using CONFIG_THERMAL_EMULATION
 * @passive:		1 if you've crossed a passive trip point, 0 otherwise.
 * @forced_passive:	If > 0, temperature at which to switch on all ACPI
 *			processor cooling devices.  Currently only used by the
 *			step-wise governor.
 * @ops:	operations this &thermal_zone_device supports
 * @tzp:	thermal zone parameters
 * @governor:	pointer to the governor for this thermal zone
175
 * @governor_data:	private pointer for governor data
176 177 178 179 180 181 182
 * @thermal_instances:	list of &struct thermal_instance of this thermal zone
 * @idr:	&struct idr to generate unique id for this zone's cooling
 *		devices
 * @lock:	lock to protect thermal_instances list
 * @node:	node in thermal_tz_list (in thermal_core.c)
 * @poll_queue:	delayed work for polling
 */
Z
Zhang Rui 已提交
183 184 185 186
struct thermal_zone_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
187 188
	struct thermal_attr *trip_temp_attrs;
	struct thermal_attr *trip_type_attrs;
D
Durgadoss R 已提交
189
	struct thermal_attr *trip_hyst_attrs;
Z
Zhang Rui 已提交
190 191
	void *devdata;
	int trips;
192 193
	int passive_delay;
	int polling_delay;
194
	int temperature;
195
	int last_temperature;
196
	int emul_temperature;
197
	int passive;
198
	unsigned int forced_passive;
199
	struct thermal_zone_device_ops *ops;
200
	struct thermal_zone_params *tzp;
201
	struct thermal_governor *governor;
202
	void *governor_data;
203
	struct list_head thermal_instances;
Z
Zhang Rui 已提交
204
	struct idr idr;
205
	struct mutex lock;
Z
Zhang Rui 已提交
206
	struct list_head node;
207
	struct delayed_work poll_queue;
Z
Zhang Rui 已提交
208
};
209

210 211 212
/**
 * struct thermal_governor - structure that holds thermal governor information
 * @name:	name of the governor
213 214 215 216 217
 * @bind_to_tz: callback called when binding to a thermal zone.  If it
 *		returns 0, the governor is bound to the thermal zone,
 *		otherwise it fails.
 * @unbind_from_tz:	callback called when a governor is unbound from a
 *			thermal zone.
218 219 220 221
 * @throttle:	callback called for every trip point even if temperature is
 *		below the trip point temperature
 * @governor_list:	node in thermal_governor_list (in thermal_core.c)
 */
222 223
struct thermal_governor {
	char name[THERMAL_NAME_LENGTH];
224 225
	int (*bind_to_tz)(struct thermal_zone_device *tz);
	void (*unbind_from_tz)(struct thermal_zone_device *tz);
226 227 228 229
	int (*throttle)(struct thermal_zone_device *tz, int trip);
	struct list_head	governor_list;
};

230 231 232 233 234 235
/* Structure that holds binding parameters for a zone */
struct thermal_bind_params {
	struct thermal_cooling_device *cdev;

	/*
	 * This is a measure of 'how effectively these devices can
236 237 238 239 240 241
	 * cool 'this' thermal zone. It shall be determined by
	 * platform characterization. This value is relative to the
	 * rest of the weights so a cooling device whose weight is
	 * double that of another cooling device is twice as
	 * effective. See Documentation/thermal/sysfs-api.txt for more
	 * information.
242 243 244 245 246 247 248 249 250
	 */
	int weight;

	/*
	 * This is a bit mask that gives the binding relation between this
	 * thermal zone and cdev, for a particular trip point.
	 * See Documentation/thermal/sysfs-api.txt for more information.
	 */
	int trip_mask;
251 252 253 254 255 256 257 258 259 260

	/*
	 * This is an array of cooling state limits. Must have exactly
	 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
	 * of tuples <lower-state upper-state> of state limits. Each trip
	 * will be associated with one state limit tuple when binding.
	 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
	 * on all trips.
	 */
	unsigned long *binding_limits;
261 262 263 264 265 266
	int (*match) (struct thermal_zone_device *tz,
			struct thermal_cooling_device *cdev);
};

/* Structure to define Thermal Zone parameters */
struct thermal_zone_params {
267
	char governor_name[THERMAL_NAME_LENGTH];
268 269 270 271 272 273 274 275

	/*
	 * a boolean to indicate if the thermal to hwmon sysfs interface
	 * is required. when no_hwmon == false, a hwmon sysfs interface
	 * will be created. when no_hwmon == true, nothing will be done
	 */
	bool no_hwmon;

276 277
	int num_tbps;	/* Number of tbp entries */
	struct thermal_bind_params *tbp;
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304

	/*
	 * Sustainable power (heat) that this thermal zone can dissipate in
	 * mW
	 */
	u32 sustainable_power;

	/*
	 * Proportional parameter of the PID controller when
	 * overshooting (i.e., when temperature is below the target)
	 */
	s32 k_po;

	/*
	 * Proportional parameter of the PID controller when
	 * undershooting
	 */
	s32 k_pu;

	/* Integral parameter of the PID controller */
	s32 k_i;

	/* Derivative parameter of the PID controller */
	s32 k_d;

	/* threshold below which the error is no longer accumulated */
	s32 integral_cutoff;
305 306
};

307 308 309 310
struct thermal_genl_event {
	u32 orig;
	enum events event;
};
Z
Zhang Rui 已提交
311

312 313 314 315 316 317 318 319
/**
 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
 *
 * Mandatory:
 * @get_temp: a pointer to a function that reads the sensor temperature.
 *
 * Optional:
 * @get_trend: a pointer to a function that reads the sensor temperature trend.
320 321
 * @set_emul_temp: a pointer to a function that sets sensor emulated
 *		   temperature.
322 323 324 325
 */
struct thermal_zone_of_device_ops {
	int (*get_temp)(void *, long *);
	int (*get_trend)(void *, long *);
326
	int (*set_emul_temp)(void *, unsigned long);
327 328
};

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
/**
 * struct thermal_trip - representation of a point in temperature domain
 * @np: pointer to struct device_node that this trip point was created from
 * @temperature: temperature value in miliCelsius
 * @hysteresis: relative hysteresis in miliCelsius
 * @type: trip point type
 */

struct thermal_trip {
	struct device_node *np;
	unsigned long int temperature;
	unsigned long int hysteresis;
	enum thermal_trip_type type;
};

D
Durgadoss R 已提交
344
/* Function declarations */
345 346
#ifdef CONFIG_THERMAL_OF
struct thermal_zone_device *
347 348
thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
				const struct thermal_zone_of_device_ops *ops);
349 350 351 352
void thermal_zone_of_sensor_unregister(struct device *dev,
				       struct thermal_zone_device *tz);
#else
static inline struct thermal_zone_device *
353 354
thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
				const struct thermal_zone_of_device_ops *ops)
355 356 357 358 359 360 361 362 363 364 365
{
	return NULL;
}

static inline
void thermal_zone_of_sensor_unregister(struct device *dev,
				       struct thermal_zone_device *tz)
{
}

#endif
366 367

#if IS_ENABLED(CONFIG_THERMAL)
368 369 370 371 372 373 374 375 376 377
static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
{
	return cdev->ops->get_requested_power && cdev->ops->state2power &&
		cdev->ops->power2state;
}

int power_actor_get_max_power(struct thermal_cooling_device *,
			      struct thermal_zone_device *tz, u32 *max_power);
int power_actor_set_power(struct thermal_cooling_device *,
			  struct thermal_instance *, u32);
378
struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
379
		void *, struct thermal_zone_device_ops *,
380
		struct thermal_zone_params *, int, int);
Z
Zhang Rui 已提交
381 382 383
void thermal_zone_device_unregister(struct thermal_zone_device *);

int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Z
Zhang Rui 已提交
384
				     struct thermal_cooling_device *,
385 386
				     unsigned long, unsigned long,
				     unsigned int);
Z
Zhang Rui 已提交
387 388
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
				       struct thermal_cooling_device *);
389
void thermal_zone_device_update(struct thermal_zone_device *);
D
Durgadoss R 已提交
390

Z
Zhang Rui 已提交
391
struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
A
Alan Cox 已提交
392
		const struct thermal_cooling_device_ops *);
393 394 395
struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np, char *, void *,
				   const struct thermal_cooling_device_ops *);
Z
Zhang Rui 已提交
396
void thermal_cooling_device_unregister(struct thermal_cooling_device *);
397
struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
398
int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
399

400 401 402
int get_tz_trend(struct thermal_zone_device *, int);
struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
		struct thermal_cooling_device *, int);
403
void thermal_cdev_update(struct thermal_cooling_device *);
404
void thermal_notify_framework(struct thermal_zone_device *, int);
405
#else
406 407 408 409 410 411 412 413
static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
{ return false; }
static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev,
			      struct thermal_zone_device *tz, u32 *max_power)
{ return 0; }
static inline int power_actor_set_power(struct thermal_cooling_device *cdev,
			  struct thermal_instance *tz, u32 power)
{ return 0; }
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
static inline struct thermal_zone_device *thermal_zone_device_register(
	const char *type, int trips, int mask, void *devdata,
	struct thermal_zone_device_ops *ops,
	const struct thermal_zone_params *tzp,
	int passive_delay, int polling_delay)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_zone_device_unregister(
	struct thermal_zone_device *tz)
{ }
static inline int thermal_zone_bind_cooling_device(
	struct thermal_zone_device *tz, int trip,
	struct thermal_cooling_device *cdev,
	unsigned long upper, unsigned long lower)
{ return -ENODEV; }
static inline int thermal_zone_unbind_cooling_device(
	struct thermal_zone_device *tz, int trip,
	struct thermal_cooling_device *cdev)
{ return -ENODEV; }
static inline void thermal_zone_device_update(struct thermal_zone_device *tz)
{ }
static inline struct thermal_cooling_device *
thermal_cooling_device_register(char *type, void *devdata,
	const struct thermal_cooling_device_ops *ops)
{ return ERR_PTR(-ENODEV); }
static inline struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np,
	char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_cooling_device_unregister(
	struct thermal_cooling_device *cdev)
{ }
static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
		const char *name)
{ return ERR_PTR(-ENODEV); }
static inline int thermal_zone_get_temp(
		struct thermal_zone_device *tz, unsigned long *temp)
{ return -ENODEV; }
static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
{ return -ENODEV; }
static inline struct thermal_instance *
get_thermal_instance(struct thermal_zone_device *tz,
	struct thermal_cooling_device *cdev, int trip)
{ return ERR_PTR(-ENODEV); }
static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
{ }
static inline void thermal_notify_framework(struct thermal_zone_device *tz,
	int trip)
{ }
#endif /* CONFIG_THERMAL */

#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
465 466
extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
						enum events event);
467
#else
E
Ezequiel Garcia 已提交
468
static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
469
						enum events event)
470 471 472 473
{
	return 0;
}
#endif
Z
Zhang Rui 已提交
474

475
#endif /* __THERMAL_H__ */