Commit d4c73d41 authored by Lee Jones's avatar Lee Jones Committed by Wolfram Sang
Browse files

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: default avatarLee Jones <lee.jones@linaro.org>
Reviewed-by: default avatarAndrew Lunn <andrew@lunn.ch>
Reviewed-by: default avatarPeter Korsgaard <peter@korsgaard.com>
Signed-off-by: default avatarWolfram Sang <wsa@kernel.org>
parent f9f193fc

drivers/i2c/busses/i2c-ocores.c

+4 −4
Original line number Diff line number Diff line
@@ -250,7 +250,7 @@ static irqreturn_t ocores_isr(int irq, void *dev_id) 
}



/**

 * Process timeout event

 * ocores_process_timeout() - Process timeout event

 * @i2c: ocores I2C device instance

 */

static void ocores_process_timeout(struct ocores_i2c *i2c)
@@ -264,7 +264,7 @@ static void ocores_process_timeout(struct ocores_i2c *i2c) 
}



/**

 * Wait until something change in a given register

 * ocores_wait() - Wait until something change in a given register

 * @i2c: ocores I2C device instance

 * @reg: register to query

 * @mask: bitmask to apply on register value
@@ -296,7 +296,7 @@ static int ocores_wait(struct ocores_i2c *i2c, 
}



/**

 * Wait until is possible to process some data

 * ocores_poll_wait() - Wait until is possible to process some data

 * @i2c: ocores I2C device instance

 *

 * Used when the device is in polling mode (interrupts disabled).
@@ -334,7 +334,7 @@ static int ocores_poll_wait(struct ocores_i2c *i2c) 
}



/**

 * It handles an IRQ-less transfer

 * ocores_process_polling() - It handles an IRQ-less transfer

 * @i2c: ocores I2C device instance

 *

 * Even if IRQ are disabled, the I2C OpenCore IP behavior is exactly the same