Page MenuHomeFreeBSD

it8613hwm(4): add man page
AcceptedPublic

Authored by jo_bruelltuete.com on May 5 2023, 12:45 AM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 12 2023, 5:16 PM
Unknown Object (File)
Nov 6 2023, 6:45 PM
Unknown Object (File)
Oct 31 2023, 5:38 PM
Unknown Object (File)
Oct 9 2023, 11:52 AM
Unknown Object (File)
Oct 9 2023, 11:52 AM
Unknown Object (File)
Sep 29 2023, 5:47 PM
Unknown Object (File)
Sep 29 2023, 5:32 PM
Unknown Object (File)
Sep 6 2023, 4:22 AM
Subscribers
Restricted Owners Package

Details

Reviewers
grahamperrin
Group Reviewers
Contributor Reviews (src)
Summary

Add man page for new driver it8613hwm.
While here, make mandoc-linter happy.

This is a refresh for D36424.

Test Plan

Renders as:

IT8613HWM(4)           FreeBSD Kernel Interfaces Manual           IT8613HWM(4)

NAME
     it8613hwm – device driver for the ITE IT8613E Super I/O hardware monitor

SYNOPSIS
     To compile this driver into the kernel, place the following lines in your
     kernel configuration file:

           device superio
           device it8613hwm

     Alternatively, to load the driver as a module at boot time, place the
     following line in loader.conf(5):

           it8613hwm_load="YES"

DESCRIPTION
     The it8613hwm driver supports reading the temperature sensor and fan
     speed from the hardware monitor present in the IT8613E Super I/O chip.

     There are 3 temperature sensor channels, not all may be connected on the
     mainboard.  These are reported through a sysctl node named
     dev.it8613hwm.0.temperature%d, where %d ranges from 0 to 2 inclusive.

     There are also 3 fan speed channels, again not all may be connected on
     the mainboard, reported in RPM via dev.it8613hwm.0.fan%d.

EXAMPLES
     To get the current values for all temperature sensors and fans:

           $ sysctl dev.it8613hwm
           dev.it8613hwm.0.fan2: 1470
           dev.it8613hwm.0.fan1: 648
           dev.it8613hwm.0.fan0: 0
           dev.it8613hwm.0.temperature2: 35C
           dev.it8613hwm.0.temperature1: 40C
           dev.it8613hwm.0.temperature0: 49C

     As can be seen in this example, there is no fan connected to fan0.

SEE ALSO
     superio(4), sysctl(8)

AUTHORS
     The driver and manual page were written by Johannes Totz
     <jo@bruelltuete.com>.

BUGS
     No public datasheet is available for this chip.  The information to write
     this driver was obtained through trial-and-error and datasheets for
     similar chips.

FreeBSD 13.2-STABLE               May 8, 2023              FreeBSD 13.2-STABLE

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

grahamperrin added inline comments.
share/man/man4/it8613hwm.4
83
88
This revision now requires changes to proceed.May 5 2023, 6:34 AM

I deleted this word in the previous set of suggestions. Maybe Phabricator did not recognise the deletion.

share/man/man4/superio.4
95–96

review comments.
i hope i got that right... man page diffs are surprisingly hard to read...

grahamperrin added inline comments.
share/man/man4/it8613hwm.4
56
62
63

Probably superfluous, in that (for revolutions per minute) I would not expect anything other than a unit.

This revision now requires changes to proceed.May 8 2023, 3:17 PM
share/man/man4/it8613hwm.4
60
This revision is now accepted and ready to land.May 8 2023, 10:15 PM

Since the docs people have said OK, I'll commit this once D39970 is ready... and you certify that this adds nothing to the igor or mandoc -T lint output.

igor says:

$ igor -R -D -y share/man/man4/it8613hwm.4 | less -RS
it8613hwm.4 style check:
  "your" used 1 time
    "You" and "your" are informal and subjective.
    Attempt to be formal and objective: "the file" rather than "your file".
  "the following" used 5 times
    If something is following, the reader can see it without being told.

Those are in the license header and the synopsis blurp. which i copy-pasta'd from somewhere...

mandoc lint says nothing:

$ mandoc -T lint share/man/man4/it8613hwm.4
$