1 /* 2 * thermal.h ($Revision: 0 $) 3 * 4 * Copyright (C) 2008 Intel Corp 5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com> 6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com> 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/workqueue.h> 32 #include <uapi/linux/thermal.h> 33 34 #define THERMAL_TRIPS_NONE -1 35 #define THERMAL_MAX_TRIPS 12 36 37 /* invalid cooling state */ 38 #define THERMAL_CSTATE_INVALID -1UL 39 40 /* No upper/lower limit requirement */ 41 #define THERMAL_NO_LIMIT ((u32)~0) 42 43 /* Default weight of a bound cooling device */ 44 #define THERMAL_WEIGHT_DEFAULT 0 45 46 /* Unit conversion macros */ 47 #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \ 48 ((long)t-2732+5)/10 : ((long)t-2732-5)/10) 49 #define CELSIUS_TO_KELVIN(t) ((t)*10+2732) 50 #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100) 51 #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732) 52 #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off)) 53 #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732) 54 55 /* Default Thermal Governor */ 56 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE) 57 #define DEFAULT_THERMAL_GOVERNOR "step_wise" 58 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE) 59 #define DEFAULT_THERMAL_GOVERNOR "fair_share" 60 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE) 61 #define DEFAULT_THERMAL_GOVERNOR "user_space" 62 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR) 63 #define DEFAULT_THERMAL_GOVERNOR "power_allocator" 64 #endif 65 66 struct thermal_zone_device; 67 struct thermal_cooling_device; 68 struct thermal_instance; 69 70 enum thermal_device_mode { 71 THERMAL_DEVICE_DISABLED = 0, 72 THERMAL_DEVICE_ENABLED, 73 }; 74 75 enum thermal_trip_type { 76 THERMAL_TRIP_ACTIVE = 0, 77 THERMAL_TRIP_PASSIVE, 78 THERMAL_TRIP_HOT, 79 THERMAL_TRIP_CRITICAL, 80 }; 81 82 enum thermal_trend { 83 THERMAL_TREND_STABLE, /* temperature is stable */ 84 THERMAL_TREND_RAISING, /* temperature is raising */ 85 THERMAL_TREND_DROPPING, /* temperature is dropping */ 86 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */ 87 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */ 88 }; 89 90 struct thermal_zone_device_ops { 91 int (*bind) (struct thermal_zone_device *, 92 struct thermal_cooling_device *); 93 int (*unbind) (struct thermal_zone_device *, 94 struct thermal_cooling_device *); 95 int (*get_temp) (struct thermal_zone_device *, unsigned long *); 96 int (*get_mode) (struct thermal_zone_device *, 97 enum thermal_device_mode *); 98 int (*set_mode) (struct thermal_zone_device *, 99 enum thermal_device_mode); 100 int (*get_trip_type) (struct thermal_zone_device *, int, 101 enum thermal_trip_type *); 102 int (*get_trip_temp) (struct thermal_zone_device *, int, 103 unsigned long *); 104 int (*set_trip_temp) (struct thermal_zone_device *, int, 105 unsigned long); 106 int (*get_trip_hyst) (struct thermal_zone_device *, int, 107 unsigned long *); 108 int (*set_trip_hyst) (struct thermal_zone_device *, int, 109 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 int (*get_trend) (struct thermal_zone_device *, int, 113 enum thermal_trend *); 114 int (*notify) (struct thermal_zone_device *, int, 115 enum thermal_trip_type); 116 }; 117 118 struct thermal_cooling_device_ops { 119 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *); 120 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *); 121 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long); 122 int (*get_requested_power)(struct thermal_cooling_device *, 123 struct thermal_zone_device *, u32 *); 124 int (*state2power)(struct thermal_cooling_device *, 125 struct thermal_zone_device *, unsigned long, u32 *); 126 int (*power2state)(struct thermal_cooling_device *, 127 struct thermal_zone_device *, u32, unsigned long *); 128 }; 129 130 struct thermal_cooling_device { 131 int id; 132 char type[THERMAL_NAME_LENGTH]; 133 struct device device; 134 struct device_node *np; 135 void *devdata; 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; 140 struct list_head node; 141 }; 142 143 struct thermal_attr { 144 struct device_attribute attr; 145 char name[THERMAL_NAME_LENGTH]; 146 }; 147 148 /** 149 * struct thermal_zone_device - structure for a thermal zone 150 * @id: unique id number for each thermal zone 151 * @type: the thermal zone device type 152 * @device: &struct device for this thermal zone 153 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature 154 * @trip_type_attrs: attributes for trip points for sysfs: trip type 155 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis 156 * @devdata: private pointer for device private data 157 * @trips: number of trip points the thermal zone supports 158 * @passive_delay: number of milliseconds to wait between polls when 159 * performing passive cooling. 160 * @polling_delay: number of milliseconds to wait between polls when 161 * checking whether trip points have been crossed (0 for 162 * interrupt driven systems) 163 * @temperature: current temperature. This is only for core code, 164 * drivers should use thermal_zone_get_temp() to get the 165 * current temperature 166 * @last_temperature: previous temperature read 167 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION 168 * @passive: 1 if you've crossed a passive trip point, 0 otherwise. 169 * @forced_passive: If > 0, temperature at which to switch on all ACPI 170 * processor cooling devices. Currently only used by the 171 * step-wise governor. 172 * @ops: operations this &thermal_zone_device supports 173 * @tzp: thermal zone parameters 174 * @governor: pointer to the governor for this thermal zone 175 * @governor_data: private pointer for governor data 176 * @thermal_instances: list of &struct thermal_instance of this thermal zone 177 * @idr: &struct idr to generate unique id for this zone's cooling 178 * devices 179 * @lock: lock to protect thermal_instances list 180 * @node: node in thermal_tz_list (in thermal_core.c) 181 * @poll_queue: delayed work for polling 182 */ 183 struct thermal_zone_device { 184 int id; 185 char type[THERMAL_NAME_LENGTH]; 186 struct device device; 187 struct thermal_attr *trip_temp_attrs; 188 struct thermal_attr *trip_type_attrs; 189 struct thermal_attr *trip_hyst_attrs; 190 void *devdata; 191 int trips; 192 int passive_delay; 193 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; 204 struct idr idr; 205 struct mutex lock; 206 struct list_head node; 207 struct delayed_work poll_queue; 208 }; 209 210 /** 211 * struct thermal_governor - structure that holds thermal governor information 212 * @name: name of the governor 213 * @bind_to_tz: callback called when binding to a thermal zone. If it 214 * returns 0, the governor is bound to the thermal zone, 215 * otherwise it fails. 216 * @unbind_from_tz: callback called when a governor is unbound from a 217 * thermal zone. 218 * @throttle: callback called for every trip point even if temperature is 219 * below the trip point temperature 220 * @governor_list: node in thermal_governor_list (in thermal_core.c) 221 */ 222 struct thermal_governor { 223 char name[THERMAL_NAME_LENGTH]; 224 int (*bind_to_tz)(struct thermal_zone_device *tz); 225 void (*unbind_from_tz)(struct thermal_zone_device *tz); 226 int (*throttle)(struct thermal_zone_device *tz, int trip); 227 struct list_head governor_list; 228 }; 229 230 /* Structure that holds binding parameters for a zone */ 231 struct thermal_bind_params { 232 struct thermal_cooling_device *cdev; 233 234 /* 235 * This is a measure of 'how effectively these devices can 236 * cool 'this' thermal zone. It shall be determined by 237 * platform characterization. This value is relative to the 238 * rest of the weights so a cooling device whose weight is 239 * double that of another cooling device is twice as 240 * effective. See Documentation/thermal/sysfs-api.txt for more 241 * information. 242 */ 243 int weight; 244 245 /* 246 * This is a bit mask that gives the binding relation between this 247 * thermal zone and cdev, for a particular trip point. 248 * See Documentation/thermal/sysfs-api.txt for more information. 249 */ 250 int trip_mask; 251 252 /* 253 * This is an array of cooling state limits. Must have exactly 254 * 2 * thermal_zone.number_of_trip_points. It is an array consisting 255 * of tuples <lower-state upper-state> of state limits. Each trip 256 * will be associated with one state limit tuple when binding. 257 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> 258 * on all trips. 259 */ 260 unsigned long *binding_limits; 261 int (*match) (struct thermal_zone_device *tz, 262 struct thermal_cooling_device *cdev); 263 }; 264 265 /* Structure to define Thermal Zone parameters */ 266 struct thermal_zone_params { 267 char governor_name[THERMAL_NAME_LENGTH]; 268 269 /* 270 * a boolean to indicate if the thermal to hwmon sysfs interface 271 * is required. when no_hwmon == false, a hwmon sysfs interface 272 * will be created. when no_hwmon == true, nothing will be done 273 */ 274 bool no_hwmon; 275 276 int num_tbps; /* Number of tbp entries */ 277 struct thermal_bind_params *tbp; 278 279 /* 280 * Sustainable power (heat) that this thermal zone can dissipate in 281 * mW 282 */ 283 u32 sustainable_power; 284 285 /* 286 * Proportional parameter of the PID controller when 287 * overshooting (i.e., when temperature is below the target) 288 */ 289 s32 k_po; 290 291 /* 292 * Proportional parameter of the PID controller when 293 * undershooting 294 */ 295 s32 k_pu; 296 297 /* Integral parameter of the PID controller */ 298 s32 k_i; 299 300 /* Derivative parameter of the PID controller */ 301 s32 k_d; 302 303 /* threshold below which the error is no longer accumulated */ 304 s32 integral_cutoff; 305 306 /* 307 * @slope: slope of a linear temperature adjustment curve. 308 * Used by thermal zone drivers. 309 */ 310 int slope; 311 /* 312 * @offset: offset of a linear temperature adjustment curve. 313 * Used by thermal zone drivers (default 0). 314 */ 315 int offset; 316 }; 317 318 struct thermal_genl_event { 319 u32 orig; 320 enum events event; 321 }; 322 323 /** 324 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones 325 * 326 * Mandatory: 327 * @get_temp: a pointer to a function that reads the sensor temperature. 328 * 329 * Optional: 330 * @get_trend: a pointer to a function that reads the sensor temperature trend. 331 * @set_emul_temp: a pointer to a function that sets sensor emulated 332 * temperature. 333 */ 334 struct thermal_zone_of_device_ops { 335 int (*get_temp)(void *, long *); 336 int (*get_trend)(void *, long *); 337 int (*set_emul_temp)(void *, unsigned long); 338 }; 339 340 /** 341 * struct thermal_trip - representation of a point in temperature domain 342 * @np: pointer to struct device_node that this trip point was created from 343 * @temperature: temperature value in miliCelsius 344 * @hysteresis: relative hysteresis in miliCelsius 345 * @type: trip point type 346 */ 347 348 struct thermal_trip { 349 struct device_node *np; 350 unsigned long int temperature; 351 unsigned long int hysteresis; 352 enum thermal_trip_type type; 353 }; 354 355 /* Function declarations */ 356 #ifdef CONFIG_THERMAL_OF 357 struct thermal_zone_device * 358 thermal_zone_of_sensor_register(struct device *dev, int id, void *data, 359 const struct thermal_zone_of_device_ops *ops); 360 void thermal_zone_of_sensor_unregister(struct device *dev, 361 struct thermal_zone_device *tz); 362 #else 363 static inline struct thermal_zone_device * 364 thermal_zone_of_sensor_register(struct device *dev, int id, void *data, 365 const struct thermal_zone_of_device_ops *ops) 366 { 367 return NULL; 368 } 369 370 static inline 371 void thermal_zone_of_sensor_unregister(struct device *dev, 372 struct thermal_zone_device *tz) 373 { 374 } 375 376 #endif 377 378 #if IS_ENABLED(CONFIG_THERMAL) 379 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev) 380 { 381 return cdev->ops->get_requested_power && cdev->ops->state2power && 382 cdev->ops->power2state; 383 } 384 385 int power_actor_get_max_power(struct thermal_cooling_device *, 386 struct thermal_zone_device *tz, u32 *max_power); 387 int power_actor_set_power(struct thermal_cooling_device *, 388 struct thermal_instance *, u32); 389 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int, 390 void *, struct thermal_zone_device_ops *, 391 struct thermal_zone_params *, int, int); 392 void thermal_zone_device_unregister(struct thermal_zone_device *); 393 394 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, 395 struct thermal_cooling_device *, 396 unsigned long, unsigned long, 397 unsigned int); 398 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int, 399 struct thermal_cooling_device *); 400 void thermal_zone_device_update(struct thermal_zone_device *); 401 402 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *, 403 const struct thermal_cooling_device_ops *); 404 struct thermal_cooling_device * 405 thermal_of_cooling_device_register(struct device_node *np, char *, void *, 406 const struct thermal_cooling_device_ops *); 407 void thermal_cooling_device_unregister(struct thermal_cooling_device *); 408 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name); 409 int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp); 410 411 int get_tz_trend(struct thermal_zone_device *, int); 412 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *, 413 struct thermal_cooling_device *, int); 414 void thermal_cdev_update(struct thermal_cooling_device *); 415 void thermal_notify_framework(struct thermal_zone_device *, int); 416 #else 417 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev) 418 { return false; } 419 static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev, 420 struct thermal_zone_device *tz, u32 *max_power) 421 { return 0; } 422 static inline int power_actor_set_power(struct thermal_cooling_device *cdev, 423 struct thermal_instance *tz, u32 power) 424 { return 0; } 425 static inline struct thermal_zone_device *thermal_zone_device_register( 426 const char *type, int trips, int mask, void *devdata, 427 struct thermal_zone_device_ops *ops, 428 const struct thermal_zone_params *tzp, 429 int passive_delay, int polling_delay) 430 { return ERR_PTR(-ENODEV); } 431 static inline void thermal_zone_device_unregister( 432 struct thermal_zone_device *tz) 433 { } 434 static inline int thermal_zone_bind_cooling_device( 435 struct thermal_zone_device *tz, int trip, 436 struct thermal_cooling_device *cdev, 437 unsigned long upper, unsigned long lower) 438 { return -ENODEV; } 439 static inline int thermal_zone_unbind_cooling_device( 440 struct thermal_zone_device *tz, int trip, 441 struct thermal_cooling_device *cdev) 442 { return -ENODEV; } 443 static inline void thermal_zone_device_update(struct thermal_zone_device *tz) 444 { } 445 static inline struct thermal_cooling_device * 446 thermal_cooling_device_register(char *type, void *devdata, 447 const struct thermal_cooling_device_ops *ops) 448 { return ERR_PTR(-ENODEV); } 449 static inline struct thermal_cooling_device * 450 thermal_of_cooling_device_register(struct device_node *np, 451 char *type, void *devdata, const struct thermal_cooling_device_ops *ops) 452 { return ERR_PTR(-ENODEV); } 453 static inline void thermal_cooling_device_unregister( 454 struct thermal_cooling_device *cdev) 455 { } 456 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name( 457 const char *name) 458 { return ERR_PTR(-ENODEV); } 459 static inline int thermal_zone_get_temp( 460 struct thermal_zone_device *tz, unsigned long *temp) 461 { return -ENODEV; } 462 static inline int get_tz_trend(struct thermal_zone_device *tz, int trip) 463 { return -ENODEV; } 464 static inline struct thermal_instance * 465 get_thermal_instance(struct thermal_zone_device *tz, 466 struct thermal_cooling_device *cdev, int trip) 467 { return ERR_PTR(-ENODEV); } 468 static inline void thermal_cdev_update(struct thermal_cooling_device *cdev) 469 { } 470 static inline void thermal_notify_framework(struct thermal_zone_device *tz, 471 int trip) 472 { } 473 #endif /* CONFIG_THERMAL */ 474 475 #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL) 476 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz, 477 enum events event); 478 #else 479 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz, 480 enum events event) 481 { 482 return 0; 483 } 484 #endif 485 486 #endif /* __THERMAL_H__ */ 487