1 /* SPDX-License-Identifier: GPL-2.0-or-later * <<
2 /* 1 /*
3 * tmon.h contains data structures and constan 2 * tmon.h contains data structures and constants used by TMON
4 * 3 *
5 * Copyright (C) 2012 Intel Corporation. All r 4 * Copyright (C) 2012 Intel Corporation. All rights reserved.
6 * 5 *
>> 6 * This program is free software; you can redistribute it and/or
>> 7 * modify it under the terms of the GNU General Public License version
>> 8 * 2 or later as published by the Free Software Foundation.
>> 9 *
>> 10 * This program is distributed in the hope that it will be useful,
>> 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
>> 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
>> 13 * GNU General Public License for more details.
>> 14 *
7 * Author Name Jacob Pan <jacob.jun.pan@linux. 15 * Author Name Jacob Pan <jacob.jun.pan@linux.intel.com>
>> 16 *
8 */ 17 */
9 18
10 #ifndef TMON_H 19 #ifndef TMON_H
11 #define TMON_H 20 #define TMON_H
12 21
13 #define MAX_DISP_TEMP 125 22 #define MAX_DISP_TEMP 125
14 #define MAX_CTRL_TEMP 105 23 #define MAX_CTRL_TEMP 105
15 #define MIN_CTRL_TEMP 40 24 #define MIN_CTRL_TEMP 40
16 #define MAX_NR_TZONE 16 25 #define MAX_NR_TZONE 16
17 #define MAX_NR_CDEV 32 26 #define MAX_NR_CDEV 32
18 #define MAX_NR_TRIP 16 27 #define MAX_NR_TRIP 16
19 #define MAX_NR_CDEV_TRIP 12 /* number of cooli 28 #define MAX_NR_CDEV_TRIP 12 /* number of cooling devices that can bind
20 * to a thermal zo 29 * to a thermal zone trip.
21 */ 30 */
22 #define MAX_TEMP_KC 140000 31 #define MAX_TEMP_KC 140000
23 /* starting char position to draw sensor data, 32 /* starting char position to draw sensor data, such as tz names
24 * trip point list, etc. 33 * trip point list, etc.
25 */ 34 */
26 #define DATA_LEFT_ALIGN 10 35 #define DATA_LEFT_ALIGN 10
27 #define NR_LINES_TZDATA 1 36 #define NR_LINES_TZDATA 1
28 #define TMON_LOG_FILE "/var/tmp/tmon.log" 37 #define TMON_LOG_FILE "/var/tmp/tmon.log"
29 <<
30 #include <sys/time.h> <<
31 #include <pthread.h> <<
32 38
33 extern unsigned long ticktime; 39 extern unsigned long ticktime;
34 extern double time_elapsed; 40 extern double time_elapsed;
35 extern unsigned long target_temp_user; 41 extern unsigned long target_temp_user;
36 extern int dialogue_on; 42 extern int dialogue_on;
37 extern char ctrl_cdev[]; 43 extern char ctrl_cdev[];
38 extern pthread_mutex_t input_lock; 44 extern pthread_mutex_t input_lock;
39 extern int tmon_exit; 45 extern int tmon_exit;
40 extern int target_thermal_zone; 46 extern int target_thermal_zone;
41 /* use fixed size record to simplify data proc 47 /* use fixed size record to simplify data processing and transfer
42 * TBD: more info to be added, e.g. programmab 48 * TBD: more info to be added, e.g. programmable trip point data.
43 */ 49 */
44 struct thermal_data_record { 50 struct thermal_data_record {
45 struct timeval tv; 51 struct timeval tv;
46 unsigned long temp[MAX_NR_TZONE]; 52 unsigned long temp[MAX_NR_TZONE];
47 double pid_out_pct; 53 double pid_out_pct;
48 }; 54 };
49 55
50 struct cdev_info { 56 struct cdev_info {
51 char type[64]; 57 char type[64];
52 int instance; 58 int instance;
53 unsigned long max_state; 59 unsigned long max_state;
54 unsigned long cur_state; 60 unsigned long cur_state;
55 unsigned long flag; 61 unsigned long flag;
56 }; 62 };
57 63
58 enum trip_type { 64 enum trip_type {
59 THERMAL_TRIP_CRITICAL, 65 THERMAL_TRIP_CRITICAL,
60 THERMAL_TRIP_HOT, 66 THERMAL_TRIP_HOT,
61 THERMAL_TRIP_PASSIVE, 67 THERMAL_TRIP_PASSIVE,
62 THERMAL_TRIP_ACTIVE, 68 THERMAL_TRIP_ACTIVE,
63 NR_THERMAL_TRIP_TYPE, 69 NR_THERMAL_TRIP_TYPE,
64 }; 70 };
65 71
66 struct trip_point { 72 struct trip_point {
67 enum trip_type type; 73 enum trip_type type;
68 unsigned long temp; 74 unsigned long temp;
69 unsigned long hysteresis; 75 unsigned long hysteresis;
70 int attribute; /* programmability etc. 76 int attribute; /* programmability etc. */
71 }; 77 };
72 78
73 /* thermal zone configuration information, bin 79 /* thermal zone configuration information, binding with cooling devices could
74 * change at runtime. 80 * change at runtime.
75 */ 81 */
76 struct tz_info { 82 struct tz_info {
77 char type[256]; /* e.g. acpitz */ 83 char type[256]; /* e.g. acpitz */
78 int instance; 84 int instance;
79 int passive; /* active zone has passiv 85 int passive; /* active zone has passive node to force passive mode */
80 int nr_cdev; /* number of cooling devi 86 int nr_cdev; /* number of cooling device binded */
81 int nr_trip_pts; 87 int nr_trip_pts;
82 struct trip_point tp[MAX_NR_TRIP]; 88 struct trip_point tp[MAX_NR_TRIP];
83 unsigned long cdev_binding; /* bitmap 89 unsigned long cdev_binding; /* bitmap for attached cdevs */
84 /* cdev bind trip points, allow one cd 90 /* cdev bind trip points, allow one cdev bind to multiple trips */
85 unsigned long trip_binding[MAX_NR_CDEV 91 unsigned long trip_binding[MAX_NR_CDEV];
86 }; 92 };
87 93
88 struct tmon_platform_data { 94 struct tmon_platform_data {
89 int nr_tz_sensor; 95 int nr_tz_sensor;
90 int nr_cooling_dev; 96 int nr_cooling_dev;
91 /* keep track of instance ids since th 97 /* keep track of instance ids since there might be gaps */
92 int max_tz_instance; 98 int max_tz_instance;
93 int max_cdev_instance; 99 int max_cdev_instance;
94 struct tz_info *tzi; 100 struct tz_info *tzi;
95 struct cdev_info *cdi; 101 struct cdev_info *cdi;
96 }; 102 };
97 103
98 struct control_ops { 104 struct control_ops {
99 void (*set_ratio)(unsigned long ratio) 105 void (*set_ratio)(unsigned long ratio);
100 unsigned long (*get_ratio)(unsigned lo 106 unsigned long (*get_ratio)(unsigned long ratio);
101 107
102 }; 108 };
103 109
104 enum cdev_types { 110 enum cdev_types {
105 CDEV_TYPE_PROC, 111 CDEV_TYPE_PROC,
106 CDEV_TYPE_FAN, 112 CDEV_TYPE_FAN,
107 CDEV_TYPE_MEM, 113 CDEV_TYPE_MEM,
108 CDEV_TYPE_NR, 114 CDEV_TYPE_NR,
109 }; 115 };
110 116
111 /* REVISIT: the idea is to group sensors if po 117 /* REVISIT: the idea is to group sensors if possible, e.g. on intel mid
112 * we have "skin0", "skin1", "sys", "msicdie" 118 * we have "skin0", "skin1", "sys", "msicdie"
113 * on DPTF enabled systems, we might have PCH, 119 * on DPTF enabled systems, we might have PCH, TSKN, TAMB, etc.
114 */ 120 */
115 enum tzone_types { 121 enum tzone_types {
116 TZONE_TYPE_ACPI, 122 TZONE_TYPE_ACPI,
117 TZONE_TYPE_PCH, 123 TZONE_TYPE_PCH,
118 TZONE_TYPE_NR, 124 TZONE_TYPE_NR,
119 }; 125 };
120 126
121 /* limit the output of PID controller adjustme 127 /* limit the output of PID controller adjustment */
122 #define LIMIT_HIGH (95) 128 #define LIMIT_HIGH (95)
123 #define LIMIT_LOW (2) 129 #define LIMIT_LOW (2)
124 130
125 struct pid_params { 131 struct pid_params {
126 double kp; /* Controller gain from Di 132 double kp; /* Controller gain from Dialog Box */
127 double ki; /* Time-constant for I act 133 double ki; /* Time-constant for I action from Dialog Box */
128 double kd; /* Time-constant for D act 134 double kd; /* Time-constant for D action from Dialog Box */
129 double ts; 135 double ts;
130 double k_lpf; 136 double k_lpf;
131 137
132 double t_target; 138 double t_target;
133 double y_k; 139 double y_k;
134 }; 140 };
135 141
136 extern int init_thermal_controller(void); 142 extern int init_thermal_controller(void);
137 extern void controller_handler(const double xk 143 extern void controller_handler(const double xk, double *yk);
138 144
139 extern struct tmon_platform_data ptdata; 145 extern struct tmon_platform_data ptdata;
140 extern struct pid_params p_param; 146 extern struct pid_params p_param;
141 147
142 extern FILE *tmon_log; 148 extern FILE *tmon_log;
143 extern int cur_thermal_record; /* index to the 149 extern int cur_thermal_record; /* index to the trec array */
144 extern struct thermal_data_record trec[]; 150 extern struct thermal_data_record trec[];
145 extern const char *trip_type_name[]; 151 extern const char *trip_type_name[];
146 extern unsigned long no_control; 152 extern unsigned long no_control;
147 153
148 extern void initialize_curses(void); 154 extern void initialize_curses(void);
149 extern void show_controller_stats(char *line); 155 extern void show_controller_stats(char *line);
150 extern void show_title_bar(void); 156 extern void show_title_bar(void);
151 extern void setup_windows(void); 157 extern void setup_windows(void);
152 extern void disable_tui(void); 158 extern void disable_tui(void);
153 extern void show_sensors_w(void); 159 extern void show_sensors_w(void);
154 extern void show_data_w(void); 160 extern void show_data_w(void);
155 extern void write_status_bar(int x, char *line 161 extern void write_status_bar(int x, char *line);
156 extern void show_control_w(); 162 extern void show_control_w();
157 163
158 extern void show_cooling_device(void); 164 extern void show_cooling_device(void);
159 extern void show_dialogue(void); 165 extern void show_dialogue(void);
160 extern int update_thermal_data(void); 166 extern int update_thermal_data(void);
161 167
162 extern int probe_thermal_sysfs(void); 168 extern int probe_thermal_sysfs(void);
163 extern void free_thermal_data(void); 169 extern void free_thermal_data(void);
164 extern void resize_handler(int sig); 170 extern void resize_handler(int sig);
165 extern void set_ctrl_state(unsigned long state 171 extern void set_ctrl_state(unsigned long state);
166 extern void get_ctrl_state(unsigned long *stat 172 extern void get_ctrl_state(unsigned long *state);
167 extern void *handle_tui_events(void *arg); 173 extern void *handle_tui_events(void *arg);
168 extern int sysfs_set_ulong(char *path, char *f 174 extern int sysfs_set_ulong(char *path, char *filename, unsigned long val);
169 extern int zone_instance_to_index(int zone_ins 175 extern int zone_instance_to_index(int zone_inst);
170 extern void close_windows(void); 176 extern void close_windows(void);
171 177
172 #define PT_COLOR_DEFAULT 1 178 #define PT_COLOR_DEFAULT 1
173 #define PT_COLOR_HEADER_BAR 2 179 #define PT_COLOR_HEADER_BAR 2
174 #define PT_COLOR_ERROR 3 180 #define PT_COLOR_ERROR 3
175 #define PT_COLOR_RED 4 181 #define PT_COLOR_RED 4
176 #define PT_COLOR_YELLOW 5 182 #define PT_COLOR_YELLOW 5
177 #define PT_COLOR_GREEN 6 183 #define PT_COLOR_GREEN 6
178 #define PT_COLOR_BRIGHT 7 184 #define PT_COLOR_BRIGHT 7
179 #define PT_COLOR_BLUE 8 185 #define PT_COLOR_BLUE 8
180 186
181 /* each thermal zone uses 12 chars, 8 for name 187 /* each thermal zone uses 12 chars, 8 for name, 2 for instance, 2 space
182 * also used to list trip points in forms of A 188 * also used to list trip points in forms of AAAC, which represents
183 * A: Active 189 * A: Active
184 * C: Critical 190 * C: Critical
185 */ 191 */
186 #define TZONE_RECORD_SIZE 12 192 #define TZONE_RECORD_SIZE 12
187 #define TZ_LEFT_ALIGN 32 193 #define TZ_LEFT_ALIGN 32
188 #define CDEV_NAME_SIZE 20 194 #define CDEV_NAME_SIZE 20
189 #define CDEV_FLAG_IN_CONTROL (1 << 0) 195 #define CDEV_FLAG_IN_CONTROL (1 << 0)
190 196
191 /* dialogue box starts */ 197 /* dialogue box starts */
192 #define DIAG_X 48 198 #define DIAG_X 48
193 #define DIAG_Y 8 199 #define DIAG_Y 8
194 #define THERMAL_SYSFS "/sys/class/thermal" 200 #define THERMAL_SYSFS "/sys/class/thermal"
195 #define CDEV "cooling_device" 201 #define CDEV "cooling_device"
196 #define TZONE "thermal_zone" 202 #define TZONE "thermal_zone"
197 #define TDATA_LEFT 16 203 #define TDATA_LEFT 16
198 #endif /* TMON_H */ 204 #endif /* TMON_H */
199 205
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.