include/linux/thermal.h

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