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