Release 4.10 include/linux/gpio/consumer.h

Directory: include/linux/gpio
#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)

/**
 * 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,
};

#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);
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);
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);
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);
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_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 fwnode_handle;

struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
					 const char *propname);
struct gpio_desc *devm_get_gpiod_from_child(struct device *dev,
					    const char *con_id,
					    struct fwnode_handle *child);
#else /* CONFIG_GPIOLIB */



static inline int gpiod_count(struct device *dev, const char *con_id)
{
	return 0;
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 20 100.00% 1 100.00%
Total 20 100.00% 1 100.00%



static inline struct gpio_desc *__must_check gpiod_get(struct device *dev,
						       const char *con_id,
						       enum gpiod_flags flags)
{
	return ERR_PTR(-ENOSYS);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 26 83.87% 1 33.33%
linus walleij linus walleij 4 12.90% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 3.23% 1 33.33%
Total 31 100.00% 3 100.00%


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);
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 30 85.71% 1 33.33%
linus walleij linus walleij 4 11.43% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 2.86% 1 33.33%
Total 35 100.00% 3 100.00%


static inline struct gpio_desc *__must_check

gpiod_get_optional(struct device *dev, const char *con_id,
		   enum gpiod_flags flags)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
thierry reding thierry reding 26 83.87% 1 33.33%
linus walleij linus walleij 4 12.90% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 3.23% 1 33.33%
Total 31 100.00% 3 100.00%


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 ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
thierry reding thierry reding 30 85.71% 1 33.33%
linus walleij linus walleij 4 11.43% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 2.86% 1 33.33%
Total 35 100.00% 3 100.00%


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);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 31 100.00% 1 100.00%
Total 31 100.00% 1 100.00%


static inline struct gpio_descs *__must_check

gpiod_get_array_optional(struct device *dev, const char *con_id,
			 enum gpiod_flags flags)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 31 100.00% 1 100.00%
Total 31 100.00% 1 100.00%



static inline void gpiod_put(struct gpio_desc *desc)
{
	might_sleep();

	/* GPIO can never have been requested */
	WARN_ON(1);
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%



static inline void gpiod_put_array(struct gpio_descs *descs)
{
	might_sleep();

	/* GPIO can never have been requested */
	WARN_ON(1);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%


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);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 26 83.87% 1 33.33%
linus walleij linus walleij 4 12.90% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 3.23% 1 33.33%
Total 31 100.00% 3 100.00%


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);
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 30 85.71% 1 33.33%
linus walleij linus walleij 4 11.43% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 2.86% 1 33.33%
Total 35 100.00% 3 100.00%


static inline struct gpio_desc *__must_check

devm_gpiod_get_optional(struct device *dev, const char *con_id,
			  enum gpiod_flags flags)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
thierry reding thierry reding 26 83.87% 1 33.33%
linus walleij linus walleij 4 12.90% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 3.23% 1 33.33%
Total 31 100.00% 3 100.00%


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 ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
thierry reding thierry reding 30 85.71% 1 33.33%
linus walleij linus walleij 4 11.43% 1 33.33%
uwe kleine-koenig uwe kleine-koenig 1 2.86% 1 33.33%
Total 35 100.00% 3 100.00%


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);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 31 100.00% 1 100.00%
Total 31 100.00% 1 100.00%


static inline struct gpio_descs *__must_check

devm_gpiod_get_array_optional(struct device *dev, const char *con_id,
			      enum gpiod_flags flags)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 31 100.00% 1 100.00%
Total 31 100.00% 1 100.00%



static inline void devm_gpiod_put(struct device *dev, struct gpio_desc *desc)
{
	might_sleep();

	/* GPIO can never have been requested */
	WARN_ON(1);
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 26 100.00% 1 100.00%
Total 26 100.00% 1 100.00%



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);
}


Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 26 100.00% 1 100.00%
Total 26 100.00% 1 100.00%



