gpio: discourage passing base to gpio_chip

Passing a fixed base in struct gpio_chip is done for legacy
systems that cannot handle dynamic allocation. Discourage this
behaviour in the kerneldoc.

Acked-by: Alexandre Courbot <acourbot@nvidia.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index 96a678842cdeef7e0d4200329565351e20278410..cc7ec129b329efb9887c0482c5abeb83562b79f7 100644 (file)
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -42,8 +42,12 @@ struct seq_file;
  * @dbg_show: optional routine to show contents in debugfs; default code
  *     will be used when this is omitted, but custom code can show extra
  *     state (such as pullup/pulldown configuration).
- * @base: identifies the first GPIO number handled by this chip; or, if
- *     negative during registration, requests dynamic ID allocation.
+ * @base: identifies the first GPIO number handled by this chip;
+ *     or, if negative during registration, requests dynamic ID allocation.
+ *     DEPRECATION: providing anything non-negative and nailing the base
+ *     base offset of GPIO chips is deprecated. Please pass -1 as base to
+ *     let gpiolib select the chip base in all possible cases. We want to
+ *     get rid of the static GPIO number space in the long run.
  * @ngpio: the number of GPIOs handled by this controller; the last GPIO
  *     handled is (base + ngpio - 1).
  * @desc: array of ngpio descriptors. Private.