Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

staging: vchiq: Add details to Kconfig help texts

Add some details to the Kconfig definitions of $CONFIG_VCHIQ_CDEV and
$CONFIG_BCM2835_VCHIQ to help make the motive behind the configs a bit
more clear.

Reviewed-by: Stefan Wahren <stefan.wahren@i2se.com>
Signed-off-by: Ojaswin Mujoo <ojaswin98@gmail.com>
Link: https://lore.kernel.org/r/ab88d3222088aca29a319147b50a9d1e9f0f8b81.1627925241.git.ojaswin98@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Ojaswin Mujoo and committed by
Greg Kroah-Hartman
69c92a74 bb13dc2b

+15 -6
+15 -6
drivers/staging/vc04_services/Kconfig
··· 15 15 tristate "BCM2835 VCHIQ" 16 16 imply VCHIQ_CDEV 17 17 help 18 - Kernel to VideoCore communication interface for the 19 - BCM2835 family of products. 20 - Defaults to Y when the Broadcom Videocore services 21 - are included in the build, N otherwise. 18 + Broadcom BCM2835 and similar SoCs have a VPU called VideoCore. This config 19 + enables the VCHIQ driver, which implements a messaging interface between 20 + the kernel and the firmware running on VideoCore. Other drivers use this 21 + interface to communicate to the VPU. More specifically, the VCHIQ driver is 22 + used by audio/video and camera drivers as well as for implementing MMAL 23 + API, which is in turn used by several multimedia services on the BCM2835 24 + family of SoCs. 25 + Defaults to Y when the Broadcom Videocore services are included in 26 + the build, N otherwise. 22 27 23 28 if BCM2835_VCHIQ 24 29 25 30 config VCHIQ_CDEV 26 31 bool "VCHIQ Character Driver" 27 32 help 28 - Enable the creation of VCHIQ character driver to help 29 - communicate with the Videocore platform. 33 + Enable the creation of VCHIQ character driver. The cdev exposes ioctls used 34 + by userspace libraries and testing tools to interact with VideoCore, via 35 + the VCHIQ core driver (Check BCM2835_VCHIQ for more info). 36 + This can be set to 'N' if the VideoCore communication is not needed by 37 + userspace but only by other kernel modules (like bcm2835-audio). If not 38 + sure, set this to 'Y'. 30 39 31 40 endif 32 41