regmap: fix the kerneldoc for regmap_test_bits()

The kerneldoc comment for regmap_test_bits() says that it returns -1 on
regmap_read() failure. This is not true - it will propagate the error
code returned by regmap_read(). Fix it.

Fixes: aa2ff9dbae ("regmap: provide helpers for simple bit operations")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Link: https://lore.kernel.org/r/20200607093421.22209-1-brgl@bgdev.pl
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Bartosz Golaszewski 2020-06-07 11:34:21 +02:00 committed by Mark Brown
parent 53d860952c
commit e680a4098f
No known key found for this signature in database
GPG Key ID: 24D68B725D5487D0

View File

@ -2936,8 +2936,9 @@ EXPORT_SYMBOL_GPL(regmap_update_bits_base);
* @reg: Register to read from
* @bits: Bits to test
*
* Returns -1 if the underlying regmap_read() fails, 0 if at least one of the
* tested bits is not set and 1 if all tested bits are set.
* Returns 0 if at least one of the tested bits is not set, 1 if all tested
* bits are set and a negative error number if the underlying regmap_read()
* fails.
*/
int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits)
{