Bug 58161 - Misleading description for CONFIG_SND_HDA_INTEL, snd_hda_intel module
Summary: Misleading description for CONFIG_SND_HDA_INTEL, snd_hda_intel module
Status: RESOLVED WILL_NOT_FIX
Alias: None
Product: Drivers
Classification: Unclassified
Component: Sound(ALSA) (show other bugs)
Hardware: All Linux
: P1 normal
Assignee: Jaroslav Kysela
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-05-15 03:17 UTC by Filipus Klutiero
Modified: 2014-05-20 02:04 UTC (History)
2 users (show)

See Also:
Kernel Version: 3.9
Subsystem:
Regression: No
Bisected commit-id:


Attachments

Description Filipus Klutiero 2013-05-15 03:17:52 UTC
snd_hda_intel drives all HD Audio controllers (ignoring bugs). Originally that meant controllers from Intel, but now this means controllers from a number of vendors including ATI, VIA and SiS.

The module and its configuration option CONFIG_SND_HDA_INTEL have misleading names and descriptions. While the names may be hard to change, a minimum would be to work on the descriptions. The module's description is:
Intel HDA driver

CONFIG_SND_HDA_INTEL's label is "Intel HD Audio" and its description reads:
	  Say Y here to include support for Intel "High Definition
	  Audio" (Azalia) and its compatible devices.

	  This option enables the HD-audio controller.  Don't forget
	  to choose the appropriate codec options below.

The label and descriptions may not be strictly wrong, since the HD Audio specification was created by Intel and is sometimes called "Intel High Definition Audio", but they reinforce the falsity carried by the names. Claiming that hda_intel is specific to Intel controllers is particularly wrong now that hda_intel has parts of code specific to non-Intel controllers (support for other controllers is not merely accidental).

The module description could simply read "High Definition Audio driver" while the option label could simply read "High Definition Audio". The option's description is harder as it is currently confused. I suggest:


Say Y here to include support for High Definition Audio (Azalia).

This option enables support for HD-audio controllers from Intel and compatible controllers. Don't forget to choose the appropriate codec options below.


I would even recommend a bolder change removing any impression that Intel has a special status:


Say Y here to include support for High Definition Audio (Azalia).

This option enables support for HD-audio controllers. The driver supports controllers from Intel, ATI, VIA, SiS and ULI. Don't forget to choose the appropriate codec options below.



By the way, if codec options do not modify the snd_hda_intel driver per se, there is no need for their description to refer to it.
Comment 1 Takashi Iwai 2013-11-13 17:18:59 UTC
Just send a fix patch to alsa-devel ML.  Thanks.
Comment 2 Filipus Klutiero 2014-05-18 19:45:26 UTC
Whatever change addressed this apparently didn't end up where it should have. From the date, I'd expect that 3.14 would feature the fix, but the issue remains the same.
Comment 3 Takashi Iwai 2014-05-18 20:37:17 UTC
The description is actually correct. The driver is only for hardware compatible with Intel chps.

And, there are other HD-audio controllers that are incompatible with Intel and others. For example, we'll have a different driver for Tegra HD-audio controller. So your change will become incorrect sooner or later since there is no longer single "HD-audio driver".

If you find better wording, please post the patch to alsa-devel ML instead of reopening this bug, as already suggested in comment 1.
ML is more suitable place for such a discussion.
Comment 4 Filipus Klutiero 2014-05-20 02:04:51 UTC
I didn't say the description is strictly wrong.

I don't see why my change would become incorrect. Feel free to have "for some HD-audio controllers" rather than "for HD-audio controllers".

The wording I proposed is better, but don't expect a patch from me or anyone else if you won't address the issue anyway.

Note You need to log in before you can comment on or make changes to this bug.