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 <config.h>
  23
  24 #ifdef HAVE_ATASMART
  25 #include <atasmart.h>
  26 #endif
  27
  28 #include <bool.h>
  29 #include <color.h>
  30 #include <measure.h>
  31 #include <plog.h>
  32
  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         SENSOR_TYPE_UDISKS2 = 0x800000,
  51
  52         /* Type of HW component */
  53         SENSOR_TYPE_HDD = 0x04000,
  54         SENSOR_TYPE_CPU = 0x08000,
  55         SENSOR_TYPE_GPU = 0x10000,
  56         SENSOR_TYPE_FAN = 0x20000,
  57
  58         SENSOR_TYPE_GRAPHICS = 0x40000,
  59         SENSOR_TYPE_VIDEO = 0x80000,
  60         SENSOR_TYPE_PCIE = 0x100000,
  61         SENSOR_TYPE_MEMORY = 0x200000,
  62         SENSOR_TYPE_AMBIENT = 0x400000,
  63
  64         /* Combinations */
  65         SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
  66         SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
  67 };
  68
  69 struct psensor {
  70         /* Human readable name of the sensor.  It may not be uniq. */
  71         char *name;
  72
  73         /* Uniq id of the sensor */
  74         char *id;
  75
  76         /* Name of the chip. */
  77         char *chip;
  78
  79         /* Maximum length of 'values' */
  80         int values_max_length;
  81
  82         /* Last registered measures of the sensor.  Index 0 for the
  83          * oldest measure.  */
  84         struct measure *measures;
  85
  86         /* Color of the sensor used for the graph */
  87         struct color *color;
  88
  89         /* Whether the graph sensor is displayed. */
  90         bool graph_enabled;
  91
  92         /* see psensor_type */
  93         unsigned int type;
  94
  95         /* The maximum detected value of the sensor */
  96         double max;
  97
  98         /* The minimum detected value of the sensor */
  99         double min;
 100
 101         /* Whether alarm alert is enabled for this sensor */
 102         bool alarm_enabled;
 103
 104         int alarm_high_threshold;
 105         int alarm_low_threshold;
 106
 107         /* Whether an alarm is raised for this sensor */
 108         unsigned int alarm_raised;
 109
 110         void (*cb_alarm_raised)(struct psensor *, void *);
 111         void *cb_alarm_raised_data;
 112
 113 #ifdef HAVE_LIBATIADL
 114         /* AMD id for the aticonfig */
 115         int amd_id;
 116 #endif
 117 #ifdef HAVE_ATASMART
 118         SkDisk *disk;
 119 #endif
 120
 121         void *provider_data;
 122         void (*provider_data_free_fct)(void *);
 123
 124         char *url;
 125
 126         bool appindicator_enabled;
 127 };
 128
 129 struct psensor *psensor_create(char *id,
 130                                char *name,
 131                                char *chip,
 132                                unsigned int type,
 133                                int values_max_length);
 134
 135 void psensor_values_resize(struct psensor *s, int new_size);
 136
 137 void psensor_free(struct psensor *sensor);
 138
 139 void psensor_list_free(struct psensor **sensors);
 140 int psensor_list_size(struct psensor **sensors);
 141
 142 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
 143
 144 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 145                                        const char *id);
 146
 147 int is_temp_type(unsigned int type);
 148
 149 double get_min_temp(struct psensor **sensors);
 150 double get_max_temp(struct psensor **sensors);
 151
 152 double get_min_rpm(struct psensor **sensors);
 153 double get_max_rpm(struct psensor **sensors);
 154
 155 /* Get the maximal current value of all sensors of a given type. */
 156 double
 157 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 158
 159 /*
 160  * Converts the value of a sensor to a string.
 161  *
 162  * parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 163  * or SENSOR_TYPE_LMSENSOR_FAN
 164  */
 165 char *psensor_value_to_str(unsigned int type,
 166                            double value,
 167                            int use_celsius);
 168
 169 char *psensor_measure_to_str(const struct measure *m,
 170                              unsigned int type,
 171                              unsigned int use_celsius);
 172
 173 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 174
 175 struct psensor **psensor_list_add(struct psensor **sensors,
 176                                   struct psensor *sensor);
 177
 178 void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
 179
 180 struct psensor **psensor_list_copy(struct psensor **);
 181
 182 void psensor_set_current_value(struct psensor *sensor, double value);
 183 void psensor_set_current_measure(struct psensor *sensor, double value,
 184                                  struct timeval tv);
 185
 186 double psensor_get_current_value(const struct psensor *);
 187
 188 struct measure *psensor_get_current_measure(struct psensor *sensor);
 189
 190 /* Returns a string representation of a psensor type. */
 191 const char *psensor_type_to_str(unsigned int type);
 192
 193 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
 194
 195 double get_max_value(struct psensor **sensors, int type);
 196
 197 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
 198
 199 void psensor_log_measures(struct psensor **sensors);
 200
 201 #endif