src/lib/psensor.h

   1 /*
   2  * Copyright (C) 2010-2014 jeanfi@gmail.com
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301 USA
  18  */
  19 #ifndef _PSENSOR_PSENSOR_H_
  20 #define _PSENSOR_PSENSOR_H_
  21
  22 #include <sensors/sensors.h>
  23
  24 #include "config.h"
  25 #ifdef HAVE_ATASMART
  26 #include <atasmart.h>
  27 #endif
  28
  29 #include "bool.h"
  30 #include "color.h"
  31 #include <plog.h>
  32 #include "measure.h"
  33
  34 enum psensor_type {
  35         /* type of sensor values */
  36         SENSOR_TYPE_TEMP = 0x00001,
  37         SENSOR_TYPE_RPM = 0x00002,
  38         SENSOR_TYPE_USAGE = 0x00004,
  39
  40         /* Whether the sensor is remote */
  41         SENSOR_TYPE_REMOTE = 0x00008,
  42
  43         /* Libraries used for retrieving sensor information */
  44         SENSOR_TYPE_LMSENSOR = 0x00100,
  45         SENSOR_TYPE_NVCTRL = 0x00200,
  46         SENSOR_TYPE_GTOP = 0x00400,
  47         SENSOR_TYPE_ATIADL = 0x00800,
  48         SENSOR_TYPE_ATASMART = 0x01000,
  49         SENSOR_TYPE_HDDTEMP = 0x02000,
  50
  51         /* Type of HW component */
  52         SENSOR_TYPE_HDD = 0x04000,
  53         SENSOR_TYPE_CPU = 0x08000,
  54         SENSOR_TYPE_GPU = 0x10000,
  55         SENSOR_TYPE_FAN = 0x20000,
  56
  57         SENSOR_TYPE_GRAPHICS = 0x40000,
  58         SENSOR_TYPE_VIDEO = 0x80000,
  59         SENSOR_TYPE_PCIE = 0x100000,
  60         SENSOR_TYPE_MEMORY = 0x200000,
  61
  62         /* Combinations */
  63         SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
  64         SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_USAGE)
  65 };
  66
  67 struct psensor {
  68         /* Human readable name of the sensor.  It may not be uniq. */
  69         char *name;
  70
  71         /* Uniq id of the sensor */
  72         char *id;
  73
  74         /* Name of the chip. */
  75         char *chip;
  76
  77         /* lm-sensor */
  78         const sensors_chip_name *iname;
  79         const sensors_feature *feature;
  80
  81         /* Maximum length of 'values' */
  82         int values_max_length;
  83
  84         /* Last registered measures of the sensor.  Index 0 for the
  85            oldest measure.  */
  86         struct measure *measures;
  87
  88         /* Color of the sensor used for the graph */
  89         struct color *color;
  90
  91         /* Whether the graph sensor is displayed. */
  92         bool graph_enabled;
  93
  94         /* see psensor_type */
  95         unsigned int type;
  96
  97         /* The maximum detected value of the sensor */
  98         double max;
  99
 100         /* The minimum detected value of the sensor */
 101         double min;
 102
 103         /* Whether alarm alert is enabled for this sensor */
 104         bool alarm_enabled;
 105
 106         int alarm_high_threshold;
 107         int alarm_low_threshold;
 108
 109         /* Whether an alarm is raised for this sensor */
 110         unsigned int alarm_raised;
 111
 112         void (*cb_alarm_raised) (struct psensor *, void *);
 113         void *cb_alarm_raised_data;
 114
 115 #ifdef HAVE_NVIDIA
 116         /* Nvidia id for the nvctrl */
 117         int nvidia_id;
 118 #endif
 119 #ifdef HAVE_LIBATIADL
 120         /* AMD id for the aticonfig */
 121         int amd_id;
 122 #endif
 123 #ifdef HAVE_ATASMART
 124         SkDisk *disk;
 125 #endif
 126         char *url;
 127
 128         bool appindicator_enabled;
 129 };
 130
 131 struct psensor *psensor_create(char *id,
 132                                char *name,
 133                                char *chip,
 134                                unsigned int type,
 135                                int values_max_length);
 136
 137 void psensor_values_resize(struct psensor *s, int new_size);
 138
 139 void psensor_free(struct psensor *sensor);
 140
 141 void psensor_list_free(struct psensor **sensors);
 142 int psensor_list_size(struct psensor **sensors);
 143
 144 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
 145
 146 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 147                                        const char *id);
 148
 149 /*
 150   Return 1 if there is at least one sensor of a given type, else
 151   returns 0 */
 152 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 153
 154 int is_temp_type(unsigned int type);
 155 int is_fan_type(unsigned int type);
 156
 157 double get_min_temp(struct psensor **sensors);
 158 double get_max_temp(struct psensor **sensors);
 159
 160 double get_min_rpm(struct psensor **sensors);
 161 double get_max_rpm(struct psensor **sensors);
 162
 163 /*
 164   Get the maximal current value of all sensors of a given type.
 165 */
 166 double
 167 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 168
 169 /*
 170   Converts the value of a sensor to a string.
 171
 172   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 173   or SENSOR_TYPE_LMSENSOR_FAN
 174 */
 175 char *psensor_value_to_str(unsigned int type,
 176                            double value,
 177                            int use_celsius);
 178
 179 char *psensor_measure_to_str(const struct measure *m,
 180                              unsigned int type,
 181                              unsigned int use_celsius);
 182
 183 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 184
 185 struct psensor **psensor_list_add(struct psensor **sensors,
 186                                   struct psensor *sensor);
 187
 188 struct psensor **psensor_list_copy(struct psensor **);
 189
 190 void psensor_set_current_value(struct psensor *sensor, double value);
 191 void psensor_set_current_measure(struct psensor *sensor, double value,
 192                                  struct timeval tv);
 193
 194 double psensor_get_current_value(const struct psensor *);
 195
 196 struct measure *psensor_get_current_measure(struct psensor *sensor);
 197
 198 /*
 199   Returns a string representation of a psensor type.
 200 */
 201 const char *psensor_type_to_str(unsigned int type);
 202
 203 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
 204
 205 void psensor_list_update_measures(struct psensor **sensors);
 206
 207 void psensor_init();
 208
 209 void psensor_cleanup();
 210
 211 double get_max_value(struct psensor **sensors, int type);
 212
 213 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
 214
 215 void psensor_log_measures(struct psensor **sensors);
 216
 217 #endif