diff options
| author | Dan Carpenter <dan.carpenter@oracle.com> | 2017-06-30 04:02:21 -0400 |
|---|---|---|
| committer | Lee Jones <lee.jones@linaro.org> | 2017-09-05 03:45:59 -0400 |
| commit | ff827cf5698b111b2e5f825cb9ee508115f94e8a (patch) | |
| tree | 760d0dedeee533e779822772eb467edb5e71f09f /drivers/mfd/twl-core.c | |
| parent | 3f979bf8f56a22b2395edceed0dc371a538e34cc (diff) | |
mfd: twl-core: Improve the documentation
Saying it "returns the result" seems tautological. The read function
does not return num_bytes on success, it returns zero on success. I
noticed this discrepancy because some of the callers were checking for
>= 0.
Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Diffstat (limited to 'drivers/mfd/twl-core.c')
| -rw-r--r-- | drivers/mfd/twl-core.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/drivers/mfd/twl-core.c b/drivers/mfd/twl-core.c index 2a09dde4ca6e..d3133a371e27 100644 --- a/drivers/mfd/twl-core.c +++ b/drivers/mfd/twl-core.c | |||
| @@ -448,7 +448,7 @@ static struct regmap *twl_get_regmap(u8 mod_no) | |||
| 448 | * @reg: register address (just offset will do) | 448 | * @reg: register address (just offset will do) |
| 449 | * @num_bytes: number of bytes to transfer | 449 | * @num_bytes: number of bytes to transfer |
| 450 | * | 450 | * |
| 451 | * Returns the result of operation - 0 is success | 451 | * Returns 0 on success or else a negative error code. |
| 452 | */ | 452 | */ |
| 453 | int twl_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes) | 453 | int twl_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes) |
| 454 | { | 454 | { |
| @@ -476,7 +476,7 @@ EXPORT_SYMBOL(twl_i2c_write); | |||
| 476 | * @reg: register address (just offset will do) | 476 | * @reg: register address (just offset will do) |
| 477 | * @num_bytes: number of bytes to transfer | 477 | * @num_bytes: number of bytes to transfer |
| 478 | * | 478 | * |
| 479 | * Returns result of operation - num_bytes is success else failure. | 479 | * Returns 0 on success or else a negative error code. |
| 480 | */ | 480 | */ |
| 481 | int twl_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes) | 481 | int twl_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes) |
| 482 | { | 482 | { |
