src/lib/psensor.h

   1 /*
   2  * Copyright (C) 2010-2012 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 #include <sensors/sensors.h>
  24
  25 #ifdef HAVE_ATASMART
  26 #include <atasmart.h>
  27 #endif
  28
  29 #include "color.h"
  30 #include "log.h"
  31 #include "measure.h"
  32
  33 enum psensor_type {
  34         SENSOR_TYPE_TEMP = 0x0001,
  35         SENSOR_TYPE_FAN = 0x0002,
  36         SENSOR_TYPE_REMOTE = 0x0004,
  37
  38         SENSOR_TYPE_LMSENSOR = 0x0100,
  39         SENSOR_TYPE_NVIDIA_TEMP = 0x0200 | SENSOR_TYPE_TEMP,
  40         SENSOR_TYPE_HDD_TEMP = 0x0400 | SENSOR_TYPE_TEMP,
  41         SENSOR_TYPE_CPU_USAGE = 0x0800,
  42         SENSOR_TYPE_AMD = 0x1000,
  43
  44         SENSOR_TYPE_HDD_TEMP_ATASMART = 0x2000 | SENSOR_TYPE_HDD_TEMP,
  45         SENSOR_TYPE_HDD_TEMP_HDDTEMP = 0x4000 | SENSOR_TYPE_HDD_TEMP,
  46
  47         SENSOR_TYPE_AMD_TEMP = SENSOR_TYPE_AMD | SENSOR_TYPE_TEMP,
  48         SENSOR_TYPE_AMD_FAN = SENSOR_TYPE_AMD | SENSOR_TYPE_FAN,
  49
  50         SENSOR_TYPE_LMSENSOR_TEMP = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_TEMP,
  51         SENSOR_TYPE_LMSENSOR_FAN = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_FAN
  52 };
  53
  54 struct psensor {
  55         /* Human readable name of the sensor.  It may not be uniq. */
  56         char *name;
  57
  58         /* Uniq id of the sensor */
  59         char *id;
  60
  61         /* lm-sensor */
  62         const sensors_chip_name *iname;
  63         const sensors_feature *feature;
  64
  65         /* Maximum length of 'values' */
  66         int values_max_length;
  67
  68         /* Last registered measures of the sensor.  Index 0 for the
  69            oldest measure.  */
  70         struct measure *measures;
  71
  72         /* Color of the sensor used for the graph */
  73         struct color *color;
  74
  75         /* Whether the sensor is displayed in the graph */
  76         int enabled;
  77
  78         /* see psensor_type */
  79         unsigned int type;
  80
  81         /* The maximum detected value of the sensor */
  82         double max;
  83
  84         /* The minimum detected value of the sensor */
  85         double min;
  86
  87         /*
  88            Whether alarm alerts is enabled for this sensor
  89          */
  90         int alarm_enabled;
  91
  92         /*
  93            An alarm is raised if the current sensor value is bigger. 0
  94            means no limit
  95          */
  96         double alarm_limit;
  97
  98         /* Whether the current value is bigger than 'alarm_limit'.  */
  99         int alarm_raised;
 100
 101         void (*cb_alarm_raised) (struct psensor *, void *);
 102         void *cb_alarm_raised_data;
 103
 104 #ifdef HAVE_NVIDIA
 105         /* Nvidia id for the nvctrl */
 106         int nvidia_id;
 107 #endif
 108 #ifdef HAVE_LIBATIADL
 109         /* AMD id for the aticonfig */
 110         int amd_id;
 111 #endif
 112 #ifdef HAVE_ATASMART
 113         SkDisk *disk;
 114 #endif
 115
 116         char *url;
 117 };
 118
 119 struct psensor *psensor_create(char *id,
 120                                char *name, unsigned int type,
 121                                int values_max_length);
 122
 123 void psensor_values_resize(struct psensor *s, int new_size);
 124
 125 void psensor_free(struct psensor *sensor);
 126
 127 void psensor_list_free(struct psensor **sensors);
 128 int psensor_list_size(struct psensor **sensors);
 129
 130 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 131                                        const char *id);
 132
 133 /*
 134   Return 1 if there is at least one sensor of a given type, else
 135   returns 0 */
 136 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 137
 138 int is_temp_type(unsigned int type);
 139 int is_fan_type(unsigned int type);
 140
 141 double get_min_temp(struct psensor **sensors);
 142 double get_max_temp(struct psensor **sensors);
 143
 144 double get_min_rpm(struct psensor **sensors);
 145 double get_max_rpm(struct psensor **sensors);
 146
 147 /*
 148   Get the maximal current value of all sensors of a given type.
 149 */
 150 double
 151 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 152
 153 /*
 154   Converts the value of a sensor to a string.
 155
 156   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 157   or SENSOR_TYPE_LMSENSOR_FAN
 158 */
 159 char *psensor_value_to_str(unsigned int type,
 160                            double value,
 161                            int use_celcius);
 162
 163 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 164
 165 struct psensor **psensor_list_add(struct psensor **sensors,
 166                                   struct psensor *sensor);
 167
 168 void psensor_set_current_value(struct psensor *sensor, double value);
 169 void psensor_set_current_measure(struct psensor *sensor, double value,
 170                                  struct timeval tv);
 171
 172 double psensor_get_current_value(struct psensor *sensor);
 173
 174 struct measure *psensor_get_current_measure(struct psensor *sensor);
 175
 176 /*
 177   Returns a string representation of a psensor type.
 178 */
 179 const char *psensor_type_to_str(unsigned int type);
 180
 181 const char *psensor_type_to_unit_str(unsigned int type, int use_celcius);
 182
 183 void psensor_list_update_measures(struct psensor **sensors);
 184
 185 void psensor_init();
 186
 187 void psensor_cleanup();
 188
 189 double get_max_value(struct psensor **sensors, int type);
 190
 191 double celcius_to_fahrenheit(double c);
 192 double fahrenheit_to_celcius(double c);
 193
 194
 195 void psensor_log_measures(struct psensor **sensors);
 196
 197 #endif