[PATCH] dma: bestcomm: gen_bd: split struct bcom_psc_params from array definition

[PATCH] dma: bestcomm: gen_bd: split struct bcom_psc_params from array definition

[Rosen Penev]

The combined struct-definition-with-initializer pattern confuses the
kernel-doc parser. Split into separate struct definition and array
declaration.

Assisted-by: Opencode:Big-pickle
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
 drivers/dma/bestcomm/gen_bd.c | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

diff --git a/drivers/dma/bestcomm/gen_bd.c b/drivers/dma/bestcomm/gen_bd.c
index 8a24a5cbc263..0b400a76adcf 100644
--- a/drivers/dma/bestcomm/gen_bd.c
+++ b/drivers/dma/bestcomm/gen_bd.c
@@ -253,18 +253,14 @@ EXPORT_SYMBOL_GPL(bcom_gen_bd_tx_release);
  * PSC support code
  */

-/**
- * bcom_psc_parameters - Bestcomm initialization value table for PSC devices
- *
- * This structure is only used internally.  It is a lookup table for PSC
- * specific parameters to bestcomm tasks.
- */
-static struct bcom_psc_params {
+struct bcom_psc_params {
 	int rx_initiator;
 	int rx_ipr;
 	int tx_initiator;
 	int tx_ipr;
-} bcom_psc_params[] = {
+};
+
+static struct bcom_psc_params bcom_psc_params[] = {
 	[0] = {
 		.rx_initiator = BCOM_INITIATOR_PSC1_RX,
 		.rx_ipr = BCOM_IPR_PSC1_RX,
--
2.54.0

Re: [PATCH] dma: bestcomm: gen_bd: split struct bcom_psc_params from array definition

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The commit completely removes the documentation block for `bcom_psc_params` instead of fixing its kernel-doc format or retaining it.
--

commit ca2ec5c8d7bd735d412b27e8045b30e921157753
Author: Rosen Penev <rosenp@gmail.com>

dma: bestcomm: gen_bd: split struct bcom_psc_params from array definition

This commit separates the struct bcom_psc_params definition from its
array declaration. The split is intended to fix kernel-doc parser
confusion caused by the combined struct-definition-with-initializer
pattern.

> diff --git a/drivers/dma/bestcomm/gen_bd.c b/drivers/dma/bestcomm/gen_bd.c
> index 8a24a5cbc2633..0b400a76adcf0 100644
> --- a/drivers/dma/bestcomm/gen_bd.c
> +++ b/drivers/dma/bestcomm/gen_bd.c
> @@ -253,18 +253,14 @@ EXPORT_SYMBOL_GPL(bcom_gen_bd_tx_release);
>   * PSC support code
>   */
>  
> -/**
> - * bcom_psc_parameters - Bestcomm initialization value table for PSC devices
> - *
> - * This structure is only used internally.  It is a lookup table for PSC
> - * specific parameters to bestcomm tasks.
> - */
> -static struct bcom_psc_params {

[Severity: Low]
This isn't a bug, but the commit message mentions fixing the kernel-doc
parser confusion by splitting the struct and array definition, yet the
actual kernel-doc block is completely removed here.

Was it intentional to drop this documentation entirely rather than keeping
it attached to the separated structure or array?

> +struct bcom_psc_params {
>  	int rx_initiator;
>  	int rx_ipr;

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260528203534.137794-1-rosenp@gmail.com?part=1