Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 6e8793674bb0d1135ca0e5c9f7e16fecbf815926 / . / Documentation / hwmon / jc42.rst
blob: 19d10512f6c0313c0d41f77bcba05fef02c2a7ec [file] [log] [blame]
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]1Kernel driver jc42
2==================
3
4Supported chips:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]5
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]6 * Analog Devices ADT7408
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]7
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]8 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]9
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]10 https://www.analog.com/static/imported-files/data_sheets/ADT7408.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]11
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]12 * Atmel AT30TS00, AT30TS002A/B, AT30TSE004A
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]13
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]14 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]15
Guenter Roeck1bd612a2012-03-05 11:13:52 -0800[diff] [blame]16 http://www.atmel.com/Images/doc8585.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]17
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]18 http://www.atmel.com/Images/doc8711.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]19
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]20 http://www.atmel.com/Images/Atmel-8852-SEEPROM-AT30TSE002A-Datasheet.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]21
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]22 http://www.atmel.com/Images/Atmel-8868-DTS-AT30TSE004A-Datasheet.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]23
Guenter Roeck0ea2f1d2015-02-01 17:20:38 -0800[diff] [blame]24 * IDT TSE2002B3, TSE2002GB2, TSE2004GB2, TS3000B3, TS3000GB0, TS3000GB2,
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]25
Guenter Roeck0ea2f1d2015-02-01 17:20:38 -0800[diff] [blame]26 TS3001GB2
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]27
Guenter Roeck1bd612a2012-03-05 11:13:52 -0800[diff] [blame]28 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]29
Guenter Roeck0ea2f1d2015-02-01 17:20:38 -0800[diff] [blame]30 Available from IDT web site
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]31
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]32 * Maxim MAX6604
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]33
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]34 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]35
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]36 http://datasheets.maxim-ic.com/en/ds/MAX6604.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]37
Alison Schofielda31887d2016-06-27 17:23:27 -0700[diff] [blame]38 * Microchip MCP9804, MCP9805, MCP9808, MCP98242, MCP98243, MCP98244, MCP9843
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]39
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]40 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]41
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]42 https://ww1.microchip.com/downloads/en/DeviceDoc/22203C.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]43
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]44 https://ww1.microchip.com/downloads/en/DeviceDoc/21977b.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]45
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]46 https://ww1.microchip.com/downloads/en/DeviceDoc/25095A.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]47
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]48 https://ww1.microchip.com/downloads/en/DeviceDoc/21996a.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]49
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]50 https://ww1.microchip.com/downloads/en/DeviceDoc/22153c.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]51
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]52 https://ww1.microchip.com/downloads/en/DeviceDoc/22327A.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]53
Guenter Roeck86dda172012-03-08 08:20:24 -0800[diff] [blame]54 * NXP Semiconductors SE97, SE97B, SE98, SE98A
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]55
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]56 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]57
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]58 https://www.nxp.com/documents/data_sheet/SE97.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]59
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]60 https://www.nxp.com/documents/data_sheet/SE97B.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]61
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]62 https://www.nxp.com/documents/data_sheet/SE98.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]63
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]64 https://www.nxp.com/documents/data_sheet/SE98A.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]65
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]66 * ON Semiconductor CAT34TS02, CAT6095
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]67
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]68 Datasheet:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]69
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]70 https://www.onsemi.com/pub_link/Collateral/CAT34TS02-D.PDF
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]71
Alexander A. Klimovd38b7e42020-07-19 20:25:39 +0200[diff] [blame]72 https://www.onsemi.com/pub/Collateral/CAT6095-D.PDF
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]73
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]74 * ST Microelectronics STTS424, STTS424E02, STTS2002, STTS2004, STTS3000
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]75
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]76 Datasheets:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]77
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]78 http://www.st.com/web/en/resource/technical/document/datasheet/CD00157556.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]79
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]80 http://www.st.com/web/en/resource/technical/document/datasheet/CD00157558.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]81
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]82 http://www.st.com/web/en/resource/technical/document/datasheet/CD00266638.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]83
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]84 http://www.st.com/web/en/resource/technical/document/datasheet/CD00225278.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]85
Guenter Roeck175c4902014-04-15 22:07:30 -0700[diff] [blame]86 http://www.st.com/web/en/resource/technical/document/datasheet/DM00076709.pdf
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]87
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]88 * JEDEC JC 42.4 compliant temperature sensor chips
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]89
Clemens Ladischd5622f52011-02-16 08:02:08 -0500[diff] [blame]90 Datasheet:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]91
Clemens Ladischd5622f52011-02-16 08:02:08 -0500[diff] [blame]92 http://www.jedec.org/sites/default/files/docs/4_01_04R19.pdf
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]93
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]94
Guenter Roeck86dda172012-03-08 08:20:24 -0800[diff] [blame]95 Common for all chips:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]96
Guenter Roeck86dda172012-03-08 08:20:24 -0800[diff] [blame]97 Prefix: 'jc42'
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]98
Guenter Roeck86dda172012-03-08 08:20:24 -0800[diff] [blame]99 Addresses scanned: I2C 0x18 - 0x1f
100
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]101Author:
Guenter Roecke3333e52013-02-20 20:58:42 -0800[diff] [blame]102 Guenter Roeck <linux@roeck-us.net>
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]103
104
105Description
106-----------
107
Clemens Ladischd5622f52011-02-16 08:02:08 -0500[diff] [blame]108This driver implements support for JEDEC JC 42.4 compliant temperature sensors,
109which are used on many DDR3 memory modules for mobile devices and servers. Some
110systems use the sensor to prevent memory overheating by automatically throttling
111the memory controller.
112
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]113The driver auto-detects the chips listed above, but can be manually instantiated
114to support other JC 42.4 compliant chips.
115
116Example: the following will load the driver for a generic JC 42.4 compliant
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]117temperature sensor at address 0x18 on I2C bus #1::
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]118
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]119 # modprobe jc42
120 # echo jc42 0x18 > /sys/bus/i2c/devices/i2c-1/new_device
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]121
122A JC 42.4 compliant chip supports a single temperature sensor. Minimum, maximum,
123and critical temperature can be configured. There are alarms for high, low,
124and critical thresholds.
125
126There is also an hysteresis to control the thresholds for resetting alarms.
127Per JC 42.4 specification, the hysteresis threshold can be configured to 0, 1.5,
1283.0, and 6.0 degrees C. Configured hysteresis values will be rounded to those
129limits. The chip supports only a single register to configure the hysteresis,
130which applies to all limits. This register can be written by writing into
131temp1_crit_hyst. Other hysteresis attributes are read-only.
132
Clemens Ladisch2c6315d2011-02-16 08:02:38 -0500[diff] [blame]133If the BIOS has configured the sensor for automatic temperature management, it
134is likely that it has locked the registers, i.e., that the temperature limits
135cannot be changed.
136
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]137Sysfs entries
138-------------
139
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]140======================= ===========================================
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]141temp1_input Temperature (RO)
Clemens Ladisch2c6315d2011-02-16 08:02:38 -0500[diff] [blame]142temp1_min Minimum temperature (RO or RW)
143temp1_max Maximum temperature (RO or RW)
144temp1_crit Critical high temperature (RO or RW)
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]145
Clemens Ladisch2c6315d2011-02-16 08:02:38 -0500[diff] [blame]146temp1_crit_hyst Critical hysteresis temperature (RO or RW)
Guenter Roeck4453d732010-08-09 17:21:08 -0700[diff] [blame]147temp1_max_hyst Maximum hysteresis temperature (RO)
148
149temp1_min_alarm Temperature low alarm
150temp1_max_alarm Temperature high alarm
151temp1_crit_alarm Temperature critical alarm
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]152======================= ===========================================