Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / c4c8dd6ef807663e42a5f04ea77cd62029eb99fa / . / Documentation / hwmon / adm1021.rst
blob: 116fb201995688495995a47a824786111383dadb [file] [log] [blame]
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]1Kernel driver adm1021
2=====================
3
4Supported chips:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]5
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]6 * Analog Devices ADM1021
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]7
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]8 Prefix: 'adm1021'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]9
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]10 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]11
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]12 Datasheet: Publicly available at the Analog Devices website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]13
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]14 * Analog Devices ADM1021A/ADM1023
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]15
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]16 Prefix: 'adm1023'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]17
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]18 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]19
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]20 Datasheet: Publicly available at the Analog Devices website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]21
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]22 * Genesys Logic GL523SM
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]23
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]24 Prefix: 'gl523sm'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]25
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]26 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]27
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]28 Datasheet:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]29
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]30 * Maxim MAX1617
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]31
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]32 Prefix: 'max1617'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]33
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]34 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]35
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]36 Datasheet: Publicly available at the Maxim website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]37
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]38 * Maxim MAX1617A
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]39
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]40 Prefix: 'max1617a'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]41
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]42 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]43
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]44 Datasheet: Publicly available at the Maxim website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]45
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]46 * National Semiconductor LM84
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]47
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]48 Prefix: 'lm84'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]49
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]50 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]51
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]52 Datasheet: Publicly available at the National Semiconductor website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]53
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]54 * Philips NE1617
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]55
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]56 Prefix: 'max1617' (probably detected as a max1617)
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]57
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]58 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]59
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]60 Datasheet: Publicly available at the Philips website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]61
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]62 * Philips NE1617A
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]63
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]64 Prefix: 'max1617' (probably detected as a max1617)
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]65
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]66 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]67
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]68 Datasheet: Publicly available at the Philips website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]69
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]70 * TI THMC10
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]71
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]72 Prefix: 'thmc10'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]73
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]74 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]75
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]76 Datasheet: Publicly available at the TI website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]77
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]78 * Onsemi MC1066
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]79
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]80 Prefix: 'mc1066'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]81
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]82 Addresses scanned: I2C 0x18 - 0x1a, 0x29 - 0x2b, 0x4c - 0x4e
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]83
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]84 Datasheet: Publicly available at the Onsemi website
85
86
87Authors:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -0300[diff] [blame]88 - Frodo Looijaard <frodol@dds.nl>,
89 - Philip Edelbrock <phil@netroedge.com>
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]90
91Module Parameters
92-----------------
93
94* read_only: int
95 Don't set any values, read only mode
96
97
98Description
99-----------
100
101The chips supported by this driver are very similar. The Maxim MAX1617 is
102the oldest; it has the problem that it is not very well detectable. The
103MAX1617A solves that. The ADM1021 is a straight clone of the MAX1617A.
104Ditto for the THMC10. From here on, we will refer to all these chips as
105ADM1021-clones.
106
107The ADM1021 and MAX1617A reports a die code, which is a sort of revision
108code. This can help us pinpoint problems; it is not very useful
109otherwise.
110
111ADM1021-clones implement two temperature sensors. One of them is internal,
112and measures the temperature of the chip itself; the other is external and
113is realised in the form of a transistor-like device. A special alarm
114indicates whether the remote sensor is connected.
115
116Each sensor has its own low and high limits. When they are crossed, the
117corresponding alarm is set and remains on as long as the temperature stays
118out of range. Temperatures are measured in degrees Celsius. Measurements
119are possible between -65 and +127 degrees, with a resolution of one degree.
120
121If an alarm triggers, it will remain triggered until the hardware register
122is read at least once. This means that the cause for the alarm may already
123have disappeared!
124
125This driver only updates its values each 1.5 seconds; reading it more often
126will do no harm, but will return 'old' values. It is possible to make
127ADM1021-clones do faster measurements, but there is really no good reason
128for that.
129
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]130
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]131Netburst-based Xeon support
132---------------------------
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]133
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]134Some Xeon processors based on the Netburst (early Pentium 4, from 2001 to
1352003) microarchitecture had real MAX1617, ADM1021, or compatible chips
136within them, with two temperature sensors. Other Xeon processors of this
137era (with 400 MHz FSB) had chips with only one temperature sensor.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]138
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]139If you have such an old Xeon, and you get two valid temperatures when
140loading the adm1021 module, then things are good.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]141
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]142If nothing happens when loading the adm1021 module, and you are certain
143that your specific Xeon processor model includes compatible sensors, you
144will have to explicitly instantiate the sensor chips from user-space. See
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -0300[diff] [blame]145method 4 in Documentation/i2c/instantiating-devices.rst. Possible slave
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]146addresses are 0x18, 0x1a, 0x29, 0x2b, 0x4c, or 0x4e. It is likely that
147only temp2 will be correct and temp1 will have to be ignored.
R.Marek@sh.cvut.cz7f15b662005-05-26 12:42:19 +0000[diff] [blame]148
Jean Delvared7ce0332011-04-29 16:33:36 +0200[diff] [blame]149Previous generations of the Xeon processor (based on Pentium II/III)
150didn't have these sensors. Next generations of Xeon processors (533 MHz
151FSB and faster) lost them, until the Core-based generation which
152introduced integrated digital thermal sensors. These are supported by
153the coretemp driver.