[mirror_ubuntu-hirsute-kernel.git] / drivers / gpio / gpiolib.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Internal GPIO functions.
 *
 * Copyright (C) 2013, Intel Corporation
 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
 */

#ifndef GPIOLIB_H
#define GPIOLIB_H

#include <linux/gpio/driver.h>
#include <linux/gpio/consumer.h> /* for enum gpiod_flags */
#include <linux/err.h>
#include <linux/device.h>
#include <linux/module.h>
#include <linux/cdev.h>

#define GPIOCHIP_NAME	"gpiochip"

/**
 * struct gpio_device - internal state container for GPIO devices
 * @id: numerical ID number for the GPIO chip
 * @dev: the GPIO device struct
 * @chrdev: character device for the GPIO device
 * @mockdev: class device used by the deprecated sysfs interface (may be
 * NULL)
 * @owner: helps prevent removal of modules exporting active GPIOs
 * @chip: pointer to the corresponding gpiochip, holding static
 * data for this device
 * @descs: array of ngpio descriptors.
 * @ngpio: the number of GPIO lines on this GPIO device, equal to the size
 * of the @descs array.
 * @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
 * at device creation time.
 * @label: a descriptive name for the GPIO device, such as the part number
 * or name of the IP component in a System on Chip.
 * @data: per-instance data assigned by the driver
 * @list: links gpio_device:s together for traversal
 *
 * This state container holds most of the runtime variable data
 * for a GPIO device and can hold references and live on after the
 * GPIO chip has been removed, if it is still being used from
 * userspace.
 */
struct gpio_device {
	int			id;
	struct device		dev;
	struct cdev		chrdev;
	struct device		*mockdev;
	struct module		*owner;
	struct gpio_chip	*chip;
	struct gpio_desc	*descs;
	int			base;
	u16			ngpio;
	const char		*label;
	void			*data;
	struct list_head        list;
	struct atomic_notifier_head notifier;

#ifdef CONFIG_PINCTRL
	/*
	 * If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
	 * describe the actual pin range which they serve in an SoC. This
	 * information would be used by pinctrl subsystem to configure
	 * corresponding pins for gpio usage.
	 */
	struct list_head pin_ranges;
#endif
};

/* gpio suffixes used for ACPI and device tree lookup */
static __maybe_unused const char * const gpio_suffixes[] = { "gpios", "gpio" };

struct gpio_array {
	struct gpio_desc	**desc;
	unsigned int		size;
	struct gpio_chip	*chip;
	unsigned long		*get_mask;
	unsigned long		*set_mask;
	unsigned long		invert_mask[];
};

struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc, unsigned int hwnum);
int gpiod_get_array_value_complex(bool raw, bool can_sleep,
				  unsigned int array_size,
				  struct gpio_desc **desc_array,
				  struct gpio_array *array_info,
				  unsigned long *value_bitmap);
int gpiod_set_array_value_complex(bool raw, bool can_sleep,
				  unsigned int array_size,
				  struct gpio_desc **desc_array,
				  struct gpio_array *array_info,
				  unsigned long *value_bitmap);

extern spinlock_t gpio_lock;
extern struct list_head gpio_devices;

struct gpio_desc {
	struct gpio_device	*gdev;
	unsigned long		flags;
/* flag symbols are bit numbers */
#define FLAG_REQUESTED	0
#define FLAG_IS_OUT	1
#define FLAG_EXPORT	2	/* protected by sysfs_lock */
#define FLAG_SYSFS	3	/* exported via /sys/class/gpio/control */
#define FLAG_ACTIVE_LOW	6	/* value has active low */
#define FLAG_OPEN_DRAIN	7	/* Gpio is open drain type */
#define FLAG_OPEN_SOURCE 8	/* Gpio is open source type */
#define FLAG_USED_AS_IRQ 9	/* GPIO is connected to an IRQ */
#define FLAG_IRQ_IS_ENABLED 10	/* GPIO is connected to an enabled IRQ */
#define FLAG_IS_HOGGED	11	/* GPIO is hogged */
#define FLAG_TRANSITORY 12	/* GPIO may lose value in sleep or reset */
#define FLAG_PULL_UP    13	/* GPIO has pull up enabled */
#define FLAG_PULL_DOWN  14	/* GPIO has pull down enabled */
#define FLAG_BIAS_DISABLE    15	/* GPIO has pull disabled */

