[PATCH] i2c: cadence: Fix the kernel-doc warnings

[PATCH] i2c: cadence: Fix the kernel-doc warnings

[Shubhrajyoti Datta]

This fixes the below warnings

drivers/i2c/busses/i2c-cadence.c:221: warning: Function parameter or
member 'rinfo' not described in 'cdns_i2c'

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202308171510.bKHBcZQW-lkp@intel.com/
Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
---

 drivers/i2c/busses/i2c-cadence.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/i2c/busses/i2c-cadence.c b/drivers/i2c/busses/i2c-cadence.c
index 9849f4502570..aa56c5704d93 100644
--- a/drivers/i2c/busses/i2c-cadence.c
+++ b/drivers/i2c/busses/i2c-cadence.c
@@ -182,6 +182,7 @@ enum cdns_i2c_slave_state {
  * @reset:		Reset control for the device
  * @quirks:		flag for broken hold bit usage in r1p10
  * @ctrl_reg:		Cached value of the control register.
+ * @rinfo:		I²C GPIO recovery information
  * @ctrl_reg_diva_divb: value of fields DIV_A and DIV_B from CR register
  * @slave:		Registered slave instance.
  * @dev_mode:		I2C operating role(master/slave).
-- 
2.17.1

Re: [PATCH] i2c: cadence: Fix the kernel-doc warnings

[Andi Shyti]

Hi Shubhrajyoti,

On Fri, Aug 18, 2023 at 04:16:54PM +0530, Shubhrajyoti Datta wrote:
> This fixes the below warnings
> 
> drivers/i2c/busses/i2c-cadence.c:221: warning: Function parameter or
> member 'rinfo' not described in 'cdns_i2c'
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202308171510.bKHBcZQW-lkp@intel.com/
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>

Reviewed-by: Andi Shyti <andi.shyti@kernel.org> 

Andi

Re: [PATCH] i2c: cadence: Fix the kernel-doc warnings

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 311 bytes --]


> + * @rinfo:		I²C GPIO recovery information

For consistency, please stick to I2C like everywhere else in the driver.

>   * @ctrl_reg_diva_divb: value of fields DIV_A and DIV_B from CR register
>   * @slave:		Registered slave instance.
>   * @dev_mode:		I2C operating role(master/slave).
				^^^


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]