root/lm-sensors/branches/lm-sensors-3.0.0/lib/sensors.h @ 4702

Revision 4702, 6.7 KB (checked in by khali, 7 years ago)

Make sensors_match_chip internal to libsensors. It is no longer used by
applications in practice.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1/*
2    sensors.h - Part of libsensors, a Linux library for reading sensor data.
3    Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl>
4    Copyright (C) 2007        Jean Delvare <khali@linux-fr.org>
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19*/
20
21#ifndef LIB_SENSORS_SENSORS_H
22#define LIB_SENSORS_SENSORS_H
23
24#include <stdio.h>
25#include <limits.h>
26
27/* Publicly accessible library functions */
28
29#define SENSORS_CHIP_NAME_PREFIX_ANY NULL
30#define SENSORS_CHIP_NAME_ADDR_ANY -1
31
32#define SENSORS_BUS_TYPE_ANY    (-1)
33#define SENSORS_BUS_TYPE_I2C    0
34#define SENSORS_BUS_TYPE_ISA    1
35#define SENSORS_BUS_TYPE_PCI    2
36#define SENSORS_BUS_TYPE_SPI    3
37#define SENSORS_BUS_NR_ANY      (-1)
38#define SENSORS_BUS_NR_IGNORE   (-2)
39
40#ifdef __cplusplus
41extern "C" {
42#endif /* __cplusplus */
43
44extern const char *libsensors_version;
45
46typedef struct sensors_bus_id {
47        short type;
48        short nr;
49} sensors_bus_id;
50
51/* A chip name is encoded in this structure */
52typedef struct sensors_chip_name {
53        char *prefix;
54        sensors_bus_id bus;
55        int addr;
56        char *path;
57} sensors_chip_name;
58
59/* Load the configuration file and the detected chips list. If this
60   returns a value unequal to zero, you are in trouble; you can not
61   assume anything will be initialized properly. If you want to
62   reload the configuration file, call sensors_cleanup() below before
63   calling sensors_init() again. */
64int sensors_init(FILE *input);
65
66/* Clean-up function: You can't access anything after
67   this, until the next sensors_init() call! */
68void sensors_cleanup(void);
69
70/* Parse a chip name to the internal representation. Return 0 on success, <0
71   on error. */
72int sensors_parse_chip_name(const char *orig_name, sensors_chip_name *res);
73
74/* Print a chip name from its internal representation. Note that chip should
75   not contain wildcard values! Return the number of characters printed on
76   success (same as snprintf), <0 on error. */
77int sensors_snprintf_chip_name(char *str, size_t size,
78                               const sensors_chip_name *chip);
79
80/* This function returns the adapter name of a bus,
81   as used within the sensors_chip_name structure. If it could not be found,
82   it returns NULL */
83const char *sensors_get_adapter_name(const sensors_bus_id *bus);
84
85/* Look up the label which belongs to this chip. Note that chip should not
86   contain wildcard values! The returned string is newly allocated (free it
87   yourself). On failure, NULL is returned.
88   If no label exists for this feature, its name is returned itself. */
89char *sensors_get_label(const sensors_chip_name *name, int feature);
90
91/* Read the value of a feature of a certain chip. Note that chip should not
92   contain wildcard values! This function will return 0 on success, and <0
93   on failure.  */
94int sensors_get_value(const sensors_chip_name *name, int feature,
95                      double *value);
96
97/* Set the value of a feature of a certain chip. Note that chip should not
98   contain wildcard values! This function will return 0 on success, and <0
99   on failure. */
100int sensors_set_value(const sensors_chip_name *name, int feature,
101                      double value);
102
103/* Execute all set statements for this particular chip. The chip may contain
104   wildcards!  This function will return 0 on success, and <0 on failure. */
105int sensors_do_chip_sets(const sensors_chip_name *name);
106
107/* This function returns all detected chips that match a given chip name,
108   one by one. If no chip name is provided, all detected chips are returned.
109   To start at the beginning of the list, use 0 for nr; NULL is returned if
110   we are at the end of the list. Do not try to change these chip names, as
111   they point to internal structures! */
112const sensors_chip_name *sensors_get_detected_chips(const sensors_chip_name
113                                                    *match, int *nr);
114
115/* These defines are used in the mode field of sensors_feature_data */
116#define SENSORS_MODE_R 1
117#define SENSORS_MODE_W 2
118
119/* This define is used in the mapping field of sensors_feature_data if no
120   mapping is available */
121#define SENSORS_NO_MAPPING -1
122
123/* This enum contains some "magic" used by sensors_read_dynamic_chip() from
124   lib/sysfs.c. All the sensor types (in, fan, temp, vid) are a multiple of
125   0x100 apart, and sensor features which should not have a compute_mapping to
126   the _input feature start at 0x?10. */
127typedef enum sensors_feature_type {
128        SENSORS_FEATURE_IN = 0x000,
129        SENSORS_FEATURE_IN_MIN,
130        SENSORS_FEATURE_IN_MAX,
131        SENSORS_FEATURE_IN_ALARM = 0x010,
132        SENSORS_FEATURE_IN_MIN_ALARM,
133        SENSORS_FEATURE_IN_MAX_ALARM,
134
135        SENSORS_FEATURE_FAN = 0x100,
136        SENSORS_FEATURE_FAN_MIN,
137        SENSORS_FEATURE_FAN_ALARM = 0x110,
138        SENSORS_FEATURE_FAN_FAULT,
139        SENSORS_FEATURE_FAN_DIV,
140
141        SENSORS_FEATURE_TEMP = 0x200,
142        SENSORS_FEATURE_TEMP_MAX,
143        SENSORS_FEATURE_TEMP_MAX_HYST,
144        SENSORS_FEATURE_TEMP_MIN,
145        SENSORS_FEATURE_TEMP_CRIT,
146        SENSORS_FEATURE_TEMP_CRIT_HYST,
147        SENSORS_FEATURE_TEMP_ALARM = 0x210,
148        SENSORS_FEATURE_TEMP_MAX_ALARM,
149        SENSORS_FEATURE_TEMP_MIN_ALARM,
150        SENSORS_FEATURE_TEMP_CRIT_ALARM,
151        SENSORS_FEATURE_TEMP_FAULT,
152        SENSORS_FEATURE_TEMP_SENS,
153
154        SENSORS_FEATURE_VID = 0x300,
155
156        SENSORS_FEATURE_UNKNOWN = INT_MAX,
157
158        /* special the largest number of subfeatures used, iow the
159           highest ## from all the 0x?## above + 1*/
160        SENSORS_FEATURE_MAX_SUB_FEATURES = 22
161} sensors_feature_type;
162
163/* This structure is used when you want to get all features of a specific
164   chip. */
165typedef struct sensors_feature_data {
166        int number;
167        char *name;
168        sensors_feature_type type;
169        int mapping;
170        int compute_mapping;
171        int mode;
172} sensors_feature_data;
173
174/* This returns all features of a specific chip. They are returned in
175   bunches: everything with the same mapping is returned just after each
176   other, with the master feature in front (that feature does not map to
177   itself, but has SENSORS_NO_MAPPING as mapping field). nr is
178   an internally used variable. Set it to zero to start again at the
179   begin of the list. If no more features are found NULL is returned.
180   Do not try to change the returned structure; you will corrupt internal
181   data structures. */
182const sensors_feature_data *sensors_get_all_features
183             (const sensors_chip_name *name, int *nr);
184
185#ifdef __cplusplus
186}
187#endif /* __cplusplus */
188
189#endif /* def LIB_SENSORS_ERROR_H */
Note: See TracBrowser for help on using the browser.