mirror of
https://github.com/lm-sensors/lm-sensors
synced 2025-09-05 16:55:45 +00:00
e01466d993
use it to retrieve a specific subfeature by type. While it is slighly less efficient than looping over sensors_get_all_subfeatures(), it often makes the application code much more elegant. git-svn-id: http://lm-sensors.org/svn/lm-sensors/branches/lm-sensors-3.0.0@4846 7894878c-1315-0410-8ee3-d5d059ff63e0
238 lines
8.5 KiB
C
238 lines
8.5 KiB
C
/*
|
|
sensors.h - Part of libsensors, a Linux library for reading sensor data.
|
|
Copyright (c) 1998, 1999 Frodo Looijaard <frodol@dds.nl>
|
|
Copyright (C) 2007 Jean Delvare <khali@linux-fr.org>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
#ifndef LIB_SENSORS_SENSORS_H
|
|
#define LIB_SENSORS_SENSORS_H
|
|
|
|
#include <stdio.h>
|
|
#include <limits.h>
|
|
|
|
/* Publicly accessible library functions */
|
|
|
|
#define SENSORS_CHIP_NAME_PREFIX_ANY NULL
|
|
#define SENSORS_CHIP_NAME_ADDR_ANY -1
|
|
|
|
#define SENSORS_BUS_TYPE_ANY (-1)
|
|
#define SENSORS_BUS_TYPE_I2C 0
|
|
#define SENSORS_BUS_TYPE_ISA 1
|
|
#define SENSORS_BUS_TYPE_PCI 2
|
|
#define SENSORS_BUS_TYPE_SPI 3
|
|
#define SENSORS_BUS_NR_ANY (-1)
|
|
#define SENSORS_BUS_NR_IGNORE (-2)
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
extern const char *libsensors_version;
|
|
|
|
typedef struct sensors_bus_id {
|
|
short type;
|
|
short nr;
|
|
} sensors_bus_id;
|
|
|
|
/* A chip name is encoded in this structure */
|
|
typedef struct sensors_chip_name {
|
|
char *prefix;
|
|
sensors_bus_id bus;
|
|
int addr;
|
|
char *path;
|
|
} sensors_chip_name;
|
|
|
|
/* Load the configuration file and the detected chips list. If this
|
|
returns a value unequal to zero, you are in trouble; you can not
|
|
assume anything will be initialized properly. If you want to
|
|
reload the configuration file, call sensors_cleanup() below before
|
|
calling sensors_init() again. */
|
|
int sensors_init(FILE *input);
|
|
|
|
/* Clean-up function: You can't access anything after
|
|
this, until the next sensors_init() call! */
|
|
void sensors_cleanup(void);
|
|
|
|
/* Parse a chip name to the internal representation. Return 0 on success, <0
|
|
on error. */
|
|
int sensors_parse_chip_name(const char *orig_name, sensors_chip_name *res);
|
|
|
|
/* Print a chip name from its internal representation. Note that chip should
|
|
not contain wildcard values! Return the number of characters printed on
|
|
success (same as snprintf), <0 on error. */
|
|
int sensors_snprintf_chip_name(char *str, size_t size,
|
|
const sensors_chip_name *chip);
|
|
|
|
/* This function returns the adapter name of a bus,
|
|
as used within the sensors_chip_name structure. If it could not be found,
|
|
it returns NULL */
|
|
const char *sensors_get_adapter_name(const sensors_bus_id *bus);
|
|
|
|
typedef struct sensors_feature sensors_feature;
|
|
|
|
/* Look up the label for a given feature. Note that chip should not
|
|
contain wildcard values! The returned string is newly allocated (free it
|
|
yourself). On failure, NULL is returned.
|
|
If no label exists for this feature, its name is returned itself. */
|
|
char *sensors_get_label(const sensors_chip_name *name,
|
|
const sensors_feature *feature);
|
|
|
|
/* Read the value of a subfeature of a certain chip. Note that chip should not
|
|
contain wildcard values! This function will return 0 on success, and <0
|
|
on failure. */
|
|
int sensors_get_value(const sensors_chip_name *name, int subfeat_nr,
|
|
double *value);
|
|
|
|
/* Set the value of a subfeature of a certain chip. Note that chip should not
|
|
contain wildcard values! This function will return 0 on success, and <0
|
|
on failure. */
|
|
int sensors_set_value(const sensors_chip_name *name, int subfeat_nr,
|
|
double value);
|
|
|
|
/* Execute all set statements for this particular chip. The chip may contain
|
|
wildcards! This function will return 0 on success, and <0 on failure. */
|
|
int sensors_do_chip_sets(const sensors_chip_name *name);
|
|
|
|
/* This function returns all detected chips that match a given chip name,
|
|
one by one. If no chip name is provided, all detected chips are returned.
|
|
To start at the beginning of the list, use 0 for nr; NULL is returned if
|
|
we are at the end of the list. Do not try to change these chip names, as
|
|
they point to internal structures! */
|
|
const sensors_chip_name *sensors_get_detected_chips(const sensors_chip_name
|
|
*match, int *nr);
|
|
|
|
/* These defines are used in the flags field of sensors_subfeature */
|
|
#define SENSORS_MODE_R 1
|
|
#define SENSORS_MODE_W 2
|
|
#define SENSORS_COMPUTE_MAPPING 4
|
|
|
|
/* This define is used in the mapping field of sensors_subfeature if no
|
|
mapping is available */
|
|
#define SENSORS_NO_MAPPING -1
|
|
|
|
/* These must match the subfeature constants below (shifted by 8 bits) */
|
|
typedef enum sensors_feature_type {
|
|
SENSORS_FEATURE_IN = 0x00,
|
|
SENSORS_FEATURE_FAN = 0x01,
|
|
SENSORS_FEATURE_TEMP = 0x02,
|
|
SENSORS_FEATURE_VID = 0x10,
|
|
SENSORS_FEATURE_BEEP_ENABLE = 0x11,
|
|
SENSORS_FEATURE_UNKNOWN = INT_MAX,
|
|
} sensors_feature_type;
|
|
|
|
/* This enum contains some "magic" used by sensors_read_dynamic_chip() from
|
|
lib/sysfs.c. All the sensor types (in, fan, temp, vid) are a multiple of
|
|
0x100 apart, and sensor subfeatures which should not have a compute
|
|
mapping to the _input subfeature start at 0x?10. */
|
|
typedef enum sensors_subfeature_type {
|
|
SENSORS_SUBFEATURE_IN_INPUT = 0x000,
|
|
SENSORS_SUBFEATURE_IN_MIN,
|
|
SENSORS_SUBFEATURE_IN_MAX,
|
|
SENSORS_SUBFEATURE_IN_ALARM = 0x010,
|
|
SENSORS_SUBFEATURE_IN_MIN_ALARM,
|
|
SENSORS_SUBFEATURE_IN_MAX_ALARM,
|
|
SENSORS_SUBFEATURE_IN_BEEP,
|
|
|
|
SENSORS_SUBFEATURE_FAN_INPUT = 0x100,
|
|
SENSORS_SUBFEATURE_FAN_MIN,
|
|
SENSORS_SUBFEATURE_FAN_ALARM = 0x110,
|
|
SENSORS_SUBFEATURE_FAN_FAULT,
|
|
SENSORS_SUBFEATURE_FAN_DIV,
|
|
SENSORS_SUBFEATURE_FAN_BEEP,
|
|
|
|
SENSORS_SUBFEATURE_TEMP_INPUT = 0x200,
|
|
SENSORS_SUBFEATURE_TEMP_MAX,
|
|
SENSORS_SUBFEATURE_TEMP_MAX_HYST,
|
|
SENSORS_SUBFEATURE_TEMP_MIN,
|
|
SENSORS_SUBFEATURE_TEMP_CRIT,
|
|
SENSORS_SUBFEATURE_TEMP_CRIT_HYST,
|
|
SENSORS_SUBFEATURE_TEMP_ALARM = 0x210,
|
|
SENSORS_SUBFEATURE_TEMP_MAX_ALARM,
|
|
SENSORS_SUBFEATURE_TEMP_MIN_ALARM,
|
|
SENSORS_SUBFEATURE_TEMP_CRIT_ALARM,
|
|
SENSORS_SUBFEATURE_TEMP_FAULT,
|
|
SENSORS_SUBFEATURE_TEMP_TYPE,
|
|
SENSORS_SUBFEATURE_TEMP_OFFSET,
|
|
SENSORS_SUBFEATURE_TEMP_BEEP,
|
|
|
|
SENSORS_SUBFEATURE_VID = 0x1000,
|
|
|
|
SENSORS_SUBFEATURE_BEEP_ENABLE = 0x1100,
|
|
|
|
SENSORS_SUBFEATURE_UNKNOWN = INT_MAX,
|
|
} sensors_subfeature_type;
|
|
|
|
/* Data about a single chip feature (or category leader) */
|
|
struct sensors_feature {
|
|
char *name;
|
|
int number;
|
|
sensors_feature_type type;
|
|
int first_subfeature;
|
|
};
|
|
|
|
/* Data about a single chip subfeature:
|
|
name is the string name used to refer to this subfeature (in config files)
|
|
number is the internal subfeature number, used in many functions to refer
|
|
to this subfeature
|
|
type is the subfeature type
|
|
mapping is either SENSORS_NO_MAPPING if this subfeature is the
|
|
main element of category; or it is the number of a subfeature with which
|
|
this subfeature is logically grouped (a group could be fan, fan_min
|
|
and fan_div)
|
|
flags is a bitfield, its value is a combination of SENSORS_MODE_R (readable),
|
|
SENSORS_MODE_W (writable) and SENSORS_COMPUTE_MAPPING (affected by the
|
|
computation rules of the main feature) */
|
|
typedef struct sensors_subfeature {
|
|
char *name;
|
|
int number;
|
|
sensors_subfeature_type type;
|
|
int mapping;
|
|
unsigned int flags;
|
|
} sensors_subfeature;
|
|
|
|
/* This returns all main features of a specific chip. nr is an internally
|
|
used variable. Set it to zero to start at the begin of the list. If no
|
|
more features are found NULL is returned.
|
|
Do not try to change the returned structure; you will corrupt internal
|
|
data structures. */
|
|
const sensors_feature *
|
|
sensors_get_features(const sensors_chip_name *name, int *nr);
|
|
|
|
/* This returns all subfeatures of a given main feature. nr is an internally
|
|
used variable. Set it to zero to start at the begin of the list. If no
|
|
more features are found NULL is returned.
|
|
Do not try to change the returned structure; you will corrupt internal
|
|
data structures. */
|
|
const sensors_subfeature *
|
|
sensors_get_all_subfeatures(const sensors_chip_name *name,
|
|
const sensors_feature *feature, int *nr);
|
|
|
|
/* This returns the subfeature of the given type for a given main feature,
|
|
if it exists, NULL otherwise.
|
|
Do not try to change the returned structure; you will corrupt internal
|
|
data structures. */
|
|
const sensors_subfeature *
|
|
sensors_get_subfeature(const sensors_chip_name *name,
|
|
const sensors_feature *feature,
|
|
sensors_subfeature_type type);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* def LIB_SENSORS_ERROR_H */
|