	/* Connection label */
	const char		*label;
	/* Name of the GPIO */
	const char		*name;
#ifdef CONFIG_OF_DYNAMIC
	struct device_node	*hog;
#endif
};

int gpiod_request(struct gpio_desc *desc, const char *label);
void gpiod_free(struct gpio_desc *desc);
int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
		unsigned long lflags, enum gpiod_flags dflags);
int gpiod_hog(struct gpio_desc *desc, const char *name,
		unsigned long lflags, enum gpiod_flags dflags);

/*
 * Return the GPIO number of the passed descriptor relative to its chip
 */
static inline int gpio_chip_hwgpio(const struct gpio_desc *desc)
{
	return desc - &desc->gdev->descs[0];
}

/* With descriptor prefix */

#define gpiod_emerg(desc, fmt, ...)					       \
	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
		 ##__VA_ARGS__)
#define gpiod_crit(desc, fmt, ...)					       \
	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
		 ##__VA_ARGS__)
#define gpiod_err(desc, fmt, ...)					       \
	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
		 ##__VA_ARGS__)
#define gpiod_warn(desc, fmt, ...)					       \
	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
		 ##__VA_ARGS__)
#define gpiod_info(desc, fmt, ...)					       \
	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
		 ##__VA_ARGS__)
#define gpiod_dbg(desc, fmt, ...)					       \
	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
		 ##__VA_ARGS__)

/* With chip prefix */

#define chip_emerg(gc, fmt, ...)					\
	dev_emerg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
