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