diff --git a/doc/developers/proc b/doc/developers/proc index e8da0f7b..bdec0ace 100644 --- a/doc/developers/proc +++ b/doc/developers/proc @@ -1,5 +1,5 @@ -Naming and data standards under /proc -------------------------------------- +Naming and data format standards under /proc +-------------------------------------------- The libsensors library offers an interface to the raw sensors data through the sysctl interface. See the 'sysctl' file and the libsensors @@ -11,12 +11,28 @@ the drivers follow, so that a program can access this data in a consistent way. Note that not all chip drivers adhere to this standard. We will attempt to migrate older drivers to this standard, -and ensure that new drivers follow this standard. +and ensure that new drivers follow this standard wherever possible. +If you are developing a userspace application please send us +feedback on this standard. + +Note that motherboards vary widely in the connections to sensor chips. +There is no standard that ensures, for example, that the second +temperature sensor is connected to the CPU, or that the second +fan is on the CPU. Therefore, programs must provide a facility +for the user to label or bind /proc entries for display. +Sensor chips often have unused inputs that should be ignored +by user programs. As each chip gets its own directory under /proc/sys/dev/sensors. The format is either chip-i2c-bus-hexaddress or chip-isa-hexaddress. (Exception - chip lm78-j has a '-' in it - should this be changed??) +All /proc values are integers or floating point numbers. +There is no facility in the lm_sensors package for drivers +to output general strings via /proc. + +------------------------------------------------------------------------- + /proc entries are as follows: @@ -29,8 +45,11 @@ alarms 1 Alarm bitmask. Generally a straight representation of a chips' internal alarm registers; no standard. -beep 2 Beep or interrupt bitmask. - Same format as 'alarms' with same bit locations. +beep 2 Beep/interrupt enable and bitmask. + The first value is 0 or 1 to globally disable + or enable the beeps. + The second value is a bitmask, with the + same format as 'alarms' with same bit locations. fan[1-3] 2 Fan min and input value. Two integers indicating RPM.