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>
This commit is contained in:
Ojaswin Mujoo 2021-08-02 23:12:11 +05:30 committed by Greg Kroah-Hartman
parent bb13dc2b3d
commit 69c92a749b

View file

@ -15,18 +15,27 @@ config BCM2835_VCHIQ
tristate "BCM2835 VCHIQ"
imply VCHIQ_CDEV
help
Kernel to VideoCore communication interface for the
BCM2835 family of products.
Defaults to Y when the Broadcom Videocore services
are included in the build, N otherwise.
Broadcom BCM2835 and similar SoCs have a VPU called VideoCore. This config
enables the VCHIQ driver, which implements a messaging interface between
the kernel and the firmware running on VideoCore. Other drivers use this
interface to communicate to the VPU. More specifically, the VCHIQ driver is
used by audio/video and camera drivers as well as for implementing MMAL
API, which is in turn used by several multimedia services on the BCM2835
family of SoCs.
Defaults to Y when the Broadcom Videocore services are included in
the build, N otherwise.
if BCM2835_VCHIQ
config VCHIQ_CDEV
bool "VCHIQ Character Driver"
help
Enable the creation of VCHIQ character driver to help
communicate with the Videocore platform.
Enable the creation of VCHIQ character driver. The cdev exposes ioctls used
by userspace libraries and testing tools to interact with VideoCore, via
the VCHIQ core driver (Check BCM2835_VCHIQ for more info).
This can be set to 'N' if the VideoCore communication is not needed by
userspace but only by other kernel modules (like bcm2835-audio). If not
sure, set this to 'Y'.
endif