static inline int gpiod_get_direction(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -ENOSYS;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 23 100.00% 1 100.00%
Total 23 100.00% 1 100.00%



static inline int gpiod_direction_input(struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -ENOSYS;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline int gpiod_direction_output(struct gpio_desc *desc, int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -ENOSYS;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 25 100.00% 1 100.00%
Total 25 100.00% 1 100.00%



static inline int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -ENOSYS;
}


Contributors
Person Tokens Prop Commits CommitProp
philipp zabel philipp zabel 25 100.00% 1 100.00%
Total 25 100.00% 1 100.00%



static inline int gpiod_get_value(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline void gpiod_set_value(struct gpio_desc *desc, int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%



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);
}
Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 27 100.00% 2 100.00%
Total 27 100.00% 2 100.00%



static inline int gpiod_get_raw_value(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline void gpiod_set_raw_value(struct gpio_desc *desc, int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%



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);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 27 100.00% 2 100.00%
Total 27 100.00% 2 100.00%



static inline int gpiod_get_value_cansleep(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%



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);
}
Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 27 100.00% 2 100.00%
Total 27 100.00% 2 100.00%



static inline int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline void gpiod_set_raw_value_cansleep(struct gpio_desc *desc,
						int value)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 21 100.00% 1 100.00%
Total 21 100.00% 1 100.00%



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);
}

Contributors
Person Tokens Prop Commits CommitProp
rojhalat ibrahim rojhalat ibrahim 27 100.00% 2 100.00%
Total 27 100.00% 2 100.00%



static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -ENOSYS;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 25 100.00% 1 100.00%
Total 25 100.00% 1 100.00%



static inline int gpiod_is_active_low(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}
Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline int gpiod_cansleep(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return 0;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 22 100.00% 1 100.00%
Total 22 100.00% 1 100.00%



static inline int gpiod_to_irq(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -EINVAL;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 23 100.00% 1 100.00%
Total 23 100.00% 1 100.00%



static inline struct gpio_desc *gpio_to_desc(unsigned gpio)
{
	return ERR_PTR(-EINVAL);
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 19 100.00% 1 100.00%
Total 19 100.00% 1 100.00%



static inline int desc_to_gpio(const struct gpio_desc *desc)
{
	/* GPIO can never have been requested */
	WARN_ON(1);
	return -EINVAL;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 23 100.00% 1 100.00%
Total 23 100.00% 1 100.00%

/* Child properties interface */
struct fwnode_handle;



static inline struct gpio_desc *fwnode_get_named_gpiod(
	struct fwnode_handle *fwnode, const char *propname)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
geert uytterhoeven geert uytterhoeven 26 100.00% 1 100.00%
Total 26 100.00% 1 100.00%



static inline struct gpio_desc *devm_get_gpiod_from_child(
	struct device *dev, const char *con_id, struct fwnode_handle *child)
{
	return ERR_PTR(-ENOSYS);
}

Contributors
Person Tokens Prop Commits CommitProp
geert uytterhoeven geert uytterhoeven 31 100.00% 1 100.00%
Total 31 100.00% 1 100.00%

#endif /* CONFIG_GPIOLIB */

#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;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 19 100.00% 1 100.00%
Total 19 100.00% 1 100.00%



static inline int gpiod_export_link(struct device *dev, const char *name,
				    struct gpio_desc *desc)
{
	return -ENOSYS;
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 26 100.00% 1 100.00%
Total 26 100.00% 1 100.00%



static inline void gpiod_unexport(struct gpio_desc *desc)
{
}

Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 11 100.00% 1 100.00%
Total 11 100.00% 1 100.00%

#endif /* CONFIG_GPIOLIB && CONFIG_GPIO_SYSFS */

#endif
Overall Contributors
Person Tokens Prop Commits CommitProp
alexandre courbot alexandre courbot 1024 53.61% 3 18.75%
rojhalat ibrahim rojhalat ibrahim 509 26.65% 4 25.00%
thierry reding thierry reding 184 9.63% 1 6.25%
geert uytterhoeven geert uytterhoeven 61 3.19% 1 6.25%
philipp zabel philipp zabel 37 1.94% 1 6.25%
mika westerberg mika westerberg 36 1.88% 1 6.25%
linus walleij linus walleij 35 1.83% 2 12.50%
uwe kleine-koenig uwe kleine-koenig 16 0.84% 1 6.25%
oliver schinagl oliver schinagl 5 0.26% 1 6.25%
arnd bergmann arnd bergmann 3 0.16% 1 6.25%
Total 1910 100.00% 16 100.00%
Directory: include/linux/gpio

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
	Person	Tokens	Prop	Commits	CommitProp
rojhalat ibrahim	rojhalat ibrahim	20	100.00%	1	100.00%
	Total	20	100.00%	1	100.00%
cregit-Linux how code gets into the kernel

Release 4.10 include/linux/gpio/consumer.h

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Contributors

Overall Contributors
