[deliverable/linux.git] / drivers / gpio / gpiolib.h

/*
 * Internal GPIO functions.
 *
 * Copyright (C) 2013, Intel Corporation
 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef GPIOLIB_H
#define GPIOLIB_H

#include <linux/gpio/driver.h>
#include <linux/err.h>
#include <linux/device.h>
#include <linux/module.h>
#include <linux/cdev.h>

enum of_gpio_flags;
enum gpiod_flags;
struct acpi_device;

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

/**
 * struct acpi_gpio_info - ACPI GPIO specific information
 * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
 * @active_low: in case of @gpioint, the pin is active low
 */
struct acpi_gpio_info {
	bool gpioint;
	int polarity;
	int triggering;
};

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

#ifdef CONFIG_ACPI
void acpi_gpiochip_add(struct gpio_chip *chip);
void acpi_gpiochip_remove(struct gpio_chip *chip);

void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);

struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
					  const char *propname, int index,
					  struct acpi_gpio_info *info);
struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
				      const char *propname, int index,
				      struct acpi_gpio_info *info);

int acpi_gpio_count(struct device *dev, const char *con_id);

bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id);
#else
static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }

static inline void
acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }

static inline void
acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }

static inline struct gpio_desc *
acpi_get_gpiod_by_index(struct acpi_device *adev, const char *propname,
			int index, struct acpi_gpio_info *info)
{
	return ERR_PTR(-ENOSYS);
}
static inline struct gpio_desc *
acpi_node_get_gpiod(struct fwnode_handle *fwnode, const char *propname,
		    int index, struct acpi_gpio_info *info)
{
	return ERR_PTR(-ENXIO);
}
static inline int acpi_gpio_count(struct device *dev, const char *con_id)
{
	return -ENODEV;
}

static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
					    const char *con_id)
{
	return false;
}
#endif

struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
		   const char *list_name, int index, enum of_gpio_flags *flags);

struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip, u16 hwnum);

