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; |
ce793486 RW |
23 | struct acpi_device; |
24 | ||
ff2b1359 LW |
25 | /** |
26 | * struct gpio_device - internal state container for GPIO devices | |
27 | * @id: numerical ID number for the GPIO chip | |
28 | * @dev: the GPIO device struct | |
3c702e99 | 29 | * @chrdev: character device for the GPIO device |
afbc4f31 LW |
30 | * @mockdev: class device used by the deprecated sysfs interface (may be |
31 | * NULL) | |
ff2b1359 LW |
32 | * @owner: helps prevent removal of modules exporting active GPIOs |
33 | * @chip: pointer to the corresponding gpiochip, holding static | |
34 | * data for this device | |
1c3cdb18 | 35 | * @descs: array of ngpio descriptors. |
fdeb8e15 LW |
36 | * @ngpio: the number of GPIO lines on this GPIO device, equal to the size |
37 | * of the @descs array. | |
38 | * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned | |
39 | * at device creation time. | |
ff2b1359 LW |
40 | * @list: links gpio_device:s together for traversal |
41 | * | |
42 | * This state container holds most of the runtime variable data | |
43 | * for a GPIO device and can hold references and live on after the | |
44 | * GPIO chip has been removed, if it is still being used from | |
45 | * userspace. | |
46 | */ | |
47 | struct gpio_device { | |
48 | int id; | |
49 | struct device dev; | |
3c702e99 | 50 | struct cdev chrdev; |
afbc4f31 | 51 | struct device *mockdev; |
ff2b1359 LW |
52 | struct module *owner; |
53 | struct gpio_chip *chip; | |
1c3cdb18 | 54 | struct gpio_desc *descs; |
fdeb8e15 LW |
55 | int base; |
56 | u16 ngpio; | |
ff2b1359 LW |
57 | struct list_head list; |
58 | }; | |
59 | ||
5ccff852 MW |
60 | /** |
61 | * struct acpi_gpio_info - ACPI GPIO specific information | |
62 | * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo | |
63 | * @active_low: in case of @gpioint, the pin is active low | |
64 | */ | |
65 | struct acpi_gpio_info { | |
66 | bool gpioint; | |
52044723 CR |
67 | int polarity; |
68 | int triggering; | |
5ccff852 MW |
69 | }; |
70 | ||
7f2e553a RI |
71 | /* gpio suffixes used for ACPI and device tree lookup */ |
72 | static const char * const gpio_suffixes[] = { "gpios", "gpio" }; | |
73 | ||
664e3e5a MW |
74 | #ifdef CONFIG_ACPI |
75 | void acpi_gpiochip_add(struct gpio_chip *chip); | |
76 | void acpi_gpiochip_remove(struct gpio_chip *chip); | |
5ccff852 | 77 | |
afa82fab MW |
78 | void acpi_gpiochip_request_interrupts(struct gpio_chip *chip); |
79 | void acpi_gpiochip_free_interrupts(struct gpio_chip *chip); | |
80 | ||
0d9a693c MW |
81 | struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev, |
82 | const char *propname, int index, | |
5ccff852 | 83 | struct acpi_gpio_info *info); |
504a3374 RW |
84 | struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode, |
85 | const char *propname, int index, | |
86 | struct acpi_gpio_info *info); | |
66858527 RI |
87 | |
88 | int acpi_gpio_count(struct device *dev, const char *con_id); | |
10cf4899 DT |
89 | |
90 | bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id); | |
664e3e5a MW |
91 | #else |
92 | static inline void acpi_gpiochip_add(struct gpio_chip *chip) { } | |
93 | static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { } | |
5ccff852 | 94 | |
afa82fab MW |
95 | static inline void |
96 | acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { } | |
97 | ||
98 | static inline void | |
99 | acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { } | |
100 | ||
5ccff852 | 101 | static inline struct gpio_desc * |
0d9a693c MW |
102 | acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname, |
103 | int index, struct acpi_gpio_info *info) | |
5ccff852 MW |
104 | { |
105 | return ERR_PTR(-ENOSYS); | |
106 | } | |
504a3374 RW |
107 | static inline struct gpio_desc * |
108 | acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname, | |
109 | int index, struct acpi_gpio_info *info) | |
110 | { | |
111 | return ERR_PTR(-ENXIO); | |
112 | } | |
66858527 RI |
113 | static inline int acpi_gpio_count(struct device *dev, const char *con_id) |
114 | { | |
115 | return -ENODEV; | |
116 | } | |
10cf4899 DT |
117 | |
118 | static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev, | |
119 | const char *con_id) | |
120 | { | |
121 | return false; | |
122 | } | |
664e3e5a MW |
123 | #endif |
124 | ||
f01d9075 AC |
125 | struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, |
126 | const char *list_name, int index, enum of_gpio_flags *flags); | |
127 | ||
1bd6b601 AC |
128 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum); |
129 | ||
0eb4c6c2 | 130 | extern struct spinlock gpio_lock; |
ff2b1359 | 131 | extern struct list_head gpio_devices; |
0eb4c6c2 AC |
132 | |
133 | struct gpio_desc { | |
fdeb8e15 | 134 | struct gpio_device *gdev; |
0eb4c6c2 AC |
135 | unsigned long flags; |
136 | /* flag symbols are bit numbers */ | |
137 | #define FLAG_REQUESTED 0 | |
138 | #define FLAG_IS_OUT 1 | |
139 | #define FLAG_EXPORT 2 /* protected by sysfs_lock */ | |
140 | #define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */ | |
0eb4c6c2 AC |
141 | #define FLAG_ACTIVE_LOW 6 /* value has active low */ |
142 | #define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */ | |
143 | #define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */ | |
144 | #define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */ | |
f625d460 | 145 | #define FLAG_IS_HOGGED 11 /* GPIO is hogged */ |
0eb4c6c2 | 146 | |
c0017ed7 | 147 | /* Connection label */ |
0eb4c6c2 | 148 | const char *label; |
c0017ed7 MP |
149 | /* Name of the GPIO */ |
150 | const char *name; | |
0eb4c6c2 AC |
151 | }; |
152 | ||
153 | int gpiod_request(struct gpio_desc *desc, const char *label); | |
154 | void gpiod_free(struct gpio_desc *desc); | |
f625d460 BP |
155 | int gpiod_hog(struct gpio_desc *desc, const char *name, |
156 | unsigned long lflags, enum gpiod_flags dflags); | |
0eb4c6c2 AC |
157 | |
158 | /* | |
159 | * Return the GPIO number of the passed descriptor relative to its chip | |
160 | */ | |
161 | static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc) | |
162 | { | |
fdeb8e15 | 163 | return desc - &desc->gdev->descs[0]; |
0eb4c6c2 AC |
164 | } |
165 | ||
166 | /* With descriptor prefix */ | |
167 | ||
168 | #define gpiod_emerg(desc, fmt, ...) \ | |
169 | pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
170 | ##__VA_ARGS__) | |
171 | #define gpiod_crit(desc, fmt, ...) \ | |
172 | pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
173 | ##__VA_ARGS__) | |
174 | #define gpiod_err(desc, fmt, ...) \ | |
175 | pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
176 | ##__VA_ARGS__) | |
177 | #define gpiod_warn(desc, fmt, ...) \ | |
178 | pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
179 | ##__VA_ARGS__) | |
180 | #define gpiod_info(desc, fmt, ...) \ | |
181 | pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
182 | ##__VA_ARGS__) | |
183 | #define gpiod_dbg(desc, fmt, ...) \ | |
184 | pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
185 | ##__VA_ARGS__) | |
186 | ||
187 | /* With chip prefix */ | |
188 | ||
189 | #define chip_emerg(chip, fmt, ...) \ | |
34ffd85d | 190 | dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 191 | #define chip_crit(chip, fmt, ...) \ |
34ffd85d | 192 | dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 193 | #define chip_err(chip, fmt, ...) \ |
34ffd85d | 194 | dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 195 | #define chip_warn(chip, fmt, ...) \ |
34ffd85d | 196 | dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 197 | #define chip_info(chip, fmt, ...) \ |
34ffd85d | 198 | dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 | 199 | #define chip_dbg(chip, fmt, ...) \ |
34ffd85d | 200 | dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
0eb4c6c2 AC |
201 | |
202 | #ifdef CONFIG_GPIO_SYSFS | |
203 | ||
afbc4f31 LW |
204 | int gpiochip_sysfs_register(struct gpio_device *gdev); |
205 | void gpiochip_sysfs_unregister(struct gpio_device *gdev); | |
0eb4c6c2 AC |
206 | |
207 | #else | |
208 | ||
afbc4f31 | 209 | static inline int gpiochip_sysfs_register(struct gpio_device *gdev) |
0eb4c6c2 AC |
210 | { |
211 | return 0; | |
212 | } | |
213 | ||
afbc4f31 | 214 | static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev) |
0eb4c6c2 AC |
215 | { |
216 | } | |
217 | ||
218 | #endif /* CONFIG_GPIO_SYSFS */ | |
219 | ||
664e3e5a | 220 | #endif /* GPIOLIB_H */ |