2 * Internal GPIO functions.
4 * Copyright (C) 2013, Intel Corporation
5 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
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.
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>
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
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 * @list: links gpio_device:s together for traversal
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
51 struct device *mockdev;
53 struct gpio_chip *chip;
54 struct gpio_desc *descs;
57 struct list_head list;
61 * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
62 * describe the actual pin range which they serve in an SoC. This
63 * information would be used by pinctrl subsystem to configure
64 * corresponding pins for gpio usage.
66 struct list_head pin_ranges;
71 * struct acpi_gpio_info - ACPI GPIO specific information
72 * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
73 * @active_low: in case of @gpioint, the pin is active low
75 struct acpi_gpio_info {
81 /* gpio suffixes used for ACPI and device tree lookup */
82 static const char * const gpio_suffixes[] = { "gpios", "gpio" };
85 void acpi_gpiochip_add(struct gpio_chip *chip);
86 void acpi_gpiochip_remove(struct gpio_chip *chip);
88 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
89 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
91 struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
92 const char *propname, int index,
93 struct acpi_gpio_info *info);
94 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
95 const char *propname, int index,
96 struct acpi_gpio_info *info);
98 int acpi_gpio_count(struct device *dev, const char *con_id);
100 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id);
102 static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
103 static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
106 acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
109 acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
111 static inline struct gpio_desc *
112 acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname,
113 int index, struct acpi_gpio_info *info)
115 return ERR_PTR(-ENOSYS);
117 static inline struct gpio_desc *
118 acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname,
119 int index, struct acpi_gpio_info *info)
121 return ERR_PTR(-ENXIO);
123 static inline int acpi_gpio_count(struct device *dev, const char *con_id)
128 static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
135 struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
136 const char *list_name, int index, enum of_gpio_flags *flags);
138 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);
140 extern struct spinlock gpio_lock;
141 extern struct list_head gpio_devices;
144 struct gpio_device *gdev;
146 /* flag symbols are bit numbers */
147 #define FLAG_REQUESTED 0
148 #define FLAG_IS_OUT 1
149 #define FLAG_EXPORT 2 /* protected by sysfs_lock */
150 #define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
151 #define FLAG_ACTIVE_LOW 6 /* value has active low */
152 #define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
153 #define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
154 #define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
155 #define FLAG_IS_HOGGED 11 /* GPIO is hogged */
157 /* Connection label */
159 /* Name of the GPIO */
163 int gpiod_request(struct gpio_desc *desc, const char *label);
164 void gpiod_free(struct gpio_desc *desc);
165 int gpiod_hog(struct gpio_desc *desc, const char *name,
166 unsigned long lflags, enum gpiod_flags dflags);
169 * Return the GPIO number of the passed descriptor relative to its chip
171 static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
173 return desc - &desc->gdev->descs[0];
176 /* With descriptor prefix */
178 #define gpiod_emerg(desc, fmt, ...) \
179 pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
181 #define gpiod_crit(desc, fmt, ...) \
182 pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
184 #define gpiod_err(desc, fmt, ...) \
185 pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
187 #define gpiod_warn(desc, fmt, ...) \
188 pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
190 #define gpiod_info(desc, fmt, ...) \
191 pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
193 #define gpiod_dbg(desc, fmt, ...) \
194 pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
197 /* With chip prefix */
199 #define chip_emerg(chip, fmt, ...) \
200 dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
201 #define chip_crit(chip, fmt, ...) \
202 dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
203 #define chip_err(chip, fmt, ...) \
204 dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
205 #define chip_warn(chip, fmt, ...) \
206 dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
207 #define chip_info(chip, fmt, ...) \
208 dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
209 #define chip_dbg(chip, fmt, ...) \
210 dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
212 #ifdef CONFIG_GPIO_SYSFS
214 int gpiochip_sysfs_register(struct gpio_device *gdev);
215 void gpiochip_sysfs_unregister(struct gpio_device *gdev);
219 static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
224 static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
228 #endif /* CONFIG_GPIO_SYSFS */
230 #endif /* GPIOLIB_H */