2 * Copyright (C) 2010-2014 jeanfi@gmail.com
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.
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.
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
19 #ifndef _PSENSOR_PSENSOR_H_
20 #define _PSENSOR_PSENSOR_H_
29 /* type of sensor values */
30 SENSOR_TYPE_TEMP = 0x00001,
31 SENSOR_TYPE_RPM = 0x00002,
32 SENSOR_TYPE_PERCENT = 0x00004,
34 /* Whether the sensor is remote */
35 SENSOR_TYPE_REMOTE = 0x00008,
37 /* Libraries used for retrieving sensor information */
38 SENSOR_TYPE_LMSENSOR = 0x00100,
39 SENSOR_TYPE_NVCTRL = 0x00200,
40 SENSOR_TYPE_GTOP = 0x00400,
41 SENSOR_TYPE_ATIADL = 0x00800,
42 SENSOR_TYPE_ATASMART = 0x01000,
43 SENSOR_TYPE_HDDTEMP = 0x02000,
44 SENSOR_TYPE_UDISKS2 = 0x800000,
46 /* Type of HW component */
47 SENSOR_TYPE_HDD = 0x04000,
48 SENSOR_TYPE_CPU = 0x08000,
49 SENSOR_TYPE_GPU = 0x10000,
50 SENSOR_TYPE_FAN = 0x20000,
52 SENSOR_TYPE_GRAPHICS = 0x40000,
53 SENSOR_TYPE_VIDEO = 0x80000,
54 SENSOR_TYPE_PCIE = 0x100000,
55 SENSOR_TYPE_MEMORY = 0x200000,
56 SENSOR_TYPE_AMBIENT = 0x400000,
59 SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
60 SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
64 /* Human readable name of the sensor. It may not be uniq. */
67 /* Uniq id of the sensor */
70 /* Name of the chip. */
73 /* Maximum length of 'values' */
74 int values_max_length;
76 /* Last registered measures of the sensor. Index 0 for the
78 struct measure *measures;
80 /* see psensor_type */
83 /* The maximum detected value of the sensor */
86 /* The minimum detected value of the sensor */
89 int alarm_high_threshold;
90 int alarm_low_threshold;
92 /* Whether an alarm is raised for this sensor */
95 void (*cb_alarm_raised)(struct psensor *, void *);
96 void *cb_alarm_raised_data;
99 /* AMD id for the aticonfig */
104 void (*provider_data_free_fct)(void *);
107 struct psensor *psensor_create(char *id,
111 int values_max_length);
113 void psensor_values_resize(struct psensor *s, int new_size);
115 void psensor_free(struct psensor *sensor);
117 void psensor_list_free(struct psensor **sensors);
118 int psensor_list_size(struct psensor **sensors);
120 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
123 int is_temp_type(unsigned int type);
125 double get_min_temp(struct psensor **sensors);
126 double get_max_temp(struct psensor **sensors);
128 double get_min_rpm(struct psensor **sensors);
129 double get_max_rpm(struct psensor **sensors);
132 * Converts the value of a sensor to a string.
134 * parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
135 * or SENSOR_TYPE_LMSENSOR_FAN
137 char *psensor_value_to_str(unsigned int type,
141 char *psensor_measure_to_str(const struct measure *m,
143 unsigned int use_celsius);
145 struct psensor **psensor_list_add(struct psensor **sensors,
146 struct psensor *sensor);
148 void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
150 struct psensor **psensor_list_copy(struct psensor **);
152 void psensor_set_current_value(struct psensor *sensor, double value);
153 void psensor_set_current_measure(struct psensor *sensor, double value,
156 double psensor_get_current_value(const struct psensor *);
158 struct measure *psensor_get_current_measure(struct psensor *sensor);
160 /* Returns a string representation of a psensor type. */
161 const char *psensor_type_to_str(unsigned int type);
163 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
165 double get_max_value(struct psensor **sensors, int type);
167 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
169 void psensor_log_measures(struct psensor **sensors);