Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753/* SPDX-License-Identifier: GPL-2.0 */#ifndef __LINUX_GPIO_CONSUMER_H#define __LINUX_GPIO_CONSUMER_H
#include <linux/bits.h>#include <linux/err.h>#include <linux/types.h>
#include "defs.h"
struct acpi_device;struct device;struct fwnode_handle;
struct gpio_array;struct gpio_desc;
/** * struct gpio_descs - Struct containing an array of descriptors that can be * obtained using gpiod_get_array() * * @info: Pointer to the opaque gpio_array structure * @ndescs: Number of held descriptors * @desc: Array of pointers to GPIO descriptors */struct gpio_descs { struct gpio_array *info; unsigned int ndescs; struct gpio_desc *desc[];};
#define GPIOD_FLAGS_BIT_DIR_SET BIT(0)#define GPIOD_FLAGS_BIT_DIR_OUT BIT(1)#define GPIOD_FLAGS_BIT_DIR_VAL BIT(2)#define GPIOD_FLAGS_BIT_OPEN_DRAIN BIT(3)/* GPIOD_FLAGS_BIT_NONEXCLUSIVE is DEPRECATED, don't use in new code. */#define GPIOD_FLAGS_BIT_NONEXCLUSIVE BIT(4)
/** * enum gpiod_flags - Optional flags that can be passed to one of gpiod_* to * configure direction and output value. These values * cannot be OR'd. * * @GPIOD_ASIS: Don't change anything * @GPIOD_IN: Set lines to input mode * @GPIOD_OUT_LOW: Set lines to output and drive them low * @GPIOD_OUT_HIGH: Set lines to output and drive them high * @GPIOD_OUT_LOW_OPEN_DRAIN: Set lines to open-drain output and drive them low * @GPIOD_OUT_HIGH_OPEN_DRAIN: Set lines to open-drain output and drive them high */enum gpiod_flags { GPIOD_ASIS = 0, GPIOD_IN = GPIOD_FLAGS_BIT_DIR_SET, GPIOD_OUT_LOW = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT, GPIOD_OUT_HIGH = GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT | GPIOD_FLAGS_BIT_DIR_VAL, GPIOD_OUT_LOW_OPEN_DRAIN = GPIOD_OUT_LOW | GPIOD_FLAGS_BIT_OPEN_DRAIN, GPIOD_OUT_HIGH_OPEN_DRAIN = GPIOD_OUT_HIGH | GPIOD_FLAGS_BIT_OPEN_DRAIN,};
#ifdef CONFIG_GPIOLIB
/* Return the number of GPIOs associated with a device / function */int gpiod_count(struct device *dev, const char *con_id);
/* Acquire and dispose GPIOs */struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_desc *__must_check gpiod_get_index(struct device *dev, const char *con_id, unsigned int idx, enum gpiod_flags flags);struct gpio_desc *__must_check gpiod_get_optional(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev, const char *con_id, unsigned int index, enum gpiod_flags flags);struct gpio_descs *__must_check gpiod_get_array(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev, const char *con_id, enum gpiod_flags flags);void gpiod_put(struct gpio_desc *desc);void gpiod_put_array(struct gpio_descs *descs);
struct gpio_desc *__must_check devm_gpiod_get(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_desc *__must_check devm_gpiod_get_index(struct device *dev, const char *con_id, unsigned int idx, enum gpiod_flags flags);struct gpio_desc *__must_check devm_gpiod_get_optional(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_desc *__must_checkdevm_gpiod_get_index_optional(struct device *dev, const char *con_id, unsigned int index, enum gpiod_flags flags);struct gpio_descs *__must_check devm_gpiod_get_array(struct device *dev, const char *con_id, enum gpiod_flags flags);struct gpio_descs *__must_checkdevm_gpiod_get_array_optional(struct device *dev, const char *con_id, enum gpiod_flags flags);void devm_gpiod_put(struct device *dev, struct gpio_desc *desc);void devm_gpiod_unhinge(struct device *dev, struct gpio_desc *desc);void devm_gpiod_put_array(struct device *dev, struct gpio_descs *descs);
int gpiod_get_direction(struct gpio_desc *desc);bool gpiod_is_single_ended(struct gpio_desc *desc);int gpiod_direction_input(struct gpio_desc *desc);int gpiod_direction_output(struct gpio_desc *desc, int value);int gpiod_direction_output_raw(struct gpio_desc *desc, int value);
/* Value get/set from non-sleeping context */int gpiod_get_value(const struct gpio_desc *desc);int gpiod_get_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_set_value(struct gpio_desc *desc, int value);int gpiod_set_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_get_raw_value(const struct gpio_desc *desc);int gpiod_get_raw_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_set_raw_value(struct gpio_desc *desc, int value);int gpiod_set_raw_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);
/* Value get/set from sleeping context */int gpiod_get_value_cansleep(const struct gpio_desc *desc);int gpiod_get_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_set_value_cansleep(struct gpio_desc *desc, int value);int gpiod_set_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc);int gpiod_get_raw_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);int gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value);int gpiod_set_raw_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap);
int gpiod_set_config(struct gpio_desc *desc, unsigned long config);int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce);void gpiod_toggle_active_low(struct gpio_desc *desc);
int gpiod_is_active_low(const struct gpio_desc *desc);int gpiod_cansleep(const struct gpio_desc *desc);
int gpiod_to_irq(const struct gpio_desc *desc);int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name);
bool gpiod_is_shared(const struct gpio_desc *desc);
/* Convert between the old gpio_ and new gpiod_ interfaces */struct gpio_desc *gpio_to_desc(unsigned gpio);int desc_to_gpio(const struct gpio_desc *desc);
int gpiod_hwgpio(const struct gpio_desc *desc);
struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode, const char *con_id, int index, enum gpiod_flags flags, const char *label);struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev, struct fwnode_handle *child, const char *con_id, int index, enum gpiod_flags flags, const char *label);
bool gpiod_is_equal(const struct gpio_desc *desc, const struct gpio_desc *other);
#else /* CONFIG_GPIOLIB */
#include <linux/bug.h>#include <linux/kernel.h>
static inline int gpiod_count(struct device *dev, const char *con_id){ return 0;}
static inline struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}static inline struct gpio_desc *__must_checkgpiod_get_index(struct device *dev, const char *con_id, unsigned int idx, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}
static inline struct gpio_desc *__must_checkgpiod_get_optional(struct device *dev, const char *con_id, enum gpiod_flags flags){ return NULL;}
static inline struct gpio_desc *__must_checkgpiod_get_index_optional(struct device *dev, const char *con_id, unsigned int index, enum gpiod_flags flags){ return NULL;}
static inline struct gpio_descs *__must_checkgpiod_get_array(struct device *dev, const char *con_id, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}
static inline struct gpio_descs *__must_checkgpiod_get_array_optional(struct device *dev, const char *con_id, enum gpiod_flags flags){ return NULL;}
static inline void gpiod_put(struct gpio_desc *desc){ might_sleep();
/* GPIO can never have been requested */ WARN_ON(desc);}
static inline void devm_gpiod_unhinge(struct device *dev, struct gpio_desc *desc){ might_sleep();
/* GPIO can never have been requested */ WARN_ON(desc);}
static inline void gpiod_put_array(struct gpio_descs *descs){ might_sleep();
/* GPIO can never have been requested */ WARN_ON(descs);}
static inline struct gpio_desc *__must_checkdevm_gpiod_get(struct device *dev, const char *con_id, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}static inlinestruct gpio_desc *__must_checkdevm_gpiod_get_index(struct device *dev, const char *con_id, unsigned int idx, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}
static inline struct gpio_desc *__must_checkdevm_gpiod_get_optional(struct device *dev, const char *con_id, enum gpiod_flags flags){ return NULL;}
static inline struct gpio_desc *__must_checkdevm_gpiod_get_index_optional(struct device *dev, const char *con_id, unsigned int index, enum gpiod_flags flags){ return NULL;}
static inline struct gpio_descs *__must_checkdevm_gpiod_get_array(struct device *dev, const char *con_id, enum gpiod_flags flags){ return ERR_PTR(-ENOSYS);}
static inline struct gpio_descs *__must_checkdevm_gpiod_get_array_optional(struct device *dev, const char *con_id, enum gpiod_flags flags){ return NULL;}
static inline void devm_gpiod_put(struct device *dev, struct gpio_desc *desc){ might_sleep();
/* GPIO can never have been requested */ WARN_ON(desc);}
static inline void devm_gpiod_put_array(struct device *dev, struct gpio_descs *descs){ might_sleep();
/* GPIO can never have been requested */ WARN_ON(descs);}
static inline int gpiod_get_direction(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}static inline bool gpiod_is_single_ended(struct gpio_desc *desc){ return false;}static inline int gpiod_direction_input(struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}static inline int gpiod_direction_output(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}static inline int gpiod_direction_output_raw(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}static inline int gpiod_get_value(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_get_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_set_value(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_set_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_get_raw_value(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_get_raw_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_set_raw_value(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_set_raw_array_value(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}
static inline int gpiod_get_value_cansleep(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_get_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_set_value_cansleep(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_set_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_get_raw_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}static inline int gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_set_raw_array_value_cansleep(unsigned int array_size, struct gpio_desc **desc_array, struct gpio_array *array_info, unsigned long *value_bitmap){ /* GPIO can never have been requested */ WARN_ON(desc_array); return 0;}
static inline int gpiod_set_config(struct gpio_desc *desc, unsigned long config){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}
static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce){ /* GPIO can never have been requested */ WARN_ON(desc); return -ENOSYS;}
static inline void gpiod_toggle_active_low(struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc);}
static inline int gpiod_is_active_low(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}static inline int gpiod_cansleep(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return 0;}
static inline int gpiod_to_irq(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return -EINVAL;}
static inline int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name){ /* GPIO can never have been requested */ WARN_ON(desc); return -EINVAL;}
static inline bool gpiod_is_shared(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return false;}
static inline struct gpio_desc *gpio_to_desc(unsigned gpio){ return NULL;}
static inline int desc_to_gpio(const struct gpio_desc *desc){ /* GPIO can never have been requested */ WARN_ON(desc); return -EINVAL;}
static inlinestruct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode, const char *con_id, int index, enum gpiod_flags flags, const char *label){ return ERR_PTR(-ENOSYS);}
static inlinestruct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev, struct fwnode_handle *fwnode, const char *con_id, int index, enum gpiod_flags flags, const char *label){ return ERR_PTR(-ENOSYS);}
static inline boolgpiod_is_equal(const struct gpio_desc *desc, const struct gpio_desc *other){ WARN_ON(desc || other); return false;}
#endif /* CONFIG_GPIOLIB */
#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_HTE)int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags);int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags);#else
#include <linux/bug.h>
static inline int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags){ if (!IS_ENABLED(CONFIG_GPIOLIB)) WARN_ON(desc);
return -ENOSYS;}static inline int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags){ if (!IS_ENABLED(CONFIG_GPIOLIB)) WARN_ON(desc);
return -ENOSYS;}#endif /* CONFIG_GPIOLIB && CONFIG_HTE */
static inlinestruct gpio_desc *fwnode_gpiod_get(struct fwnode_handle *fwnode, const char *con_id, enum gpiod_flags flags, const char *label){ return fwnode_gpiod_get_index(fwnode, con_id, 0, flags, label);}
static inlinestruct gpio_desc *devm_fwnode_gpiod_get(struct device *dev, struct fwnode_handle *fwnode, const char *con_id, enum gpiod_flags flags, const char *label){ return devm_fwnode_gpiod_get_index(dev, fwnode, con_id, 0, flags, label);}
/** * devm_fwnode_gpiod_get_optional - obtain an optional GPIO from firmware node * @dev: GPIO consumer * @fwnode: handle of the firmware node * @con_id: function within the GPIO consumer * @flags: GPIO initialization flags * @label: label to attach to the requested GPIO * * This function can be used for drivers that get their configuration * from opaque firmware. * * GPIO descriptors returned from this function are automatically disposed on * driver detach. * * Returns: * The GPIO descriptor corresponding to the optional function @con_id of device * dev, NULL if no GPIO has been assigned to the requested function, or * another IS_ERR() code if an error occurred while trying to acquire the GPIO. */static inlinestruct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev, struct fwnode_handle *fwnode, const char *con_id, enum gpiod_flags flags, const char *label){ struct gpio_desc *desc;
desc = devm_fwnode_gpiod_get_index(dev, fwnode, con_id, 0, flags, label); if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) return NULL;
return desc;}
struct acpi_gpio_params { unsigned int crs_entry_index; unsigned short line_index; bool active_low;};
struct acpi_gpio_mapping { const char *name; const struct acpi_gpio_params *data; unsigned int size;
/* Ignore IoRestriction field */#define ACPI_GPIO_QUIRK_NO_IO_RESTRICTION BIT(0)/* * When ACPI GPIO mapping table is in use the index parameter inside it * refers to the GPIO resource in _CRS method. That index has no * distinction of actual type of the resource. When consumer wants to * get GpioIo type explicitly, this quirk may be used. */#define ACPI_GPIO_QUIRK_ONLY_GPIOIO BIT(1)/* Use given pin as an absolute GPIO number in the system */#define ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER BIT(2)
unsigned int quirks;};
#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_ACPI)
int acpi_dev_add_driver_gpios(struct acpi_device *adev, const struct acpi_gpio_mapping *gpios);void acpi_dev_remove_driver_gpios(struct acpi_device *adev);
int devm_acpi_dev_add_driver_gpios(struct device *dev, const struct acpi_gpio_mapping *gpios);
#else /* CONFIG_GPIOLIB && CONFIG_ACPI */
static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev, const struct acpi_gpio_mapping *gpios){ return -ENXIO;}static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
static inline int devm_acpi_dev_add_driver_gpios(struct device *dev, const struct acpi_gpio_mapping *gpios){ return -ENXIO;}
#endif /* CONFIG_GPIOLIB && CONFIG_ACPI */
#if IS_ENABLED(CONFIG_GPIOLIB) && IS_ENABLED(CONFIG_GPIO_SYSFS)
int gpiod_export(struct gpio_desc *desc, bool direction_may_change);int gpiod_export_link(struct device *dev, const char *name, struct gpio_desc *desc);void gpiod_unexport(struct gpio_desc *desc);
#else /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */
static inline int gpiod_export(struct gpio_desc *desc, bool direction_may_change){ return -ENOSYS;}
static inline int gpiod_export_link(struct device *dev, const char *name, struct gpio_desc *desc){ return -ENOSYS;}
static inline void gpiod_unexport(struct gpio_desc *desc){}
#endif /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */
static inline int gpiod_multi_set_value_cansleep(struct gpio_descs *descs, unsigned long *value_bitmap){ if (IS_ERR_OR_NULL(descs)) return PTR_ERR_OR_ZERO(descs);
return gpiod_set_array_value_cansleep(descs->ndescs, descs->desc, descs->info, value_bitmap);}
#endif