extern struct spinlock 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_IS_HOGGED	11	/* GPIO is hogged */

	/* 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_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 int __maybe_unused 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
664e3e5a MW	1	/*
	2	* Internal GPIO functions.
	3	*
	4	* Copyright (C) 2013, Intel Corporation
	5	* Author: Mika Westerberg <mika.westerberg@linux.intel.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11
	12	#ifndef GPIOLIB_H
	13	#define GPIOLIB_H
	14
ff2b1359	15	#include <linux/gpio/driver.h>
5ccff852 MW	16	#include <linux/err.h>
5ccff852 MW	17	#include <linux/device.h>
ff2b1359 LW	18	#include <linux/module.h>
ff2b1359 LW	19	#include <linux/cdev.h>
5ccff852	20
f01d9075	21	enum of_gpio_flags;
29ab875b	22	enum gpiod_flags;
ce793486 RW	23	struct acpi_device;
ce793486 RW	24
ff2b1359 LW	25	/**
	26	* struct gpio_device - internal state container for GPIO devices
	27	* @id: numerical ID number for the GPIO chip
	28	* @dev: the GPIO device struct
3c702e99	29	* @chrdev: character device for the GPIO device
afbc4f31 LW	30	* @mockdev: class device used by the deprecated sysfs interface (may be
afbc4f31 LW	31	* NULL)
ff2b1359 LW	32	* @owner: helps prevent removal of modules exporting active GPIOs
	33	* @chip: pointer to the corresponding gpiochip, holding static
	34	* data for this device
1c3cdb18	35	* @descs: array of ngpio descriptors.
fdeb8e15 LW	36	* @ngpio: the number of GPIO lines on this GPIO device, equal to the size
	37	* of the @descs array.
	38	* @base: GPIO base in the DEPRECATED global Linux GPIO numberspace, assigned
	39	* at device creation time.
43c54eca	40	* @data: per-instance data assigned by the driver
ff2b1359 LW	41	* @list: links gpio_device:s together for traversal
	42	*
	43	* This state container holds most of the runtime variable data
	44	* for a GPIO device and can hold references and live on after the
	45	* GPIO chip has been removed, if it is still being used from
	46	* userspace.
	47	*/
	48	struct gpio_device {
	49	int id;
	50	struct device dev;
3c702e99	51	struct cdev chrdev;
afbc4f31	52	struct device *mockdev;
ff2b1359 LW	53	struct module *owner;
ff2b1359 LW	54	struct gpio_chip *chip;
1c3cdb18	55	struct gpio_desc *descs;
fdeb8e15 LW	56	int base;
fdeb8e15 LW	57	u16 ngpio;
43c54eca	58	void *data;
ff2b1359	59	struct list_head list;
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
5ccff852 MW	72	/**
	73	* struct acpi_gpio_info - ACPI GPIO specific information
	74	* @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
	75	* @active_low: in case of @gpioint, the pin is active low
	76	*/
	77	struct acpi_gpio_info {
	78	bool gpioint;
52044723 CR	79	int polarity;
52044723 CR	80	int triggering;
5ccff852 MW	81	};
5ccff852 MW	82
7f2e553a RI	83	/* gpio suffixes used for ACPI and device tree lookup */
	84	static const char * const gpio_suffixes[] = { "gpios", "gpio" };
	85
664e3e5a MW	86	#ifdef CONFIG_ACPI
	87	void acpi_gpiochip_add(struct gpio_chip *chip);
	88	void acpi_gpiochip_remove(struct gpio_chip *chip);
5ccff852	89
afa82fab MW	90	void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
	91	void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
	92
0d9a693c MW	93	struct gpio_desc acpi_get_gpiod_by_index(struct acpi_device adev,
0d9a693c MW	94	const char *propname, int index,
5ccff852	95	struct acpi_gpio_info *info);
504a3374 RW	96	struct gpio_desc acpi_node_get_gpiod(struct fwnode_handle fwnode,
	97	const char *propname, int index,
	98	struct acpi_gpio_info *info);
66858527 RI	99
66858527 RI	100	int acpi_gpio_count(struct device dev, const char con_id);
10cf4899 DT	101
10cf4899 DT	102	bool acpi_can_fallback_to_crs(struct acpi_device adev, const char con_id);
664e3e5a MW	103	#else
	104	static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
	105	static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
5ccff852	106
afa82fab MW	107	static inline void
	108	acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
	109
	110	static inline void
	111	acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
	112
5ccff852	113	static inline struct gpio_desc *
0d9a693c MW	114	acpi_get_gpiod_by_index(struct acpi_device adev, const char propname,
0d9a693c MW	115	int index, struct acpi_gpio_info *info)
5ccff852 MW	116	{
	117	return ERR_PTR(-ENOSYS);
	118	}
504a3374 RW	119	static inline struct gpio_desc *
	120	acpi_node_get_gpiod(struct fwnode_handle fwnode, const char propname,
	121	int index, struct acpi_gpio_info *info)
	122	{
	123	return ERR_PTR(-ENXIO);
	124	}
66858527 RI	125	static inline int acpi_gpio_count(struct device dev, const char con_id)
	126	{
	127	return -ENODEV;
	128	}
10cf4899 DT	129
	130	static inline bool acpi_can_fallback_to_crs(struct acpi_device *adev,
	131	const char *con_id)
	132	{
	133	return false;
	134	}
664e3e5a MW	135	#endif
664e3e5a MW	136
f01d9075 AC	137	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
	138	const char list_name, int index, enum of_gpio_flags flags);
	139