#define chip_crit(gc, fmt, ...)					\
	dev_crit(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
#define chip_err(gc, fmt, ...)					\
	dev_err(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
#define chip_warn(gc, fmt, ...)					\
	dev_warn(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
#define chip_info(gc, fmt, ...)					\
	dev_info(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
#define chip_dbg(gc, fmt, ...)					\
	dev_dbg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)

#ifdef CONFIG_GPIO_SYSFS

int gpiochip_sysfs_register(struct gpio_device *gdev);
void gpiochip_sysfs_unregister(struct gpio_device *gdev);

#else

static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
{
	return 0;
}

static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
{
}

#endif /* CONFIG_GPIO_SYSFS */

#endif /* GPIOLIB_H */
Commit	Line	Data
dae5f0af	1	/* SPDX-License-Identifier: GPL-2.0 */
664e3e5a MW	2	/*
	3	* Internal GPIO functions.
	4	*
	5	* Copyright (C) 2013, Intel Corporation
	6	* Author: Mika Westerberg <mika.westerberg@linux.intel.com>
664e3e5a MW	7	*/
	8
	9	#ifndef GPIOLIB_H
	10	#define GPIOLIB_H
	11
ff2b1359	12	#include <linux/gpio/driver.h>
63f2dc0a	13	#include <linux/gpio/consumer.h> /* for enum gpiod_flags */
5ccff852 MW	14	#include <linux/err.h>
5ccff852 MW	15	#include <linux/device.h>
ff2b1359 LW	16	#include <linux/module.h>
ff2b1359 LW	17	#include <linux/cdev.h>
5ccff852	18
ddd8891e GU	19	#define GPIOCHIP_NAME "gpiochip"
ddd8891e GU	20
ff2b1359 LW	21	/**
	22	* struct gpio_device - internal state container for GPIO devices
	23	* @id: numerical ID number for the GPIO chip
	24	* @dev: the GPIO device struct
3c702e99	25	* @chrdev: character device for the GPIO device
afbc4f31 LW	26	* @mockdev: class device used by the deprecated sysfs interface (may be
afbc4f31 LW	27	* NULL)
ff2b1359 LW	28	* @owner: helps prevent removal of modules exporting active GPIOs
	29	* @chip: pointer to the corresponding gpiochip, holding static
	30	* data for this device
1c3cdb18	31	* @descs: array of ngpio descriptors.
fdeb8e15 LW	32	* @ngpio: the number of GPIO lines on this GPIO device, equal to the size
	33	* of the @descs array.
	34	* @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
	35	* at device creation time.
df4878e9 LW	36	* @label: a descriptive name for the GPIO device, such as the part number
df4878e9 LW	37	* or name of the IP component in a System on Chip.
43c54eca	38	* @data: per-instance data assigned by the driver
ff2b1359 LW	39	* @list: links gpio_device:s together for traversal
	40	*
	41	* This state container holds most of the runtime variable data
	42	* for a GPIO device and can hold references and live on after the
	43	* GPIO chip has been removed, if it is still being used from
	44	* userspace.
	45	*/
	46	struct gpio_device {
	47	int id;
	48	struct device dev;
3c702e99	49	struct cdev chrdev;
afbc4f31	50	struct device *mockdev;
ff2b1359 LW	51	struct module *owner;
ff2b1359 LW	52	struct gpio_chip *chip;
1c3cdb18	53	struct gpio_desc *descs;
fdeb8e15 LW	54	int base;
fdeb8e15 LW	55	u16 ngpio;
3b469b0a	56	const char *label;
43c54eca	57	void *data;
ff2b1359	58	struct list_head list;
51c1064e	59	struct atomic_notifier_head notifier;
20ec3e39 LW	60
	61	#ifdef CONFIG_PINCTRL
	62	/*
	63	* If CONFIG_PINCTRL is enabled, then gpio controllers can optionally
	64	* describe the actual pin range which they serve in an SoC. This
	65	* information would be used by pinctrl subsystem to configure
	66	* corresponding pins for gpio usage.
	67	*/
	68	struct list_head pin_ranges;
	69	#endif
ff2b1359 LW	70	};
ff2b1359 LW	71
7f2e553a	72	/* gpio suffixes used for ACPI and device tree lookup */
b23ec599	73	static __maybe_unused const char * const gpio_suffixes[] = { "gpios", "gpio" };
7f2e553a	74
bf9346f5 JK	75	struct gpio_array {
	76	struct gpio_desc **desc;
	77	unsigned int size;
	78	struct gpio_chip *chip;
	79	unsigned long *get_mask;
	80	unsigned long *set_mask;
	81	unsigned long invert_mask[];
	82	};
	83
a5e93436	84	struct gpio_desc gpiochip_get_desc(struct gpio_chip gc, unsigned int hwnum);
eec1d566 LW	85	int gpiod_get_array_value_complex(bool raw, bool can_sleep,
	86	unsigned int array_size,
	87	struct gpio_desc **desc_array,
77588c14	88	struct gpio_array *array_info,
b9762beb	89	unsigned long *value_bitmap);
3027743f	90	int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3c940660 GU	91	unsigned int array_size,
	92	struct gpio_desc **desc_array,
	93	struct gpio_array *array_info,
	94	unsigned long *value_bitmap);
1bd6b601	95
f0b40863	96	extern spinlock_t gpio_lock;
ff2b1359	97	extern struct list_head gpio_devices;
0eb4c6c2 AC	98
0eb4c6c2 AC	99	struct gpio_desc {
fdeb8e15	100	struct gpio_device *gdev;
0eb4c6c2 AC	101	unsigned long flags;
	102	/* flag symbols are bit numbers */
	103	#define FLAG_REQUESTED 0
	104	#define FLAG_IS_OUT 1
	105	#define FLAG_EXPORT 2 /* protected by sysfs_lock */
	106	#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
0eb4c6c2 AC	107	#define FLAG_ACTIVE_LOW 6 /* value has active low */
	108	#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
	109	#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
	110	#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
4e9439dd	111	#define FLAG_IRQ_IS_ENABLED 10 /* GPIO is connected to an enabled IRQ */
f625d460	112	#define FLAG_IS_HOGGED 11 /* GPIO is hogged */
e10f72bf	113	#define FLAG_TRANSITORY 12 /* GPIO may lose value in sleep or reset */
d449991c TP	114	#define FLAG_PULL_UP 13 /* GPIO has pull up enabled */
d449991c TP	115	#define FLAG_PULL_DOWN 14 /* GPIO has pull down enabled */
2148ad77	116	#define FLAG_BIAS_DISABLE 15 /* GPIO has pull disabled */
0eb4c6c2	117
c0017ed7	118	/* Connection label */
0eb4c6c2	119	const char *label;
c0017ed7 MP	120	/* Name of the GPIO */
c0017ed7 MP	121	const char *name;
63636d95 GU	122	#ifdef CONFIG_OF_DYNAMIC
	123	struct device_node *hog;
	124	#endif
0eb4c6c2 AC	125	};
	126
	127	int gpiod_request(struct gpio_desc desc, const char label);
	128	void gpiod_free(struct gpio_desc *desc);
c29fd9eb AS	129	int gpiod_configure_flags(struct gpio_desc desc, const char con_id,
c29fd9eb AS	130	unsigned long lflags, enum gpiod_flags dflags);
f625d460 BP	131	int gpiod_hog(struct gpio_desc desc, const char name,
f625d460 BP	132	unsigned long lflags, enum gpiod_flags dflags);
0eb4c6c2 AC	133
	134	/*
	135	* Return the GPIO number of the passed descriptor relative to its chip
	136	*/
4a5c886e	137	static inline int gpio_chip_hwgpio(const struct gpio_desc *desc)
0eb4c6c2	138	{
fdeb8e15	139	return desc - &desc->gdev->descs[0];
0eb4c6c2 AC	140	}
	141
	142	/* With descriptor prefix */
	143
	144	#define gpiod_emerg(desc, fmt, ...) \
	145	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	146	##__VA_ARGS__)
	147	#define gpiod_crit(desc, fmt, ...) \
	148	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	149	##__VA_ARGS__)
	150	#define gpiod_err(desc, fmt, ...) \
	151	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	152	##__VA_ARGS__)
	153	#define gpiod_warn(desc, fmt, ...) \
	154	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	155	##__VA_ARGS__)
	156	#define gpiod_info(desc, fmt, ...) \
	157	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	158	##__VA_ARGS__)
	159	#define gpiod_dbg(desc, fmt, ...) \
	160	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	161	##__VA_ARGS__)
	162
	163	/* With chip prefix */
	164
a5e93436 GU	165	#define chip_emerg(gc, fmt, ...) \
	166	dev_emerg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
	167	#define chip_crit(gc, fmt, ...) \
	168	dev_crit(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
	169	#define chip_err(gc, fmt, ...) \
	170	dev_err(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
	171	#define chip_warn(gc, fmt, ...) \
	172	dev_warn(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
	173	#define chip_info(gc, fmt, ...) \
	174	dev_info(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
	175	#define chip_dbg(gc, fmt, ...) \
	176	dev_dbg(&gc->gpiodev->dev, "(%s): " fmt, gc->label, ##__VA_ARGS__)
0eb4c6c2 AC	177
	178	#ifdef CONFIG_GPIO_SYSFS
	179
afbc4f31 LW	180	int gpiochip_sysfs_register(struct gpio_device *gdev);
afbc4f31 LW	181	void gpiochip_sysfs_unregister(struct gpio_device *gdev);
0eb4c6c2 AC	182
	183	#else
	184
afbc4f31	185	static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
0eb4c6c2 AC	186	{
	187	return 0;
	188	}
	189
afbc4f31	190	static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
0eb4c6c2 AC	191	{
	192	}
	193
	194	#endif /* CONFIG_GPIO_SYSFS */
	195
664e3e5a	196	#endif /* GPIOLIB_H */