summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/sysfs-interface
Commit message (Collapse)AuthorAgeFilesLines
* docs: hwmon: Add an index file and rename docs to *.rstMauro Carvalho Chehab2019-04-171-1086/+0
| | | | | | | | 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>
* docs: hwmon: convert remaining files to ReST formatMauro Carvalho Chehab2019-04-171-236/+495
| | | | | | | | 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>
* hwmon: Document the samples attributesAdamski, Krzysztof (Nokia - PL/Wroclaw)2019-04-151-0/+18
| | | | | | | Document new ABI attributes: {in,power,curr,temp}_samples and samples. Signed-off-by: Krzysztof Adamski <krzysztof.adamski@nokia.com> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Document the sensor enable attributeShilpasri G Bhat2018-07-081-0/+48
| | | | | | | | | | | | | | | | Document new ABI attributes: in[0-*]_enable fan[1-*]_enable temp[1-*]_enable curr[1-*]_enable power[1-*]_enable energy[1-*]_enable humidity[1-*]_enable Signed-off-by: Shilpasri G Bhat <shilpa.bhat@linux.vnet.ibm.com> [groeck: Updated commit text, removed unnecessary details from ABI description] Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Update documentation to clarify rules for the 'name' attributeGuenter Roeck2017-01-251-2/+3
| | | | | | | | | Clarify that the name attribute must report a valid name, and the rules for valid names. Also clarify that the name parameter must be provided for all supported API functions. Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Document temp[1-*]_min_hyst sysfs attributeJean Delvare2014-05-251-0/+14
| | | | | | | | | | | | The temp[1-*]_min_hyst sysfs attribute is already implemented by 3 hwmon drivers (adt7x10, lm77 and lm92) but was missing from the standard interface. Also add temp[1-*]_lcrit_hyst for consistency, even though no driver implement that one for the time being. Signed-off-by: Jean Delvare <jdelvare@suse.de> Reviewed-by: Guenter Roeck <linux@roeck-us.net>
* hwmon: Retire SENSORS_LIMITGuenter Roeck2013-01-251-4/+4
| | | | | | | | SENSORS_LIMIT and clamp_val have the same functionality, so retire SENSORS_LIMIT as it is no longer needed. Signed-off-by: Guenter Roeck <linux@roeck-us.net> Acked-by: Jean Delvare <khali@linux-fr.org>
* hwmon: (sysfs-interface) Update tempX_type attribute to be more genericGuenter Roeck2012-01-161-1/+1
| | | | | | | | | | The temp[1-*]_type attribute reports the temperature sensor type. Sensor type 1 is described as "PII/Celeron Diode", which is quite restrictive; other CPUs may also have an embedded temperature sensor diode with similar characteristics. Change description to "CPU embedded diode" to be more generic. Signed-off-by: Guenter Roeck <linux@roeck-us.net> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Add new attributes to sysfs ABIGuenter Roeck2011-07-281-0/+46
| | | | | | | | | | | | | | | | | | | Add the following attributes to the sysfs ABI. in[0-*]_average in[0-*]_lowest in[0-*]_highest in[0-*]_reset_history in_reset_history curr[1-*]_average curr[1-*]_lowest curr[1-*]_highest curr[1-*]_reset_history curr_reset_history Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Reviewed-by: Robert Coulson <robert.coulson@ericsson.com>
* Fix common misspellingsLucas De Marchi2011-03-311-1/+1
| | | | | | Fixes generated by 'codespell' and manually reviewed. Signed-off-by: Lucas De Marchi <lucas.demarchi@profusion.mobi>
* hwmon: Add tachometer pulses per fan revolution to sysfs ABIGuenter Roeck2011-03-141-0/+11
| | | | | | | | | Some fan control chips support a configuration register to set the number of tachometer pulses per fan revolution. Add an ABI attribute to support this configuration register. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Acked-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Add humidity attribute to sysfs ABIGuenter Roeck2011-01-081-0/+9
| | | | | | | | | The humidity attribute is already supported by the sht15 driver, and another driver supporting it is about to be added. Make it official. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Acked-by: Jonathan Cameron <jic23@cam.ac.uk> Acked-by: Jean Delvare <khali@linux-fr.org>
* hwmon: sysfs ABI updatesGuenter Roeck2011-01-081-7/+33
| | | | | | Add attributes supported by various PMBus devices to hwmon sysfs ABI. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com>
* hwmon: Add tempX_emergency attribute to sysfs ABIGuenter Roeck2010-10-281-0/+15
| | | | | Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: (adm1031) Replace update_rate sysfs attribute with update_intervalGuenter Roeck2010-09-171-4/+3
| | | | | | | | The attribute reflects an interval, not a rate. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Acked-by: Ira W. Snyder <iws@ovro.caltech.edu> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Remove in[0-*]_fault from sysfs-interfaceJean Delvare2010-08-141-1/+0
| | | | | | | | | | Fault files are for hardware failures that can be reported. So far we've seen chips reporting such failures for temperature sensors and fans, but not for voltages. Remove in[0-*]_fault for now. It can be added back later if really needed, but I doubt it. Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Guenter Roeck <guenter.roeck@ericsson.com>
* hwmon: Add 4 current alarm/beep attributes to sysfs-interfaceGuenter Roeck2010-08-141-3/+4
| | | | | | | | | | | Add currX_alarm, currX_min_alarm, currX_max_alarm and currX_beep attributes to the hwmon sysfs API. currX_min_alarm and currX_max_alarm are already supported by the LTC4215 and LTC4245 drivers. currX_alarm is supported by the LTC4261 driver. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Add 3 critical limit attributes to sysfs-interfaceGuenter Roeck2010-08-141-1/+20
| | | | | | | | Added _lcrit and _crit to voltage attributes. Added _lcrit to temperature attributes. Signed-off-by: Guenter Roeck <guenter.roeck@ericsson.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Add description of the update_rate sysfs attributeIra W. Snyder2010-05-271-3/+10
| | | | | | | | The update_rate attribute can be used by drivers to let userspace choose the update rate of the chip, if it is configurable. Signed-off-by: Ira W. Snyder <iws@ovro.caltech.edu> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Clarify autopwm trip points documentationJean Delvare2009-12-091-2/+9
| | | | | | | | Document the case of hybrid automatic fan speed control implementations, where trip points are associated to both PWM output channels and temperature input channels. Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: enhance the sysfs API for power metersDarrick J. Wong2009-10-291-1/+56
| | | | | | | | | | | | Augment the documentation of the hwmon sysfs API to accomodate ACPI power meters and the current desired behavior of power capping hardware drivers. Signed-off-by: Darrick J. Wong <djwong@us.ibm.com> Cc: Zhang Rui <rui.zhang@intel.com> Cc: Pavel Machek <pavel@ucw.cz> Cc: Len Brown <len.brown@intel.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* hwmon: (tmp401) Add documentationAndre Prendel2009-06-151-0/+19
| | | | | | | | | | | | | | Documentation for the tmp401 driver. The documentation describes the tmp401 driver and the supported Texas Instruments TMP401 and TMP411 temperature sensor chips. Further documentation for new sysfs attributes supported by this driver is added to Documentation/hwmon/sysfs-interface. Signed-off-by: Andre Prendel <andre.prendel@gmx.de> Acked-by: Hans de Goede <hdegoede@redhat.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Update documentation on fan_maxChristian Engelmayer2009-06-011-0/+6
| | | | | | | | | | Add fan_max description. Add fan limit alarm 'max_alarm' to the alarm section. Signed-off-by: Christian Engelmayer <christian.engelmayer@frequentis.com> Acked-by: Hans de Goede <hdegoede@redhat.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Define a standard interface for chassis intrusion detectionJean Delvare2009-03-301-0/+22
| | | | | | | | | | | Define a standard interface for the chassis intrusion detection feature some hardware monitoring chips have. Some drivers have custom sysfs entries for it, but a standard interface would allow integration with user-space (namely libsensors.) Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Hans de Goede <j.w.r.degoede@hhs.nl> Acked-by: Matt Roberds <mattroberds@cox.net>
* hwmon: Define sysfs interface for energy consumption registerDarrick J. Wong2008-10-091-0/+12
| | | | | | | Describe the sysfs files that were introduced in the ibmaem driver. Signed-off-by: Darrick J. Wong <djwong@us.ibm.com> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Update the sysfs interface documentationJean Delvare2008-06-191-20/+13
| | | | | | | | | * Document the characteristics of libsensors 3.0.0 and 3.0.1. * The sysfs interface is no longer subject to changes. Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Juerg Haefliger <juergh at gmail.com> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Add power meter spec to Documentation/hwmon/sysfs-interfaceDarrick J. Wong2007-11-081-0/+31
| | | | | | | | | Update the hwmon sysfs interface documentation to include a specification for power meters. Signed-off-by: Darrick J. Wong <djwong@us.ibm.com> Acked-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Fix the code examples in documentationJean Delvare2007-10-091-17/+15
| | | | | | | | | Fix a bug in the code examples, make them comply with CodingStyle, and indent them for a better redability. Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Hans de Goede <j.w.r.degoede@hhs.nl> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: update sysfs interface document - error handlingHans de Goede2007-10-091-0/+58
| | | | | | | | | | Here is a patch adding some text to the sysfs interface documentation on how settings written to sysfs attributes should be handled, focussing mainly on error handling. This version incorperates Jean's latest comments. Signed-off-by: Hans de Goede <j.w.r.degoede@hhs.nl> Acked-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Update the sysfs interface documentationJean Delvare2007-10-091-34/+41
| | | | | | | | | | | * Document the name attribute. * Document the *_label attributes. * Drop "typical usage" lists, they no longer match the reality. * Drop non hardware-monitoring related entries. Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Hans de Goede <j.w.r.degoede@hhs.nl> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Don't export thermistor betaJean Delvare2007-10-091-2/+2
| | | | | | | | | Deprecate the use of thermistor beta values as thermal sensor types. No driver supports changing the beta value anyway. Signed-off-by: Jean Delvare <khali@linux-fr.org> Acked-by: Hans de Goede <j.w.r.degoede@hhs.nl> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Improve the pwmN_enable documentationJean Delvare2007-07-191-5/+4
| | | | | | | | The documentation of the pwmN_enable interface file is not very clear, and has been confusing several driver authors already. Make it clearer. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Mark M. Hoffman <mhoffman@lightlink.com>
* hwmon: Fault files naming conventionJean Delvare2007-07-191-3/+3
| | | | | | | | | | | | | | | | | | | | We have the following naming convention documented in Documentation/hwmon/sysfs-interface for fault files: in[0-*]_input_fault fan[1-*]_input_fault temp[1-*]_input_fault Some drivers follow this convention (lm63, lm83, lm90, smsc47m192). However some drivers omit the "input" part and create files named fan1_fault (pc87427) or temp1_fault (dme1737). And the new "generic" libsensors follows this second (non-standard) convention, so it fails to report fault conditions for drivers which follow the standard. We want a single naming scheme, and everyone seems to prefer the shorter variant, so let's go for it. Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon: Document the new fan1_target interface fileJean Delvare2007-05-081-0/+7
| | | | Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon/it87: Add PWM base frequency controlJean Delvare2007-02-141-5/+10
| | | | | | | | | | | Let the user select the base PWM frequency when using the it87 hardware monitoring driver. Different frequencies can give better control on some fans. Also update the documentation to mention the PWM frequency control files, with misc cleanups to the PWM section. Signed-off-by: Jean Delvare <khali@linux-fr.org>
* hwmon/w83793: Add documentation and maintainerRudolf Marek2006-12-121-1/+3
| | | | | | | | | | Documentation for the new w83793 hardware monitoring driver, originally provided by Yuan My from Winbond. Also add myself as the maintainer of this driver. Signed-off-by: Rudolf Marek <r.marek@assembler.cz> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* [PATCH] hwmon: Sysfs interface documentation update, 2 of 2, take 2Jean Delvare2006-06-221-16/+29
| | | | | | | | | Reword and complete certain parts of the hwmon sysfs-interface documentation file. Hopefully this will make things clearer for new driver authors. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] hwmon: Sysfs interface documentation update, 1 of 2Rudolf Marek2006-06-221-74/+107
| | | | | | | | | This patch cleans up hwmon sysfs documentation file, plus introduces the description of DC/PWM selection for fan speed control. Signed-off-by: Rudolf Marek <r.marek@sh.cvut.cz> Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] hwmon: Add sysfs interface for individual alarm filesJean Delvare2006-06-221-25/+73
| | | | | | | | | | | | | | | | Extend the sysfs interface of hardware monitoring chips, by adding individual alarm and beep files. Contrary to the old aggregated "alarms" and "beeps" files, individual files constitute a standard way to access the status information, making it finally possible to implement a chip-independant hardware monitoring chip access library (once all drivers have been added this new interface, that is.) If future drivers need more individual files, the interface will be extended as needed at the same time these drivers are merged into the kernel tree. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] smsc47m192: New hwmon driver for SMSC LPC47M192/997Hartmut Rick2006-06-221-0/+6
| | | | | | | | | New driver (smsc47m192) which supports voltage and temperature measurement features of SMSC LPC47M192 and LPC47M997 chips. Signed-off-by: Hartmut Rick <linux@rick.claranet.de> Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] hwmon: New f71805f driverJean Delvare2006-02-061-1/+17
| | | | | | | | | | | | | | | This is my f71805f hardware monitoring driver ported from lm_sensors to Linux 2.6. This new driver differs from the other hardware monitoring drivers in that it is implemented as a platform driver. This might not be optimal yet (we would probably need a generic infrastructure and bus type for Super-I/O logical devices) but it is certainly much better than the i2c-isa solution. Note that this driver requires lm_sensors CVS. I hope to get it released as 2.10.0 soon. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] hwmon: Add PEC support to the lm90 driverJean Delvare2005-10-281-0/+3
| | | | | | | | | | | | | | Add PEC support to the lm90 driver. Only the ADM1032 chip supports it, and in a rather tricky way, which is why this patch comes with documentation reinforcements. At least, this demonstrates that the new PEC support logic in i2c-core can properly deal with chips with partial PEC support. As enabling PEC causes a significant performance drop, it can be disabled through a sysfs file (unsurprisingly named "pec"). Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] I2C: Move hwmon drivers (3/3)Jean Delvare2005-07-111-0/+274
Part 3: Move the drivers documentation, plus two general documentation files. Note that the patch "adds trailing whitespace", because it does move the files as-is, and some files happen to have trailing whitespace. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-30 11:46:55 +0000