xref: /openbmc/linux/Documentation/hwmon/max1668.rst (revision c39f2d9db0fd81ea20bb5cce9b3f082ca63753e2)
1*7ebd8b66SMauro Carvalho ChehabKernel driver max1668
2*7ebd8b66SMauro Carvalho Chehab=====================
3*7ebd8b66SMauro Carvalho Chehab
4*7ebd8b66SMauro Carvalho ChehabSupported chips:
5*7ebd8b66SMauro Carvalho Chehab
6*7ebd8b66SMauro Carvalho Chehab  * Maxim MAX1668, MAX1805 and MAX1989
7*7ebd8b66SMauro Carvalho Chehab
8*7ebd8b66SMauro Carvalho Chehab    Prefix: 'max1668'
9*7ebd8b66SMauro Carvalho Chehab
10*7ebd8b66SMauro Carvalho Chehab    Addresses scanned: I2C 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e
11*7ebd8b66SMauro Carvalho Chehab
12*7ebd8b66SMauro Carvalho Chehab    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX1668-MAX1989.pdf
13*7ebd8b66SMauro Carvalho Chehab
14*7ebd8b66SMauro Carvalho ChehabAuthor:
15*7ebd8b66SMauro Carvalho Chehab
16*7ebd8b66SMauro Carvalho Chehab    David George <david.george@ska.ac.za>
17*7ebd8b66SMauro Carvalho Chehab
18*7ebd8b66SMauro Carvalho ChehabDescription
19*7ebd8b66SMauro Carvalho Chehab-----------
20*7ebd8b66SMauro Carvalho Chehab
21*7ebd8b66SMauro Carvalho ChehabThis driver implements support for the Maxim MAX1668, MAX1805 and MAX1989
22*7ebd8b66SMauro Carvalho Chehabchips.
23*7ebd8b66SMauro Carvalho Chehab
24*7ebd8b66SMauro Carvalho ChehabThe three devices are very similar, but the MAX1805 has a reduced feature
25*7ebd8b66SMauro Carvalho Chehabset; only two remote temperature inputs vs the four available on the other
26*7ebd8b66SMauro Carvalho Chehabtwo ICs.
27*7ebd8b66SMauro Carvalho Chehab
28*7ebd8b66SMauro Carvalho ChehabThe driver is able to distinguish between the devices and creates sysfs
29*7ebd8b66SMauro Carvalho Chehabentries as follows:
30*7ebd8b66SMauro Carvalho Chehab
31*7ebd8b66SMauro Carvalho Chehab- MAX1805, MAX1668 and MAX1989:
32*7ebd8b66SMauro Carvalho Chehab
33*7ebd8b66SMauro Carvalho Chehab=============== == ============================================================
34*7ebd8b66SMauro Carvalho Chehabtemp1_input     ro local (ambient) temperature
35*7ebd8b66SMauro Carvalho Chehabtemp1_max       rw local temperature maximum threshold for alarm
36*7ebd8b66SMauro Carvalho Chehabtemp1_max_alarm ro local temperature maximum threshold alarm
37*7ebd8b66SMauro Carvalho Chehabtemp1_min       rw local temperature minimum threshold for alarm
38*7ebd8b66SMauro Carvalho Chehabtemp1_min_alarm ro local temperature minimum threshold alarm
39*7ebd8b66SMauro Carvalho Chehabtemp2_input     ro remote temperature 1
40*7ebd8b66SMauro Carvalho Chehabtemp2_max       rw remote temperature 1 maximum threshold for alarm
41*7ebd8b66SMauro Carvalho Chehabtemp2_max_alarm ro remote temperature 1 maximum threshold alarm
42*7ebd8b66SMauro Carvalho Chehabtemp2_min       rw remote temperature 1 minimum threshold for alarm
43*7ebd8b66SMauro Carvalho Chehabtemp2_min_alarm ro remote temperature 1 minimum threshold alarm
44*7ebd8b66SMauro Carvalho Chehabtemp3_input     ro remote temperature 2
45*7ebd8b66SMauro Carvalho Chehabtemp3_max       rw remote temperature 2 maximum threshold for alarm
46*7ebd8b66SMauro Carvalho Chehabtemp3_max_alarm ro remote temperature 2 maximum threshold alarm
47*7ebd8b66SMauro Carvalho Chehabtemp3_min       rw remote temperature 2 minimum threshold for alarm
48*7ebd8b66SMauro Carvalho Chehabtemp3_min_alarm ro remote temperature 2 minimum threshold alarm
49*7ebd8b66SMauro Carvalho Chehab=============== == ============================================================
50*7ebd8b66SMauro Carvalho Chehab
51*7ebd8b66SMauro Carvalho Chehab- MAX1668 and MAX1989 only:
52*7ebd8b66SMauro Carvalho Chehab
53*7ebd8b66SMauro Carvalho Chehab=============== == ============================================================
54*7ebd8b66SMauro Carvalho Chehabtemp4_input     ro remote temperature 3
55*7ebd8b66SMauro Carvalho Chehabtemp4_max       rw remote temperature 3 maximum threshold for alarm
56*7ebd8b66SMauro Carvalho Chehabtemp4_max_alarm ro remote temperature 3 maximum threshold alarm
57*7ebd8b66SMauro Carvalho Chehabtemp4_min       rw remote temperature 3 minimum threshold for alarm
58*7ebd8b66SMauro Carvalho Chehabtemp4_min_alarm ro remote temperature 3 minimum threshold alarm
59*7ebd8b66SMauro Carvalho Chehabtemp5_input     ro remote temperature 4
60*7ebd8b66SMauro Carvalho Chehabtemp5_max       rw remote temperature 4 maximum threshold for alarm
61*7ebd8b66SMauro Carvalho Chehabtemp5_max_alarm ro remote temperature 4 maximum threshold alarm
62*7ebd8b66SMauro Carvalho Chehabtemp5_min       rw remote temperature 4 minimum threshold for alarm
63*7ebd8b66SMauro Carvalho Chehabtemp5_min_alarm ro remote temperature 4 minimum threshold alarm
64*7ebd8b66SMauro Carvalho Chehab=============== == ============================================================
65*7ebd8b66SMauro Carvalho Chehab
66*7ebd8b66SMauro Carvalho ChehabModule Parameters
67*7ebd8b66SMauro Carvalho Chehab-----------------
68*7ebd8b66SMauro Carvalho Chehab
69*7ebd8b66SMauro Carvalho Chehab* read_only: int
70*7ebd8b66SMauro Carvalho Chehab  Set to non-zero if you wish to prevent write access to alarm thresholds.
71