mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-11-01 00:48:50 +00:00
Code Issues Releases Wiki Activity
linux-stable/Documentation/hwmon/emc1403.rst

81 lines
2.4 KiB
ReStructuredText
Raw Normal View History

hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Kernel driver emc1403
=====================
Supported chips:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* SMSC / Microchip EMC1402, EMC1412
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Addresses scanned: I2C 0x18, 0x1c, 0x29, 0x4c, 0x4d, 0x5c
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Prefix: 'emc1402'
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Datasheets:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
- http://ww1.microchip.com/downloads/en/DeviceDoc/1412.pdf
hwmon: Replace HTTP links with HTTPS ones Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de> Link: https://lore.kernel.org/r/20200719175512.60745-1-grandmaster@al2klimov.de Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2020-07-19 17:55:12 +00:00
- https://ww1.microchip.com/downloads/en/DeviceDoc/1402.pdf
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* SMSC / Microchip EMC1403, EMC1404, EMC1413, EMC1414
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Addresses scanned: I2C 0x18, 0x29, 0x4c, 0x4d
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Prefix: 'emc1403', 'emc1404'
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Datasheets:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
- http://ww1.microchip.com/downloads/en/DeviceDoc/1403_1404.pdf
- http://ww1.microchip.com/downloads/en/DeviceDoc/1413_1414.pdf
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* SMSC / Microchip EMC1422
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Addresses scanned: I2C 0x4c
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Prefix: 'emc1422'
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Datasheet:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: Replace HTTP links with HTTPS ones Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de> Link: https://lore.kernel.org/r/20200719175512.60745-1-grandmaster@al2klimov.de Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2020-07-19 17:55:12 +00:00
- https://ww1.microchip.com/downloads/en/DeviceDoc/1422.pdf
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* SMSC / Microchip EMC1423, EMC1424
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Addresses scanned: I2C 0x4c
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Prefix: 'emc1423', 'emc1424'
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Datasheet:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: Replace HTTP links with HTTPS ones Rationale: Reduces attack surface on kernel devs opening the links for MITM as HTTPS traffic is much harder to manipulate. Deterministic algorithm: For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS. Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de> Link: https://lore.kernel.org/r/20200719175512.60745-1-grandmaster@al2klimov.de Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2020-07-19 17:55:12 +00:00
- https://ww1.microchip.com/downloads/en/DeviceDoc/1423_1424.pdf
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
Author:
Kalhan Trisal <kalhan.trisal@intel.com
Description
-----------
The Standard Microsystems Corporation (SMSC) / Microchip EMC14xx chips
contain up to four temperature sensors. EMC14x2 support two sensors
(one internal, one external). EMC14x3 support three sensors (one internal,
two external), and EMC14x4 support four sensors (one internal, three
external).
The chips implement three limits for each sensor: low (tempX_min), high
(tempX_max) and critical (tempX_crit.) The chips also implement an
hysteresis mechanism which applies to all limits. The relative difference
is stored in a single register on the chip, which means that the relative
difference between the limit and its hysteresis is always the same for
all three limits.
This implementation detail implies the following:
docs: hwmon: convert remaining files to ReST format Convert all other hwmon files to ReST format, in order to allow them to be parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2019-04-17 09:46:28 +00:00
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* When setting a limit, its hysteresis will automatically follow, the
difference staying unchanged. For example, if the old critical limit
was 80 degrees C, and the hysteresis was 75 degrees C, and you change
the critical limit to 90 degrees C, then the hysteresis will
automatically change to 85 degrees C.
hwmon: (emc1403) Make all hyst attributes except for temp1_crit_hyst read-only All chips in this chip series only support a single hysteresis value. Having multiple writable hysteresis attributes is therefore confusing, since a single write affects all hysteresis temperatures. Make all but one (temp1_crit_hyst) read-only. Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 18:10:56 +00:00
* The hysteresis values can't be set independently. We decided to make
only temp1_crit_hyst writable, while all other hysteresis attributes
are read-only. Setting temp1_crit_hyst writes the difference between
temp1_crit_hyst and temp1_crit into the chip, and the same relative
hysteresis applies automatically to all other limits.
hwmon: (emc1403) Add driver documentation With the driver now supporting several chip variants, it is about time to document what is supported. Signed-off-by: Guenter Roeck <linux@roeck-us.net>
2014-05-12 17:11:32 +00:00
* The limits should be set before the hysteresis.
Reference in a new issue Copy permalink