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

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

struct gpio_desc *acpi_get_gpiod_by_index(struct device *dev, 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 struct gpio_desc *
acpi_get_gpiod_by_index(struct device *dev, 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 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);

/*
 * 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
664e3e5a MW	30	#ifdef CONFIG_ACPI
	31	void acpi_gpiochip_add(struct gpio_chip *chip);
	32	void acpi_gpiochip_remove(struct gpio_chip *chip);
5ccff852 MW	33
	34	struct gpio_desc acpi_get_gpiod_by_index(struct device dev, int index,
	35	struct acpi_gpio_info *info);
664e3e5a MW	36	#else
	37	static inline void acpi_gpiochip_add(struct gpio_chip *chip) { }
	38	static inline void acpi_gpiochip_remove(struct gpio_chip *chip) { }
5ccff852 MW	39
	40	static inline struct gpio_desc *
	41	acpi_get_gpiod_by_index(struct device *dev, int index,
	42	struct acpi_gpio_info *info)
	43	{
	44	return ERR_PTR(-ENOSYS);
	45	}
664e3e5a MW	46	#endif
664e3e5a MW	47
f01d9075 AC	48	struct gpio_desc of_get_named_gpiod_flags(struct device_node np,
	49	const char list_name, int index, enum of_gpio_flags flags);
	50
1bd6b601 AC	51	struct gpio_desc gpiochip_get_desc(struct gpio_chip chip, u16 hwnum);
1bd6b601 AC	52
0eb4c6c2 AC	53	extern struct spinlock gpio_lock;
	54	extern struct list_head gpio_chips;
	55
	56	struct gpio_desc {
	57	struct gpio_chip *chip;
	58	unsigned long flags;
	59	/* flag symbols are bit numbers */
	60	#define FLAG_REQUESTED 0
	61	#define FLAG_IS_OUT 1
	62	#define FLAG_EXPORT 2 /* protected by sysfs_lock */
	63	#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
	64	#define FLAG_TRIG_FALL 4 /* trigger on falling edge */
	65	#define FLAG_TRIG_RISE 5 /* trigger on rising edge */
	66	#define FLAG_ACTIVE_LOW 6 /* value has active low */
	67	#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
	68	#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
	69	#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
	70
	71	#define ID_SHIFT 16 /* add new flags before this one */
	72
	73	#define GPIO_FLAGS_MASK ((1 << ID_SHIFT) - 1)
	74	#define GPIO_TRIGGER_MASK (BIT(FLAG_TRIG_FALL) \| BIT(FLAG_TRIG_RISE))
	75
	76	const char *label;
	77	};
	78
	79	int gpiod_request(struct gpio_desc desc, const char label);
	80	void gpiod_free(struct gpio_desc *desc);
	81
	82	/*
	83	* Return the GPIO number of the passed descriptor relative to its chip
	84	*/
	85	static int __maybe_unused gpio_chip_hwgpio(const struct gpio_desc *desc)
	86	{
	87	return desc - &desc->chip->desc[0];
	88	}
	89
	90	/* With descriptor prefix */
	91
	92	#define gpiod_emerg(desc, fmt, ...) \
	93	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	94	##__VA_ARGS__)
	95	#define gpiod_crit(desc, fmt, ...) \
	96	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	97	##__VA_ARGS__)
	98	#define gpiod_err(desc, fmt, ...) \
	99	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	100	##__VA_ARGS__)
	101	#define gpiod_warn(desc, fmt, ...) \
	102	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	103	##__VA_ARGS__)
	104	#define gpiod_info(desc, fmt, ...) \
	105	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
	106	##__VA_ARGS__)
	107	#define gpiod_dbg(desc, fmt, ...) \
	108	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
	109	##__VA_ARGS__)
	110
	111	/* With chip prefix */
	112
	113	#define chip_emerg(chip, fmt, ...) \
	114	pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
	115	#define chip_crit(chip, fmt, ...) \
	116	pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
117	#define chip_err(chip, fmt, ...) \
118	pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
119	#define chip_warn(chip, fmt, ...) \
120	pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
121	#define chip_info(chip, fmt, ...) \
122	pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
123	#define chip_dbg(chip, fmt, ...) \
124	pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
125
126	#ifdef CONFIG_GPIO_SYSFS
127
128	int gpiochip_export(struct gpio_chip *chip);
129	void gpiochip_unexport(struct gpio_chip *chip);
130
131	#else
132
133	static inline int gpiochip_export(struct gpio_chip *chip)
134	{
135	return 0;
136	}
137
138	static inline void gpiochip_unexport(struct gpio_chip *chip)
139	{
140	}
141
142	#endif /* CONFIG_GPIO_SYSFS */
143
664e3e5a	144	#endif /* GPIOLIB_H */