Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Internal GPIO functions.
4 *
5 * Copyright (C) 2013, Intel Corporation
6 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
7 */
8
9#ifndef GPIOLIB_H
10#define GPIOLIB_H
11
12#include <linux/gpio/driver.h>
13#include <linux/gpio/consumer.h> /* for enum gpiod_flags */
14#include <linux/err.h>
15#include <linux/device.h>
16#include <linux/module.h>
17#include <linux/cdev.h>
18#include <linux/rwsem.h>
19
20#define GPIOCHIP_NAME "gpiochip"
21
22/**
23 * struct gpio_device - internal state container for GPIO devices
24 * @dev: the GPIO device struct
25 * @chrdev: character device for the GPIO device
26 * @id: numerical ID number for the GPIO chip
27 * @mockdev: class device used by the deprecated sysfs interface (may be
28 * NULL)
29 * @owner: helps prevent removal of modules exporting active GPIOs
30 * @chip: pointer to the corresponding gpiochip, holding static
31 * data for this device
32 * @descs: array of ngpio descriptors.
33 * @ngpio: the number of GPIO lines on this GPIO device, equal to the size
34 * of the @descs array.
35 * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
36 * at device creation time.
37 * @label: a descriptive name for the GPIO device, such as the part number
38 * or name of the IP component in a System on Chip.
39 * @data: per-instance data assigned by the driver
40 * @list: links gpio_device:s together for traversal
41 * @notifier: used to notify subscribers about lines being requested, released
42 * or reconfigured
43 * @sem: protects the structure from a NULL-pointer dereference of @chip by
44 * user-space operations when the device gets unregistered during
45 * a hot-unplug event
46 * @pin_ranges: range of pins served by the GPIO driver
47 *
48 * This state container holds most of the runtime variable data
49 * for a GPIO device and can hold references and live on after the
50 * GPIO chip has been removed, if it is still being used from
51 * userspace.
52 */
53struct gpio_device {
54 struct device dev;
55 struct cdev chrdev;
56 int id;
57 struct device *mockdev;
58 struct module *owner;
59 struct gpio_chip *chip;
60 struct gpio_desc *descs;
61 int base;
62 u16 ngpio;
63 const char *label;
64 void *data;
65 struct list_head list;
66 struct blocking_notifier_head notifier;
67 struct rw_semaphore sem;
68
69#ifdef CONFIG_PINCTRL
70 /*
71 * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
72 * describe the actual pin range which they serve in an SoC. This
73 * information would be used by pinctrl subsystem to configure
74 * corresponding pins for gpio usage.
75 */
76 struct list_head pin_ranges;
77#endif
78};
79
80static inline struct gpio_device *to_gpio_device(struct device *dev)
81{
82 return container_of(dev, struct gpio_device, dev);
83}
84
85/* gpio suffixes used for ACPI and device tree lookup */
86static __maybe_unused const char * const gpio_suffixes[] = { "gpios", "gpio" };
87
88/**
89 * struct gpio_array - Opaque descriptor for a structure of GPIO array attributes
90 *
91 * @desc: Array of pointers to the GPIO descriptors
92 * @size: Number of elements in desc
93 * @chip: Parent GPIO chip
94 * @get_mask: Get mask used in fastpath
95 * @set_mask: Set mask used in fastpath
96 * @invert_mask: Invert mask used in fastpath
97 *
98 * This structure is attached to struct gpiod_descs obtained from
99 * gpiod_get_array() and can be passed back to get/set array functions in order
100 * to activate fast processing path if applicable.
101 */
102struct gpio_array {
103 struct gpio_desc **desc;
104 unsigned int size;
105 struct gpio_chip *chip;
106 unsigned long *get_mask;
107 unsigned long *set_mask;
108 unsigned long invert_mask[];
109};
110
111struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc, unsigned int hwnum);
112
113#define for_each_gpio_desc(gc, desc) \
114 for (unsigned int __i = 0; \
115 __i < gc->ngpio && (desc = gpiochip_get_desc(gc, __i)); \
116 __i++) \
117
118#define for_each_gpio_desc_with_flag(gc, desc, flag) \
119 for_each_gpio_desc(gc, desc) \
120 if (!test_bit(flag, &desc->flags)) {} else
121
122int gpiod_get_array_value_complex(bool raw, bool can_sleep,
123 unsigned int array_size,
124 struct gpio_desc **desc_array,
125 struct gpio_array *array_info,
126 unsigned long *value_bitmap);
127int gpiod_set_array_value_complex(bool raw, bool can_sleep,
128 unsigned int array_size,
129 struct gpio_desc **desc_array,
130 struct gpio_array *array_info,
131 unsigned long *value_bitmap);
132
133extern spinlock_t gpio_lock;
134extern struct list_head gpio_devices;
135
136
137/**
138 * struct gpio_desc - Opaque descriptor for a GPIO
139 *
140 * @gdev: Pointer to the parent GPIO device
141 * @flags: Binary descriptor flags
142 * @label: Name of the consumer
143 * @name: Line name
144 * @hog: Pointer to the device node that hogs this line (if any)
145 * @debounce_period_us: Debounce period in microseconds
146 *
147 * These are obtained using gpiod_get() and are preferable to the old
148 * integer-based handles.
149 *
150 * Contrary to integers, a pointer to a &struct gpio_desc is guaranteed to be
151 * valid until the GPIO is released.
152 */
153struct gpio_desc {
154 struct gpio_device *gdev;
155 unsigned long flags;
156/* flag symbols are bit numbers */
157#define FLAG_REQUESTED 0
158#define FLAG_IS_OUT 1
159#define FLAG_EXPORT 2 /* protected by sysfs_lock */
160#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
161#define FLAG_ACTIVE_LOW 6 /* value has active low */
162#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
163#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
164#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
165#define FLAG_IRQ_IS_ENABLED 10 /* GPIO is connected to an enabled IRQ */
166#define FLAG_IS_HOGGED 11 /* GPIO is hogged */
167#define FLAG_TRANSITORY 12 /* GPIO may lose value in sleep or reset */
168#define FLAG_PULL_UP 13 /* GPIO has pull up enabled */
169#define FLAG_PULL_DOWN 14 /* GPIO has pull down enabled */
170#define FLAG_BIAS_DISABLE 15 /* GPIO has pull disabled */
171#define FLAG_EDGE_RISING 16 /* GPIO CDEV detects rising edge events */
172#define FLAG_EDGE_FALLING 17 /* GPIO CDEV detects falling edge events */
173#define FLAG_EVENT_CLOCK_REALTIME 18 /* GPIO CDEV reports REALTIME timestamps in events */
174#define FLAG_EVENT_CLOCK_HTE 19 /* GPIO CDEV reports hardware timestamps in events */
175
176 /* Connection label */
177 const char *label;
178 /* Name of the GPIO */
179 const char *name;
180#ifdef CONFIG_OF_DYNAMIC
181 struct device_node *hog;
182#endif
183#ifdef CONFIG_GPIO_CDEV
184 /* debounce period in microseconds */
185 unsigned int debounce_period_us;
186#endif
187};
188
189#define gpiod_not_found(desc) (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT)
190
191int gpiod_request(struct gpio_desc *desc, const char *label);
192void gpiod_free(struct gpio_desc *desc);
193
194static inline int gpiod_request_user(struct gpio_desc *desc, const char *label)
195{
196 int ret;
197
198 ret = gpiod_request(desc, label);
199 if (ret == -EPROBE_DEFER)
200 ret = -ENODEV;
201
202 return ret;
203}
204
205int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
206 unsigned long lflags, enum gpiod_flags dflags);
207int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce);
208int gpiod_hog(struct gpio_desc *desc, const char *name,
209 unsigned long lflags, enum gpiod_flags dflags);
210
211/*
212 * Return the GPIO number of the passed descriptor relative to its chip
213 */
214static inline int gpio_chip_hwgpio(const struct gpio_desc *desc)
215{
216 return desc - &desc->gdev->descs[0];
217}
218
219/* With descriptor prefix */
220
221#define gpiod_emerg(desc, fmt, ...) \
222 pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
223 ##__VA_ARGS__)
224#define gpiod_crit(desc, fmt, ...) \
225 pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
226 ##__VA_ARGS__)
227#define gpiod_err(desc, fmt, ...) \
228 pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
229 ##__VA_ARGS__)
230#define gpiod_warn(desc, fmt, ...) \
231 pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
232 ##__VA_ARGS__)
233#define gpiod_info(desc, fmt, ...) \
234 pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
235 ##__VA_ARGS__)
236#define gpiod_dbg(desc, fmt, ...) \
237 pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
238 ##__VA_ARGS__)
239
240/* With chip prefix */
241
242#define chip_emerg(gc, fmt, ...) \
243 dev_emerg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
244#define chip_crit(gc, fmt, ...) \
245 dev_crit(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
246#define chip_err(gc, fmt, ...) \
247 dev_err(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
248#define chip_warn(gc, fmt, ...) \
249 dev_warn(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
250#define chip_info(gc, fmt, ...) \
251 dev_info(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
252#define chip_dbg(gc, fmt, ...) \
253 dev_dbg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
254
255#endif /* GPIOLIB_H */
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
15#include <linux/gpio/driver.h>
16#include <linux/gpio/consumer.h> /* for enum gpiod_flags */
17#include <linux/err.h>
18#include <linux/device.h>
19#include <linux/module.h>
20#include <linux/cdev.h>
21
22enum of_gpio_flags;
23enum gpio_lookup_flags;
24struct acpi_device;
25
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
30 * @chrdev: character device for the GPIO device
31 * @mockdev: class device used by the deprecated sysfs interface (may be
32 * NULL)
33 * @owner: helps prevent removal of modules exporting active GPIOs
34 * @chip: pointer to the corresponding gpiochip, holding static
35 * data for this device
36 * @descs: array of ngpio descriptors.
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.
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.
43 * @data: per-instance data assigned by the driver
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 */
51struct gpio_device {
52 int id;
53 struct device dev;
54 struct cdev chrdev;
55 struct device *mockdev;
56 struct module *owner;
57 struct gpio_chip *chip;
58 struct gpio_desc *descs;
59 int base;
60 u16 ngpio;
61 const char *label;
62 void *data;
63 struct list_head list;
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
74};
75
76/**
77 * struct acpi_gpio_info - ACPI GPIO specific information
78 * @adev: reference to ACPI device which consumes GPIO resource
79 * @flags: GPIO initialization flags
80 * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
81 * @polarity: interrupt polarity as provided by ACPI
82 * @triggering: triggering type as provided by ACPI
83 * @quirks: Linux specific quirks as provided by struct acpi_gpio_mapping
84 */
85struct acpi_gpio_info {
86 struct acpi_device *adev;
87 enum gpiod_flags flags;
88 bool gpioint;
89 int polarity;
90 int triggering;
91 unsigned int quirks;
92};
93
94/* gpio suffixes used for ACPI and device tree lookup */
95static const char * const gpio_suffixes[] = { "gpios", "gpio" };
96
97#ifdef CONFIG_OF_GPIO
98struct gpio_desc *of_find_gpio(struct device *dev,
99 const char *con_id,
100 unsigned int idx,
101 enum gpio_lookup_flags *flags);
102struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
103 const char *list_name, int index, enum of_gpio_flags *flags);
104int of_gpiochip_add(struct gpio_chip *gc);
105void of_gpiochip_remove(struct gpio_chip *gc);
106#else
107static inline struct gpio_desc *of_find_gpio(struct device *dev,
108 const char *con_id,
109 unsigned int idx,
110 enum gpio_lookup_flags *flags)
111{
112 return ERR_PTR(-ENOENT);
113}
114static inline struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
115 const char *list_name, int index, enum of_gpio_flags *flags)
116{
117 return ERR_PTR(-ENOENT);
118}
119static inline int of_gpiochip_add(struct gpio_chip *gc) { return 0; }
120static inline void of_gpiochip_remove(struct gpio_chip *gc) { }
121#endif /* CONFIG_OF_GPIO */
122
123#ifdef CONFIG_ACPI
124void acpi_gpiochip_add(struct gpio_chip *chip);
125void acpi_gpiochip_remove(struct gpio_chip *chip);
126
127void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
128void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
129
130int acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags,
131 struct acpi_gpio_info *info);
132
133struct gpio_desc *acpi_find_gpio(struct device *dev,
134 const char *con_id,
135 unsigned int idx,
136 enum gpiod_flags *dflags,
137 enum gpio_lookup_flags *lookupflags);
138struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
139 const char *propname, int index,
140 struct acpi_gpio_info *info);
141
142int acpi_gpio_count(struct device *dev, const char *con_id);
143
144bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id);
145#else
146static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
147static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
148
149static inline void
150acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
151
152static inline void
153acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
154
155static inline int
156acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
157{
158 return 0;
159}
160
161static inline struct gpio_desc *
162acpi_find_gpio(struct device *dev, const char *con_id,
163 unsigned int idx, enum gpiod_flags *dflags,
164 enum gpio_lookup_flags *lookupflags)
165{
166 return ERR_PTR(-ENOENT);
167}
168static inline struct gpio_desc *
169acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname,
170 int index, struct acpi_gpio_info *info)
171{
172 return ERR_PTR(-ENXIO);
173}
174static inline int acpi_gpio_count(struct device *dev, const char *con_id)
175{
176 return -ENODEV;
177}
178
179static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
180 const char *con_id)
181{
182 return false;
183}
184#endif
185
186struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);
187int gpiod_get_array_value_complex(bool raw, bool can_sleep,
188 unsigned int array_size,
189 struct gpio_desc **desc_array,
190 int *value_array);
191void gpiod_set_array_value_complex(bool raw, bool can_sleep,
192 unsigned int array_size,
193 struct gpio_desc **desc_array,
194 int *value_array);
195
196/* This is just passed between gpiolib and devres */
197struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
198 const char *propname, int index,
199 enum gpiod_flags dflags,
200 const char *label);
201
202extern struct spinlock gpio_lock;
203extern struct list_head gpio_devices;
204
205struct gpio_desc {
206 struct gpio_device *gdev;
207 unsigned long flags;
208/* flag symbols are bit numbers */
209#define FLAG_REQUESTED 0
210#define FLAG_IS_OUT 1
211#define FLAG_EXPORT 2 /* protected by sysfs_lock */
212#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
213#define FLAG_ACTIVE_LOW 6 /* value has active low */
214#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
215#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
216#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
217#define FLAG_IS_HOGGED 11 /* GPIO is hogged */
218#define FLAG_TRANSITORY 12 /* GPIO may lose value in sleep or reset */
219
220 /* Connection label */
221 const char *label;
222 /* Name of the GPIO */
223 const char *name;
224};
225
226int gpiod_request(struct gpio_desc *desc, const char *label);
227void gpiod_free(struct gpio_desc *desc);
228int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
229 unsigned long lflags, enum gpiod_flags dflags);
230int gpiod_hog(struct gpio_desc *desc, const char *name,
231 unsigned long lflags, enum gpiod_flags dflags);
232
233/*
234 * Return the GPIO number of the passed descriptor relative to its chip
235 */
236static inline int gpio_chip_hwgpio(const struct gpio_desc *desc)
237{
238 return desc - &desc->gdev->descs[0];
239}
240
241void devprop_gpiochip_set_names(struct gpio_chip *chip,
242 const struct fwnode_handle *fwnode);
243
244/* With descriptor prefix */
245
246#define gpiod_emerg(desc, fmt, ...) \
247 pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
248 ##__VA_ARGS__)
249#define gpiod_crit(desc, fmt, ...) \
250 pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
251 ##__VA_ARGS__)
252#define gpiod_err(desc, fmt, ...) \
253 pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
254 ##__VA_ARGS__)
255#define gpiod_warn(desc, fmt, ...) \
256 pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
257 ##__VA_ARGS__)
258#define gpiod_info(desc, fmt, ...) \
259 pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
260 ##__VA_ARGS__)
261#define gpiod_dbg(desc, fmt, ...) \
262 pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
263 ##__VA_ARGS__)
264
265/* With chip prefix */
266
267#define chip_emerg(chip, fmt, ...) \
268 dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
269#define chip_crit(chip, fmt, ...) \
270 dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
271#define chip_err(chip, fmt, ...) \
272 dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
273#define chip_warn(chip, fmt, ...) \
274 dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
275#define chip_info(chip, fmt, ...) \
276 dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
277#define chip_dbg(chip, fmt, ...) \
278 dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
279
280#ifdef CONFIG_GPIO_SYSFS
281
282int gpiochip_sysfs_register(struct gpio_device *gdev);
283void gpiochip_sysfs_unregister(struct gpio_device *gdev);
284
285#else
286
287static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
288{
289 return 0;
290}
291
292static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
293{
294}
295
296#endif /* CONFIG_GPIO_SYSFS */
297
298#endif /* GPIOLIB_H */