src/lib/psensor.h

   1 /*
   2     Copyright (C) 2010-2011 jeanfi@gmail.com
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU 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
  20 #ifndef _PSENSOR_PSENSOR_H_
  21 #define _PSENSOR_PSENSOR_H_
  22
  23 #include "config.h"
  24 #include <sensors/sensors.h>
  25
  26 #include "color.h"
  27 #include "measure.h"
  28
  29 enum psensor_type {
  30         SENSOR_TYPE_TEMP = 0x0001,
  31         SENSOR_TYPE_FAN = 0x0002,
  32         SENSOR_TYPE_REMOTE = 0x0004,
  33
  34         SENSOR_TYPE_LMSENSOR = 0x0100,
  35         SENSOR_TYPE_NVIDIA_TEMP = 0x0200 | SENSOR_TYPE_TEMP,
  36         SENSOR_TYPE_HDD_TEMP = 0x0400 | SENSOR_TYPE_TEMP,
  37         SENSOR_TYPE_AMD = 0x1000,
  38
  39         SENSOR_TYPE_AMD_TEMP = SENSOR_TYPE_AMD | SENSOR_TYPE_TEMP,
  40         SENSOR_TYPE_AMD_FAN = SENSOR_TYPE_AMD | SENSOR_TYPE_FAN,
  41
  42         SENSOR_TYPE_LMSENSOR_TEMP = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_TEMP,
  43         SENSOR_TYPE_LMSENSOR_FAN = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_FAN
  44 };
  45
  46 struct psensor {
  47         /* Human readable name of the sensor.  It may not be uniq. */
  48         char *name;
  49
  50         /* Uniq id of the sensor */
  51         char *id;
  52
  53         /* lm-sensor */
  54         const sensors_chip_name *iname;
  55         const sensors_feature *feature;
  56
  57         /* Maximum length of 'values' */
  58         int values_max_length;
  59
  60         /* Last registered measures of the sensor.  Index 0 for the
  61            oldest measure.  */
  62         struct measure *measures;
  63
  64         /* Color of the sensor used for the graph */
  65         struct color *color;
  66
  67         /* Whether the sensor is displayed in the graph */
  68         int enabled;
  69
  70         /* see psensor_type */
  71         unsigned int type;
  72
  73         /* The maximum detected value of the sensor */
  74         double max;
  75
  76         /* The minimum detected value of the sensor */
  77         double min;
  78
  79         /*
  80            Whether alarm alerts is enabled for this sensor
  81          */
  82         int alarm_enabled;
  83
  84         /*
  85            An alarm is raised if the current sensor value is bigger. 0
  86            means no limit
  87          */
  88         double alarm_limit;
  89
  90         /* Whether the current value is bigger than 'alarm_limit'.  */
  91         int alarm_raised;
  92
  93         void (*cb_alarm_raised) (struct psensor *, void *);
  94         void *cb_alarm_raised_data;
  95
  96 #ifdef HAVE_NVIDIA
  97         /* Nvidia id for the nvctrl */
  98         int nvidia_id;
  99 #endif
 100 #ifdef HAVE_LIBATIADL
 101         /* AMD id for the aticonfig */
 102         int amd_id;
 103 #endif
 104
 105         char *url;
 106 };
 107
 108 struct psensor *psensor_create(char *id,
 109                                char *name, unsigned int type,
 110                                int values_max_length);
 111
 112 void psensor_values_resize(struct psensor *s, int new_size);
 113
 114 void psensor_free(struct psensor *sensor);
 115
 116 void psensor_list_free(struct psensor **sensors);
 117 int psensor_list_size(struct psensor **sensors);
 118
 119 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 120                                        const char *id);
 121
 122 /*
 123   Return 1 if there is at least one sensor of a given type, else
 124   returns 0 */
 125 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 126
 127 int is_temp_type(unsigned int type);
 128 int is_fan_type(unsigned int type);
 129
 130 double get_min_temp(struct psensor **sensors);
 131 double get_max_temp(struct psensor **sensors);
 132
 133 double get_min_rpm(struct psensor **sensors);
 134 double get_max_rpm(struct psensor **sensors);
 135
 136 /*
 137   Get the maximal current value of all sensors of a given type.
 138 */
 139 double
 140 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 141
 142 /*
 143   Converts the value of a sensor to a string.
 144
 145   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 146   or SENSOR_TYPE_LMSENSOR_FAN
 147 */
 148 char *psensor_value_to_string(unsigned int type, double value);
 149
 150 struct psensor **get_all_sensors(int values_max_length);
 151
 152 struct psensor **psensor_list_add(struct psensor **sensors,
 153                                   struct psensor *sensor);
 154
 155 void psensor_set_current_value(struct psensor *sensor, double value);
 156 void psensor_set_current_measure(struct psensor *sensor, double value,
 157                                  struct timeval tv);
 158
 159 double psensor_get_current_value(struct psensor *sensor);
 160
 161 struct measure *psensor_get_current_measure(struct psensor *sensor);
 162
 163 /*
 164   Returns a string representation of a psensor type.
 165 */
 166 const char *psensor_type_to_str(unsigned int type);
 167
 168 const char *psensor_type_to_unit_str(unsigned int type);
 169
 170 void psensor_list_update_measures(struct psensor **sensors);
 171
 172 void psensor_init();
 173
 174 void psensor_cleanup();
 175
 176 #endif