Page MenuHomeFreeBSD

snd_hda.4: Improve HARDWARE for HW Relnotes
ClosedPublic

Authored by ziaee on Jan 17 2025, 3:15 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Oct 15, 1:26 AM
Unknown Object (File)
Fri, Oct 3, 4:36 AM
Unknown Object (File)
Thu, Oct 2, 3:45 PM
Unknown Object (File)
Sun, Sep 21, 9:28 PM
Unknown Object (File)
Sep 15 2025, 3:26 PM
Unknown Object (File)
Sep 15 2025, 10:17 AM
Unknown Object (File)
Sep 14 2025, 12:48 AM
Unknown Object (File)
Sep 13 2025, 12:16 PM
Subscribers

Details

Summary

Rewrite the HARDWARE section to improve hardware release notes. Add a
path to the complete list in src like we did in u3g.4, and move it after
DESCRIPTION like we did in all Wi-Fi drivers. Hopefully, we can
improve the HW Relnotes generation to add a cgit link when it sees a
path macro. While here, tag SPDX and remove document description quotes.

MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Jan 17 2025, 3:15 PM

While I guess u3g.4 might indeed include the full list of supported devices, simply because IIRC many of them require some quirks to attach and operate, the snd_hda was written with a goal to work on unknown hardware. The list of devices in the code in most cases is just for cosmetics and user convenience. That is why I would not like it to be listed as more than examples. We've actually had a list in the man page before, but I axed it out at some point.

Seconding @mav's comment. Looking at the defined codecs in sys/dev/sound/pci/hda/hdac.c can be helpful, but also misleading.

Thanks! This is great info. I'll reflect on proper wording to reflect that it's designed to work on potentially unknown hardware.

share/man/man4/snd_hda.4
398

Would it be better to just say "...supports any PCI class 04h subclass 03h audio controllers...."? Although I do understand what you mean by "potentially unknown", I think it is somewhat non-obvious.

Thanks christos! Is this better?

This revision is now accepted and ready to land.Jun 12 2025, 12:50 AM
This revision was automatically updated to reflect the committed changes.