Commit | Line | Data |
---|---|---|
af6074fc | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
863fbf49 AV |
2 | /* |
3 | * OF helpers for the GPIO API | |
4 | * | |
5 | * Copyright (c) 2007-2008 MontaVista Software, Inc. | |
6 | * | |
7 | * Author: Anton Vorontsov <avorontsov@ru.mvista.com> | |
863fbf49 AV |
8 | */ |
9 | ||
10 | #ifndef __LINUX_OF_GPIO_H | |
11 | #define __LINUX_OF_GPIO_H | |
12 | ||
b908b53d | 13 | #include <linux/compiler.h> |
046e14af AS |
14 | #include <linux/gpio/driver.h> |
15 | #include <linux/gpio.h> /* FIXME: Shouldn't be here */ | |
15c9a0ac | 16 | #include <linux/of.h> |
863fbf49 | 17 | |
b908b53d AV |
18 | struct device_node; |
19 | ||
20 | /* | |
21 | * This is Linux-specific flags. By default controllers' and Linux' mapping | |
22 | * match, but GPIO controllers are free to translate their own flags to | |
23 | * Linux-specific in their .xlate callback. Though, 1:1 mapping is recommended. | |
24 | */ | |
25 | enum of_gpio_flags { | |
26 | OF_GPIO_ACTIVE_LOW = 0x1, | |
90b665f6 | 27 | OF_GPIO_SINGLE_ENDED = 0x2, |
4c0facdd | 28 | OF_GPIO_OPEN_DRAIN = 0x4, |
e10f72bf | 29 | OF_GPIO_TRANSITORY = 0x8, |
d449991c TP |
30 | OF_GPIO_PULL_UP = 0x10, |
31 | OF_GPIO_PULL_DOWN = 0x20, | |
31bea231 | 32 | OF_GPIO_PULL_DISABLE = 0x40, |
b908b53d AV |
33 | }; |
34 | ||
863fbf49 AV |
35 | #ifdef CONFIG_OF_GPIO |
36 | ||
046e14af AS |
37 | #include <linux/kernel.h> |
38 | ||
863fbf49 AV |
39 | /* |
40 | * OF GPIO chip for memory mapped banks | |
41 | */ | |
42 | struct of_mm_gpio_chip { | |
a19e3da5 | 43 | struct gpio_chip gc; |
863fbf49 AV |
44 | void (*save_regs)(struct of_mm_gpio_chip *mm_gc); |
45 | void __iomem *regs; | |
46 | }; | |
47 | ||
48 | static inline struct of_mm_gpio_chip *to_of_mm_gpio_chip(struct gpio_chip *gc) | |
49 | { | |
a19e3da5 | 50 | return container_of(gc, struct of_mm_gpio_chip, gc); |
863fbf49 AV |
51 | } |
52 | ||
e6ae9a83 | 53 | extern int of_get_named_gpio_flags(const struct device_node *np, |
a6b09191 JB |
54 | const char *list_name, int index, enum of_gpio_flags *flags); |
55 | ||
3208b0f0 LW |
56 | extern int of_mm_gpiochip_add_data(struct device_node *np, |
57 | struct of_mm_gpio_chip *mm_gc, | |
58 | void *data); | |
59 | static inline int of_mm_gpiochip_add(struct device_node *np, | |
60 | struct of_mm_gpio_chip *mm_gc) | |
61 | { | |
62 | return of_mm_gpiochip_add_data(np, mm_gc, NULL); | |
63 | } | |
d621e8ba | 64 | extern void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc); |
594fa265 | 65 | |
a19e3da5 | 66 | #else /* CONFIG_OF_GPIO */ |
863fbf49 | 67 | |
046e14af AS |
68 | #include <linux/errno.h> |
69 | ||
863fbf49 | 70 | /* Drivers may not strictly depend on the GPIO support, so let them link. */ |
e6ae9a83 | 71 | static inline int of_get_named_gpio_flags(const struct device_node *np, |
a6b09191 | 72 | const char *list_name, int index, enum of_gpio_flags *flags) |
863fbf49 | 73 | { |
427e0dc5 AB |
74 | if (flags) |
75 | *flags = 0; | |
76 | ||
f01d9075 | 77 | return -ENOSYS; |
863fbf49 AV |
78 | } |
79 | ||
80 | #endif /* CONFIG_OF_GPIO */ | |
81 | ||
ff64abef | 82 | /** |
e80beb27 | 83 | * of_gpio_named_count() - Count GPIOs for a device |
ff64abef | 84 | * @np: device node to count GPIOs for |
e80beb27 | 85 | * @propname: property name containing gpio specifier(s) |
ff64abef JCPV |
86 | * |
87 | * The function returns the count of GPIOs specified for a node. | |
e80beb27 GL |
88 | * Note that the empty GPIO specifiers count too. Returns either |
89 | * Number of gpios defined in property, | |
90 | * -EINVAL for an incorrectly formed gpios property, or | |
91 | * -ENOENT for a missing gpios property | |
ff64abef | 92 | * |
e80beb27 | 93 | * Example: |
ff64abef | 94 | * gpios = <0 |
e80beb27 | 95 | * &gpio1 1 2 |
ff64abef | 96 | * 0 |
e80beb27 GL |
97 | * &gpio2 3 4>; |
98 | * | |
99 | * The above example defines four GPIOs, two of which are not specified. | |
100 | * This function will return '4' | |
101 | */ | |
e6ae9a83 KK |
102 | static inline int of_gpio_named_count(const struct device_node *np, |
103 | const char *propname) | |
e80beb27 GL |
104 | { |
105 | return of_count_phandle_with_args(np, propname, "#gpio-cells"); | |
106 | } | |
107 | ||
108 | /** | |
109 | * of_gpio_count() - Count GPIOs for a device | |
110 | * @np: device node to count GPIOs for | |
ff64abef | 111 | * |
e80beb27 | 112 | * Same as of_gpio_named_count, but hard coded to use the 'gpios' property |
ff64abef | 113 | */ |
e6ae9a83 | 114 | static inline int of_gpio_count(const struct device_node *np) |
ff64abef JCPV |
115 | { |
116 | return of_gpio_named_count(np, "gpios"); | |
117 | } | |
118 | ||
e6ae9a83 | 119 | static inline int of_get_gpio_flags(const struct device_node *np, int index, |
a6b09191 JB |
120 | enum of_gpio_flags *flags) |
121 | { | |
122 | return of_get_named_gpio_flags(np, "gpios", index, flags); | |
123 | } | |
124 | ||
125 | /** | |
126 | * of_get_named_gpio() - Get a GPIO number to use with GPIO API | |
127 | * @np: device node to get GPIO from | |
128 | * @propname: Name of property containing gpio specifier(s) | |
129 | * @index: index of the GPIO | |
130 | * | |
131 | * Returns GPIO number to use with Linux generic GPIO API, or one of the errno | |
132 | * value on the error condition. | |
133 | */ | |
e6ae9a83 | 134 | static inline int of_get_named_gpio(const struct device_node *np, |
a6b09191 JB |
135 | const char *propname, int index) |
136 | { | |
137 | return of_get_named_gpio_flags(np, propname, index, NULL); | |
138 | } | |
139 | ||
140 | /** | |
141 | * of_get_gpio() - Get a GPIO number to use with GPIO API | |
b908b53d AV |
142 | * @np: device node to get GPIO from |
143 | * @index: index of the GPIO | |
144 | * | |
145 | * Returns GPIO number to use with Linux generic GPIO API, or one of the errno | |
146 | * value on the error condition. | |
147 | */ | |
e6ae9a83 | 148 | static inline int of_get_gpio(const struct device_node *np, int index) |
b908b53d AV |
149 | { |
150 | return of_get_gpio_flags(np, index, NULL); | |
151 | } | |
152 | ||
863fbf49 | 153 | #endif /* __LINUX_OF_GPIO_H */ |