Commit 97dc8ace authored by Paul Walmsley's avatar Paul Walmsley Committed by Tony Lindgren

TWL4030: convert old-style function documentation to current kerneldoc

Several functions use old-style function documentation; convert those to
use the current kerneldoc style.

Thanks to Felipe Balbi <felipe.balbi@nokia.com> for catching an error.
Signed-off-by: default avatarPaul Walmsley <paul@pwsan.com>
Signed-off-by: default avatarTony Lindgren <tony@atomide.com>
parent cb1ca770
...@@ -403,17 +403,18 @@ static struct irq_chip twl4030_irq_chip = { ...@@ -403,17 +403,18 @@ static struct irq_chip twl4030_irq_chip = {
}; };
/* Global Functions */ /* Global Functions */
/*
* @brief twl4030_i2c_write - Writes a n bit register in TWL4030 /**
* twl4030_i2c_write - Writes a n bit register in TWL4030
* @mod_no: module number
* @value: an array of num_bytes+1 containing data to write
* @reg: register address (just offset will do)
* @num_bytes: number of bytes to transfer
* *
* @param mod_no - module number * IMPORTANT: for 'value' parameter: Allocate value num_bytes+1 and
* @param *value - an array of num_bytes+1 containing data to write * valid data starts at Offset 1.
* IMPORTANT - Allocate value num_bytes+1 and valid data starts at
* Offset 1.
* @param reg - register address (just offset will do)
* @param num_bytes - number of bytes to transfer
* *
* @return result of operation - 0 is success * Returns the result of operation - 0 is success
*/ */
int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes)
{ {
...@@ -457,14 +458,13 @@ int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) ...@@ -457,14 +458,13 @@ int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes)
EXPORT_SYMBOL(twl4030_i2c_write); EXPORT_SYMBOL(twl4030_i2c_write);
/** /**
* @brief twl4030_i2c_read - Reads a n bit register in TWL4030 * twl4030_i2c_read - Reads a n bit register in TWL4030
* @mod_no: module number
* @value: an array of num_bytes containing data to be read
* @reg: register address (just offset will do)
* @num_bytes: number of bytes to transfer
* *
* @param mod_no - module number * Returns result of operation - num_bytes is success else failure.
* @param *value - an array of num_bytes containing data to be read
* @param reg - register address (just offset will do)
* @param num_bytes - number of bytes to transfer
*
* @return result of operation - num_bytes is success else failure.
*/ */
int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes)
{ {
...@@ -511,13 +511,12 @@ int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes) ...@@ -511,13 +511,12 @@ int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes)
EXPORT_SYMBOL(twl4030_i2c_read); EXPORT_SYMBOL(twl4030_i2c_read);
/** /**
* @brief twl4030_i2c_write_u8 - Writes a 8 bit register in TWL4030 * twl4030_i2c_write_u8 - Writes a 8 bit register in TWL4030
* * @mod_no: module number
* @param mod_no - module number * @value: the value to be written 8 bit
* @param value - the value to be written 8 bit * @reg: register address (just offset will do)
* @param reg - register address (just offset will do)
* *
* @return result of operation - 0 is success * Returns result of operation - 0 is success
*/ */
int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg) int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg)
{ {
...@@ -531,13 +530,12 @@ int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg) ...@@ -531,13 +530,12 @@ int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg)
EXPORT_SYMBOL(twl4030_i2c_write_u8); EXPORT_SYMBOL(twl4030_i2c_write_u8);
/** /**
* @brief twl4030_i2c_read_u8 - Reads a 8 bit register from TWL4030 * twl4030_i2c_read_u8 - Reads a 8 bit register from TWL4030
* * @mod_no: module number
* @param mod_no - module number * @value: the value read 8 bit
* @param *value - the value read 8 bit * @reg: register address (just offset will do)
* @param reg - register address (just offset will do)
* *
* @return result of operation - 0 is success * Returns result of operation - 0 is success
*/ */
int twl4030_i2c_read_u8(u8 mod_no, u8 *value, u8 reg) int twl4030_i2c_read_u8(u8 mod_no, u8 *value, u8 reg)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment