mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-10-12 03:26:26 +00:00
92542edc42
We have been holding back on adding an API for fetching GPIO handles directly from device nodes, strongly preferring to get it from the spawn devices instead. The fwnode interface however already contains an API for doing this, as it is used for opaque device tree nodes or ACPI nodes for getting handles to LEDs and keys that use GPIO: those are specified as one child per LED/key in the device tree and are not individual devices. However regulators present a special problem as they already have helper functions to traverse the device tree from a regulator node and two levels down to fill in data, and as it already traverses GPIO nodes in its own way, and already holds a pointer to each regulators device tree node, it makes most sense to export an API to fetch the GPIO descriptor directly from the node. We only support the devm_* version for now, hopefully no non-devres version will be needed. Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
553 lines
15 KiB
C
553 lines
15 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef __LINUX_GPIO_CONSUMER_H
|
|
#define __LINUX_GPIO_CONSUMER_H
|
|
|
|
#include <linux/bug.h>
|
|
#include <linux/err.h>
|
|
#include <linux/kernel.h>
|
|
|
|
struct device;
|
|
|
|
/**
|
|
* Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
|
|
* preferable to the old integer-based handles.
|
|
*
|
|
* Contrary to integers, a pointer to a gpio_desc is guaranteed to be valid
|
|
* until the GPIO is released.
|
|
*/
|
|
struct gpio_desc;
|
|
|
|
/**
|
|
* Struct containing an array of descriptors that can be obtained using
|
|
* gpiod_get_array().
|
|
*/
|
|
struct gpio_descs {
|
|
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)
|
|
|
|
/**
|
|
* Optional flags that can be passed to one of gpiod_* to configure direction
|
|
* and output value. These values cannot be OR'd.
|
|
*/
|
|
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_FLAGS_BIT_DIR_SET |
|
|
GPIOD_FLAGS_BIT_DIR_OUT | GPIOD_FLAGS_BIT_OPEN_DRAIN,
|
|
GPIOD_OUT_HIGH_OPEN_DRAIN = GPIOD_FLAGS_BIT_DIR_SET |
|
|
GPIOD_FLAGS_BIT_DIR_OUT | GPIOD_FLAGS_BIT_DIR_VAL |
|
|
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_check
|
|
devm_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_check
|
|
devm_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_put_array(struct device *dev, struct gpio_descs *descs);
|
|
|
|
int gpiod_get_direction(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, int *value_array);
|
|
void gpiod_set_value(struct gpio_desc *desc, int value);
|
|
void gpiod_set_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array, int *value_array);
|
|
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,
|
|
int *value_array);
|
|
void gpiod_set_raw_value(struct gpio_desc *desc, int value);
|
|
void gpiod_set_raw_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array);
|
|
|
|
/* 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,
|
|
int *value_array);
|
|
void gpiod_set_value_cansleep(struct gpio_desc *desc, int value);
|
|
void gpiod_set_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array);
|
|
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,
|
|
int *value_array);
|
|
void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value);
|
|
void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array);
|
|
|
|
int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce);
|
|
int gpiod_set_transitory(struct gpio_desc *desc, bool transitory);
|
|
|
|
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);
|
|
|
|
/* 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);
|
|
|
|
/* Child properties interface */
|
|
struct device_node;
|
|
struct fwnode_handle;
|
|
|
|
struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
|
|
struct device_node *node,
|
|
const char *propname, int index,
|
|
enum gpiod_flags dflags,
|
|
const char *label);
|
|
struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
|
|
const char *propname, int index,
|
|
enum gpiod_flags dflags,
|
|
const char *label);
|
|
struct gpio_desc *devm_fwnode_get_index_gpiod_from_child(struct device *dev,
|
|
const char *con_id, int index,
|
|
struct fwnode_handle *child,
|
|
enum gpiod_flags flags,
|
|
const char *label);
|
|
|
|
#else /* CONFIG_GPIOLIB */
|
|
|
|
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_check
|
|
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_check
|
|
gpiod_get_optional(struct device *dev, const char *con_id,
|
|
enum gpiod_flags flags)
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
static inline struct gpio_desc *__must_check
|
|
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_check
|
|
gpiod_get_array(struct device *dev, const char *con_id,
|
|
enum gpiod_flags flags)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
|
|
static inline struct gpio_descs *__must_check
|
|
gpiod_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(1);
|
|
}
|
|
|
|
static inline void gpiod_put_array(struct gpio_descs *descs)
|
|
{
|
|
might_sleep();
|
|
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
|
|
static inline struct gpio_desc *__must_check
|
|
devm_gpiod_get(struct device *dev,
|
|
const char *con_id,
|
|
enum gpiod_flags flags)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
static inline
|
|
struct gpio_desc *__must_check
|
|
devm_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_check
|
|
devm_gpiod_get_optional(struct device *dev, const char *con_id,
|
|
enum gpiod_flags flags)
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
static inline struct gpio_desc *__must_check
|
|
devm_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_check
|
|
devm_gpiod_get_array(struct device *dev, const char *con_id,
|
|
enum gpiod_flags flags)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
|
|
static inline struct gpio_descs *__must_check
|
|
devm_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(1);
|
|
}
|
|
|
|
static inline void devm_gpiod_put_array(struct device *dev,
|
|
struct gpio_descs *descs)
|
|
{
|
|
might_sleep();
|
|
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
|
|
|
|
static inline int gpiod_get_direction(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
static inline int gpiod_direction_input(struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
static inline int gpiod_direction_output(struct gpio_desc *desc, int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
static inline int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
|
|
|
|
static inline int gpiod_get_value(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline int gpiod_get_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline void gpiod_set_value(struct gpio_desc *desc, int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline void gpiod_set_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline int gpiod_get_raw_value(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline int gpiod_get_raw_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline void gpiod_set_raw_value(struct gpio_desc *desc, int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline void gpiod_set_raw_array_value(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
|
|
static inline int gpiod_get_value_cansleep(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline int gpiod_get_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline void gpiod_set_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline void gpiod_set_raw_value_cansleep(struct gpio_desc *desc,
|
|
int value)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
static inline void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
|
|
struct gpio_desc **desc_array,
|
|
int *value_array)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
}
|
|
|
|
static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
|
|
static inline int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -ENOSYS;
|
|
}
|
|
|
|
static inline int gpiod_is_active_low(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
static inline int gpiod_cansleep(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return 0;
|
|
}
|
|
|
|
static inline int gpiod_to_irq(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -EINVAL;
|
|
}
|
|
|
|
static inline struct gpio_desc *gpio_to_desc(unsigned gpio)
|
|
{
|
|
return ERR_PTR(-EINVAL);
|
|
}
|
|
|
|
static inline int desc_to_gpio(const struct gpio_desc *desc)
|
|
{
|
|
/* GPIO can never have been requested */
|
|
WARN_ON(1);
|
|
return -EINVAL;
|
|
}
|
|
|
|
/* Child properties interface */
|
|
struct device_node;
|
|
struct fwnode_handle;
|
|
|
|
static inline
|
|
struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
|
|
struct device_node *node,
|
|
const char *propname, int index,
|
|
enum gpiod_flags dflags,
|
|
const char *label)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
|
|
static inline
|
|
struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
|
|
const char *propname, int index,
|
|
enum gpiod_flags dflags,
|
|
const char *label)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
|
|
static inline
|
|
struct gpio_desc *devm_fwnode_get_index_gpiod_from_child(struct device *dev,
|
|
const char *con_id, int index,
|
|
struct fwnode_handle *child,
|
|
enum gpiod_flags flags,
|
|
const char *label)
|
|
{
|
|
return ERR_PTR(-ENOSYS);
|
|
}
|
|
|
|
#endif /* CONFIG_GPIOLIB */
|
|
|
|
static inline
|
|
struct gpio_desc *devm_fwnode_get_gpiod_from_child(struct device *dev,
|
|
const char *con_id,
|
|
struct fwnode_handle *child,
|
|
enum gpiod_flags flags,
|
|
const char *label)
|
|
{
|
|
return devm_fwnode_get_index_gpiod_from_child(dev, con_id, 0, child,
|
|
flags, label);
|
|
}
|
|
|
|
#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 */
|
|
|
|
#endif
|