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_PERCENT = 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         SENSOR_TYPE_AMBIENT = 0x400000,
  62
  63         /* Combinations */
  64         SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
  65         SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
  66 };
  67
  68 struct psensor {
  69         /* Human readable name of the sensor.  It may not be uniq. */
  70         char *name;
  71
  72         /* Uniq id of the sensor */
  73         char *id;
  74
  75         /* Name of the chip. */
  76         char *chip;
  77
  78         /* lm-sensor */
  79         const sensors_chip_name *iname;
  80         const sensors_feature *feature;
  81
  82         /* Maximum length of 'values' */
  83         int values_max_length;
  84
  85         /* Last registered measures of the sensor.  Index 0 for the
  86            oldest measure.  */
  87         struct measure *measures;
  88
  89         /* Color of the sensor used for the graph */
  90         struct color *color;
  91
  92         /* Whether the graph sensor is displayed. */
  93         bool graph_enabled;
  94
  95         /* see psensor_type */
  96         unsigned int type;
  97
  98         /* The maximum detected value of the sensor */
  99         double max;
 100
 101         /* The minimum detected value of the sensor */
 102         double min;
 103
 104         /* Whether alarm alert is enabled for this sensor */
 105         bool alarm_enabled;
 106
 107         int alarm_high_threshold;
 108         int alarm_low_threshold;
 109
 110         /* Whether an alarm is raised for this sensor */
 111         unsigned int alarm_raised;
 112
 113         void (*cb_alarm_raised) (struct psensor *, void *);
 114         void *cb_alarm_raised_data;
 115
 116 #ifdef HAVE_NVIDIA
 117         /* Nvidia id for the nvctrl */
 118         int nvidia_id;
 119 #endif
 120 #ifdef HAVE_LIBATIADL
 121         /* AMD id for the aticonfig */
 122         int amd_id;
 123 #endif
 124 #ifdef HAVE_ATASMART
 125         SkDisk *disk;
 126 #endif
 127         char *url;
 128
 129         bool appindicator_enabled;
 130 };
 131
 132 struct psensor *psensor_create(char *id,
 133                                char *name,
 134                                char *chip,
 135                                unsigned int type,
 136                                int values_max_length);
 137
 138 void psensor_values_resize(struct psensor *s, int new_size);
 139
 140 void psensor_free(struct psensor *sensor);
 141
 142 void psensor_list_free(struct psensor **sensors);
 143 int psensor_list_size(struct psensor **sensors);
 144
 145 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
 146
 147 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 148                                        const char *id);
 149
 150 /*
 151   Return 1 if there is at least one sensor of a given type, else
 152   returns 0 */
 153 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 154
 155 int is_temp_type(unsigned int type);
 156 int is_fan_type(unsigned int type);
 157
 158 double get_min_temp(struct psensor **sensors);
 159 double get_max_temp(struct psensor **sensors);
 160
 161 double get_min_rpm(struct psensor **sensors);
 162 double get_max_rpm(struct psensor **sensors);
 163
 164 /*
 165   Get the maximal current value of all sensors of a given type.
 166 */
 167 double
 168 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 169
 170 /*
 171   Converts the value of a sensor to a string.
 172
 173   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 174   or SENSOR_TYPE_LMSENSOR_FAN
 175 */
 176 char *psensor_value_to_str(unsigned int type,
 177                            double value,
 178                            int use_celsius);
 179
 180 char *psensor_measure_to_str(const struct measure *m,
 181                              unsigned int type,
 182                              unsigned int use_celsius);
 183
 184 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 185
 186 struct psensor **psensor_list_add(struct psensor **sensors,
 187                                   struct psensor *sensor);
 188
 189 struct psensor **psensor_list_copy(struct psensor **);
 190
 191 void psensor_set_current_value(struct psensor *sensor, double value);
 192 void psensor_set_current_measure(struct psensor *sensor, double value,
 193                                  struct timeval tv);
 194
 195 double psensor_get_current_value(const struct psensor *);
 196
 197 struct measure *psensor_get_current_measure(struct psensor *sensor);
 198
 199 /*
 200   Returns a string representation of a psensor type.
 201 */
 202 const char *psensor_type_to_str(unsigned int type);
 203
 204 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
 205
 206 void psensor_list_update_measures(struct psensor **sensors);
 207
 208 void psensor_init();
 209
 210 void psensor_cleanup();
 211
 212 double get_max_value(struct psensor **sensors, int type);
 213
 214 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
 215
 216 void psensor_log_measures(struct psensor **sensors);
 217
 218 #endif