Merge tag 'armsoc-drivers' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[linux-block.git] / Documentation / hwmon / max1668.rst
CommitLineData
731b4cac
DG
1Kernel driver max1668
2=====================
3
4Supported chips:
b04f2f7d 5
731b4cac 6 * Maxim MAX1668, MAX1805 and MAX1989
b04f2f7d 7
731b4cac 8 Prefix: 'max1668'
b04f2f7d 9
731b4cac 10 Addresses scanned: I2C 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e
b04f2f7d 11
731b4cac
DG
12 Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX1668-MAX1989.pdf
13
14Author:
b04f2f7d 15
731b4cac
DG
16 David George <david.george@ska.ac.za>
17
18Description
19-----------
20
21This driver implements support for the Maxim MAX1668, MAX1805 and MAX1989
22chips.
23
24The three devices are very similar, but the MAX1805 has a reduced feature
76b5808e 25set; only two remote temperature inputs vs the four available on the other
731b4cac
DG
26two ICs.
27
28The driver is able to distinguish between the devices and creates sysfs
29entries as follows:
30
b04f2f7d 31- MAX1805, MAX1668 and MAX1989:
731b4cac 32
b04f2f7d 33=============== == ============================================================
731b4cac
DG
34temp1_input ro local (ambient) temperature
35temp1_max rw local temperature maximum threshold for alarm
36temp1_max_alarm ro local temperature maximum threshold alarm
37temp1_min rw local temperature minimum threshold for alarm
38temp1_min_alarm ro local temperature minimum threshold alarm
39temp2_input ro remote temperature 1
40temp2_max rw remote temperature 1 maximum threshold for alarm
41temp2_max_alarm ro remote temperature 1 maximum threshold alarm
42temp2_min rw remote temperature 1 minimum threshold for alarm
43temp2_min_alarm ro remote temperature 1 minimum threshold alarm
44temp3_input ro remote temperature 2
45temp3_max rw remote temperature 2 maximum threshold for alarm
46temp3_max_alarm ro remote temperature 2 maximum threshold alarm
47temp3_min rw remote temperature 2 minimum threshold for alarm
48temp3_min_alarm ro remote temperature 2 minimum threshold alarm
b04f2f7d
MCC
49=============== == ============================================================
50
51- MAX1668 and MAX1989 only:
731b4cac 52
b04f2f7d 53=============== == ============================================================
731b4cac
DG
54temp4_input ro remote temperature 3
55temp4_max rw remote temperature 3 maximum threshold for alarm
56temp4_max_alarm ro remote temperature 3 maximum threshold alarm
57temp4_min rw remote temperature 3 minimum threshold for alarm
58temp4_min_alarm ro remote temperature 3 minimum threshold alarm
59temp5_input ro remote temperature 4
60temp5_max rw remote temperature 4 maximum threshold for alarm
61temp5_max_alarm ro remote temperature 4 maximum threshold alarm
62temp5_min rw remote temperature 4 minimum threshold for alarm
63temp5_min_alarm ro remote temperature 4 minimum threshold alarm
b04f2f7d 64=============== == ============================================================
731b4cac
DG
65
66Module Parameters
67-----------------
68
69* read_only: int
70 Set to non-zero if you wish to prevent write access to alarm thresholds.