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