1 /* 2 * thermal.h ($Revision: 0 $) 3 * 4 * Copyright (C) 2008 Intel Corp 5 * Copyright (C) 2008 Zhang Rui <[email protected]> 6 * Copyright (C) 2008 Sujith Thomas <[email protected]> 7 * 8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License as published by 11 * the Free Software Foundation; version 2 of the License. 12 * 13 * This program is distributed in the hope that it will be useful, but 14 * WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License along 19 * with this program; if not, write to the Free Software Foundation, Inc., 20 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 21 * 22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 23 */ 24 25 #ifndef __THERMAL_H__ 26 #define __THERMAL_H__ 27 28 #include <linux/of.h> 29 #include <linux/idr.h> 30 #include <linux/device.h> 31 #include <linux/sysfs.h> 32 #include <linux/workqueue.h> 33 #include <uapi/linux/thermal.h> 34 35 #define THERMAL_TRIPS_NONE -1 36 #define THERMAL_MAX_TRIPS 12 37 38 /* invalid cooling state */ 39 #define THERMAL_CSTATE_INVALID -1UL 40 41 /* No upper/lower limit requirement */ 42 #define THERMAL_NO_LIMIT ((u32)~0) 43 44 /* Default weight of a bound cooling device */ 45 #define THERMAL_WEIGHT_DEFAULT 0 46 47 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */ 48 #define THERMAL_TEMP_INVALID -274000 49 50 /* Unit conversion macros */ 51 #define DECI_KELVIN_TO_CELSIUS(t) ({ \ 52 long _t = (t); \ 53 ((_t-2732 >= 0) ? (_t-2732+5)/10 : (_t-2732-5)/10); \ 54 }) 55 #define CELSIUS_TO_DECI_KELVIN(t) ((t)*10+2732) 56 #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100) 57 #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732) 58 #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off)) 59 #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732) 60 61 /* Default Thermal Governor */ 62 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE) 63 #define DEFAULT_THERMAL_GOVERNOR "step_wise" 64 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE) 65 #define DEFAULT_THERMAL_GOVERNOR "fair_share" 66 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE) 67 #define DEFAULT_THERMAL_GOVERNOR "user_space" 68 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR) 69 #define DEFAULT_THERMAL_GOVERNOR "power_allocator" 70 #endif 71 72 struct thermal_zone_device; 73 struct thermal_cooling_device; 74 struct thermal_instance; 75 76 enum thermal_device_mode { 77 THERMAL_DEVICE_DISABLED = 0, 78 THERMAL_DEVICE_ENABLED, 79 }; 80 81 enum thermal_trip_type { 82 THERMAL_TRIP_ACTIVE = 0, 83 THERMAL_TRIP_PASSIVE, 84 THERMAL_TRIP_HOT, 85 THERMAL_TRIP_CRITICAL, 86 }; 87 88 enum thermal_trend { 89 THERMAL_TREND_STABLE, /* temperature is stable */ 90 THERMAL_TREND_RAISING, /* temperature is raising */ 91 THERMAL_TREND_DROPPING, /* temperature is dropping */ 92 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */ 93 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */ 94 }; 95 96 /* Thermal notification reason */ 97 enum thermal_notify_event { 98 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */ 99 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */ 100 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */ 101 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */ 102 THERMAL_DEVICE_DOWN, /* Thermal device is down */ 103 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */ 104 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */ 105 THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */ 106 }; 107 108 struct thermal_zone_device_ops { 109 int (*bind) (struct thermal_zone_device *, 110 struct thermal_cooling_device *); 111 int (*unbind) (struct thermal_zone_device *, 112 struct thermal_cooling_device *); 113 int (*get_temp) (struct thermal_zone_device *, int *); 114 int (*set_trips) (struct thermal_zone_device *, int, int); 115 int (*get_mode) (struct thermal_zone_device *, 116 enum thermal_device_mode *); 117 int (*set_mode) (struct thermal_zone_device *, 118 enum thermal_device_mode); 119 int (*get_trip_type) (struct thermal_zone_device *, int, 120 enum thermal_trip_type *); 121 int (*get_trip_temp) (struct thermal_zone_device *, int, int *); 122 int (*set_trip_temp) (struct thermal_zone_device *, int, int); 123 int (*get_trip_hyst) (struct thermal_zone_device *, int, int *); 124 int (*set_trip_hyst) (struct thermal_zone_device *, int, int); 125 int (*get_crit_temp) (struct thermal_zone_device *, int *); 126 int (*set_emul_temp) (struct thermal_zone_device *, int); 127 int (*get_trend) (struct thermal_zone_device *, int, 128 enum thermal_trend *); 129 int (*notify) (struct thermal_zone_device *, int, 130 enum thermal_trip_type); 131 }; 132 133 struct thermal_cooling_device_ops { 134 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *); 135 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *); 136 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long); 137 int (*get_requested_power)(struct thermal_cooling_device *, 138 struct thermal_zone_device *, u32 *); 139 int (*state2power)(struct thermal_cooling_device *, 140 struct thermal_zone_device *, unsigned long, u32 *); 141 int (*power2state)(struct thermal_cooling_device *, 142 struct thermal_zone_device *, u32, unsigned long *); 143 }; 144 145 struct thermal_cooling_device { 146 int id; 147 char type[THERMAL_NAME_LENGTH]; 148 struct device device; 149 struct device_node *np; 150 void *devdata; 151 void *stats; 152 const struct thermal_cooling_device_ops *ops; 153 bool updated; /* true if the cooling device does not need update */ 154 struct mutex lock; /* protect thermal_instances list */ 155 struct list_head thermal_instances; 156 struct list_head node; 157 }; 158 159 struct thermal_attr { 160 struct device_attribute attr; 161 char name[THERMAL_NAME_LENGTH]; 162 }; 163 164 /** 165 * struct thermal_zone_device - structure for a thermal zone 166 * @id: unique id number for each thermal zone 167 * @type: the thermal zone device type 168 * @device: &struct device for this thermal zone 169 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature 170 * @trip_type_attrs: attributes for trip points for sysfs: trip type 171 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis 172 * @devdata: private pointer for device private data 173 * @trips: number of trip points the thermal zone supports 174 * @trips_disabled; bitmap for disabled trips 175 * @passive_delay: number of milliseconds to wait between polls when 176 * performing passive cooling. 177 * @polling_delay: number of milliseconds to wait between polls when 178 * checking whether trip points have been crossed (0 for 179 * interrupt driven systems) 180 * @temperature: current temperature. This is only for core code, 181 * drivers should use thermal_zone_get_temp() to get the 182 * current temperature 183 * @last_temperature: previous temperature read 184 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION 185 * @passive: 1 if you've crossed a passive trip point, 0 otherwise. 186 * @prev_low_trip: the low current temperature if you've crossed a passive 187 trip point. 188 * @prev_high_trip: the above current temperature if you've crossed a 189 passive trip point. 190 * @forced_passive: If > 0, temperature at which to switch on all ACPI 191 * processor cooling devices. Currently only used by the 192 * step-wise governor. 193 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked. 194 * @ops: operations this &thermal_zone_device supports 195 * @tzp: thermal zone parameters 196 * @governor: pointer to the governor for this thermal zone 197 * @governor_data: private pointer for governor data 198 * @thermal_instances: list of &struct thermal_instance of this thermal zone 199 * @ida: &struct ida to generate unique id for this zone's cooling 200 * devices 201 * @lock: lock to protect thermal_instances list 202 * @node: node in thermal_tz_list (in thermal_core.c) 203 * @poll_queue: delayed work for polling 204 * @notify_event: Last notification event 205 */ 206 struct thermal_zone_device { 207 int id; 208 char type[THERMAL_NAME_LENGTH]; 209 struct device device; 210 struct attribute_group trips_attribute_group; 211 struct thermal_attr *trip_temp_attrs; 212 struct thermal_attr *trip_type_attrs; 213 struct thermal_attr *trip_hyst_attrs; 214 void *devdata; 215 int trips; 216 unsigned long trips_disabled; /* bitmap for disabled trips */ 217 int passive_delay; 218 int polling_delay; 219 int temperature; 220 int last_temperature; 221 int emul_temperature; 222 int passive; 223 int prev_low_trip; 224 int prev_high_trip; 225 unsigned int forced_passive; 226 atomic_t need_update; 227 struct thermal_zone_device_ops *ops; 228 struct thermal_zone_params *tzp; 229 struct thermal_governor *governor; 230 void *governor_data; 231 struct list_head thermal_instances; 232 struct ida ida; 233 struct mutex lock; 234 struct list_head node; 235 struct delayed_work poll_queue; 236 enum thermal_notify_event notify_event; 237 }; 238 239 /** 240 * struct thermal_governor - structure that holds thermal governor information 241 * @name: name of the governor 242 * @bind_to_tz: callback called when binding to a thermal zone. If it 243 * returns 0, the governor is bound to the thermal zone, 244 * otherwise it fails. 245 * @unbind_from_tz: callback called when a governor is unbound from a 246 * thermal zone. 247 * @throttle: callback called for every trip point even if temperature is 248 * below the trip point temperature 249 * @governor_list: node in thermal_governor_list (in thermal_core.c) 250 */ 251 struct thermal_governor { 252 char name[THERMAL_NAME_LENGTH]; 253 int (*bind_to_tz)(struct thermal_zone_device *tz); 254 void (*unbind_from_tz)(struct thermal_zone_device *tz); 255 int (*throttle)(struct thermal_zone_device *tz, int trip); 256 struct list_head governor_list; 257 }; 258 259 /* Structure that holds binding parameters for a zone */ 260 struct thermal_bind_params { 261 struct thermal_cooling_device *cdev; 262 263 /* 264 * This is a measure of 'how effectively these devices can 265 * cool 'this' thermal zone. It shall be determined by 266 * platform characterization. This value is relative to the 267 * rest of the weights so a cooling device whose weight is 268 * double that of another cooling device is twice as 269 * effective. See Documentation/thermal/sysfs-api.txt for more 270 * information. 271 */ 272 int weight; 273 274 /* 275 * This is a bit mask that gives the binding relation between this 276 * thermal zone and cdev, for a particular trip point. 277 * See Documentation/thermal/sysfs-api.txt for more information. 278 */ 279 int trip_mask; 280 281 /* 282 * This is an array of cooling state limits. Must have exactly 283 * 2 * thermal_zone.number_of_trip_points. It is an array consisting 284 * of tuples <lower-state upper-state> of state limits. Each trip 285 * will be associated with one state limit tuple when binding. 286 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> 287 * on all trips. 288 */ 289 unsigned long *binding_limits; 290 int (*match) (struct thermal_zone_device *tz, 291 struct thermal_cooling_device *cdev); 292 }; 293 294 /* Structure to define Thermal Zone parameters */ 295 struct thermal_zone_params { 296 char governor_name[THERMAL_NAME_LENGTH]; 297 298 /* 299 * a boolean to indicate if the thermal to hwmon sysfs interface 300 * is required. when no_hwmon == false, a hwmon sysfs interface 301 * will be created. when no_hwmon == true, nothing will be done 302 */ 303 bool no_hwmon; 304 305 int num_tbps; /* Number of tbp entries */ 306 struct thermal_bind_params *tbp; 307 308 /* 309 * Sustainable power (heat) that this thermal zone can dissipate in 310 * mW 311 */ 312 u32 sustainable_power; 313 314 /* 315 * Proportional parameter of the PID controller when 316 * overshooting (i.e., when temperature is below the target) 317 */ 318 s32 k_po; 319 320 /* 321 * Proportional parameter of the PID controller when 322 * undershooting 323 */ 324 s32 k_pu; 325 326 /* Integral parameter of the PID controller */ 327 s32 k_i; 328 329 /* Derivative parameter of the PID controller */ 330 s32 k_d; 331 332 /* threshold below which the error is no longer accumulated */ 333 s32 integral_cutoff; 334 335 /* 336 * @slope: slope of a linear temperature adjustment curve. 337 * Used by thermal zone drivers. 338 */ 339 int slope; 340 /* 341 * @offset: offset of a linear temperature adjustment curve. 342 * Used by thermal zone drivers (default 0). 343 */ 344 int offset; 345 }; 346 347 struct thermal_genl_event { 348 u32 orig; 349 enum events event; 350 }; 351 352 /** 353 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones 354 * 355 * Mandatory: 356 * @get_temp: a pointer to a function that reads the sensor temperature. 357 * 358 * Optional: 359 * @get_trend: a pointer to a function that reads the sensor temperature trend. 360 * @set_trips: a pointer to a function that sets a temperature window. When 361 * this window is left the driver must inform the thermal core via 362 * thermal_zone_device_update. 363 * @set_emul_temp: a pointer to a function that sets sensor emulated 364 * temperature. 365 * @set_trip_temp: a pointer to a function that sets the trip temperature on 366 * hardware. 367 */ 368 struct thermal_zone_of_device_ops { 369 int (*get_temp)(void *, int *); 370 int (*get_trend)(void *, int, enum thermal_trend *); 371 int (*set_trips)(void *, int, int); 372 int (*set_emul_temp)(void *, int); 373 int (*set_trip_temp)(void *, int, int); 374 }; 375 376 /** 377 * struct thermal_trip - representation of a point in temperature domain 378 * @np: pointer to struct device_node that this trip point was created from 379 * @temperature: temperature value in miliCelsius 380 * @hysteresis: relative hysteresis in miliCelsius 381 * @type: trip point type 382 */ 383 384 struct thermal_trip { 385 struct device_node *np; 386 int temperature; 387 int hysteresis; 388 enum thermal_trip_type type; 389 }; 390 391 /* Function declarations */ 392 #ifdef CONFIG_THERMAL_OF 393 struct thermal_zone_device * 394 thermal_zone_of_sensor_register(struct device *dev, int id, void *data, 395 const struct thermal_zone_of_device_ops *ops); 396 void thermal_zone_of_sensor_unregister(struct device *dev, 397 struct thermal_zone_device *tz); 398 struct thermal_zone_device *devm_thermal_zone_of_sensor_register( 399 struct device *dev, int id, void *data, 400 const struct thermal_zone_of_device_ops *ops); 401 void devm_thermal_zone_of_sensor_unregister(struct device *dev, 402 struct thermal_zone_device *tz); 403 #else 404 static inline struct thermal_zone_device * 405 thermal_zone_of_sensor_register(struct device *dev, int id, void *data, 406 const struct thermal_zone_of_device_ops *ops) 407 { 408 return ERR_PTR(-ENODEV); 409 } 410 411 static inline 412 void thermal_zone_of_sensor_unregister(struct device *dev, 413 struct thermal_zone_device *tz) 414 { 415 } 416 417 static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register( 418 struct device *dev, int id, void *data, 419 const struct thermal_zone_of_device_ops *ops) 420 { 421 return ERR_PTR(-ENODEV); 422 } 423 424 static inline 425 void devm_thermal_zone_of_sensor_unregister(struct device *dev, 426 struct thermal_zone_device *tz) 427 { 428 } 429 430 #endif 431 432 #if IS_ENABLED(CONFIG_THERMAL) 433 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev) 434 { 435 return cdev->ops->get_requested_power && cdev->ops->state2power && 436 cdev->ops->power2state; 437 } 438 439 int power_actor_get_max_power(struct thermal_cooling_device *, 440 struct thermal_zone_device *tz, u32 *max_power); 441 int power_actor_get_min_power(struct thermal_cooling_device *, 442 struct thermal_zone_device *tz, u32 *min_power); 443 int power_actor_set_power(struct thermal_cooling_device *, 444 struct thermal_instance *, u32); 445 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int, 446 void *, struct thermal_zone_device_ops *, 447 struct thermal_zone_params *, int, int); 448 void thermal_zone_device_unregister(struct thermal_zone_device *); 449 450 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, 451 struct thermal_cooling_device *, 452 unsigned long, unsigned long, 453 unsigned int); 454 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int, 455 struct thermal_cooling_device *); 456 void thermal_zone_device_update(struct thermal_zone_device *, 457 enum thermal_notify_event); 458 void thermal_zone_set_trips(struct thermal_zone_device *); 459 460 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *, 461 const struct thermal_cooling_device_ops *); 462 struct thermal_cooling_device * 463 thermal_of_cooling_device_register(struct device_node *np, char *, void *, 464 const struct thermal_cooling_device_ops *); 465 void thermal_cooling_device_unregister(struct thermal_cooling_device *); 466 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name); 467 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp); 468 int thermal_zone_get_slope(struct thermal_zone_device *tz); 469 int thermal_zone_get_offset(struct thermal_zone_device *tz); 470 471 int get_tz_trend(struct thermal_zone_device *, int); 472 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *, 473 struct thermal_cooling_device *, int); 474 void thermal_cdev_update(struct thermal_cooling_device *); 475 void thermal_notify_framework(struct thermal_zone_device *, int); 476 #else 477 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev) 478 { return false; } 479 static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev, 480 struct thermal_zone_device *tz, u32 *max_power) 481 { return 0; } 482 static inline int power_actor_get_min_power(struct thermal_cooling_device *cdev, 483 struct thermal_zone_device *tz, 484 u32 *min_power) 485 { return -ENODEV; } 486 static inline int power_actor_set_power(struct thermal_cooling_device *cdev, 487 struct thermal_instance *tz, u32 power) 488 { return 0; } 489 static inline struct thermal_zone_device *thermal_zone_device_register( 490 const char *type, int trips, int mask, void *devdata, 491 struct thermal_zone_device_ops *ops, 492 struct thermal_zone_params *tzp, 493 int passive_delay, int polling_delay) 494 { return ERR_PTR(-ENODEV); } 495 static inline void thermal_zone_device_unregister( 496 struct thermal_zone_device *tz) 497 { } 498 static inline int thermal_zone_bind_cooling_device( 499 struct thermal_zone_device *tz, int trip, 500 struct thermal_cooling_device *cdev, 501 unsigned long upper, unsigned long lower, 502 unsigned int weight) 503 { return -ENODEV; } 504 static inline int thermal_zone_unbind_cooling_device( 505 struct thermal_zone_device *tz, int trip, 506 struct thermal_cooling_device *cdev) 507 { return -ENODEV; } 508 static inline void thermal_zone_device_update(struct thermal_zone_device *tz, 509 enum thermal_notify_event event) 510 { } 511 static inline void thermal_zone_set_trips(struct thermal_zone_device *tz) 512 { } 513 static inline struct thermal_cooling_device * 514 thermal_cooling_device_register(char *type, void *devdata, 515 const struct thermal_cooling_device_ops *ops) 516 { return ERR_PTR(-ENODEV); } 517 static inline struct thermal_cooling_device * 518 thermal_of_cooling_device_register(struct device_node *np, 519 char *type, void *devdata, const struct thermal_cooling_device_ops *ops) 520 { return ERR_PTR(-ENODEV); } 521 static inline void thermal_cooling_device_unregister( 522 struct thermal_cooling_device *cdev) 523 { } 524 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name( 525 const char *name) 526 { return ERR_PTR(-ENODEV); } 527 static inline int thermal_zone_get_temp( 528 struct thermal_zone_device *tz, int *temp) 529 { return -ENODEV; } 530 static inline int thermal_zone_get_slope( 531 struct thermal_zone_device *tz) 532 { return -ENODEV; } 533 static inline int thermal_zone_get_offset( 534 struct thermal_zone_device *tz) 535 { return -ENODEV; } 536 static inline int get_tz_trend(struct thermal_zone_device *tz, int trip) 537 { return -ENODEV; } 538 static inline struct thermal_instance * 539 get_thermal_instance(struct thermal_zone_device *tz, 540 struct thermal_cooling_device *cdev, int trip) 541 { return ERR_PTR(-ENODEV); } 542 static inline void thermal_cdev_update(struct thermal_cooling_device *cdev) 543 { } 544 static inline void thermal_notify_framework(struct thermal_zone_device *tz, 545 int trip) 546 { } 547 #endif /* CONFIG_THERMAL */ 548 549 #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL) 550 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz, 551 enum events event); 552 #else 553 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz, 554 enum events event) 555 { 556 return 0; 557 } 558 #endif 559 560 #endif /* __THERMAL_H__ */ 561