1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * thermal_core.h 4 * 5 * Copyright (C) 2012 Intel Corp 6 * Author: Durgadoss R <durgadoss.r@intel.com> 7 */ 8 9 #ifndef __THERMAL_CORE_H__ 10 #define __THERMAL_CORE_H__ 11 12 #include <linux/device.h> 13 #include <linux/thermal.h> 14 15 #include "thermal_netlink.h" 16 17 /* Default Thermal Governor */ 18 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE) 19 #define DEFAULT_THERMAL_GOVERNOR "step_wise" 20 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE) 21 #define DEFAULT_THERMAL_GOVERNOR "fair_share" 22 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE) 23 #define DEFAULT_THERMAL_GOVERNOR "user_space" 24 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR) 25 #define DEFAULT_THERMAL_GOVERNOR "power_allocator" 26 #endif 27 28 /* Initial state of a cooling device during binding */ 29 #define THERMAL_NO_TARGET -1UL 30 31 /* Init section thermal table */ 32 extern struct thermal_governor *__governor_thermal_table[]; 33 extern struct thermal_governor *__governor_thermal_table_end[]; 34 35 #define THERMAL_TABLE_ENTRY(table, name) \ 36 static typeof(name) *__thermal_table_entry_##name \ 37 __used __section("__" #table "_thermal_table") = &name 38 39 #define THERMAL_GOVERNOR_DECLARE(name) THERMAL_TABLE_ENTRY(governor, name) 40 41 #define for_each_governor_table(__governor) \ 42 for (__governor = __governor_thermal_table; \ 43 __governor < __governor_thermal_table_end; \ 44 __governor++) 45 46 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *), 47 void *); 48 49 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *, 50 void *), void *); 51 52 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *), 53 void *thermal_governor); 54 55 struct thermal_zone_device *thermal_zone_get_by_id(int id); 56 57 struct thermal_attr { 58 struct device_attribute attr; 59 char name[THERMAL_NAME_LENGTH]; 60 }; 61 62 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev) 63 { 64 return cdev->ops->get_requested_power && cdev->ops->state2power && 65 cdev->ops->power2state; 66 } 67 68 void thermal_cdev_update(struct thermal_cooling_device *); 69 70 /** 71 * struct thermal_trip - representation of a point in temperature domain 72 * @np: pointer to struct device_node that this trip point was created from 73 * @temperature: temperature value in miliCelsius 74 * @hysteresis: relative hysteresis in miliCelsius 75 * @type: trip point type 76 */ 77 struct thermal_trip { 78 struct device_node *np; 79 int temperature; 80 int hysteresis; 81 enum thermal_trip_type type; 82 }; 83 84 int get_tz_trend(struct thermal_zone_device *tz, int trip); 85 86 struct thermal_instance * 87 get_thermal_instance(struct thermal_zone_device *tz, 88 struct thermal_cooling_device *cdev, 89 int trip); 90 91 /* 92 * This structure is used to describe the behavior of 93 * a certain cooling device on a certain trip point 94 * in a certain thermal zone 95 */ 96 struct thermal_instance { 97 int id; 98 char name[THERMAL_NAME_LENGTH]; 99 struct thermal_zone_device *tz; 100 struct thermal_cooling_device *cdev; 101 int trip; 102 bool initialized; 103 unsigned long upper; /* Highest cooling state for this trip point */ 104 unsigned long lower; /* Lowest cooling state for this trip point */ 105 unsigned long target; /* expected cooling state */ 106 char attr_name[THERMAL_NAME_LENGTH]; 107 struct device_attribute attr; 108 char weight_attr_name[THERMAL_NAME_LENGTH]; 109 struct device_attribute weight_attr; 110 struct list_head tz_node; /* node in tz->thermal_instances */ 111 struct list_head cdev_node; /* node in cdev->thermal_instances */ 112 unsigned int weight; /* The weight of the cooling device */ 113 }; 114 115 #define to_thermal_zone(_dev) \ 116 container_of(_dev, struct thermal_zone_device, device) 117 118 #define to_cooling_device(_dev) \ 119 container_of(_dev, struct thermal_cooling_device, device) 120 121 int thermal_register_governor(struct thermal_governor *); 122 void thermal_unregister_governor(struct thermal_governor *); 123 int thermal_zone_device_set_policy(struct thermal_zone_device *, char *); 124 int thermal_build_list_of_policies(char *buf); 125 126 /* Helpers */ 127 void thermal_zone_set_trips(struct thermal_zone_device *tz); 128 void thermal_set_delay_jiffies(unsigned long *delay_jiffies, int delay_ms); 129 130 /* sysfs I/F */ 131 int thermal_zone_create_device_groups(struct thermal_zone_device *, int); 132 void thermal_zone_destroy_device_groups(struct thermal_zone_device *); 133 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device *); 134 void thermal_cooling_device_destroy_sysfs(struct thermal_cooling_device *cdev); 135 /* used only at binding time */ 136 ssize_t trip_point_show(struct device *, struct device_attribute *, char *); 137 ssize_t weight_show(struct device *, struct device_attribute *, char *); 138 ssize_t weight_store(struct device *, struct device_attribute *, const char *, 139 size_t); 140 141 #ifdef CONFIG_THERMAL_STATISTICS 142 void thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev, 143 unsigned long new_state); 144 #else 145 static inline void 146 thermal_cooling_device_stats_update(struct thermal_cooling_device *cdev, 147 unsigned long new_state) {} 148 #endif /* CONFIG_THERMAL_STATISTICS */ 149 150 /* device tree support */ 151 #ifdef CONFIG_THERMAL_OF 152 int of_parse_thermal_zones(void); 153 int of_thermal_get_ntrips(struct thermal_zone_device *); 154 bool of_thermal_is_trip_valid(struct thermal_zone_device *, int); 155 const struct thermal_trip * 156 of_thermal_get_trip_points(struct thermal_zone_device *); 157 #else 158 static inline int of_parse_thermal_zones(void) { return 0; } 159 static inline int of_thermal_get_ntrips(struct thermal_zone_device *tz) 160 { 161 return 0; 162 } 163 static inline bool of_thermal_is_trip_valid(struct thermal_zone_device *tz, 164 int trip) 165 { 166 return false; 167 } 168 static inline const struct thermal_trip * 169 of_thermal_get_trip_points(struct thermal_zone_device *tz) 170 { 171 return NULL; 172 } 173 #endif 174 175 int thermal_zone_device_is_enabled(struct thermal_zone_device *tz); 176 177 #endif /* __THERMAL_CORE_H__ */ 178