]>
Commit | Line | Data |
---|---|---|
664e3e5a MW |
1 | /* |
2 | * Internal GPIO functions. | |
3 | * | |
4 | * Copyright (C) 2013, Intel Corporation | |
5 | * Author: Mika Westerberg <mika.westerberg@linux.intel.com> | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License version 2 as | |
9 | * published by the Free Software Foundation. | |
10 | */ | |
11 | ||
12 | #ifndef GPIOLIB_H | |
13 | #define GPIOLIB_H | |
14 | ||
ff2b1359 | 15 | #include <linux/gpio/driver.h> |
5ccff852 MW |
16 | #include <linux/err.h> |
17 | #include <linux/device.h> | |
ff2b1359 LW |
18 | #include <linux/module.h> |
19 | #include <linux/cdev.h> | |
5ccff852 | 20 | |
f01d9075 | 21 | enum of_gpio_flags; |
29ab875b | 22 | enum gpiod_flags; |
ea713bc4 | 23 | enum gpio_lookup_flags; |
ce793486 RW |
24 | struct acpi_device; |
25 | ||
ff2b1359 LW |
26 | /** |
27 | * struct gpio_device - internal state container for GPIO devices | |
28 | * @id: numerical ID number for the GPIO chip | |
29 | * @dev: the GPIO device struct | |
3c702e99 | 30 | * @chrdev: character device for the GPIO device |
afbc4f31 LW |
31 | * @mockdev: class device used by the deprecated sysfs interface (may be |
32 | * NULL) | |
ff2b1359 LW |
33 | * @owner: helps prevent removal of modules exporting active GPIOs |
34 | * @chip: pointer to the corresponding gpiochip, holding static | |
35 | * data for this device | |
1c3cdb18 | 36 | * @descs: array of ngpio descriptors. |
fdeb8e15 LW |
37 | * @ngpio: the number of GPIO lines on this GPIO device, equal to the size |
38 | * of the @descs array. | |
39 | * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned | |
40 | * at device creation time. | |
df4878e9 LW |
41 | * @label: a descriptive name for the GPIO device, such as the part number |
42 | * or name of the IP component in a System on Chip. | |
43c54eca | 43 | * @data: per-instance data assigned by the driver |
ff2b1359 LW |
44 | * @list: links gpio_device:s together for traversal |
45 | * | |
46 | * This state container holds most of the runtime variable data | |
47 | * for a GPIO device and can hold references and live on after the | |
48 | * GPIO chip has been removed, if it is still being used from | |
49 | * userspace. | |
50 | */ | |
51 | struct gpio_device { | |
52 | int id; | |
53 | struct device dev; | |
3c702e99 | 54 | struct cdev chrdev; |
afbc4f31 | 55 | struct device *mockdev; |
ff2b1359 LW |
56 | struct module *owner; |
57 | struct gpio_chip *chip; | |
1c3cdb18 | 58 | struct gpio_desc *descs; |
fdeb8e15 LW |
59 | int base; |
60 | u16 ngpio; | |
df4878e9 | 61 | char *label; |
43c54eca | 62 | void *data; |
ff2b1359 | 63 | struct list_head list; |
20ec3e39 LW |
64 | |
65 | #ifdef CONFIG_PINCTRL | |
66 | /* | |
67 | * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally | |
68 | * describe the actual pin range which they serve in an SoC. This | |
69 | * information would be used by pinctrl subsystem to configure | |
70 | * corresponding pins for gpio usage. | |
71 | */ | |
72 | struct list_head pin_ranges; | |
73 | #endif | |
ff2b1359 LW |
74 | }; |
75 | ||
5ccff852 MW |
76 | /** |
77 | * struct acpi_gpio_info - ACPI GPIO specific information | |
a31f5c3a | 78 | * @flags: GPIO initialization flags |
5ccff852 | 79 | * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo |
e567c35f AS |
80 | * @polarity: interrupt polarity as provided by ACPI |
81 | * @triggering: triggering type as provided by ACPI | |
5ccff852 MW |
82 | */ |
83 | struct acpi_gpio_info { | |
a31f5c3a | 84 | enum gpiod_flags flags; |
5ccff852 | 85 | bool gpioint; |
52044723 CR |
86 | int polarity; |
87 | int triggering; | |
5ccff852 MW |
88 | }; |
89 | ||
7f2e553a RI |
90 | /* gpio suffixes used for ACPI and device tree lookup */ |
91 | static const char * const gpio_suffixes[] = { "gpios", "gpio" }; | |
92 | ||
ea713bc4 LW |
93 | #ifdef CONFIG_OF_GPIO |
94 | struct gpio_desc *of_find_gpio(struct device *dev, | |
95 | const char *con_id, | |
96 | unsigned int idx, | |
97 | enum gpio_lookup_flags *flags); | |
e0852940 LW |
98 | struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, |
99 | const char *list_name, int index, enum of_gpio_flags *flags); | |
f4c1181f LW |
100 | int of_gpiochip_add(struct gpio_chip *gc); |
101 | void of_gpiochip_remove(struct gpio_chip *gc); | |
ea713bc4 LW |
102 | #else |
103 | static inline struct gpio_desc *of_find_gpio(struct device *dev, | |
104 | const char *con_id, | |
105 | unsigned int idx, | |
106 | enum gpio_lookup_flags *flags) | |
107 | { | |
108 | return ERR_PTR(-ENOENT); | |
109 | } | |
e0852940 LW |
110 | static inline struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, |
111 | const char *list_name, int index, enum of_gpio_flags *flags) | |
112 | { | |
113 | return ERR_PTR(-ENOENT); | |
114 | } | |
f4c1181f LW |
115 | static inline int of_gpiochip_add(struct gpio_chip *gc) { return 0; } |
116 | static inline void of_gpiochip_remove(struct gpio_chip *gc) { } | |
ea713bc4 LW |
117 | #endif /* CONFIG_OF_GPIO */ |
118 | ||
664e3e5a MW |
119 | #ifdef CONFIG_ACPI |
120 | void acpi_gpiochip_add(struct gpio_chip *chip); | |
121 | void acpi_gpiochip_remove(struct gpio_chip *chip); | |
5ccff852 | 122 | |
afa82fab MW |
123 | void acpi_gpiochip_request_interrupts(struct gpio_chip *chip); |
124 | void acpi_gpiochip_free_interrupts(struct gpio_chip *chip); | |
125 | ||
a31f5c3a AS |
126 | int acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, |
127 | enum gpiod_flags update); | |
128 | ||
031ba28a LW |
129 | struct gpio_desc *acpi_find_gpio(struct device *dev, |
130 | const char *con_id, | |
131 | unsigned int idx, | |
a31f5c3a | 132 | enum gpiod_flags *dflags, |
031ba28a | 133 | enum gpio_lookup_flags *lookupflags); |
504a3374 RW |
134 | struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode, |
135 | const char *propname, int index, | |
136 | struct acpi_gpio_info *info); | |
66858527 RI |
137 | |
138 | int acpi_gpio_count(struct device *dev, const char *con_id); | |
10cf4899 DT |
139 | |
140 | bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id); | |
664e3e5a MW |
141 | #else |
142 | static inline void acpi_gpiochip_add(struct gpio_chip *chip) { } | |
143 | static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { } | |
5ccff852 | 144 | |
afa82fab MW |
145 | static inline void |
146 | acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { } | |
147 | ||
148 | static inline void | |
149 | acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { } | |
150 | ||
a31f5c3a AS |
151 | static inline int |
152 | acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update) | |
153 | { | |
154 | return 0; | |
155 | } | |
156 | ||
5ccff852 | 157 | static inline struct gpio_desc * |
031ba28a | 158 | acpi_find_gpio(struct device *dev, const char *con_id, |
a31f5c3a | 159 | unsigned int idx, enum gpiod_flags *dflags, |
031ba28a | 160 | enum gpio_lookup_flags *lookupflags) |
5ccff852 | 161 | { |
031ba28a | 162 | return ERR_PTR(-ENOENT); |
5ccff852 | 163 | } |
504a3374 RW |
164 | static inline struct gpio_desc * |
165 | acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname, | |
166 | int index, struct acpi_gpio_info *info) | |
167 | { | |
168 | return ERR_PTR(-ENXIO); | |
169 | } | |
66858527 RI |
170 | static inline int acpi_gpio_count(struct device *dev, const char *con_id) |
171 | { | |
172 | return -ENODEV; | |
173 | } | |
10cf4899 DT |
174 | |
175 | static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev, | |
176 | const char *con_id) | |
177 | { | |
178 | return false; | |
179 | } | |
664e3e5a MW |
180 | #endif |
181 | ||
1bd6b601 | 182 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum); |
eec1d566 LW |
183 | int gpiod_get_array_value_complex(bool raw, bool can_sleep, |
184 | unsigned int array_size, | |
185 | struct gpio_desc **desc_array, | |
186 | int *value_array); | |
44c7288f LW |
187 | void gpiod_set_array_value_complex(bool raw, bool can_sleep, |
188 | unsigned int array_size, | |
189 | struct gpio_desc **desc_array, | |
190 | int *value_array); | |
1bd6b601 | 191 | |
0eb4c6c2 | 192 | extern struct spinlock gpio_lock; |
ff2b1359 | 193 | extern struct list_head gpio_devices; |
0eb4c6c2 AC |
194 | |
195 | struct gpio_desc { | |
fdeb8e15 | 196 | struct gpio_device *gdev; |
0eb4c6c2 AC |
197 | unsigned long flags; |
198 | /* flag symbols are bit numbers */ | |
199 | #define FLAG_REQUESTED 0 | |
200 | #define FLAG_IS_OUT 1 | |
201 | #define FLAG_EXPORT 2 /* protected by sysfs_lock */ | |
202 | #define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */ | |
0eb4c6c2 AC |
203 | #define FLAG_ACTIVE_LOW 6 /* value has active low */ |
204 | #define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */ | |
205 | #define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */ | |
206 | #define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */ | |
f625d460 | 207 | #define FLAG_IS_HOGGED 11 /* GPIO is hogged */ |
2cbfca66 | 208 | #define FLAG_SLEEP_MAY_LOSE_VALUE 12 /* GPIO may lose value in sleep */ |
0eb4c6c2 | 209 | |
c0017ed7 | 210 | /* Connection label */ |
0eb4c6c2 | 211 | const char *label; |
c0017ed7 MP |
212 | /* Name of the GPIO */ |
213 | const char *name; | |
0eb4c6c2 AC |
214 | }; |
215 | ||
216 | int gpiod_request(struct gpio_desc *desc, const char *label); | |
217 | void gpiod_free(struct gpio_desc *desc); | |
c29fd9eb AS |
218 | int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id, |
219 | unsigned long lflags, enum gpiod_flags dflags); | |
f625d460 BP |
220 | int gpiod_hog(struct gpio_desc *desc, const char *name, |
221 | unsigned long lflags, enum gpiod_flags dflags); | |
0eb4c6c2 AC |
222 | |
223 | /* | |
224 | * Return the GPIO number of the passed descriptor relative to its chip | |
225 | */ | |
4a5c886e | 226 | static inline int gpio_chip_hwgpio(const struct gpio_desc *desc) |
0eb4c6c2 | 227 | { |
fdeb8e15 | 228 | return desc - &desc->gdev->descs[0]; |
0eb4c6c2 AC |
229 | } |
230 | ||
9427ecbe MW |
231 | void devprop_gpiochip_set_names(struct gpio_chip *chip); |
232 | ||
0eb4c6c2 AC |
233 | /* With descriptor prefix */ |
234 | ||
235 | #define gpiod_emerg(desc, fmt, ...) \ | |
236 | pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
237 | ##__VA_ARGS__) | |
238 | #define gpiod_crit(desc, fmt, ...) \ | |
239 | pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
240 | ##__VA_ARGS__) | |
241 | #define gpiod_err(desc, fmt, ...) \ | |
242 | pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
243 | ##__VA_ARGS__) | |
244 | #define gpiod_warn(desc, fmt, ...) \ | |
245 | pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
246 | ##__VA_ARGS__) | |
247 | #define gpiod_info(desc, fmt, ...) \ | |
248 | pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
249 | ##__VA_ARGS__) | |
250 | #define gpiod_dbg(desc, fmt, ...) \ | |
251 | pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
252 | ##__VA_ARGS__) | |
253 | ||
254 | /* With chip prefix */ | |
255 | ||
256 | #define chip_emerg(chip, fmt, ...) \ | |
34ffd85d | 257 | dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 258 | #define chip_crit(chip, fmt, ...) \ |
34ffd85d | 259 | dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 260 | #define chip_err(chip, fmt, ...) \ |
34ffd85d | 261 | dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 262 | #define chip_warn(chip, fmt, ...) \ |
34ffd85d | 263 | dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 264 | #define chip_info(chip, fmt, ...) \ |
34ffd85d | 265 | dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 266 | #define chip_dbg(chip, fmt, ...) \ |
34ffd85d | 267 | dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 AC |
268 | |
269 | #ifdef CONFIG_GPIO_SYSFS | |
270 | ||
afbc4f31 LW |
271 | int gpiochip_sysfs_register(struct gpio_device *gdev); |
272 | void gpiochip_sysfs_unregister(struct gpio_device *gdev); | |
0eb4c6c2 AC |
273 | |
274 | #else | |
275 | ||
afbc4f31 | 276 | static inline int gpiochip_sysfs_register(struct gpio_device *gdev) |
0eb4c6c2 AC |
277 | { |
278 | return 0; | |
279 | } | |
280 | ||
afbc4f31 | 281 | static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev) |
0eb4c6c2 AC |
282 | { |
283 | } | |
284 | ||
285 | #endif /* CONFIG_GPIO_SYSFS */ | |
286 | ||
664e3e5a | 287 | #endif /* GPIOLIB_H */ |