pinctrl: Document pin_config_group_get() return codes like pin_config_get()
authorDouglas Anderson <dianders@chromium.org>
Mon, 2 Jul 2018 22:59:37 +0000 (15:59 -0700)
committerLinus Walleij <linus.walleij@linaro.org>
Mon, 9 Jul 2018 11:09:21 +0000 (13:09 +0200)
The pinconf_generic_dump_one() function makes the assumption that
pin_config_group_get() should return -EINVAL and -ENOTSUPP just like
pin_config_get() does.  Document that so it's more obvious.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
include/linux/pinctrl/pinconf.h

index 09eb80f..8dd85d3 100644 (file)
@@ -28,7 +28,8 @@ struct seq_file;
  *     is not available on this controller this should return -ENOTSUPP
  *     and if it is available but disabled it should return -EINVAL
  * @pin_config_set: configure an individual pin
- * @pin_config_group_get: get configurations for an entire pin group
+ * @pin_config_group_get: get configurations for an entire pin group; should
+ *     return -ENOTSUPP and -EINVAL using the same rules as pin_config_get.
  * @pin_config_group_set: configure all pins in a group
  * @pin_config_dbg_parse_modify: optional debugfs to modify a pin configuration
  * @pin_config_dbg_show: optional debugfs display hook that will provide