tools/thermal/tmon/tmon.h

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