linux-kernel - [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220414152340.68932-2-athierry@redhat.com>
Date:   Thu, 14 Apr 2022 11:23:39 -0400
From:   Adrien Thierry <athierry@...hat.com>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Nicolas Saenz Julienne <nsaenz@...nel.org>,
        Florian Fainelli <f.fainelli@...il.com>,
        Ray Jui <rjui@...adcom.com>,
        Scott Branden <sbranden@...adcom.com>,
        bcm-kernel-feedback-list@...adcom.com,
        Maxime Ripard <mripard@...nel.org>,
        Takashi Iwai <tiwai@...e.com>
Cc:     linux-staging@...ts.linux.dev,
        linux-rpi-kernel@...ts.infradead.org,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        Adrien Thierry <athierry@...hat.com>
Subject: [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol

Explain SND_BCM2835 config option in more detail, especially the
implications of using the bcm2835-audio driver in conjunction with vc4
for HDMI audio.

Reported by checkpatch:

WARNING: please write a help paragraph that fully describes the config
symbol
FILE: drivers/staging/vc04_services/bcm2835-audio/Kconfig:2

Signed-off-by: Adrien Thierry <athierry@...hat.com>
---
 drivers/staging/vc04_services/bcm2835-audio/Kconfig | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/vc04_services/bcm2835-audio/Kconfig b/drivers/staging/vc04_services/bcm2835-audio/Kconfig
index d32ea348e846..7cd0b3c0cae4 100644
--- a/drivers/staging/vc04_services/bcm2835-audio/Kconfig
+++ b/drivers/staging/vc04_services/bcm2835-audio/Kconfig
@@ -5,5 +5,8 @@ config SND_BCM2835
 	select SND_PCM
 	select BCM2835_VCHIQ
 	help
-	  Say Y or M if you want to support BCM2835 built in audio
+	  Say Y or M if you want to support BCM2835 built in audio.
+	  This driver handles both 3.5mm and HDMI audio. However, please
+	  note that when HDMI audio is enabled with this driver, the vc4
+	  driver cannot be used simultaneously, otherwise HDMI will break.
 
-- 
2.35.1