Skip to contentSkip to conversation

i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members

PATCH Applied Rosen Penev 3 participants 3 messages Jun 3 – Jun 10

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 i2c: mxs: add missing kernel-doc for struct mxs_i2c_dev members

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

---
v2: fixed Signed-off-by.

 drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/i2c/busses/i2c-mxs.c +8 -0
index 08c9091a1e35..4e07babea9c3 100644
@@ -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

maintainer Reviewed-by on v2 1/1
#1 lore raw
Quoted 7 lines · Rosen Penev

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

---

Quoted 26 lines

v2: fixed Signed-off-by.

 drivers/i2c/busses/i2c-mxs.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/i2c/busses/i2c-mxs.c +8 -1
index 08c9091a1e35..4e07babea9c3 100644
@@ -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

maintainer Applied
#2 lore raw
In reply to Rosen Penev

Hi Rosen,

Quoted 6 lines · Rosen Penev

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

merged to i2c/i2c-host.

Thanks,
Andi