Re: [PATCH v11 2/2] Revert "crypto: qce - Mark QCE as BROKEN"

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] crypto: qce: missing documentation for qcrypto.do_register_algos parameter
--

commit 7402540901cd549c757f6e4846f133d63cd4febc
Author: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>

Revert "crypto: qce - Mark QCE as BROKEN"

This commit reverts marking the Qualcomm crypto engine driver as broken now
that self-tests are fixed and algorithm registration is gated behind the
do_register_algos module parameter. It also updates the Kconfig help text to
describe the parameter and re-enables the driver in arm and arm64 defconfigs.

> diff --git a/drivers/crypto/Kconfig b/drivers/crypto/Kconfig
> index 0189dfdcbbe11..adcbe15851899 100644
> --- a/drivers/crypto/Kconfig
> +++ b/drivers/crypto/Kconfig
> @@ -527,17 +527,21 @@ source "drivers/crypto/marvell/Kconfig"
>  source "drivers/crypto/intel/Kconfig"
>  
>  config CRYPTO_DEV_QCE
> -	tristate "Qualcomm crypto engine accelerator"
> -	depends on (BROKEN && ARCH_QCOM) || COMPILE_TEST
> +	tristate "Qualcomm crypto engine offloader"
> +	depends on ARCH_QCOM || COMPILE_TEST
>  	depends on HAS_IOMEM
>  	help
> -	  This driver supports Qualcomm crypto engine accelerator
> -	  hardware. To compile this driver as a module, choose M here. The
> -	  module will be called qcrypto.
> -
> -	  This driver does not have exclusive access to the
> -	  hardware, causing races with the secure world.  It
> -	  is also slower than the CPU.
> +	  This driver supports Qualcomm crypto engine offloader hardware. To
> +	  compile this driver as a module, choose M here. The module will be
> +	  called qcrypto.
> +
> +	  NOTE: With qcrypto.do_register_algos module parameter set to true,
> +	  this driver does not have exclusive access to the hardware, and may
> +	  cause races with the secure world. It is also *slower* than the
> +	  CPU for the same algorithms. By default it will not register crypto
> +	  algorithms and only scale down the interconnect bandwidth and disable
> +	  the relevant clocks. Use qcrypto.do_register_algos=1 at your own
> +	  risk!

[Severity: Low]
The help text for CRYPTO_DEV_QCE in drivers/crypto/Kconfig instructs users to
pass the qcrypto.do_register_algos=1 parameter, which was introduced in
commit 47675c12b3c6 ("crypto: qce - Only register algos if the user really
wants it"):

drivers/crypto/qce/core.c:
    static bool do_register_algos;
    module_param(do_register_algos, bool, 0444);

However, neither commit adds an entry for qcrypto.do_register_algos to
Documentation/admin-guide/kernel-parameters.txt or provides a
MODULE_PARM_DESC() in drivers/crypto/qce/core.c (unlike aes_sw_max_len in
drivers/crypto/qce/skcipher.c).

Should qcrypto.do_register_algos be documented in
Documentation/admin-guide/kernel-parameters.txt and given a
MODULE_PARM_DESC() entry?

>  
>  config CRYPTO_DEV_QCE_SKCIPHER
>  	bool

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261022-qce-fixes-broken-label-v11-0-0d33c34fd0c3@oss.qualcomm.com?part=2