thermal.h 12.8 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>
Z
Zhang Rui 已提交
32

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

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	THERMAL_CSTATE_INVALID
D
Durgadoss R 已提交
42 43 44 45 46

/* 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)
47 48
#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)
49 50
#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 已提交
51 52 53 54

/* Adding event notification support elements */
#define THERMAL_GENL_FAMILY_NAME                "thermal_event"
#define THERMAL_GENL_VERSION                    0x01
55
#define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_grp"
D
Durgadoss R 已提交
56

Z
Zhang Rui 已提交
57 58 59 60 61 62 63 64
/* 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"
#endif
65

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

69 70 71 72 73 74 75 76 77 78 79 80
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,
};

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

D
Durgadoss R 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
/* Events supported by Thermal Netlink */
enum events {
	THERMAL_AUX0,
	THERMAL_AUX1,
	THERMAL_CRITICAL,
	THERMAL_DEV_FAULT,
};

/* attributes of thermal_genl_family */
enum {
	THERMAL_GENL_ATTR_UNSPEC,
	THERMAL_GENL_ATTR_EVENT,
	__THERMAL_GENL_ATTR_MAX,
};
#define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)

/* commands supported by the thermal_genl_family */
enum {
	THERMAL_GENL_CMD_UNSPEC,
	THERMAL_GENL_CMD_EVENT,
	__THERMAL_GENL_CMD_MAX,
};
#define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)

Z
Zhang Rui 已提交
113 114 115 116 117
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 *);
118 119 120 121 122 123 124 125 126
	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 *);
127 128
	int (*set_trip_temp) (struct thermal_zone_device *, int,
			      unsigned long);
D
Durgadoss R 已提交
129 130 131 132
	int (*get_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long *);
	int (*set_trip_hyst) (struct thermal_zone_device *, int,
			      unsigned long);
133
	int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
134
	int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
135 136
	int (*get_trend) (struct thermal_zone_device *, int,
			  enum thermal_trend *);
137 138
	int (*notify) (struct thermal_zone_device *, int,
		       enum thermal_trip_type);
Z
Zhang Rui 已提交
139 140 141
};

struct thermal_cooling_device_ops {
142 143 144
	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);
Z
Zhang Rui 已提交
145 146 147 148 149 150
};

struct thermal_cooling_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
151
	struct device_node *np;
Z
Zhang Rui 已提交
152
	void *devdata;
A
Alan Cox 已提交
153
	const struct thermal_cooling_device_ops *ops;
154
	bool updated; /* true if the cooling device does not need update */
155
	struct mutex lock; /* protect thermal_instances list */
156
	struct list_head thermal_instances;
Z
Zhang Rui 已提交
157 158 159
	struct list_head node;
};

160 161 162 163 164
struct thermal_attr {
	struct device_attribute attr;
	char name[THERMAL_NAME_LENGTH];
};

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
/**
 * 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
 *			performing passive cooling.  Currenty only used by the
 *			step-wise governor
 * @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.
 *			Currenty only used by the step-wise governor.
 * @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
 * @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 已提交
201 202 203 204
struct thermal_zone_device {
	int id;
	char type[THERMAL_NAME_LENGTH];
	struct device device;
205 206
	struct thermal_attr *trip_temp_attrs;
	struct thermal_attr *trip_type_attrs;
D
Durgadoss R 已提交
207
	struct thermal_attr *trip_hyst_attrs;
Z
Zhang Rui 已提交
208 209
	void *devdata;
	int trips;
210 211
	int passive_delay;
	int polling_delay;
212
	int temperature;
213
	int last_temperature;
214
	int emul_temperature;
215
	int passive;
216
	unsigned int forced_passive;
217
	struct thermal_zone_device_ops *ops;
218
	const struct thermal_zone_params *tzp;
219
	struct thermal_governor *governor;
220
	struct list_head thermal_instances;
Z
Zhang Rui 已提交
221
	struct idr idr;
222
	struct mutex lock;
Z
Zhang Rui 已提交
223
	struct list_head node;
224
	struct delayed_work poll_queue;
Z
Zhang Rui 已提交
225
};
226

227 228 229 230 231 232 233
/**
 * struct thermal_governor - structure that holds thermal governor information
 * @name:	name of the governor
 * @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)
 */
234 235 236 237 238 239
struct thermal_governor {
	char name[THERMAL_NAME_LENGTH];
	int (*throttle)(struct thermal_zone_device *tz, int trip);
	struct list_head	governor_list;
};

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
/* 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
	 * cool 'this' thermal zone. The shall be determined by platform
	 * characterization. This is on a 'percentage' scale.
	 * See Documentation/thermal/sysfs-api.txt for more information.
	 */
	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;
258 259 260 261 262 263 264 265 266 267

	/*
	 * 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;
268 269 270 271 272 273
	int (*match) (struct thermal_zone_device *tz,
			struct thermal_cooling_device *cdev);
};

/* Structure to define Thermal Zone parameters */
struct thermal_zone_params {
274
	char governor_name[THERMAL_NAME_LENGTH];
275 276 277 278 279 280 281 282

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

283 284 285 286
	int num_tbps;	/* Number of tbp entries */
	struct thermal_bind_params *tbp;
};

287 288 289 290
struct thermal_genl_event {
	u32 orig;
	enum events event;
};
Z
Zhang Rui 已提交
291

292 293 294 295 296 297 298 299 300 301 302 303 304 305
/**
 * 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.
 */
struct thermal_zone_of_device_ops {
	int (*get_temp)(void *, long *);
	int (*get_trend)(void *, long *);
};

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
/**
 * 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 已提交
321
/* Function declarations */
322 323
#ifdef CONFIG_THERMAL_OF
struct thermal_zone_device *
324 325
thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
				const struct thermal_zone_of_device_ops *ops);
326 327 328 329
void thermal_zone_of_sensor_unregister(struct device *dev,
				       struct thermal_zone_device *tz);
#else
static inline struct thermal_zone_device *
330 331
thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
				const struct thermal_zone_of_device_ops *ops)
332 333 334 335 336 337 338 339 340 341 342
{
	return NULL;
}

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

#endif
343
struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
344
		void *, struct thermal_zone_device_ops *,
345
		const struct thermal_zone_params *, int, int);
Z
Zhang Rui 已提交
346 347 348
void thermal_zone_device_unregister(struct thermal_zone_device *);

int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Z
Zhang Rui 已提交
349 350
				     struct thermal_cooling_device *,
				     unsigned long, unsigned long);
Z
Zhang Rui 已提交
351 352
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
				       struct thermal_cooling_device *);
353
void thermal_zone_device_update(struct thermal_zone_device *);
D
Durgadoss R 已提交
354

Z
Zhang Rui 已提交
355
struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
A
Alan Cox 已提交
356
		const struct thermal_cooling_device_ops *);
357 358 359
struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node *np, char *, void *,
				   const struct thermal_cooling_device_ops *);
Z
Zhang Rui 已提交
360
void thermal_cooling_device_unregister(struct thermal_cooling_device *);
361
struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
362
int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
363

364 365 366
int get_tz_trend(struct thermal_zone_device *, int);
struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
		struct thermal_cooling_device *, int);
367
void thermal_cdev_update(struct thermal_cooling_device *);
368
void thermal_notify_framework(struct thermal_zone_device *, int);
369

370
#ifdef CONFIG_NET
371 372
extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
						enum events event);
373
#else
E
Ezequiel Garcia 已提交
374
static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
375
						enum events event)
376 377 378 379
{
	return 0;
}
#endif
Z
Zhang Rui 已提交
380

381
#endif /* __THERMAL_H__ */