From 95003a7c4bf48e7e619eb7496fd5b238b599368d Mon Sep 17 00:00:00 2001 From: "Mark D. Studebaker" Date: Sat, 10 Feb 2001 20:14:52 +0000 Subject: [PATCH] format help a little better at top of sensors.conf, add temp limit example. git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@1020 7894878c-1315-0410-8ee3-d5d059ff63e0 --- CHANGES | 3 + etc/sensors.conf.eg | 193 ++++++++++++++++++++++++++++---------------- 2 files changed, 128 insertions(+), 68 deletions(-) diff --git a/CHANGES b/CHANGES index 59a408d6..50ab8af9 100644 --- a/CHANGES +++ b/CHANGES @@ -25,6 +25,7 @@ ask CVS about it: File doc/FAQ: Updates File doc/chips/via686a: Claim support for 686b. File sensors.conf.eg: Adjust as99127f in5 (-12V) and temp2 calculations + File sensors.conf.eg: Enhance help comments in file File sensors.c: Add xxx_init() calls for drivers added to mkpatch in 2.5.5. Include file i2c-isa.h: No longer required, moved to i2c.h in i2c package Include file sensors.h: Most contents moved to i2c-proc.h in i2c package @@ -267,8 +268,10 @@ ask CVS about it: 2.1.58 Modules: Somewhat less verbose on transfers Module lm78.o now recognizes and handles lm78-j and lm79 + 2.0.1 (1998121?) Module gl518sm.o updates, to make it actually work Module lm75.o high/low-byte swapping write bug fixed + 2.0.0 (19981209) Initial release diff --git a/etc/sensors.conf.eg b/etc/sensors.conf.eg index eba88145..e4d3227c 100644 --- a/etc/sensors.conf.eg +++ b/etc/sensors.conf.eg @@ -11,19 +11,25 @@ # # ########################################################################## # +# +# OVERVIEW +# -------- # This configuration file will be used by all userspace applications # linked to libsensors. It is NOT used by the lm_sensors drivers directly. - +# # This config file consists of two parts: the heavily commented LM78 # example, and the real parts. Search for '####' if you want to skip # to the real stuff. - +# # Hash marks introduce comments, which continue until the end of a line # # Identifiers consisting of only digits and letters can be used # unquoted; other identifiers must be quoted. Escape characters within # quotes operate like those in C. - +# +# +# CHIP LINES +# ---------- # A 'chip' line specifies what the following 'label', 'compute', 'set' and # 'ignore' lines refer to. In this case, until the # next 'chip' line, everything refers to all lm78, lm78-j and lm79 @@ -35,110 +41,154 @@ # lm78-* to "This", and later on the in0 label for lm78-isa-* to "That", # "That" is used for LM78 chips on the ISA bus, and "This" for LM78 # chips on a non-ISA bus. - -#chip "lm78-*" "lm78-j-*" "lm79-*" - +# +# chip "lm78-*" "lm78-j-*" "lm79-*" +# +# +# FEATURE NAMES +# ------------- +# Feature names are used in 'label', 'compute', 'set', and 'ignore' lines. +# Example feature names are 'in0', 'temp2', 'in3_min', and 'temp3_over'. +# These features are defined for each chip in lib/chips.c. +# Undefined features will be silently ignored!!!! +# If you have trouble, verify the features in lib/chips.c!!! +# +# +# LABEL LINES +# ----------- # A label line describes what a certain feature stands for on your # mainboard. Programs can retrieve these names and display them. # If no label is specified for a certain feature, the default name # (ie. 'fan1' for fan1) is used. - +# # If you specify a label for in1, this label is also used for in1_min and # in1_max, unless they have their own labels declared. There are several # of these logical groups. - -# These are as advised in the LM78 and LM79 data sheets, and used on almost -# any mainboard we have seen. - -# label in0 "VCore 1" -# label in1 "VCore 2" -# label in2 "+3.3V" -# label in3 "+5V" -# label in4 "+12V" -# label in5 "-12V" -# label in6 "-5V" - +# +# These are as advised in the LM78 and LM79 data sheets, and used on most +# boards we have seen. +# +# label in0 "VCore 1" +# label in1 "VCore 2" +# label in2 "+3.3V" +# label in3 "+5V" +# label in4 "+12V" +# label in5 "-12V" +# label in6 "-5V" +# +# +# COMPUTE LINES +# ------------- # A compute line describes how to scale a certain feature. There are # two expressions in it: the first describes how the /proc value must # be translated to a user value, the second how a user value must be # translated to a /proc value. '@' is the value to operate on. You may # refer to other readable features (like '2 * vid'). - +# # Like for the label statement, there are logical groups here. They are # sometimes a bit different, though. For example, fan1_div is in the # logical label group of fan1 (it gets the same label if none is declared # for it), but it is not in the compute group of fan1 (as it uses a # completely different system of values). - -# For positive voltages (in0..in4), two resistors are used, with the following +# +# +# VOLTAGE COMPUTATION DETAILS +# --------------------------- +# Most voltage sensors in sensor chips have a range of 0 to 4.096 Volts. +# This is generally sufficient for the 3.3 and CPU (2.5V, for example) +# supply voltages, so the sensor chip reading is the actual voltage. +# +# Other supply voltages must be scaled with an external resistor network. +# The chip driver generally reports the 'raw' value 0 - 4.09 V, and the +# userspace application must convert this raw value to an actual voltage. +# The 'compute' lines provide this facility. +# +# Unfortunately the resistor values vary among motherboard types. +# Therefore you may have to adjust the computations in this file +# to match your motherboard. +# +# For positive voltages (in3, in4), two resistors are used, with the following # formula (R1,R2: resistor values, Vs: read voltage, Vin: pin voltage) -# R1 = R2 * (Vs/Vin - 1) +# R1 = R2 * (Vs/Vin - 1) # For negative voltages (in5, in6) two resistors are used, with the following # formula (Rin,Rf: resistor values, Vs: read voltage, Vin: pin voltage) -# Rin = (Vs * Rf) / Vin - +# Rin = (Vs * Rf) / Vin +# # Here are the official LM78 and LM79 data sheet values. -# Vs R1,Rin R2,Rf Vin -# in3 +5.0 6.8 10 +2.98 -# in4 +12.0 30 10 +3.00 -# in5 -12.0 240 60 +3.00 -# in6 -5.0 100 60 +3.00 - +# Vs R1,Rin R2,Rf Vin +# in3 +5.0 6.8 10 +2.98 +# in4 +12.0 30 10 +3.00 +# in5 -12.0 240 60 +3.00 +# in6 -5.0 100 60 +3.00 +# # These would lead to these declarations: -# compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) -# compute in4 ((30/10)+1)*@ , @/((30/10)+1) -# compute in5 -(240/60)*@ , -@/(240/60) -# compute in6 -(100/60)*@ , -@/(100/60) - +# compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) +# compute in4 ((30/10)+1)*@ , @/((30/10)+1) +# compute in5 -(240/60)*@ , -@/(240/60) +# compute in6 -(100/60)*@ , -@/(100/60) +# # On almost any mainboard we have seen, the Winbond compute values lead to # much better results, though. - -# Vs R1,Rin R2,Rf Vin -# in4 +12.0 28 10 +3.00 -# in5 -12.0 210 60.4 +3.00 -# in6 -5.0 90.9 60.4 +3.00 - +# +# Vs R1,Rin R2,Rf Vin +# in4 +12.0 28 10 +3.00 +# in5 -12.0 210 60.4 +3.00 +# in6 -5.0 90.9 60.4 +3.00 +# # These leads to these declarations: -# compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) -# compute in4 ((28/10)+1)*@ , @/((28/10)+1) -# compute in5 -(210/60.4)*@ , -@/(210/60.4) -# compute in6 -(90.9/60.4)*@ , -@/(90.9/60.4) - +# compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) +# compute in4 ((28/10)+1)*@ , @/((28/10)+1) +# compute in5 -(210/60.4)*@ , -@/(210/60.4) +# compute in6 -(90.9/60.4)*@ , -@/(90.9/60.4) +# +# +# SET LINES +# --------- # Set statements set things like limits. Complete expressions can be # used. Not everything can sensibly be set: setting 'in0', for example, # is impossible! These settings are put through the compute translations; # so if we specify '12.8' for in6, '3.2' will actually be written! - -#set in0_max vid*1.05 -#set in0_min vid*0.95 - +# +# Important note: In the 'sensors' program, these only take effect +# after running 'sensors -s'!!! +# +# set in0_max vid*1.05 +# set in0_min vid*0.95 +# set temp1_over 40 +# set temp1_hyst 37 +# +# +# IGNORE LINES +# ------------ # Ignore statements tell certain features are not wanted. User programs can # still read them if they really want, though; this is just an advisory # marking. 'in0' would also invalidate 'in0_max' and 'in0_min'. # 'ignore' does not disable anything in the actual sensor chip; it # simply advises the user program to not access that data. # -#ignore in0 - - +# ignore in0 +# +# +# BUS LINES +# --------- # There is one other feature: the 'bus' statement. An example is below. - -#bus "i2c-0" "SMBus PIIX4 adapter at e800" "Non-I2C SMBus adapter" - +# +# bus "i2c-0" "SMBus PIIX4 adapter at e800" "Non-I2C SMBus adapter" +# # If we refer from now on to 'i2c-0' in 'chip' lines, this will run-time # be matched to this bus. So even if the PIIX4 is called 'i2c-5' at that # moment, because five other adapters were detected first, 'i2c-0' in # the config file would always only match this physical bus. In the above # config file, this feature is not needed; but the next lines would # only affect the LM75 chips on the PIIX4 adapter: - -#chip "lm75-i2c-0-*" - +# +# chip "lm75-i2c-0-*" +# # You should really use the output of /proc/bus/chips to generate bus lines, # because one mistyped characted will inhibit the match. Wildcards are not # yet supported; spaces at the end are ignored, though. - - +# +# ########################################################################## #### Here begins the real configuration file @@ -155,34 +205,34 @@ chip "lm78-*" "lm78-j-*" "lm79-*" "w83781d-*" "sis5595-*" label in5 "-12V" label in6 "-5V" -# For positive voltages (in0..in4), two resistors are used, with the following +# For positive voltages (in3, in4), two resistors are used, with the following # formula (R1,R2: resistor values, Vs: read voltage, Vin: pin voltage) # R1 = R2 * (Vs/Vin - 1) # For negative voltages (in5, in6) two resistors are used, with the following # formula (Rin,Rf: resistor values, Vs: read voltage, Vin: pin voltage) # Rin = (Vs * Rf) / Vin - +# # Here are the official LM78 and LM79 data sheet values. # Vs R1,Rin R2,Rf Vin # in3 +5.0 6.8 10 +2.98 # in4 +12.0 30 10 +3.00 # in5 -12.0 240 60 +3.00 # in6 -5.0 100 60 +3.00 - +# # These would lead to these declarations: # compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) # compute in4 ((30/10)+1)*@ , @/((30/10)+1) # compute in5 -(240/60)*@ , -@/(240/60) # compute in6 -(100/60)*@ , -@/(100/60) - +# # On almost any mainboard we have seen, the Winbond compute values lead to # much better results, though. - +# # Vs R1,Rin R2,Rf Vin # in4 +12.0 28 10 +3.00 # in5 -12.0 210 60.4 +3.00 # in6 -5.0 90.9 60.4 +3.00 - +# # These leads to these declarations: compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1) @@ -207,6 +257,13 @@ chip "lm78-*" "lm78-j-*" "lm79-*" "w83781d-*" "sis5595-*" set in6_min -5 * 0.95 set in6_max -5 * 1.05 +# examples for temperature limits +# set temp1_over 40 +# set temp1_hyst 37 +# set temp2_over 52 +# set temp2_hyst 47 +# set temp3_over 52 +# set temp3_hyst 47 chip "w83782d-*" "w83783s-*" "w83627hf-*"