Mika Westerberg | 664e3e5 | 2014-01-08 12:40:54 +0200 | [diff] [blame] | 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 | |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 15 | #include <linux/gpio/driver.h> |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 16 | #include <linux/err.h> |
| 17 | #include <linux/device.h> |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 18 | #include <linux/module.h> |
| 19 | #include <linux/cdev.h> |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 20 | |
Alexandre Courbot | f01d907 | 2014-05-17 14:54:50 +0900 | [diff] [blame] | 21 | enum of_gpio_flags; |
Linus Walleij | 29ab875 | 2015-12-08 22:45:10 +0100 | [diff] [blame] | 22 | enum gpiod_flags; |
Rafael J. Wysocki | ce79348 | 2015-03-16 23:49:03 +0100 | [diff] [blame] | 23 | struct acpi_device; |
| 24 | |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 25 | /** |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 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 |
Linus Walleij | 3c702e9 | 2015-10-21 15:29:53 +0200 | [diff] [blame^] | 29 | * @chrdev: character device for the GPIO device |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 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 | * @list: links gpio_device:s together for traversal |
| 34 | * |
| 35 | * This state container holds most of the runtime variable data |
| 36 | * for a GPIO device and can hold references and live on after the |
| 37 | * GPIO chip has been removed, if it is still being used from |
| 38 | * userspace. |
| 39 | */ |
| 40 | struct gpio_device { |
| 41 | int id; |
| 42 | struct device dev; |
Linus Walleij | 3c702e9 | 2015-10-21 15:29:53 +0200 | [diff] [blame^] | 43 | struct cdev chrdev; |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 44 | struct module *owner; |
| 45 | struct gpio_chip *chip; |
| 46 | struct list_head list; |
| 47 | }; |
| 48 | |
| 49 | /** |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 50 | * struct acpi_gpio_info - ACPI GPIO specific information |
| 51 | * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo |
| 52 | * @active_low: in case of @gpioint, the pin is active low |
| 53 | */ |
| 54 | struct acpi_gpio_info { |
| 55 | bool gpioint; |
Christophe RICARD | 5204472 | 2015-12-23 23:25:34 +0100 | [diff] [blame] | 56 | int polarity; |
| 57 | int triggering; |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 58 | }; |
| 59 | |
Rojhalat Ibrahim | 7f2e553 | 2015-02-11 17:27:55 +0100 | [diff] [blame] | 60 | /* gpio suffixes used for ACPI and device tree lookup */ |
| 61 | static const char * const gpio_suffixes[] = { "gpios", "gpio" }; |
| 62 | |
Mika Westerberg | 664e3e5 | 2014-01-08 12:40:54 +0200 | [diff] [blame] | 63 | #ifdef CONFIG_ACPI |
| 64 | void acpi_gpiochip_add(struct gpio_chip *chip); |
| 65 | void acpi_gpiochip_remove(struct gpio_chip *chip); |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 66 | |
Mika Westerberg | afa82fa | 2014-07-25 09:54:48 +0300 | [diff] [blame] | 67 | void acpi_gpiochip_request_interrupts(struct gpio_chip *chip); |
| 68 | void acpi_gpiochip_free_interrupts(struct gpio_chip *chip); |
| 69 | |
Mika Westerberg | 0d9a693 | 2014-10-29 15:41:01 +0100 | [diff] [blame] | 70 | struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev, |
| 71 | const char *propname, int index, |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 72 | struct acpi_gpio_info *info); |
Rafael J. Wysocki | 504a337 | 2015-08-27 04:42:33 +0200 | [diff] [blame] | 73 | struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode, |
| 74 | const char *propname, int index, |
| 75 | struct acpi_gpio_info *info); |
Rojhalat Ibrahim | 6685852 | 2015-02-11 17:27:58 +0100 | [diff] [blame] | 76 | |
| 77 | int acpi_gpio_count(struct device *dev, const char *con_id); |
Dmitry Torokhov | 10cf489 | 2015-11-11 11:45:30 -0800 | [diff] [blame] | 78 | |
| 79 | bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id); |
Mika Westerberg | 664e3e5 | 2014-01-08 12:40:54 +0200 | [diff] [blame] | 80 | #else |
| 81 | static inline void acpi_gpiochip_add(struct gpio_chip *chip) { } |
| 82 | static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { } |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 83 | |
Mika Westerberg | afa82fa | 2014-07-25 09:54:48 +0300 | [diff] [blame] | 84 | static inline void |
| 85 | acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { } |
| 86 | |
| 87 | static inline void |
| 88 | acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { } |
| 89 | |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 90 | static inline struct gpio_desc * |
Mika Westerberg | 0d9a693 | 2014-10-29 15:41:01 +0100 | [diff] [blame] | 91 | acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname, |
| 92 | int index, struct acpi_gpio_info *info) |
Mika Westerberg | 5ccff85 | 2014-01-08 12:40:56 +0200 | [diff] [blame] | 93 | { |
| 94 | return ERR_PTR(-ENOSYS); |
| 95 | } |
Rafael J. Wysocki | 504a337 | 2015-08-27 04:42:33 +0200 | [diff] [blame] | 96 | static inline struct gpio_desc * |
| 97 | acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname, |
| 98 | int index, struct acpi_gpio_info *info) |
| 99 | { |
| 100 | return ERR_PTR(-ENXIO); |
| 101 | } |
Rojhalat Ibrahim | 6685852 | 2015-02-11 17:27:58 +0100 | [diff] [blame] | 102 | static inline int acpi_gpio_count(struct device *dev, const char *con_id) |
| 103 | { |
| 104 | return -ENODEV; |
| 105 | } |
Dmitry Torokhov | 10cf489 | 2015-11-11 11:45:30 -0800 | [diff] [blame] | 106 | |
| 107 | static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev, |
| 108 | const char *con_id) |
| 109 | { |
| 110 | return false; |
| 111 | } |
Mika Westerberg | 664e3e5 | 2014-01-08 12:40:54 +0200 | [diff] [blame] | 112 | #endif |
| 113 | |
Alexandre Courbot | f01d907 | 2014-05-17 14:54:50 +0900 | [diff] [blame] | 114 | 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 | |
Alexandre Courbot | 1bd6b60 | 2014-07-22 16:17:41 +0900 | [diff] [blame] | 117 | struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum); |
| 118 | |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 119 | extern struct spinlock gpio_lock; |
Linus Walleij | ff2b135 | 2015-10-20 11:10:38 +0200 | [diff] [blame] | 120 | extern struct list_head gpio_devices; |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 121 | |
| 122 | struct gpio_desc { |
| 123 | struct gpio_chip *chip; |
| 124 | unsigned long flags; |
| 125 | /* flag symbols are bit numbers */ |
| 126 | #define FLAG_REQUESTED 0 |
| 127 | #define FLAG_IS_OUT 1 |
| 128 | #define FLAG_EXPORT 2 /* protected by sysfs_lock */ |
| 129 | #define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */ |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 130 | #define FLAG_ACTIVE_LOW 6 /* value has active low */ |
| 131 | #define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */ |
| 132 | #define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */ |
| 133 | #define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */ |
Benoit Parrot | f625d46 | 2015-02-02 11:44:44 -0600 | [diff] [blame] | 134 | #define FLAG_IS_HOGGED 11 /* GPIO is hogged */ |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 135 | |
Markus Pargmann | c0017ed | 2015-08-14 16:10:59 +0200 | [diff] [blame] | 136 | /* Connection label */ |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 137 | const char *label; |
Markus Pargmann | c0017ed | 2015-08-14 16:10:59 +0200 | [diff] [blame] | 138 | /* Name of the GPIO */ |
| 139 | const char *name; |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 140 | }; |
| 141 | |
| 142 | int gpiod_request(struct gpio_desc *desc, const char *label); |
| 143 | void gpiod_free(struct gpio_desc *desc); |
Benoit Parrot | f625d46 | 2015-02-02 11:44:44 -0600 | [diff] [blame] | 144 | int gpiod_hog(struct gpio_desc *desc, const char *name, |
| 145 | unsigned long lflags, enum gpiod_flags dflags); |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 146 | |
| 147 | /* |
| 148 | * Return the GPIO number of the passed descriptor relative to its chip |
| 149 | */ |
| 150 | static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc) |
| 151 | { |
| 152 | return desc - &desc->chip->desc[0]; |
| 153 | } |
| 154 | |
| 155 | /* With descriptor prefix */ |
| 156 | |
| 157 | #define gpiod_emerg(desc, fmt, ...) \ |
| 158 | pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ |
| 159 | ##__VA_ARGS__) |
| 160 | #define gpiod_crit(desc, fmt, ...) \ |
| 161 | pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ |
| 162 | ##__VA_ARGS__) |
| 163 | #define gpiod_err(desc, fmt, ...) \ |
| 164 | pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ |
| 165 | ##__VA_ARGS__) |
| 166 | #define gpiod_warn(desc, fmt, ...) \ |
| 167 | pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ |
| 168 | ##__VA_ARGS__) |
| 169 | #define gpiod_info(desc, fmt, ...) \ |
| 170 | pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \ |
| 171 | ##__VA_ARGS__) |
| 172 | #define gpiod_dbg(desc, fmt, ...) \ |
| 173 | pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\ |
| 174 | ##__VA_ARGS__) |
| 175 | |
| 176 | /* With chip prefix */ |
| 177 | |
| 178 | #define chip_emerg(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 179 | dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 180 | #define chip_crit(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 181 | dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 182 | #define chip_err(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 183 | dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 184 | #define chip_warn(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 185 | dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 186 | #define chip_info(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 187 | dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 188 | #define chip_dbg(chip, fmt, ...) \ |
Linus Walleij | 34ffd85 | 2015-10-20 11:31:54 +0200 | [diff] [blame] | 189 | dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 190 | |
| 191 | #ifdef CONFIG_GPIO_SYSFS |
| 192 | |
Johan Hovold | 426577b | 2015-05-04 17:10:32 +0200 | [diff] [blame] | 193 | int gpiochip_sysfs_register(struct gpio_chip *chip); |
| 194 | void gpiochip_sysfs_unregister(struct gpio_chip *chip); |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 195 | |
| 196 | #else |
| 197 | |
Johan Hovold | 426577b | 2015-05-04 17:10:32 +0200 | [diff] [blame] | 198 | static inline int gpiochip_sysfs_register(struct gpio_chip *chip) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 199 | { |
| 200 | return 0; |
| 201 | } |
| 202 | |
Johan Hovold | 426577b | 2015-05-04 17:10:32 +0200 | [diff] [blame] | 203 | static inline void gpiochip_sysfs_unregister(struct gpio_chip *chip) |
Alexandre Courbot | 0eb4c6c | 2014-07-01 14:45:15 +0900 | [diff] [blame] | 204 | { |
| 205 | } |
| 206 | |
| 207 | #endif /* CONFIG_GPIO_SYSFS */ |
| 208 | |
Mika Westerberg | 664e3e5 | 2014-01-08 12:40:54 +0200 | [diff] [blame] | 209 | #endif /* GPIOLIB_H */ |