Skip to contentSkip to conversation

documentation-only update for w83791d to note

PATCH New Charles Spirakis 2 participants 4 messages Aug 17, 2006 – Aug 18, 2006

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 documentation-only update for w83791d to note

From: Charles Spirakis <bezaur at gmail.com>

The alarm bits and the beep enable bits are in different positions in the hardware. This patch documents the problem and leaves it to the user-space code to handle the situation. When this driver is updated to the standardized sysfs alarm/beep methodology, this won't be a problem.

This is a documentation only change.

Signed-off by: Charles Spirakis <bezaur at gmail.com>

---

 Documentation/hwmon/w83791d |   70
+++++++++++++++++++++++++------------------- drivers/hwmon/w83791d.c
  |    6 ++-
 2 files changed, 44 insertions(+), 32 deletions(-)

-------------- next part --------------
A non-text attachment was scrubbed...
Name: w83791d_update.patch
Type: text/x-patch
Size: 5812 bytes
Desc: not available
Url : http://lists.lm-sensors.org/pipermail/lm-sensors/attachments/20060817/9c817129/attachment-0001.bin

#1 lore raw

PATCH 1/1 documentation-only update for w83791d to

Hi Charles,

Quoted 8 lines

From: Charles Spirakis <bezaur at gmail.com>

The alarm bits and the beep enable bits are in different positions in the hardware. This patch documents the problem and leaves it to the user-space code to handle the situation. When this driver is updated to the standardized sysfs alarm/beep methodology, this won't be a problem.

This is a documentation only change.

Mostly fine with me, see my comments inline.

Review

Quoted 2 lines
(quoted diff) +2 -0
+alarm_rsvd   :  alarms: 0x800000 beep_enable: --------
+reserved     :  alarms: 0x008000 beep_enable: 0x008000

I don't think it's worth documenting these, as they won't ever be used by definition.

Review

Quoted 4 lines
(quoted diff) +4 -0
+
+*** NOTE: It is the responsibility of user-space code to handle the fact
+that the enable and alarm bits are in different positions when using that
+feature of the chip.

Please write "beep enable" rather than only "enable", it's clearer.

Review often will do no harm, but will return ' · line 121

Quoted 10 lines

When an alarm goes off, you can be warned by a beeping signal through your computer speaker. It is possible to enable all beeping globally, or only

(quoted diff) +2 -1
@@ -109,5 +117,7 @@ often will do no harm, but will return '
 
 W83791D TODO:
 ---------------
-Provide a patch for per-file alarms as discussed on the mailing list
+Provide a patch for per-file alarms and beep enables as defined in the hwmon
+	documentation (.../Documentation/hwmon/sysfs-interface)

No need to add ".../" before documentation.

Review often will do no harm, but will return ' · line 123

Quoted 2 lines
(quoted diff) +1 -0
 Provide a patch for smart-fan control (still need appropriate motherboard/fans)
+

No need to add this blank line.

drivers/hwmon/w83791d.c line 34

Quoted 13 lines

diff -urpN linux-2.6.18-rc2-git2/drivers/hwmon/w83791d.c linux-2.6.18-rc2-git2_update/drivers/hwmon/w83791d.c

drivers/hwmon/w83791d.c +3 -2
@@ -28,8 +28,9 @@
     The w83791d chip appears to be part way between the 83781d and the
     83792d. Thus, this file is derived from both the w83792d.c and
     w83781d.c files, but its output is more along the lines of the
-    83781d (which means there are no changes to the user-mode sensors
-    program which treats the 83791d as an 83781d).
+    83781d.
+
+    The w83791g chip is the same as the w83791d but lead-free.
 */

While you're at it, what about removing the "its output is more along the lines of the 83781d" part? I don't see how relevant it is, the output is standardized anyway.

Thanks,

Signature · 1 line
Jean Delvare
#2 lore raw

PATCH 1/1 documentation-only update for w83791d to

In reply to Charles Spirakis

No disagreements.

Updated patch enclosed.

-- charles

Quoted 62 lines · Jean Delvare

Hi Charles,

Quoted 8 lines

From: Charles Spirakis <bezaur at gmail.com>

The alarm bits and the beep enable bits are in different positions in the hardware. This patch documents the problem and leaves it to the user-space code to handle the situation. When this driver is updated to the standardized sysfs alarm/beep methodology, this won't be a problem.

This is a documentation only change.

Mostly fine with me, see my comments inline.

Review

Quoted 2 lines
(quoted diff) +2 -0
+alarm_rsvd   :  alarms: 0x800000 beep_enable: --------
+reserved     :  alarms: 0x008000 beep_enable: 0x008000

I don't think it's worth documenting these, as they won't ever be used by definition.

Review

Quoted 4 lines
(quoted diff) +4 -0
+
+*** NOTE: It is the responsibility of user-space code to handle the fact
+that the enable and alarm bits are in different positions when using that
+feature of the chip.

Please write "beep enable" rather than only "enable", it's clearer.

Review often will do no harm, but will return ' · line 121

Quoted 10 lines

When an alarm goes off, you can be warned by a beeping signal through your computer speaker. It is possible to enable all beeping globally, or only

(quoted diff) +2 -1
@@ -109,5 +117,7 @@ often will do no harm, but will return '
 
 W83791D TODO:
 ---------------
-Provide a patch for per-file alarms as discussed on the mailing list
+Provide a patch for per-file alarms and beep enables as defined in the hwmon
+     documentation (.../Documentation/hwmon/sysfs-interface)

No need to add ".../" before documentation.

Review often will do no harm, but will return ' · line 123

Quoted 2 lines
(quoted diff) +1 -0
 Provide a patch for smart-fan control (still need appropriate motherboard/fans)
+

No need to add this blank line.

drivers/hwmon/w83791d.c 2006-08-17 11:30:12.000000000 -0700 line 34

Quoted 13 lines

diff -urpN linux-2.6.18-rc2-git2/drivers/hwmon/w83791d.c linux-2.6.18-rc2-git2_update/drivers/hwmon/w83791d.c

drivers/hwmon/w83791d.c 2006-08-17 11:30:12.000000000 -0700 renamed from drivers/hwmon/w83791d.c 2006-07-24 19:00:43.000000000 -0700 +3 -2
@@ -28,8 +28,9 @@
     The w83791d chip appears to be part way between the 83781d and the
     83792d. Thus, this file is derived from both the w83792d.c and
     w83781d.c files, but its output is more along the lines of the
-    83781d (which means there are no changes to the user-mode sensors
-    program which treats the 83791d as an 83781d).
+    83781d.
+
+    The w83791g chip is the same as the w83791d but lead-free.
 */

While you're at it, what about removing the "its output is more along the lines of the 83781d" part? I don't see how relevant it is, the output is standardized anyway.

Quoted 4 lines

Thanks,
--
Jean Delvare

-------------- next part --------------
A non-text attachment was scrubbed...
Name: w83791d_update.patch
Type: text/x-patch
Size: 5710 bytes
Desc: not available
Url : http://lists.lm-sensors.org/pipermail/lm-sensors/attachments/20060818/7b7dcbee/attachment.bin