diff options
| author | Linus Walleij <linus.walleij@linaro.org> | 2017-11-30 11:03:05 +0100 |
|---|---|---|
| committer | Linus Walleij <linus.walleij@linaro.org> | 2017-11-30 11:05:02 +0100 |
| commit | 56a46b6144e7311e2bf605755a168409ef527fc4 (patch) | |
| tree | 8fc5d675f23c2eef99b62c038b83a83f5f3d7008 | |
| parent | 35541874e6dbde376c68adc686fd6a7df4095e58 (diff) | |
gpio: Clarify that <linux/gpio.h> is legacy
It should be clear to developers that they should not include
this file in new code.
Suggested-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
| -rw-r--r-- | include/linux/gpio.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/linux/gpio.h b/include/linux/gpio.h index 8ef7fc0ce0f0..91ed23468530 100644 --- a/include/linux/gpio.h +++ b/include/linux/gpio.h @@ -1,4 +1,14 @@ /* SPDX-License-Identifier: GPL-2.0 */ +/* + * <linux/gpio.h> + * + * This is the LEGACY GPIO bulk include file, including legacy APIs. It is + * used for GPIO drivers still referencing the global GPIO numberspace, + * and should not be included in new code. + * + * If you're implementing a GPIO driver, only include <linux/gpio/driver.h> + * If you're implementing a GPIO consumer, only include <linux/gpio/consumer.h> + */ #ifndef __LINUX_GPIO_H #define __LINUX_GPIO_H |