[linux-2.6-block.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>

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

#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 *chip, u16 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;
};

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