1bd6b601 AC	140	struct gpio_desc gpiochip_get_desc(struct gpio_chip chip, u16 hwnum);
1bd6b601 AC	141
0eb4c6c2	142	extern struct spinlock gpio_lock;
ff2b1359	143	extern struct list_head gpio_devices;
0eb4c6c2 AC	144
0eb4c6c2 AC	145	struct gpio_desc {
fdeb8e15	146	struct gpio_device *gdev;
0eb4c6c2 AC	147	unsigned long flags;
	148	/* flag symbols are bit numbers */
	149	#define FLAG_REQUESTED 0
	150	#define FLAG_IS_OUT 1
	151	#define FLAG_EXPORT 2 /* protected by sysfs_lock */
	152	#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
0eb4c6c2 AC	153	#define FLAG_ACTIVE_LOW 6 /* value has active low */
	154	#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
	155	#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
	156	#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
f625d460	157	#define FLAG_IS_HOGGED 11 /* GPIO is hogged */
0eb4c6c2	158
c0017ed7	159	/* Connection label */
0eb4c6c2	160	const char *label;
c0017ed7 MP	161	/* Name of the GPIO */
c0017ed7 MP	162	const char *name;
0eb4c6c2 AC	163	};
	164
	165	int gpiod_request(struct gpio_desc desc, const char label);
	166	void gpiod_free(struct gpio_desc *desc);
f625d460 BP	167	int gpiod_hog(struct gpio_desc desc, const char name,
f625d460 BP	168	unsigned long lflags, enum gpiod_flags dflags);
0eb4c6c2 AC	169
	170	/*
	171	* Return the GPIO number of the passed descriptor relative to its chip
	172	*/
	173	static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
	174	{
fdeb8e15	175	return desc - &desc->gdev->descs[0];
0eb4c6c2 AC	176	}
	177
	178	/* With descriptor prefix */
	179
	180	#define gpiod_emerg(desc, fmt, ...) \
	181	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	182	##__VA_ARGS__)
	183	#define gpiod_crit(desc, fmt, ...) \
	184	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	185	##__VA_ARGS__)
	186	#define gpiod_err(desc, fmt, ...) \
	187	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	188	##__VA_ARGS__)
	189	#define gpiod_warn(desc, fmt, ...) \
	190	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	191	##__VA_ARGS__)
	192	#define gpiod_info(desc, fmt, ...) \
	193	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	194	##__VA_ARGS__)
	195	#define gpiod_dbg(desc, fmt, ...) \
	196	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	197	##__VA_ARGS__)
	198
	199	/* With chip prefix */
	200
	201	#define chip_emerg(chip, fmt, ...) \
34ffd85d	202	dev_emerg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2	203	#define chip_crit(chip, fmt, ...) \
34ffd85d	204	dev_crit(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2	205	#define chip_err(chip, fmt, ...) \
34ffd85d	206	dev_err(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2	207	#define chip_warn(chip, fmt, ...) \
34ffd85d	208	dev_warn(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2	209	#define chip_info(chip, fmt, ...) \
34ffd85d	210	dev_info(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2	211	#define chip_dbg(chip, fmt, ...) \
34ffd85d	212	dev_dbg(&chip->gpiodev->dev, "(%s): " fmt, chip->label, ##__VA_ARGS__)
0eb4c6c2 AC	213
	214	#ifdef CONFIG_GPIO_SYSFS
	215
afbc4f31 LW	216	int gpiochip_sysfs_register(struct gpio_device *gdev);
afbc4f31 LW	217	void gpiochip_sysfs_unregister(struct gpio_device *gdev);
0eb4c6c2 AC	218
	219	#else
	220
afbc4f31	221	static inline int gpiochip_sysfs_register(struct gpio_device *gdev)
0eb4c6c2 AC	222	{
	223	return 0;
	224	}
	225
afbc4f31	226	static inline void gpiochip_sysfs_unregister(struct gpio_device *gdev)
0eb4c6c2 AC	227	{
	228	}
	229
	230	#endif /* CONFIG_GPIO_SYSFS */
	231
664e3e5a	232	#endif /* GPIOLIB_H */