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