Commit a4a5e7cf authored by Jean Delvare's avatar Jean Delvare Committed by Patrick Mochel

[PATCH] I2C: i2c documentation update (2/2)

Here is a patch to Documentation/i2c/sysfs-interface. This is mostly my
intent to make the document more readable. There are also a few
incorrectnesses fixed, and some comments added.
parent 92e54f42
...@@ -74,18 +74,15 @@ to cause an alarm) is chip-dependent. ...@@ -74,18 +74,15 @@ to cause an alarm) is chip-dependent.
************ ************
in[0-8]_min Voltage min value. in[0-8]_min Voltage min value.
Fixed point value in form XXXX. Divide by 1000 to get Unit: millivolt
Volts.
Read/Write Read/Write
in[0-8]_max Voltage max value. in[0-8]_max Voltage max value.
Fixed point value in form XXXX. Divide by 1000 to get Unit: millivolt
Volts.
Read/Write Read/Write
in[0-8]_input Voltage input value. in[0-8]_input Voltage input value.
Fixed point value in form XXXX. Divide by 1000 to get Unit: millivolt
Volts.
Read only Read only
Actual voltage depends on the scaling resistors on the Actual voltage depends on the scaling resistors on the
motherboard, as recommended in the chip datasheet. motherboard, as recommended in the chip datasheet.
...@@ -95,10 +92,10 @@ in[0-8]_input Voltage input value. ...@@ -95,10 +92,10 @@ in[0-8]_input Voltage input value.
However, some drivers (notably lm87 and via686a) However, some drivers (notably lm87 and via686a)
do scale, with various degrees of success. do scale, with various degrees of success.
These drivers will output the actual voltage. These drivers will output the actual voltage.
First two values are read/write and third is read only.
Typical usage: Typical usage:
in0_* CPU #1 voltage (not scaled) in0_* CPU #1 voltage (not scaled)
in1_* CPU #1 voltage (not scaled) in1_* CPU #2 voltage (not scaled)
in2_* 3.3V nominal (not scaled) in2_* 3.3V nominal (not scaled)
in3_* 5.0V nominal (scaled) in3_* 5.0V nominal (scaled)
in4_* 12.0V nominal (scaled) in4_* 12.0V nominal (scaled)
...@@ -108,17 +105,16 @@ in[0-8]_input Voltage input value. ...@@ -108,17 +105,16 @@ in[0-8]_input Voltage input value.
in8_* varies in8_* varies
in0_ref CPU core reference voltage. in0_ref CPU core reference voltage.
Unit: millivolt
Read only. Read only.
Fixed point value in form XXXX corresponding to CPU core Not always correct.
voltage as told to the sensor chip. Divide by 1000 to
get Volts. Not always correct.
vrm Voltage Regulator Module version number. vrm Voltage Regulator Module version number.
Read only. Read only.
Two digit number (XX), first is major version, second is Two digit number, first is major version, second is
minor version. minor version.
Affects the way the driver calculates the core voltage from Affects the way the driver calculates the CPU core reference
the vid pins. See doc/vid for details. voltage from the vid pins.
******** ********
...@@ -126,23 +122,23 @@ vrm Voltage Regulator Module version number. ...@@ -126,23 +122,23 @@ vrm Voltage Regulator Module version number.
******** ********
fan[1-3]_min Fan minimum value fan[1-3]_min Fan minimum value
Integer value indicating RPM Unit: revolution/min (RPM)
Read/Write. Read/Write.
fan[1-3]_input Fan input value. fan[1-3]_input Fan input value.
Integer value indicating RPM Unit: revolution/min (RPM)
Read only. Read only.
fan[1-3]_div Fan divisor. fan[1-3]_div Fan divisor.
Integers in powers of two (1,2,4,8,16,32,64,128). Integer value in powers of two (1, 2, 4, 8, 16, 32, 64, 128).
Some chips only support values 1,2,4,8. Some chips only support values 1, 2, 4 and 8.
See doc/fan-divisors for details. Note that this is actually an internal clock divisor, which
affects the measurable speed range, not the read value.
fan[1-3]_pwm Pulse width modulation fan control. fan[1-3]_pwm Pulse width modulation fan control.
Integer 0 - 255 Integer value in the range 0 to 255
Read/Write Read/Write
255 is max or 100%. 255 is max or 100%.
Corresponds to the fans 1-3.
fan[1-3]_pwm_enable fan[1-3]_pwm_enable
Switch PWM on and off. Switch PWM on and off.
...@@ -157,46 +153,46 @@ fan[1-3]_pwm_enable ...@@ -157,46 +153,46 @@ fan[1-3]_pwm_enable
**************** ****************
temp[1-3]_type Sensor type selection. temp[1-3]_type Sensor type selection.
Integers 1,2,3, or thermistor Beta value (3435) Integers 1, 2, 3 or thermistor Beta value (3435)
Read/Write. Read/Write.
1: PII/Celeron Diode
2: 3904 transistor
3: thermal diode
Not all types are supported by all chips
temp[1-4]_max Temperature max value. temp[1-4]_max Temperature max value.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius.
Read/Write value. Read/Write value.
temp[1-3]_min Temperature min value. temp[1-3]_min Temperature min value.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius.
Read/Write value. Read/Write value.
temp[1-3]_max_hyst temp[1-3]_max_hyst
Temperature hysteresis value for max limit. Temperature hysteresis value for max limit.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius. Must be reported as an Must be reported as an absolute temperature, NOT a delta
absolute temperature, NOT a delta from the max value. from the max value.
Read/Write value. Read/Write value.
temp[1-4]_input Temperature input value. temp[1-4]_input Temperature input value.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius.
Read only value. Read only value.
temp[1-4]_crit Temperature critical value, typically greater than temp[1-4]_crit Temperature critical value, typically greater than
corresponding temp_max values. corresponding temp_max values.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius.
Read/Write value. Read/Write value.
temp[1-2]_crit_hyst temp[1-2]_crit_hyst
Temperature hysteresis value for critical limit. Temperature hysteresis value for critical limit.
Fixed point value in form XXXXX and should be divided by Unit: millidegree Celcius
1000 to get degrees Celsius. Must be reported as an Must be reported as an absolute temperature, NOT a delta
absolute temperature, NOT a delta from the critical value. from the critical value.
Read/Write value. Read/Write value.
If there are multiple temperature sensors, temp1_* is If there are multiple temperature sensors, temp1_* is
generally the sensor inside the chip itself, generally generally the sensor inside the chip itself,
reported as "motherboard temperature". temp2_* to reported as "motherboard temperature". temp2_* to
temp4_* are generally sensors external to the chip temp4_* are generally sensors external to the chip
itself, for example the thermal diode inside the CPU or itself, for example the thermal diode inside the CPU or
...@@ -211,15 +207,15 @@ Note that no known chip provides current measurements as of writing, ...@@ -211,15 +207,15 @@ Note that no known chip provides current measurements as of writing,
so this part is theoretical, so to say. so this part is theoretical, so to say.
curr[1-n]_max Current max value curr[1-n]_max Current max value
Fixed point XXXXX, divide by 1000 to get Amps. Unit: milliampere
Read/Write. Read/Write.
curr[1-n]_min Current min value. curr[1-n]_min Current min value.
Fixed point XXXXX, divide by 1000 to get Amps. Unit: milliampere
Read/Write. Read/Write.
curr[1-n]_input Current input value curr[1-n]_input Current input value
Fixed point XXXXX, divide by 1000 to get Amps. Unit: milliampere
Read only. Read only.
...@@ -246,7 +242,7 @@ beep_enable Beep/interrupt enable ...@@ -246,7 +242,7 @@ beep_enable Beep/interrupt enable
beep_mask Bitmask for beep. beep_mask Bitmask for beep.
Same format as 'alarms' with the same bit locations. Same format as 'alarms' with the same bit locations.
Read only. Read/Write
eeprom Raw EEPROM data in binary form. eeprom Raw EEPROM data in binary form.
Read only. Read only.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment