[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/err.h>
#include <linux/device.h>

enum of_gpio_flags;

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

/* 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);
#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);
}
#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_chips;

struct gpio_desc {
	struct gpio_chip	*chip;
	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_TRIG_FALL	4	/* trigger on falling edge */
#define FLAG_TRIG_RISE	5	/* trigger on rising edge */
#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_SYSFS_DIR	10	/* show sysfs direction attribute */
#define FLAG_IS_HOGGED	11	/* GPIO is hogged */

#define ID_SHIFT	16	/* add new flags before this one */

#define GPIO_FLAGS_MASK		((1 << ID_SHIFT) - 1)
#define GPIO_TRIGGER_MASK	(BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))

	const char		*label;
};

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->chip->desc[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, ...)					\
	pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_crit(chip, fmt, ...)					\
	pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_err(chip, fmt, ...)					\
	pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_warn(chip, fmt, ...)					\
	pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_info(chip, fmt, ...)					\
	pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_dbg(chip, fmt, ...)					\
	pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)

#ifdef CONFIG_GPIO_SYSFS

int gpiochip_export(struct gpio_chip *chip);
void gpiochip_unexport(struct gpio_chip *chip);

#else

static inline int gpiochip_export(struct gpio_chip *chip)
{
	return 0;
}

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

#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
5ccff852 MW	15	#include <linux/err.h>
	16	#include <linux/device.h>
	17
f01d9075 AC	18	enum of_gpio_flags;
f01d9075 AC	19
5ccff852 MW	20	/**
	21	* struct acpi_gpio_info - ACPI GPIO specific information
	22	* @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
	23	* @active_low: in case of @gpioint, the pin is active low
	24	*/
	25	struct acpi_gpio_info {
	26	bool gpioint;
	27	bool active_low;
	28	};
	29
7f2e553a RI	30	/* gpio suffixes used for ACPI and device tree lookup */
	31	static const char * const gpio_suffixes[] = { "gpios", "gpio" };
	32
664e3e5a MW	33	#ifdef CONFIG_ACPI
	34	void acpi_gpiochip_add(struct gpio_chip *chip);
	35	void acpi_gpiochip_remove(struct gpio_chip *chip);
5ccff852	36
afa82fab MW	37	void acpi_gpiochip_request_interrupts(struct gpio_chip *chip);
	38	void acpi_gpiochip_free_interrupts(struct gpio_chip *chip);
	39
0d9a693c MW	40	struct gpio_desc acpi_get_gpiod_by_index(struct acpi_device adev,
0d9a693c MW	41	const char *propname, int index,
5ccff852	42	struct acpi_gpio_info *info);
664e3e5a MW	43	#else
	44	static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
	45	static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
5ccff852	46
afa82fab MW	47	static inline void
	48	acpi_gpiochip_request_interrupts(struct gpio_chip *chip) { }
	49
	50	static inline void
	51	acpi_gpiochip_free_interrupts(struct gpio_chip *chip) { }
	52
5ccff852	53	static inline struct gpio_desc *
0d9a693c MW	54	acpi_get_gpiod_by_index(struct acpi_device adev, const char propname,
0d9a693c MW	55	int index, struct acpi_gpio_info *info)
5ccff852 MW	56	{
	57	return ERR_PTR(-ENOSYS);
	58	}
664e3e5a MW	59	#endif
664e3e5a MW	60
f01d9075 AC	61	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
	62	const char list_name, int index, enum of_gpio_flags flags);
	63
1bd6b601 AC	64	struct gpio_desc gpiochip_get_desc(struct gpio_chip chip, u16 hwnum);
1bd6b601 AC	65
0eb4c6c2 AC	66	extern struct spinlock gpio_lock;
	67	extern struct list_head gpio_chips;
	68
	69	struct gpio_desc {
	70	struct gpio_chip *chip;
	71	unsigned long flags;
	72	/* flag symbols are bit numbers */
	73	#define FLAG_REQUESTED 0
	74	#define FLAG_IS_OUT 1
	75	#define FLAG_EXPORT 2 /* protected by sysfs_lock */
	76	#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
	77	#define FLAG_TRIG_FALL 4 /* trigger on falling edge */
	78	#define FLAG_TRIG_RISE 5 /* trigger on rising edge */
	79	#define FLAG_ACTIVE_LOW 6 /* value has active low */
	80	#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
	81	#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
	82	#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
ebbeba12	83	#define FLAG_SYSFS_DIR 10 /* show sysfs direction attribute */
f625d460	84	#define FLAG_IS_HOGGED 11 /* GPIO is hogged */
0eb4c6c2 AC	85
	86	#define ID_SHIFT 16 /* add new flags before this one */
	87
	88	#define GPIO_FLAGS_MASK ((1 << ID_SHIFT) - 1)
	89	#define GPIO_TRIGGER_MASK (BIT(FLAG_TRIG_FALL) \| BIT(FLAG_TRIG_RISE))
	90
	91	const char *label;
	92	};
	93
	94	int gpiod_request(struct gpio_desc desc, const char label);
	95	void gpiod_free(struct gpio_desc *desc);
f625d460 BP	96	int gpiod_hog(struct gpio_desc desc, const char name,
f625d460 BP	97	unsigned long lflags, enum gpiod_flags dflags);
0eb4c6c2 AC	98
	99	/*
	100	* Return the GPIO number of the passed descriptor relative to its chip
	101	*/
	102	static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
	103	{
	104	return desc - &desc->chip->desc[0];
	105	}
	106
	107	/* With descriptor prefix */
	108
	109	#define gpiod_emerg(desc, fmt, ...) \
	110	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	111	##__VA_ARGS__)
	112	#define gpiod_crit(desc, fmt, ...) \
	113	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	114	##__VA_ARGS__)
	115	#define gpiod_err(desc, fmt, ...) \
	116	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	117	##__VA_ARGS__)
	118	#define gpiod_warn(desc, fmt, ...) \
	119	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	120	##__VA_ARGS__)
	121	#define gpiod_info(desc, fmt, ...) \
	122	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	123	##__VA_ARGS__)
	124	#define gpiod_dbg(desc, fmt, ...) \
	125	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	126	##__VA_ARGS__)
	127
	128	/* With chip prefix */
	129
	130	#define chip_emerg(chip, fmt, ...) \
	131	pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	132	#define chip_crit(chip, fmt, ...) \
	133	pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	134	#define chip_err(chip, fmt, ...) \
	135	pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	136	#define chip_warn(chip, fmt, ...) \
	137	pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	138	#define chip_info(chip, fmt, ...) \
	139	pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	140	#define chip_dbg(chip, fmt, ...) \
	141	pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	142
	143	#ifdef CONFIG_GPIO_SYSFS
	144
	145	int gpiochip_export(struct gpio_chip *chip);
	146	void gpiochip_unexport(struct gpio_chip *chip);
	147
	148	#else
	149
	150	static inline int gpiochip_export(struct gpio_chip *chip)
	151	{
	152	return 0;
	153	}
	154
	155	static inline void gpiochip_unexport(struct gpio_chip *chip)
	156	{
	157	}
	158
	159	#endif /* CONFIG_GPIO_SYSFS */
	160
664e3e5a	161	#endif /* GPIOLIB_H */