[linux-2.6-block.git] / include / linux / of_gpio.h

/*
 * OF helpers for the GPIO API
 *
 * Copyright (c) 2007-2008  MontaVista Software, Inc.
 *
 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef __LINUX_OF_GPIO_H
#define __LINUX_OF_GPIO_H

#include <linux/compiler.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/gpio.h>

struct device_node;

/*
 * This is Linux-specific flags. By default controllers' and Linux' mapping
 * match, but GPIO controllers are free to translate their own flags to
 * Linux-specific in their .xlate callback. Though, 1:1 mapping is recommended.
 */
enum of_gpio_flags {
	OF_GPIO_ACTIVE_LOW = 0x1,
};

#ifdef CONFIG_OF_GPIO

/*
 * Generic OF GPIO chip
 */
struct of_gpio_chip {
	struct gpio_chip gc;
	int gpio_cells;
	int (*xlate)(struct of_gpio_chip *of_gc, struct device_node *np,
		     const void *gpio_spec, enum of_gpio_flags *flags);
};

static inline struct of_gpio_chip *to_of_gpio_chip(struct gpio_chip *gc)
{
	return container_of(gc, struct of_gpio_chip, gc);
}

/*
 * OF GPIO chip for memory mapped banks
 */
struct of_mm_gpio_chip {
	struct of_gpio_chip of_gc;
	void (*save_regs)(struct of_mm_gpio_chip *mm_gc);
	void __iomem *regs;
};

static inline struct of_mm_gpio_chip *to_of_mm_gpio_chip(struct gpio_chip *gc)
{
	struct of_gpio_chip *of_gc = to_of_gpio_chip(gc);

	return container_of(of_gc, struct of_mm_gpio_chip, of_gc);
}

extern int of_get_gpio_flags(struct device_node *np, int index,
			     enum of_gpio_flags *flags);
extern unsigned int of_gpio_count(struct device_node *np);

extern int of_mm_gpiochip_add(struct device_node *np,
			      struct of_mm_gpio_chip *mm_gc);
extern int of_gpio_simple_xlate(struct of_gpio_chip *of_gc,
				struct device_node *np,
				const void *gpio_spec,
				enum of_gpio_flags *flags);
#else

/* Drivers may not strictly depend on the GPIO support, so let them link. */
static inline int of_get_gpio_flags(struct device_node *np, int index,
				    enum of_gpio_flags *flags)
{
	return -ENOSYS;
}

static inline unsigned int of_gpio_count(struct device_node *np)
{
	return 0;
}

#endif /* CONFIG_OF_GPIO */

/**
 * of_get_gpio - Get a GPIO number to use with GPIO API
 * @np:		device node to get GPIO from
 * @index:	index of the GPIO
 *
 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
 * value on the error condition.
 */
static inline int of_get_gpio(struct device_node *np, int index)
{
	return of_get_gpio_flags(np, index, NULL);
}

#endif /* __LINUX_OF_GPIO_H */
Commit	Line	Data
863fbf49 AV	1	/*
	2	* OF helpers for the GPIO API
	3	*
	4	* Copyright (c) 2007-2008 MontaVista Software, Inc.
	5	*
	6	* Author: Anton Vorontsov <avorontsov@ru.mvista.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*/
	13
	14	#ifndef __LINUX_OF_GPIO_H
	15	#define __LINUX_OF_GPIO_H
	16
b908b53d AV	17	#include <linux/compiler.h>
b908b53d AV	18	#include <linux/kernel.h>
863fbf49	19	#include <linux/errno.h>
18ad7a61	20	#include <linux/gpio.h>
863fbf49	21
b908b53d AV	22	struct device_node;
	23
	24	/*
	25	* This is Linux-specific flags. By default controllers' and Linux' mapping
	26	* match, but GPIO controllers are free to translate their own flags to
	27	* Linux-specific in their .xlate callback. Though, 1:1 mapping is recommended.
	28	*/
	29	enum of_gpio_flags {
	30	OF_GPIO_ACTIVE_LOW = 0x1,
	31	};
	32
863fbf49 AV	33	#ifdef CONFIG_OF_GPIO
	34
	35	/*
	36	* Generic OF GPIO chip
	37	*/
	38	struct of_gpio_chip {
	39	struct gpio_chip gc;
	40	int gpio_cells;
	41	int (xlate)(struct of_gpio_chip of_gc, struct device_node *np,
b908b53d	42	const void gpio_spec, enum of_gpio_flags flags);
863fbf49 AV	43	};
	44
	45	static inline struct of_gpio_chip to_of_gpio_chip(struct gpio_chip gc)
	46	{
	47	return container_of(gc, struct of_gpio_chip, gc);
	48	}
	49
	50	/*
	51	* OF GPIO chip for memory mapped banks
	52	*/
	53	struct of_mm_gpio_chip {
	54	struct of_gpio_chip of_gc;
	55	void (save_regs)(struct of_mm_gpio_chip mm_gc);
	56	void __iomem *regs;
	57	};
	58
	59	static inline struct of_mm_gpio_chip to_of_mm_gpio_chip(struct gpio_chip gc)
	60	{
	61	struct of_gpio_chip *of_gc = to_of_gpio_chip(gc);
	62
	63	return container_of(of_gc, struct of_mm_gpio_chip, of_gc);
	64	}
	65
b908b53d AV	66	extern int of_get_gpio_flags(struct device_node *np, int index,
b908b53d AV	67	enum of_gpio_flags *flags);
74982092	68	extern unsigned int of_gpio_count(struct device_node *np);
b908b53d	69
863fbf49 AV	70	extern int of_mm_gpiochip_add(struct device_node *np,
	71	struct of_mm_gpio_chip *mm_gc);
	72	extern int of_gpio_simple_xlate(struct of_gpio_chip *of_gc,
	73	struct device_node *np,
b908b53d AV	74	const void *gpio_spec,
b908b53d AV	75	enum of_gpio_flags *flags);
863fbf49 AV	76	#else
	77
	78	/* Drivers may not strictly depend on the GPIO support, so let them link. */
b908b53d AV	79	static inline int of_get_gpio_flags(struct device_node *np, int index,
b908b53d AV	80	enum of_gpio_flags *flags)
863fbf49 AV	81	{
	82	return -ENOSYS;
	83	}
	84
74982092 AV	85	static inline unsigned int of_gpio_count(struct device_node *np)
	86	{
	87	return 0;
	88	}
	89
863fbf49 AV	90	#endif /* CONFIG_OF_GPIO */
863fbf49 AV	91
b908b53d AV	92	/**
	93	* of_get_gpio - Get a GPIO number to use with GPIO API
	94	* @np: device node to get GPIO from
	95	* @index: index of the GPIO
	96	*
	97	* Returns GPIO number to use with Linux generic GPIO API, or one of the errno
	98	* value on the error condition.
	99	*/
	100	static inline int of_get_gpio(struct device_node *np, int index)
	101	{
	102	return of_get_gpio_flags(np, index, NULL);
	103	}
	104
863fbf49	105	#endif /* __LINUX_OF_GPIO_H */