| Message ID | 2969992a1005d7e7f4ea23d4c684d2f10d4a0aca.1526935804.git.chunkeey@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v5,1/4] dt-bindings: pinctrl: qcom: add gpio-ranges, gpio-reserved-ranges | expand |
On Mon, May 21, 2018 at 10:57 PM, Christian Lamparter <chunkeey@gmail.com> wrote: > This patch adds the stern warning to the kerneldoc text of both > gpiochip_add_pin[group]_range() functions in hope of detering > developers from ever using them in their DeviceTree-supported > pinctrl drivers in the future. > > For anyone affected: Please refer to Section 2.1 of > Documentation/devicetree/bindings/gpio/gpio.txt on how to > bind pinctrl and gpio drivers via the "gpio-ranges" property. > > Signed-off-by: Christian Lamparter <chunkeey@gmail.com> I'm a big fan of this patch, so applied. I wouldn't mind a pr_info() warning about it at runtime too, but this is nice. Yours, Linus Walleij -- To unsubscribe from this list: send the line "unsubscribe linux-gpio" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/drivers/gpio/gpiolib.c b/drivers/gpio/gpiolib.c index d1171db66c30..387bf0677ca8 100644 --- a/drivers/gpio/gpiolib.c +++ b/drivers/gpio/gpiolib.c @@ -2117,6 +2117,11 @@ EXPORT_SYMBOL_GPL(gpiochip_generic_config); * @pctldev: the pin controller to map to * @gpio_offset: the start offset in the current gpio_chip number space * @pin_group: name of the pin group inside the pin controller + * + * Calling this function directly from a DeviceTree-supported + * pinctrl driver is DEPRECATED. Please see Section 2.1 of + * Documentation/devicetree/bindings/gpio/gpio.txt on how to + * bind pinctrl and gpio drivers via the "gpio-ranges" property. */ int gpiochip_add_pingroup_range(struct gpio_chip *chip, struct pinctrl_dev *pctldev, @@ -2170,6 +2175,11 @@ EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range); * * Returns: * 0 on success, or a negative error-code on failure. + * + * Calling this function directly from a DeviceTree-supported + * pinctrl driver is DEPRECATED. Please see Section 2.1 of + * Documentation/devicetree/bindings/gpio/gpio.txt on how to + * bind pinctrl and gpio drivers via the "gpio-ranges" property. */ int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name, unsigned int gpio_offset, unsigned int pin_offset,
This patch adds the stern warning to the kerneldoc text of both gpiochip_add_pin[group]_range() functions in hope of detering developers from ever using them in their DeviceTree-supported pinctrl drivers in the future. For anyone affected: Please refer to Section 2.1 of Documentation/devicetree/bindings/gpio/gpio.txt on how to bind pinctrl and gpio drivers via the "gpio-ranges" property. Signed-off-by: Christian Lamparter <chunkeey@gmail.com> --- As a (final?) follow-up to Stephen's request of adding a warning to notify devs and users alike about any potentially broken drivers: of_gpiochip_add_pin_range() - which parses the gpio-ranges property - calls both gpiochip_add_pin(group)_range functions. So adding a warning/debug message into the code will not really work (unless the DT-check will also take the call-trace into account... which is possible, but at this point it would make more sense to just refactor the code). --- drivers/gpio/gpiolib.c | 10 ++++++++++ 1 file changed, 10 insertions(+)