Skip to content

Commit d4c73d4

Browse files
Lee Joneswsakernel
authored andcommitted
i2c: busses: i2c-ocores: Place the expected function names into the documentation headers
Fixes the following W=1 kernel build warning(s): drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead Signed-off-by: Lee Jones <[email protected]> Reviewed-by: Andrew Lunn <[email protected]> Reviewed-by: Peter Korsgaard <[email protected]> Signed-off-by: Wolfram Sang <[email protected]>
1 parent f9f193f commit d4c73d4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

drivers/i2c/busses/i2c-ocores.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ static irqreturn_t ocores_isr(int irq, void *dev_id)
250250
}
251251

252252
/**
253-
* Process timeout event
253+
* ocores_process_timeout() - Process timeout event
254254
* @i2c: ocores I2C device instance
255255
*/
256256
static void ocores_process_timeout(struct ocores_i2c *i2c)
@@ -264,7 +264,7 @@ static void ocores_process_timeout(struct ocores_i2c *i2c)
264264
}
265265

266266
/**
267-
* Wait until something change in a given register
267+
* ocores_wait() - Wait until something change in a given register
268268
* @i2c: ocores I2C device instance
269269
* @reg: register to query
270270
* @mask: bitmask to apply on register value
@@ -296,7 +296,7 @@ static int ocores_wait(struct ocores_i2c *i2c,
296296
}
297297

298298
/**
299-
* Wait until is possible to process some data
299+
* ocores_poll_wait() - Wait until is possible to process some data
300300
* @i2c: ocores I2C device instance
301301
*
302302
* Used when the device is in polling mode (interrupts disabled).
@@ -334,7 +334,7 @@ static int ocores_poll_wait(struct ocores_i2c *i2c)
334334
}
335335

336336
/**
337-
* It handles an IRQ-less transfer
337+
* ocores_process_polling() - It handles an IRQ-less transfer
338338
* @i2c: ocores I2C device instance
339339
*
340340
* Even if IRQ are disabled, the I2C OpenCore IP behavior is exactly the same

0 commit comments

Comments
 (0)