* [PATCHv2] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members
@ 2026-06-03 3:11 Rosen Penev
2026-06-03 18:51 ` Frank Li
0 siblings, 1 reply; 2+ messages in thread
From: Rosen Penev @ 2026-06-03 3:11 UTC (permalink / raw)
To: linux-i2c
Cc: Andi Shyti, Frank Li, Sascha Hauer, Pengutronix Kernel Team,
Fabio Estevam, open list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE,
moderated list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE,
open list
Add kernel-doc documentation for the struct members that were previously
undocumented. This fixes warnings when building with W=1 and ensures
the struct is fully documented per kernel-doc conventions.
Assisted-by: opencode:big-pickle
Signed-off-by: Rosen Penev <rosenp@gmail•com>
---
v2: fixed Signed-off-by.
drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/drivers/i2c/busses/i2c-mxs.c b/drivers/i2c/busses/i2c-mxs.c
index 08c9091a1e35..4e07babea9c3 100644
--- a/drivers/i2c/busses/i2c-mxs.c
+++ b/drivers/i2c/busses/i2c-mxs.c
@@ -108,6 +108,14 @@ enum mxs_i2c_devtype {
* @cmd_complete: completion object for transaction wait
* @cmd_err: error code for last transaction
* @adapter: i2c subsystem adapter node
+ * @timing0: I2C TIMING0 register value
+ * @timing1: I2C TIMING1 register value
+ * @timing2: I2C TIMING2 register value
+ * @dmach: DMA channel
+ * @pio_data: PIO data for DMA
+ * @addr_data: address data for DMA
+ * @sg_io: scatterlist for I/O
+ * @dma_read: flag indicating DMA read
*/
struct mxs_i2c_dev {
struct device *dev;
--
2.54.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCHv2] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members
2026-06-03 3:11 [PATCHv2] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members Rosen Penev
@ 2026-06-03 18:51 ` Frank Li
0 siblings, 0 replies; 2+ messages in thread
From: Frank Li @ 2026-06-03 18:51 UTC (permalink / raw)
To: Rosen Penev
Cc: linux-i2c, Andi Shyti, Sascha Hauer, Pengutronix Kernel Team,
Fabio Estevam, open list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE,
moderated list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE,
open list
On Tue, Jun 02, 2026 at 08:11:35PM -0700, Rosen Penev wrote:
> Add kernel-doc documentation for the struct members that were previously
> undocumented. This fixes warnings when building with W=1 and ensures
> the struct is fully documented per kernel-doc conventions.
>
> Assisted-by: opencode:big-pickle
> Signed-off-by: Rosen Penev <rosenp@gmail•com>
> ---
Reviewed-by: Frank Li <Frank.Li@nxp•com>
> v2: fixed Signed-off-by.
> drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/drivers/i2c/busses/i2c-mxs.c b/drivers/i2c/busses/i2c-mxs.c
> index 08c9091a1e35..4e07babea9c3 100644
> --- a/drivers/i2c/busses/i2c-mxs.c
> +++ b/drivers/i2c/busses/i2c-mxs.c
> @@ -108,6 +108,14 @@ enum mxs_i2c_devtype {
> * @cmd_complete: completion object for transaction wait
> * @cmd_err: error code for last transaction
> * @adapter: i2c subsystem adapter node
> + * @timing0: I2C TIMING0 register value
> + * @timing1: I2C TIMING1 register value
> + * @timing2: I2C TIMING2 register value
> + * @dmach: DMA channel
> + * @pio_data: PIO data for DMA
> + * @addr_data: address data for DMA
> + * @sg_io: scatterlist for I/O
> + * @dma_read: flag indicating DMA read
> */
> struct mxs_i2c_dev {
> struct device *dev;
> --
> 2.54.0
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-06-03 18:52 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-06-03 3:11 [PATCHv2] i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members Rosen Penev
2026-06-03 18:51 ` Frank Li
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox