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/idr.h>
  29 #include <linux/device.h>
  30
  31 struct thermal_zone_device;
  32 struct thermal_cooling_device;
  33
  34 enum thermal_device_mode {
  35         THERMAL_DEVICE_DISABLED = 0,
  36         THERMAL_DEVICE_ENABLED,
  37 };
  38
  39 enum thermal_trip_type {
  40         THERMAL_TRIP_ACTIVE = 0,
  41         THERMAL_TRIP_PASSIVE,
  42         THERMAL_TRIP_HOT,
  43         THERMAL_TRIP_CRITICAL,
  44 };
  45
  46 struct thermal_zone_device_ops {
  47         int (*bind) (struct thermal_zone_device *,
  48                      struct thermal_cooling_device *);
  49         int (*unbind) (struct thermal_zone_device *,
  50                        struct thermal_cooling_device *);
  51         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
  52         int (*get_mode) (struct thermal_zone_device *,
  53                          enum thermal_device_mode *);
  54         int (*set_mode) (struct thermal_zone_device *,
  55                 enum thermal_device_mode);
  56         int (*get_trip_type) (struct thermal_zone_device *, int,
  57                 enum thermal_trip_type *);
  58         int (*get_trip_temp) (struct thermal_zone_device *, int,
  59                               unsigned long *);
  60         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
  61 };
  62
  63 struct thermal_cooling_device_ops {
  64         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
  65         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
  66         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
  67 };
  68
  69 #define THERMAL_TRIPS_NONE -1
  70 #define THERMAL_MAX_TRIPS 12
  71 #define THERMAL_NAME_LENGTH 20
  72 struct thermal_cooling_device {
  73         int id;
  74         char type[THERMAL_NAME_LENGTH];
  75         struct device device;
  76         void *devdata;
  77         struct thermal_cooling_device_ops *ops;
  78         struct list_head node;
  79 };
  80
  81 #define KELVIN_TO_CELSIUS(t)    (long)(((long)t-2732 >= 0) ?    \
  82                                 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
  83 #define CELSIUS_TO_KELVIN(t)    ((t)*10+2732)
  84
  85 #if defined(CONFIG_THERMAL_HWMON)
  86 /* thermal zone devices with the same type share one hwmon device */
  87 struct thermal_hwmon_device {
  88         char type[THERMAL_NAME_LENGTH];
  89         struct device *device;
  90         int count;
  91         struct list_head tz_list;
  92         struct list_head node;
  93 };
  94
  95 struct thermal_hwmon_attr {
  96         struct device_attribute attr;
  97         char name[16];
  98 };
  99 #endif
 100
 101 struct thermal_zone_device {
 102         int id;
 103         char type[THERMAL_NAME_LENGTH];
 104         struct device device;
 105         void *devdata;
 106         int trips;
 107         struct thermal_zone_device_ops *ops;
 108         struct list_head cooling_devices;
 109         struct idr idr;
 110         struct mutex lock;      /* protect cooling devices list */
 111         struct list_head node;
 112 #if defined(CONFIG_THERMAL_HWMON)
 113         struct list_head hwmon_node;
 114         struct thermal_hwmon_device *hwmon;
 115         struct thermal_hwmon_attr temp_input;   /* hwmon sys attr */
 116         struct thermal_hwmon_attr temp_crit;    /* hwmon sys attr */
 117 #endif
 118 };
 119
 120 struct thermal_zone_device *thermal_zone_device_register(char *, int, void *,
 121                                                          struct
 122                                                          thermal_zone_device_ops
 123                                                          *);
 124 void thermal_zone_device_unregister(struct thermal_zone_device *);
 125
 126 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
 127                                      struct thermal_cooling_device *);
 128 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
 129                                        struct thermal_cooling_device *);
 130 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
 131                                                                struct
 132                                                                thermal_cooling_device_ops
 133                                                                *);
 134 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
 135
 136 #endif /* __THERMAL_H__ */