[PATCH] spi: spi-mem: Add missing kdoc argument

[PATCH] spi: spi-mem: Add missing kdoc argument

[Miquel Raynal]

The "*mem" pointer has been added without description, describe it in
the kdoc comment in order to fix the following W=1 warning:

Warning: drivers/spi/spi-mem.c:594 function parameter 'mem' not
described in 'spi_mem_calc_op_duration'

Fixes: a11a51896572 ("spi: spi-mem: Take into account the actual maximum frequency")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202507310409.fnuQ21qb-lkp@intel.com/
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 drivers/spi/spi-mem.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/spi/spi-mem.c b/drivers/spi/spi-mem.c
index d3b7e857b377..841b0995c8ea 100644
--- a/drivers/spi/spi-mem.c
+++ b/drivers/spi/spi-mem.c
@@ -577,6 +577,7 @@ EXPORT_SYMBOL_GPL(spi_mem_adjust_op_freq);
  * spi_mem_calc_op_duration() - Derives the theoretical length (in ns) of an
  *			        operation. This helps finding the best variant
  *			        among a list of possible choices.
+ * @mem: the SPI memory
  * @op: the operation to benchmark
  *
  * Some chips have per-op frequency limitations, PCBs usually have their own
-- 
2.50.1

Re: [PATCH] spi: spi-mem: Add missing kdoc argument

[Pratyush Yadav]

On Mon, Aug 04 2025, Miquel Raynal wrote:

> The "*mem" pointer has been added without description, describe it in
> the kdoc comment in order to fix the following W=1 warning:

Hmm, this warning does not show up for me with W=1, but does with W=2. I
am running:

   make drivers/spi/spi-mem.o LLVM=1 ARCH=arm W=1

Am I doing something wrong? I usually test with W=1 for SPI NOR patches
to make sure no new warnings are added.

Anyway,

Acked-by: Pratyush Yadav <pratyush@kernel.org>

>
> Warning: drivers/spi/spi-mem.c:594 function parameter 'mem' not
> described in 'spi_mem_calc_op_duration'
>
> Fixes: a11a51896572 ("spi: spi-mem: Take into account the actual maximum frequency")
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202507310409.fnuQ21qb-lkp@intel.com/
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>  drivers/spi/spi-mem.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/spi/spi-mem.c b/drivers/spi/spi-mem.c
> index d3b7e857b377..841b0995c8ea 100644
> --- a/drivers/spi/spi-mem.c
> +++ b/drivers/spi/spi-mem.c
> @@ -577,6 +577,7 @@ EXPORT_SYMBOL_GPL(spi_mem_adjust_op_freq);
>   * spi_mem_calc_op_duration() - Derives the theoretical length (in ns) of an
>   *			        operation. This helps finding the best variant
>   *			        among a list of possible choices.
> + * @mem: the SPI memory
>   * @op: the operation to benchmark
>   *
>   * Some chips have per-op frequency limitations, PCBs usually have their own

-- 
Regards,
Pratyush Yadav

Re: [PATCH] spi: spi-mem: Add missing kdoc argument

[Miquel Raynal]

On 04/08/2025 at 16:45:47 +02, Pratyush Yadav <pratyush@kernel.org> wrote:

> On Mon, Aug 04 2025, Miquel Raynal wrote:
>
>> The "*mem" pointer has been added without description, describe it in
>> the kdoc comment in order to fix the following W=1 warning:
>
> Hmm, this warning does not show up for me with W=1, but does with W=2. I
> am running:
>
>    make drivers/spi/spi-mem.o LLVM=1 ARCH=arm W=1

It shows up on my side with W=1, but not with LLVM. No idea if makes a
difference?

Cheers,
Miquèl

Re: [PATCH] spi: spi-mem: Add missing kdoc argument

[Mark Brown]

On Mon, 04 Aug 2025 11:50:13 +0200, Miquel Raynal wrote:
> The "*mem" pointer has been added without description, describe it in
> the kdoc comment in order to fix the following W=1 warning:
> 
> Warning: drivers/spi/spi-mem.c:594 function parameter 'mem' not
> described in 'spi_mem_calc_op_duration'
> 
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/1] spi: spi-mem: Add missing kdoc argument
      commit: 72332439e6b0a39e763d4604e71774ab83423275

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark