Skip to contentSkip to conversation

Documentation: hwmon: lm75: document sysfs interface

PATCH Superseded Chen-Shi-Hong 2 participants 4 messages May 16 1 message not in the archive

Subsystems (2)
lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH v2 1/1 Documentation: hwmon: lm75: document sysfs interface

Document the sysfs attributes supported by the lm75 driver.

The driver exposes temp1_input, temp1_max, temp1_max_hyst, and the standard update_interval attribute. Some chips also expose temp1_alarm, and temp1_label is available if a label is provided for the device.

Add a sysfs-Interface section to Documentation/hwmon/lm75.rst to describe the supported attributes and clarify that temp1_alarm, temp1_label, and the write permissions of update_interval depend on the chip.

---
 Documentation/hwmon/lm75.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/hwmon/lm75.rst +25 -0
index 4269da04508e..fa8ddcaa0c2b 100644
@@ -181,3 +181,28 @@ is supported by this driver, other specific enhancements are not.
 
 The LM77 is not supported, contrary to what we pretended for a long time.
 Both chips are simply not compatible, value encoding differs.
+
+sysfs-Interface
+---------------
+
+================ ============================================
+temp1_input      temperature input
+temp1_max        maximum temperature
+temp1_max_hyst   maximum temperature hysteresis
+================ ============================================
+
+If a label is provided for the device, the following attribute is also
+available:
+
+================ ============================================
+temp1_label      temperature channel label
+================ ============================================
+
+If supported by the chip, the following attribute is also available:
+
+================ ============================================
+temp1_alarm      temperature alarm
+================ ============================================
+
+The standard update_interval attribute is also supported. Its write
+permissions depend on the chip.
Signature · 1 line
2.53.0
maintainer
#2 lore raw
Quoted 6 lines · Chen-Shi-Hong

Document the sysfs attributes supported by the lm75 driver.

The driver exposes temp1_input, temp1_max, temp1_max_hyst, and the standard update_interval attribute. Some chips also expose temp1_alarm, and temp1_label is available if a label is provided for the device.

Quoted 6 lines

Add a sysfs-Interface section to Documentation/hwmon/lm75.rst to describe the supported attributes and clarify that temp1_alarm, temp1_label, and the write permissions of update_interval depend on the chip.

Change log is missing.

Yes, I do see Sashiko's reply, but that is not an excuse for neglecting to provide a change log.

Guenter

Quoted 37 lines
---
  Documentation/hwmon/lm75.rst | 25 +++++++++++++++++++++++++
  1 file changed, 25 insertions(+)
Documentation/hwmon/lm75.rst +25 -0
index 4269da04508e..fa8ddcaa0c2b 100644
@@ -181,3 +181,28 @@ is supported by this driver, other specific enhancements are not.
 
  The LM77 is not supported, contrary to what we pretended for a long time.
  Both chips are simply not compatible, value encoding differs.
+
+sysfs-Interface
+---------------
+
+================ ============================================
+temp1_input      temperature input
+temp1_max        maximum temperature
+temp1_max_hyst   maximum temperature hysteresis
+================ ============================================
+
+If a label is provided for the device, the following attribute is also
+available:
+
+================ ============================================
+temp1_label      temperature channel label
+================ ============================================
+
+If supported by the chip, the following attribute is also available:
+
+================ ============================================
+temp1_alarm      temperature alarm
+================ ============================================
+
+The standard update_interval attribute is also supported. Its write
+permissions depend on the chip.
#3 lore raw

PATCH v3 1/1 Documentation: hwmon: lm75: document sysfs interface

In reply to a message not in the archive

Document the sysfs attributes supported by the lm75 driver.

The driver exposes temp1_input, temp1_max, temp1_max_hyst, and the standard update_interval attribute. Some chips also expose temp1_alarm, and temp1_label is available if a label is provided for the device.

Add a sysfs-Interface section to Documentation/hwmon/lm75.rst to describe the supported attributes and clarify that temp1_alarm, temp1_label, and the write permissions of update_interval depend on the chip.

---
Changes in v2:
- Document temp1_label as conditionally available when a device label is provided.

Changes in v3:
- Add changelog requested during review.

 Documentation/hwmon/lm75.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/hwmon/lm75.rst +25 -0
index 4269da04508e..fa8ddcaa0c2b 100644
@@ -181,3 +181,28 @@ is supported by this driver, other specific enhancements are not.
 
 The LM77 is not supported, contrary to what we pretended for a long time.
 Both chips are simply not compatible, value encoding differs.
+
+sysfs-Interface
+---------------
+
+================ ============================================
+temp1_input      temperature input
+temp1_max        maximum temperature
+temp1_max_hyst   maximum temperature hysteresis
+================ ============================================
+
+If a label is provided for the device, the following attribute is also
+available:
+
+================ ============================================
+temp1_label      temperature channel label
+================ ============================================
+
+If supported by the chip, the following attribute is also available:
+
+================ ============================================
+temp1_alarm      temperature alarm
+================ ============================================
+
+The standard update_interval attribute is also supported. Its write
+permissions depend on the chip.
Signature · 1 line
2.53.0
maintainer
#4 lore raw
Quoted 6 lines · Chen-Shi-Hong

Document the sysfs attributes supported by the lm75 driver.

The driver exposes temp1_input, temp1_max, temp1_max_hyst, and the standard update_interval attribute. Some chips also expose temp1_alarm, and temp1_label is available if a label is provided for the device.

Quoted 6 lines

Add a sysfs-Interface section to Documentation/hwmon/lm75.rst to describe the supported attributes and clarify that temp1_alarm, temp1_label, and the write permissions of update_interval depend on the chip.

When I tried to apply this patch, I noticed that a similar patch is already queued in hwmon-next. Sorry that I didn't realize this earlier.

Guenter

Quoted 44 lines

---
Changes in v2:
- Document temp1_label as conditionally available when a device label is provided.

Changes in v3:
- Add changelog requested during review.

 Documentation/hwmon/lm75.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/hwmon/lm75.rst +25 -0
index 4269da04508e..fa8ddcaa0c2b 100644
@@ -181,3 +181,28 @@ is supported by this driver, other specific enhancements are not.
 
 The LM77 is not supported, contrary to what we pretended for a long time.
 Both chips are simply not compatible, value encoding differs.
+
+sysfs-Interface
+---------------
+
+================ ============================================
+temp1_input      temperature input
+temp1_max        maximum temperature
+temp1_max_hyst   maximum temperature hysteresis
+================ ============================================
+
+If a label is provided for the device, the following attribute is also
+available:
+
+================ ============================================
+temp1_label      temperature channel label
+================ ============================================
+
+If supported by the chip, the following attribute is also available:
+
+================ ============================================
+temp1_alarm      temperature alarm
+================ ============================================
+
+The standard update_interval attribute is also supported. Its write
+permissions depend on the chip.