forked from Minki/linux
docs: hwmon: Add an index file and rename docs to *.rst
Now that all files were converted to ReST format, rename them and add an index. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
This commit is contained in:
parent
b04f2f7d38
commit
7ebd8b66dd
@ -21,7 +21,7 @@ If an optional property is not set in .dts file, then current value is kept
|
|||||||
unmodified (e.g. u-boot installed value).
|
unmodified (e.g. u-boot installed value).
|
||||||
|
|
||||||
Additional information on operational parameters for the device is available
|
Additional information on operational parameters for the device is available
|
||||||
in Documentation/hwmon/g762. A detailed datasheet for the device is available
|
in Documentation/hwmon/g762.rst. A detailed datasheet for the device is available
|
||||||
at http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf.
|
at http://natisbad.org/NAS/refs/GMT_EDS-762_763-080710-0.2.pdf.
|
||||||
|
|
||||||
Example g762 node:
|
Example g762 node:
|
||||||
|
@ -18,7 +18,7 @@ Authors:
|
|||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
See also Documentation/hwmon/abx500. This is the ST-Ericsson AB8500 specific
|
See also Documentation/hwmon/abx500.rst. This is the ST-Ericsson AB8500 specific
|
||||||
driver.
|
driver.
|
||||||
|
|
||||||
Currently only the AB8500 internal sensor and one external sensor for battery
|
Currently only the AB8500 internal sensor and one external sensor for battery
|
@ -21,7 +21,7 @@ the ACPI 4.0 spec (Chapter 10.4). These devices have a simple set of
|
|||||||
features--a power meter that returns average power use over a configurable
|
features--a power meter that returns average power use over a configurable
|
||||||
interval, an optional capping mechanism, and a couple of trip points. The
|
interval, an optional capping mechanism, and a couple of trip points. The
|
||||||
sysfs interface conforms with the specification outlined in the "Power" section
|
sysfs interface conforms with the specification outlined in the "Power" section
|
||||||
of Documentation/hwmon/sysfs-interface.
|
of Documentation/hwmon/sysfs-interface.rst.
|
||||||
|
|
||||||
Special Features
|
Special Features
|
||||||
----------------
|
----------------
|
@ -68,7 +68,7 @@ integrated 12 bit analog-to-digital converter (ADC), accessed using a
|
|||||||
PMBus interface.
|
PMBus interface.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver. Please see
|
The driver is a client driver to the core PMBus driver. Please see
|
||||||
Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
||||||
@ -90,7 +90,7 @@ Platform data support
|
|||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
The driver supports standard PMBus driver platform data. Please see
|
The driver supports standard PMBus driver platform data. Please see
|
||||||
Documentation/hwmon/pmbus for details.
|
Documentation/hwmon/pmbus.rst for details.
|
||||||
|
|
||||||
|
|
||||||
Sysfs entries
|
Sysfs entries
|
@ -68,4 +68,3 @@ The ADT7462 will scale the pwm between the lower and higher pwm speed when
|
|||||||
the temperature is between the two temperature boundaries. PWM values range
|
the temperature is between the two temperature boundaries. PWM values range
|
||||||
from 0 (off) to 255 (full speed). Fan speed will be set to maximum when the
|
from 0 (off) to 255 (full speed). Fan speed will be set to maximum when the
|
||||||
temperature sensor associated with the PWM control exceeds temp#_max.
|
temperature sensor associated with the PWM control exceeds temp#_max.
|
||||||
|
|
@ -106,4 +106,3 @@ different settings, you can set the following parameters:
|
|||||||
|
|
||||||
- init=1,
|
- init=1,
|
||||||
- pwminv: 0 default pwm output, 1 inverts pwm output.
|
- pwminv: 0 default pwm output, 1 inverts pwm output.
|
||||||
|
|
@ -71,4 +71,3 @@ TODO:
|
|||||||
* Experiment with temp. sensor types.
|
* Experiment with temp. sensor types.
|
||||||
* Are there really 13 voltage inputs? Probably not...
|
* Are there really 13 voltage inputs? Probably not...
|
||||||
* Cleanups, no doubt...
|
* Cleanups, no doubt...
|
||||||
|
|
@ -7,7 +7,7 @@ modes - PWM or DC - are supported by the device.
|
|||||||
|
|
||||||
For additional information, a detailed datasheet is available at
|
For additional information, a detailed datasheet is available at
|
||||||
http://natisbad.org/NAS/ref/GMT_EDS-762_763-080710-0.2.pdf. sysfs
|
http://natisbad.org/NAS/ref/GMT_EDS-762_763-080710-0.2.pdf. sysfs
|
||||||
bindings are described in Documentation/hwmon/sysfs-interface.
|
bindings are described in Documentation/hwmon/sysfs-interface.rst.
|
||||||
|
|
||||||
The following entries are available to the user in a subdirectory of
|
The following entries are available to the user in a subdirectory of
|
||||||
/sys/bus/i2c/drivers/g762/ to control the operation of the device.
|
/sys/bus/i2c/drivers/g762/ to control the operation of the device.
|
@ -12,10 +12,10 @@ drivers that want to use the hardware monitoring framework.
|
|||||||
This document does not describe what a hardware monitoring (hwmon) Driver or
|
This document does not describe what a hardware monitoring (hwmon) Driver or
|
||||||
Device is. It also does not describe the API which can be used by user space
|
Device is. It also does not describe the API which can be used by user space
|
||||||
to communicate with a hardware monitoring device. If you want to know this
|
to communicate with a hardware monitoring device. If you want to know this
|
||||||
then please read the following file: Documentation/hwmon/sysfs-interface.
|
then please read the following file: Documentation/hwmon/sysfs-interface.rst.
|
||||||
|
|
||||||
For additional guidelines on how to write and improve hwmon drivers, please
|
For additional guidelines on how to write and improve hwmon drivers, please
|
||||||
also read Documentation/hwmon/submitting-patches.
|
also read Documentation/hwmon/submitting-patches.rst.
|
||||||
|
|
||||||
The API
|
The API
|
||||||
-------
|
-------
|
@ -78,7 +78,7 @@ refer to the Documentation/devicetree/bindings/hwmon/ina2xx.txt for bindings
|
|||||||
if the device tree is used.
|
if the device tree is used.
|
||||||
|
|
||||||
Additionally ina226 supports update_interval attribute as described in
|
Additionally ina226 supports update_interval attribute as described in
|
||||||
Documentation/hwmon/sysfs-interface. Internally the interval is the sum of
|
Documentation/hwmon/sysfs-interface.rst. Internally the interval is the sum of
|
||||||
bus and shunt voltage conversion times multiplied by the averaging rate. We
|
bus and shunt voltage conversion times multiplied by the averaging rate. We
|
||||||
don't touch the conversion times and only modify the number of averages. The
|
don't touch the conversion times and only modify the number of averages. The
|
||||||
lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
|
lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
|
179
Documentation/hwmon/index.rst
Normal file
179
Documentation/hwmon/index.rst
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
=========================
|
||||||
|
Linux Hardware Monitoring
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
hwmon-kernel-api.rst
|
||||||
|
pmbus-core.rst
|
||||||
|
submitting-patches.rst
|
||||||
|
sysfs-interface.rst
|
||||||
|
userspace-tools.rst
|
||||||
|
|
||||||
|
Hardware Monitoring Kernel Drivers
|
||||||
|
==================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
ab8500.rst
|
||||||
|
abituguru.rst
|
||||||
|
abituguru3.rst
|
||||||
|
abx500.rst
|
||||||
|
acpi_power_meter.rst
|
||||||
|
ad7314.rst
|
||||||
|
adc128d818.rst
|
||||||
|
adm1021.rst
|
||||||
|
adm1025.rst
|
||||||
|
adm1026.rst
|
||||||
|
adm1031.rst
|
||||||
|
adm1275.rst
|
||||||
|
adm9240.rst
|
||||||
|
ads1015.rst
|
||||||
|
ads7828.rst
|
||||||
|
adt7410.rst
|
||||||
|
adt7411.rst
|
||||||
|
adt7462.rst
|
||||||
|
adt7470.rst
|
||||||
|
adt7475.rst
|
||||||
|
amc6821.rst
|
||||||
|
asb100.rst
|
||||||
|
asc7621.rst
|
||||||
|
aspeed-pwm-tacho.rst
|
||||||
|
coretemp.rst
|
||||||
|
da9052.rst
|
||||||
|
da9055.rst
|
||||||
|
dme1737.rst
|
||||||
|
ds1621.rst
|
||||||
|
ds620.rst
|
||||||
|
emc1403.rst
|
||||||
|
emc2103.rst
|
||||||
|
emc6w201.rst
|
||||||
|
f71805f.rst
|
||||||
|
f71882fg.rst
|
||||||
|
fam15h_power.rst
|
||||||
|
ftsteutates.rst
|
||||||
|
g760a.rst
|
||||||
|
g762.rst
|
||||||
|
gl518sm.rst
|
||||||
|
hih6130.rst
|
||||||
|
ibmaem.rst
|
||||||
|
ibm-cffps.rst
|
||||||
|
ibmpowernv.rst
|
||||||
|
ina209.rst
|
||||||
|
ina2xx.rst
|
||||||
|
ina3221.rst
|
||||||
|
ir35221.rst
|
||||||
|
it87.rst
|
||||||
|
jc42.rst
|
||||||
|
k10temp.rst
|
||||||
|
k8temp.rst
|
||||||
|
lineage-pem.rst
|
||||||
|
lm25066.rst
|
||||||
|
lm63.rst
|
||||||
|
lm70.rst
|
||||||
|
lm73.rst
|
||||||
|
lm75.rst
|
||||||
|
lm77.rst
|
||||||
|
lm78.rst
|
||||||
|
lm80.rst
|
||||||
|
lm83.rst
|
||||||
|
lm85.rst
|
||||||
|
lm87.rst
|
||||||
|
lm90.rst
|
||||||
|
lm92.rst
|
||||||
|
lm93.rst
|
||||||
|
lm95234.rst
|
||||||
|
lm95245.rst
|
||||||
|
ltc2945.rst
|
||||||
|
ltc2978.rst
|
||||||
|
ltc2990.rst
|
||||||
|
ltc3815.rst
|
||||||
|
ltc4151.rst
|
||||||
|
ltc4215.rst
|
||||||
|
ltc4245.rst
|
||||||
|
ltc4260.rst
|
||||||
|
ltc4261.rst
|
||||||
|
max16064.rst
|
||||||
|
max16065.rst
|
||||||
|
max1619.rst
|
||||||
|
max1668.rst
|
||||||
|
max197.rst
|
||||||
|
max20751.rst
|
||||||
|
max31722.rst
|
||||||
|
max31785.rst
|
||||||
|
max31790.rst
|
||||||
|
max34440.rst
|
||||||
|
max6639.rst
|
||||||
|
max6642.rst
|
||||||
|
max6650.rst
|
||||||
|
max6697.rst
|
||||||
|
max8688.rst
|
||||||
|
mc13783-adc.rst
|
||||||
|
mcp3021.rst
|
||||||
|
menf21bmc.rst
|
||||||
|
mlxreg-fan.rst
|
||||||
|
nct6683.rst
|
||||||
|
nct6775.rst
|
||||||
|
nct7802.rst
|
||||||
|
nct7904.rst
|
||||||
|
npcm750-pwm-fan.rst
|
||||||
|
nsa320.rst
|
||||||
|
ntc_thermistor.rst
|
||||||
|
occ.rst
|
||||||
|
pc87360.rst
|
||||||
|
pc87427.rst
|
||||||
|
pcf8591.rst
|
||||||
|
pmbus.rst
|
||||||
|
powr1220.rst
|
||||||
|
pwm-fan.rst
|
||||||
|
raspberrypi-hwmon.rst
|
||||||
|
sch5627.rst
|
||||||
|
sch5636.rst
|
||||||
|
scpi-hwmon.rst
|
||||||
|
sht15.rst
|
||||||
|
sht21.rst
|
||||||
|
sht3x.rst
|
||||||
|
shtc1.rst
|
||||||
|
sis5595.rst
|
||||||
|
smm665.rst
|
||||||
|
smsc47b397.rst
|
||||||
|
smsc47m192.rst
|
||||||
|
smsc47m1.rst
|
||||||
|
tc654.rst
|
||||||
|
tc74.rst
|
||||||
|
thmc50.rst
|
||||||
|
tmp102.rst
|
||||||
|
tmp103.rst
|
||||||
|
tmp108.rst
|
||||||
|
tmp401.rst
|
||||||
|
tmp421.rst
|
||||||
|
tps40422.rst
|
||||||
|
twl4030-madc-hwmon.rst
|
||||||
|
ucd9000.rst
|
||||||
|
ucd9200.rst
|
||||||
|
vexpress.rst
|
||||||
|
via686a.rst
|
||||||
|
vt1211.rst
|
||||||
|
w83627ehf.rst
|
||||||
|
w83627hf.rst
|
||||||
|
w83773g.rst
|
||||||
|
w83781d.rst
|
||||||
|
w83791d.rst
|
||||||
|
w83792d.rst
|
||||||
|
w83793.rst
|
||||||
|
w83795.rst
|
||||||
|
w83l785ts.rst
|
||||||
|
w83l786ng.rst
|
||||||
|
wm831x.rst
|
||||||
|
wm8350.rst
|
||||||
|
xgene-hwmon.rst
|
||||||
|
zl6100.rst
|
||||||
|
|
||||||
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
Indices
|
||||||
|
=======
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
@ -69,7 +69,7 @@ LM25066, LM5064, and LM5066/LM5066I Power Management, Monitoring,
|
|||||||
Control, and Protection ICs.
|
Control, and Protection ICs.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver. Please see
|
The driver is a client driver to the core PMBus driver. Please see
|
||||||
Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
@ -21,7 +21,7 @@ This driver supports hardware monitoring for Maxim MAX16064 Quad Power-Supply
|
|||||||
Controller with Active-Voltage Output Control and PMBus Interface.
|
Controller with Active-Voltage Output Control and PMBus Interface.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver.
|
The driver is a client driver to the core PMBus driver.
|
||||||
Please see Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Please see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
@ -31,4 +31,3 @@ Only the external sensor has high and low limits.
|
|||||||
The max1619 driver will not update its values more frequently than every
|
The max1619 driver will not update its values more frequently than every
|
||||||
other second; reading them more often will do no harm, but will return
|
other second; reading them more often will do no harm, but will return
|
||||||
'old' values.
|
'old' values.
|
||||||
|
|
@ -23,7 +23,7 @@ This driver supports MAX20751 Multiphase Master with PMBus Interface
|
|||||||
and Internal Buck Converter.
|
and Internal Buck Converter.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver.
|
The driver is a client driver to the core PMBus driver.
|
||||||
Please see Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Please see Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
@ -76,7 +76,7 @@ based on GIN pins. The MAX34460 supports 12 voltage channels, and the MAX34461
|
|||||||
supports 16 voltage channels.
|
supports 16 voltage channels.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver. Please see
|
The driver is a client driver to the core PMBus driver. Please see
|
||||||
Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
@ -72,4 +72,3 @@ clock: The clock frequency in Hz of the chip the driver should assume [254000]
|
|||||||
|
|
||||||
Please have a look at the MAX6650/6651 data sheet and make sure that you fully
|
Please have a look at the MAX6650/6651 data sheet and make sure that you fully
|
||||||
understand the meaning of these parameters before you attempt to change them.
|
understand the meaning of these parameters before you attempt to change them.
|
||||||
|
|
@ -21,7 +21,7 @@ This driver supports hardware monitoring for Maxim MAX8688 Digital Power-Supply
|
|||||||
Controller/Monitor with PMBus Interface.
|
Controller/Monitor with PMBus Interface.
|
||||||
|
|
||||||
The driver is a client driver to the core PMBus driver. Please see
|
The driver is a client driver to the core PMBus driver. Please see
|
||||||
Documentation/hwmon/pmbus for details on PMBus client drivers.
|
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
|
||||||
|
|
||||||
|
|
||||||
Usage Notes
|
Usage Notes
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user