hradio: Add driver to report RFKILL button press
ClosedPublic
Actions

Authored by obiwac on Thu, Jun 25, 2:09 AM.

Details

Reviewers

wulf
git_danielschaefer.me
aokblast
0mp
ziaee

Group Reviewers

manpages

Commits

rGe2d56447b3a9: hrfkill: Add driver to report RFKILL button press

Summary

This driver only reports the RFKILL button presses for the time being.

This is needed for the "airplane" key on some Framework laptops.

Event: Halifax Hackathon 202606
Location: vishwin@'s car
Co-authored-by: Daniel Shaefer
Sponsored by: The FreeBSD Foundation
Sponsored by: Framework Computer Inc

Test Plan

See D56026 for previous revision and discussion.

Made into separate hradio(4) driver at wulf@'s request.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

obiwac created this revision.Thu, Jun 25, 2:09 AM

Herald added subscribers: ziaee, imp. · View Herald TranscriptThu, Jun 25, 2:09 AM

obiwac requested review of this revision.Thu, Jun 25, 2:09 AM

Harbormaster completed remote builds in B74225: Diff 180587.Thu, Jun 25, 2:09 AM

ziaee added a reviewer: manpages.Thu, Jun 25, 2:53 AM

ziaee added inline comments.

share/man/man4/hradio.4
2–4 ↗	(On Diff #180587)	Probably meaningless nit: On the second page of style(9) it shows the copyright coming first. Sorry I didn't notice on the one that was complained about on the mailing list.
14 ↗	(On Diff #180587)	I wonder if we should do something like this to facilitate search accessibility? This does have a regression over the draft in omitting "radio", but I can't think of any ways that aren't clunky.
16–32 ↗	(On Diff #180587)	Would you be willing to use this? Everywhere else in the manual for many generations `SYNOPSIS` means "list the options, no prose". Currently we have around 200/500 driver manuals written this way, and I gave a talk on trying to consolidate around doing it that way last year at BSDCan, and I also posted uncontested on arch@ in January. I have an open revision to update our style guides to do it this way (D54586), and some parts of the FreeBSD documentation primer suggested to do so since long before I showed up.
39 ↗	(On Diff #180587)	We should mention something about how it reports the buttons so readers can know how to use it. In hgame(4) last year I wrote "and presents them to applications over the evdev interface".
41–46 ↗	(On Diff #180587)	This paragraph is usually for `CAVEATS`.
46 ↗	(On Diff #180587)	This section gets pulled verbatim into the hardware compatibility list, I wrote about it a little in style.mdoc(5).
50 ↗	(On Diff #180587)	Traditionally no period here, because this is not a sentence.
53 ↗	(On Diff #180587)	Traditionally we use no period here, I think the linter will complain also. All the hid drivers appear to also have xrefs back and forth to hidbus(4).

shuriku_shurik.kiev.ua added a subscriber: shuriku_shurik.kiev.ua.Thu, Jun 25, 5:49 AM

apply ziaee@'s suggestions

Harbormaster completed remote builds in B74309: Diff 180775.Fri, Jun 26, 6:38 PM

obiwac added inline comments.Fri, Jun 26, 6:38 PM

share/man/man4/hradio.4
2–4 ↗	(On Diff #180587)	i am really in favour of changing this in style(9). It doesn't make much sense to me to have this wedged inside the copyright header, especially for files with many copyright owners, and the vast majority of our tree and most of open source puts this as the first line.
14 ↗	(On Diff #180587)	this will be a more generic "radio" driver in the future, so I don't want to just call it "airplane mode key". I guess "rfkill" would be a better name here, and maybe even hrfkill would be a better name than hradio on second thought.
16–32 ↗	(On Diff #180587)	sure

Looks good from manpages! I defer to senior colleagues for the rest of the implementation.

share/man/man4/hradio.4
2–4 ↗	(On Diff #180587)	Ok I won't request changes on this, but please, take that up with srcmgr@, this is beyond my jurisdiction and changing style guides is well beyond the scope of this thread. IIUC, to be a good teammate I'm supposed to kindly ask you to follow the guidelines we have in place (which is consistent in many places). It's one thing if we have many different conflicting guidelines, like in the case of SYNOPSIS I'm trying to standardize.
16–32 ↗	(On Diff #180587)	Thanks!