xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/max1668.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel driver max1668
2*4882a593Smuzhiyun=====================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported chips:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun  * Maxim MAX1668, MAX1805 and MAX1989
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun    Prefix: 'max1668'
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Addresses scanned: I2C 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX1668-MAX1989.pdf
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunAuthor:
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun    David George <david.george@ska.ac.za>
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunDescription
19*4882a593Smuzhiyun-----------
20*4882a593Smuzhiyun
21*4882a593SmuzhiyunThis driver implements support for the Maxim MAX1668, MAX1805 and MAX1989
22*4882a593Smuzhiyunchips.
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunThe three devices are very similar, but the MAX1805 has a reduced feature
25*4882a593Smuzhiyunset; only two remote temperature inputs vs the four available on the other
26*4882a593Smuzhiyuntwo ICs.
27*4882a593Smuzhiyun
28*4882a593SmuzhiyunThe driver is able to distinguish between the devices and creates sysfs
29*4882a593Smuzhiyunentries as follows:
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun- MAX1805, MAX1668 and MAX1989:
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun=============== == ============================================================
34*4882a593Smuzhiyuntemp1_input     ro local (ambient) temperature
35*4882a593Smuzhiyuntemp1_max       rw local temperature maximum threshold for alarm
36*4882a593Smuzhiyuntemp1_max_alarm ro local temperature maximum threshold alarm
37*4882a593Smuzhiyuntemp1_min       rw local temperature minimum threshold for alarm
38*4882a593Smuzhiyuntemp1_min_alarm ro local temperature minimum threshold alarm
39*4882a593Smuzhiyuntemp2_input     ro remote temperature 1
40*4882a593Smuzhiyuntemp2_max       rw remote temperature 1 maximum threshold for alarm
41*4882a593Smuzhiyuntemp2_max_alarm ro remote temperature 1 maximum threshold alarm
42*4882a593Smuzhiyuntemp2_min       rw remote temperature 1 minimum threshold for alarm
43*4882a593Smuzhiyuntemp2_min_alarm ro remote temperature 1 minimum threshold alarm
44*4882a593Smuzhiyuntemp3_input     ro remote temperature 2
45*4882a593Smuzhiyuntemp3_max       rw remote temperature 2 maximum threshold for alarm
46*4882a593Smuzhiyuntemp3_max_alarm ro remote temperature 2 maximum threshold alarm
47*4882a593Smuzhiyuntemp3_min       rw remote temperature 2 minimum threshold for alarm
48*4882a593Smuzhiyuntemp3_min_alarm ro remote temperature 2 minimum threshold alarm
49*4882a593Smuzhiyun=============== == ============================================================
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun- MAX1668 and MAX1989 only:
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun=============== == ============================================================
54*4882a593Smuzhiyuntemp4_input     ro remote temperature 3
55*4882a593Smuzhiyuntemp4_max       rw remote temperature 3 maximum threshold for alarm
56*4882a593Smuzhiyuntemp4_max_alarm ro remote temperature 3 maximum threshold alarm
57*4882a593Smuzhiyuntemp4_min       rw remote temperature 3 minimum threshold for alarm
58*4882a593Smuzhiyuntemp4_min_alarm ro remote temperature 3 minimum threshold alarm
59*4882a593Smuzhiyuntemp5_input     ro remote temperature 4
60*4882a593Smuzhiyuntemp5_max       rw remote temperature 4 maximum threshold for alarm
61*4882a593Smuzhiyuntemp5_max_alarm ro remote temperature 4 maximum threshold alarm
62*4882a593Smuzhiyuntemp5_min       rw remote temperature 4 minimum threshold for alarm
63*4882a593Smuzhiyuntemp5_min_alarm ro remote temperature 4 minimum threshold alarm
64*4882a593Smuzhiyun=============== == ============================================================
65*4882a593Smuzhiyun
66*4882a593SmuzhiyunModule Parameters
67*4882a593Smuzhiyun-----------------
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun* read_only: int
70*4882a593Smuzhiyun  Set to non-zero if you wish to prevent write access to alarm thresholds.
71