Commit | Line | Data |
---|---|---|
dae5f0af | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
664e3e5a MW |
2 | /* |
3 | * Internal GPIO functions. | |
4 | * | |
5 | * Copyright (C) 2013, Intel Corporation | |
6 | * Author: Mika Westerberg <mika.westerberg@linux.intel.com> | |
664e3e5a MW |
7 | */ |
8 | ||
9 | #ifndef GPIOLIB_H | |
10 | #define GPIOLIB_H | |
11 | ||
ff2b1359 | 12 | #include <linux/gpio/driver.h> |
63f2dc0a | 13 | #include <linux/gpio/consumer.h> /* for enum gpiod_flags */ |
5ccff852 MW |
14 | #include <linux/err.h> |
15 | #include <linux/device.h> | |
ff2b1359 LW |
16 | #include <linux/module.h> |
17 | #include <linux/cdev.h> | |
5ccff852 | 18 | |
ddd8891e GU |
19 | #define GPIOCHIP_NAME "gpiochip" |
20 | ||
ff2b1359 LW |
21 | /** |
22 | * struct gpio_device - internal state container for GPIO devices | |
23 | * @id: numerical ID number for the GPIO chip | |
24 | * @dev: the GPIO device struct | |
3c702e99 | 25 | * @chrdev: character device for the GPIO device |
afbc4f31 LW |
26 | * @mockdev: class device used by the deprecated sysfs interface (may be |
27 | * NULL) | |
ff2b1359 LW |
28 | * @owner: helps prevent removal of modules exporting active GPIOs |
29 | * @chip: pointer to the corresponding gpiochip, holding static | |
30 | * data for this device | |
1c3cdb18 | 31 | * @descs: array of ngpio descriptors. |
fdeb8e15 LW |
32 | * @ngpio: the number of GPIO lines on this GPIO device, equal to the size |
33 | * of the @descs array. | |
34 | * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned | |
35 | * at device creation time. | |
df4878e9 LW |
36 | * @label: a descriptive name for the GPIO device, such as the part number |
37 | * or name of the IP component in a System on Chip. | |
43c54eca | 38 | * @data: per-instance data assigned by the driver |
ff2b1359 LW |
39 | * @list: links gpio_device:s together for traversal |
40 | * | |
41 | * This state container holds most of the runtime variable data | |
42 | * for a GPIO device and can hold references and live on after the | |
43 | * GPIO chip has been removed, if it is still being used from | |
44 | * userspace. | |
45 | */ | |
46 | struct gpio_device { | |
47 | int id; | |
48 | struct device dev; | |
3c702e99 | 49 | struct cdev chrdev; |
afbc4f31 | 50 | struct device *mockdev; |
ff2b1359 LW |
51 | struct module *owner; |
52 | struct gpio_chip *chip; | |
1c3cdb18 | 53 | struct gpio_desc *descs; |
fdeb8e15 LW |
54 | int base; |
55 | u16 ngpio; | |
3b469b0a | 56 | const char *label; |
43c54eca | 57 | void *data; |
ff2b1359 | 58 | struct list_head list; |
6accc376 | 59 | struct blocking_notifier_head notifier; |
20ec3e39 LW |
60 | |
61 | #ifdef CONFIG_PINCTRL | |
62 | /* | |
63 | * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally | |
64 | * describe the actual pin range which they serve in an SoC. This | |
65 | * information would be used by pinctrl subsystem to configure | |
66 | * corresponding pins for gpio usage. | |
67 | */ | |
68 | struct list_head pin_ranges; | |
69 | #endif | |
ff2b1359 LW |
70 | }; |
71 | ||
7f2e553a | 72 | /* gpio suffixes used for ACPI and device tree lookup */ |
b23ec599 | 73 | static __maybe_unused const char * const gpio_suffixes[] = { "gpios", "gpio" }; |
7f2e553a | 74 | |
bf9346f5 JK |
75 | struct gpio_array { |
76 | struct gpio_desc **desc; | |
77 | unsigned int size; | |
78 | struct gpio_chip *chip; | |
79 | unsigned long *get_mask; | |
80 | unsigned long *set_mask; | |
81 | unsigned long invert_mask[]; | |
82 | }; | |
83 | ||
a5e93436 | 84 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc, unsigned int hwnum); |
eec1d566 LW |
85 | int gpiod_get_array_value_complex(bool raw, bool can_sleep, |
86 | unsigned int array_size, | |
87 | struct gpio_desc **desc_array, | |
77588c14 | 88 | struct gpio_array *array_info, |
b9762beb | 89 | unsigned long *value_bitmap); |
3027743f | 90 | int gpiod_set_array_value_complex(bool raw, bool can_sleep, |
3c940660 GU |
91 | unsigned int array_size, |
92 | struct gpio_desc **desc_array, | |
93 | struct gpio_array *array_info, | |
94 | unsigned long *value_bitmap); | |
1bd6b601 | 95 | |
f0b40863 | 96 | extern spinlock_t gpio_lock; |
ff2b1359 | 97 | extern struct list_head gpio_devices; |
0eb4c6c2 AC |
98 | |
99 | struct gpio_desc { | |
fdeb8e15 | 100 | struct gpio_device *gdev; |
0eb4c6c2 AC |
101 | unsigned long flags; |
102 | /* flag symbols are bit numbers */ | |
103 | #define FLAG_REQUESTED 0 | |
104 | #define FLAG_IS_OUT 1 | |
105 | #define FLAG_EXPORT 2 /* protected by sysfs_lock */ | |
106 | #define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */ | |
0eb4c6c2 AC |
107 | #define FLAG_ACTIVE_LOW 6 /* value has active low */ |
108 | #define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */ | |
109 | #define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */ | |
110 | #define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */ | |
4e9439dd | 111 | #define FLAG_IRQ_IS_ENABLED 10 /* GPIO is connected to an enabled IRQ */ |
f625d460 | 112 | #define FLAG_IS_HOGGED 11 /* GPIO is hogged */ |
e10f72bf | 113 | #define FLAG_TRANSITORY 12 /* GPIO may lose value in sleep or reset */ |
d449991c TP |
114 | #define FLAG_PULL_UP 13 /* GPIO has pull up enabled */ |
115 | #define FLAG_PULL_DOWN 14 /* GPIO has pull down enabled */ | |
2148ad77 | 116 | #define FLAG_BIAS_DISABLE 15 /* GPIO has pull disabled */ |
73e03419 KG |
117 | #define FLAG_EDGE_RISING 16 /* GPIO CDEV detects rising edge events */ |
118 | #define FLAG_EDGE_FALLING 17 /* GPIO CDEV detects falling edge events */ | |
26d060e4 | 119 | #define FLAG_EVENT_CLOCK_REALTIME 18 /* GPIO CDEV reports REALTIME timestamps in events */ |
0eb4c6c2 | 120 | |
c0017ed7 | 121 | /* Connection label */ |
0eb4c6c2 | 122 | const char *label; |
c0017ed7 MP |
123 | /* Name of the GPIO */ |
124 | const char *name; | |
63636d95 GU |
125 | #ifdef CONFIG_OF_DYNAMIC |
126 | struct device_node *hog; | |
127 | #endif | |
65cff704 KG |
128 | #ifdef CONFIG_GPIO_CDEV |
129 | /* debounce period in microseconds */ | |
130 | unsigned int debounce_period_us; | |
131 | #endif | |
0eb4c6c2 AC |
132 | }; |
133 | ||
7b58696d AS |
134 | #define gpiod_not_found(desc) (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) |
135 | ||
0eb4c6c2 AC |
136 | int gpiod_request(struct gpio_desc *desc, const char *label); |
137 | void gpiod_free(struct gpio_desc *desc); | |
c29fd9eb AS |
138 | int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id, |
139 | unsigned long lflags, enum gpiod_flags dflags); | |
f725edd8 | 140 | int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce); |
f625d460 BP |
141 | int gpiod_hog(struct gpio_desc *desc, const char *name, |
142 | unsigned long lflags, enum gpiod_flags dflags); | |
0eb4c6c2 AC |
143 | |
144 | /* | |
145 | * Return the GPIO number of the passed descriptor relative to its chip | |
146 | */ | |
4a5c886e | 147 | static inline int gpio_chip_hwgpio(const struct gpio_desc *desc) |
0eb4c6c2 | 148 | { |
fdeb8e15 | 149 | return desc - &desc->gdev->descs[0]; |
0eb4c6c2 AC |
150 | } |
151 | ||
152 | /* With descriptor prefix */ | |
153 | ||
154 | #define gpiod_emerg(desc, fmt, ...) \ | |
155 | pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
156 | ##__VA_ARGS__) | |
157 | #define gpiod_crit(desc, fmt, ...) \ | |
158 | pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
159 | ##__VA_ARGS__) | |
160 | #define gpiod_err(desc, fmt, ...) \ | |
161 | pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
162 | ##__VA_ARGS__) | |
163 | #define gpiod_warn(desc, fmt, ...) \ | |
164 | pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
165 | ##__VA_ARGS__) | |
166 | #define gpiod_info(desc, fmt, ...) \ | |
167 | pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ | |
168 | ##__VA_ARGS__) | |
169 | #define gpiod_dbg(desc, fmt, ...) \ | |
170 | pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ | |
171 | ##__VA_ARGS__) | |
172 | ||
173 | /* With chip prefix */ | |
174 | ||
a5e93436 GU |
175 | #define chip_emerg(gc, fmt, ...) \ |
176 | dev_emerg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
177 | #define chip_crit(gc, fmt, ...) \ | |
178 | dev_crit(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
179 | #define chip_err(gc, fmt, ...) \ | |
180 | dev_err(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
181 | #define chip_warn(gc, fmt, ...) \ | |
182 | dev_warn(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
183 | #define chip_info(gc, fmt, ...) \ | |
184 | dev_info(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
185 | #define chip_dbg(gc, fmt, ...) \ | |
186 | dev_dbg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__) | |
0eb4c6c2 | 187 | |
664e3e5a | 188 | #endif /* GPIOLIB_H */ |