drivers/thermal/thermal_core.h

   1 /*
   2  *  thermal_core.h
   3  *
   4  *  Copyright (C) 2012  Intel Corp
   5  *  Author: Durgadoss R <[email protected]>
   6  *
   7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; version 2 of the License.
  11  *
  12  *  This program is distributed in the hope that it will be useful, but
  13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *  General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License along
  18  *  with this program; if not, write to the Free Software Foundation, Inc.,
  19  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  20  *
  21  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22  */
  23
  24 #ifndef __THERMAL_CORE_H__
  25 #define __THERMAL_CORE_H__
  26
  27 #include <linux/device.h>
  28 #include <linux/thermal.h>
  29
  30 /* Initial state of a cooling device during binding */
  31 #define THERMAL_NO_TARGET -1UL
  32
  33 /*
  34  * This structure is used to describe the behavior of
  35  * a certain cooling device on a certain trip point
  36  * in a certain thermal zone
  37  */
  38 struct thermal_instance {
  39         int id;
  40         char name[THERMAL_NAME_LENGTH];
  41         struct thermal_zone_device *tz;
  42         struct thermal_cooling_device *cdev;
  43         int trip;
  44         bool initialized;
  45         unsigned long upper;    /* Highest cooling state for this trip point */
  46         unsigned long lower;    /* Lowest cooling state for this trip point */
  47         unsigned long target;   /* expected cooling state */
  48         char attr_name[THERMAL_NAME_LENGTH];
  49         struct device_attribute attr;
  50         char weight_attr_name[THERMAL_NAME_LENGTH];
  51         struct device_attribute weight_attr;
  52         struct list_head tz_node; /* node in tz->thermal_instances */
  53         struct list_head cdev_node; /* node in cdev->thermal_instances */
  54         unsigned int weight; /* The weight of the cooling device */
  55 };
  56
  57 #define to_thermal_zone(_dev) \
  58         container_of(_dev, struct thermal_zone_device, device)
  59
  60 #define to_cooling_device(_dev) \
  61         container_of(_dev, struct thermal_cooling_device, device)
  62
  63 int thermal_register_governor(struct thermal_governor *);
  64 void thermal_unregister_governor(struct thermal_governor *);
  65 void thermal_zone_device_rebind_exception(struct thermal_zone_device *,
  66                                           const char *, size_t);
  67 void thermal_zone_device_unbind_exception(struct thermal_zone_device *,
  68                                           const char *, size_t);
  69 int thermal_zone_device_set_policy(struct thermal_zone_device *, char *);
  70 int thermal_build_list_of_policies(char *buf);
  71
  72 /* sysfs I/F */
  73 int thermal_zone_create_device_groups(struct thermal_zone_device *, int);
  74 void thermal_zone_destroy_device_groups(struct thermal_zone_device *);
  75 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device *);
  76 void thermal_cooling_device_destroy_sysfs(struct thermal_cooling_device *cdev);
  77 /* used only at binding time */
  78 ssize_t
  79 thermal_cooling_device_trip_point_show(struct device *,
  80                                        struct device_attribute *, char *);
  81 ssize_t thermal_cooling_device_weight_show(struct device *,
  82                                            struct device_attribute *, char *);
  83
  84 ssize_t thermal_cooling_device_weight_store(struct device *,
  85                                             struct device_attribute *,
  86                                             const char *, size_t);
  87
  88 #ifdef CONFIG_THERMAL_STATISTICS
  89 void thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev,
  90                                          unsigned long new_state);
  91 #else
  92 static inline void
  93 thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev,
  94                                     unsigned long new_state) {}
  95 #endif /* CONFIG_THERMAL_STATISTICS */
  96
  97 #ifdef CONFIG_THERMAL_GOV_STEP_WISE
  98 int thermal_gov_step_wise_register(void);
  99 void thermal_gov_step_wise_unregister(void);
 100 #else
 101 static inline int thermal_gov_step_wise_register(void) { return 0; }
 102 static inline void thermal_gov_step_wise_unregister(void) {}
 103 #endif /* CONFIG_THERMAL_GOV_STEP_WISE */
 104
 105 #ifdef CONFIG_THERMAL_GOV_FAIR_SHARE
 106 int thermal_gov_fair_share_register(void);
 107 void thermal_gov_fair_share_unregister(void);
 108 #else
 109 static inline int thermal_gov_fair_share_register(void) { return 0; }
 110 static inline void thermal_gov_fair_share_unregister(void) {}
 111 #endif /* CONFIG_THERMAL_GOV_FAIR_SHARE */
 112
 113 #ifdef CONFIG_THERMAL_GOV_BANG_BANG
 114 int thermal_gov_bang_bang_register(void);
 115 void thermal_gov_bang_bang_unregister(void);
 116 #else
 117 static inline int thermal_gov_bang_bang_register(void) { return 0; }
 118 static inline void thermal_gov_bang_bang_unregister(void) {}
 119 #endif /* CONFIG_THERMAL_GOV_BANG_BANG */
 120
 121 #ifdef CONFIG_THERMAL_GOV_USER_SPACE
 122 int thermal_gov_user_space_register(void);
 123 void thermal_gov_user_space_unregister(void);
 124 #else
 125 static inline int thermal_gov_user_space_register(void) { return 0; }
 126 static inline void thermal_gov_user_space_unregister(void) {}
 127 #endif /* CONFIG_THERMAL_GOV_USER_SPACE */
 128
 129 #ifdef CONFIG_THERMAL_GOV_POWER_ALLOCATOR
 130 int thermal_gov_power_allocator_register(void);
 131 void thermal_gov_power_allocator_unregister(void);
 132 #else
 133 static inline int thermal_gov_power_allocator_register(void) { return 0; }
 134 static inline void thermal_gov_power_allocator_unregister(void) {}
 135 #endif /* CONFIG_THERMAL_GOV_POWER_ALLOCATOR */
 136
 137 /* device tree support */
 138 #ifdef CONFIG_THERMAL_OF
 139 int of_parse_thermal_zones(void);
 140 void of_thermal_destroy_zones(void);
 141 int of_thermal_get_ntrips(struct thermal_zone_device *);
 142 bool of_thermal_is_trip_valid(struct thermal_zone_device *, int);
 143 const struct thermal_trip *
 144 of_thermal_get_trip_points(struct thermal_zone_device *);
 145 #else
 146 static inline int of_parse_thermal_zones(void) { return 0; }
 147 static inline void of_thermal_destroy_zones(void) { }
 148 static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz)
 149 {
 150         return 0;
 151 }
 152 static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz,
 153                                             int trip)
 154 {
 155         return false;
 156 }
 157 static inline const struct thermal_trip *
 158 of_thermal_get_trip_points(struct thermal_zone_device *tz)
 159 {
 160         return NULL;
 161 }
 162 #endif
 163
 164 #endif /* __THERMAL_CORE_H__ */