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

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

int acpi_gpio_count(struct device *dev, 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 int acpi_gpio_count(struct device *dev, const char *con_id)
{
	return -ENODEV;
}
#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_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 */

	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_sysfs_register(struct gpio_chip *chip);
void gpiochip_sysfs_unregister(struct gpio_chip *chip);

#else

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

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