2008-04-11 07:06:45 -06:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
|
2008-11-30 23:30:04 -07:00
|
|
|
#include <linux/compiler.h>
|
|
|
|
#include <linux/kernel.h>
|
2008-04-11 07:06:45 -06:00
|
|
|
#include <linux/errno.h>
|
2008-05-30 06:51:33 -06:00
|
|
|
#include <linux/gpio.h>
|
2011-12-12 09:25:57 -07:00
|
|
|
#include <linux/of.h>
|
2013-10-29 03:10:13 -06:00
|
|
|
#include <linux/gpio/consumer.h>
|
2008-04-11 07:06:45 -06:00
|
|
|
|
2008-11-30 23:30:04 -07:00
|
|
|
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,
|
|
|
|
};
|
|
|
|
|
2008-04-11 07:06:45 -06:00
|
|
|
#ifdef CONFIG_OF_GPIO
|
|
|
|
|
|
|
|
/*
|
|
|
|
* OF GPIO chip for memory mapped banks
|
|
|
|
*/
|
|
|
|
struct of_mm_gpio_chip {
|
2010-06-08 07:48:16 -06:00
|
|
|
struct gpio_chip gc;
|
2008-04-11 07:06:45 -06:00
|
|
|
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)
|
|
|
|
{
|
2010-06-08 07:48:16 -06:00
|
|
|
return container_of(gc, struct of_mm_gpio_chip, gc);
|
2008-04-11 07:06:45 -06:00
|
|
|
}
|
|
|
|
|
2013-10-17 11:21:37 -06:00
|
|
|
extern struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
|
2011-06-27 17:49:57 -06:00
|
|
|
const char *list_name, int index, enum of_gpio_flags *flags);
|
|
|
|
|
2008-04-11 07:06:45 -06:00
|
|
|
extern int of_mm_gpiochip_add(struct device_node *np,
|
|
|
|
struct of_mm_gpio_chip *mm_gc);
|
2010-06-08 07:48:16 -06:00
|
|
|
|
2010-06-08 07:48:17 -06:00
|
|
|
extern void of_gpiochip_add(struct gpio_chip *gc);
|
|
|
|
extern void of_gpiochip_remove(struct gpio_chip *gc);
|
2011-12-12 09:25:57 -07:00
|
|
|
extern int of_gpio_simple_xlate(struct gpio_chip *gc,
|
|
|
|
const struct of_phandle_args *gpiospec,
|
|
|
|
u32 *flags);
|
2010-06-08 07:48:16 -06:00
|
|
|
|
2010-06-08 07:48:16 -06:00
|
|
|
#else /* CONFIG_OF_GPIO */
|
2008-04-11 07:06:45 -06:00
|
|
|
|
|
|
|
/* Drivers may not strictly depend on the GPIO support, so let them link. */
|
2013-10-17 11:21:37 -06:00
|
|
|
static inline struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
|
2011-06-27 17:49:57 -06:00
|
|
|
const char *list_name, int index, enum of_gpio_flags *flags)
|
2008-04-11 07:06:45 -06:00
|
|
|
{
|
2013-10-17 11:21:37 -06:00
|
|
|
return ERR_PTR(-ENOSYS);
|
2008-04-11 07:06:45 -06:00
|
|
|
}
|
|
|
|
|
2011-07-28 09:25:41 -06:00
|
|
|
static inline int of_gpio_simple_xlate(struct gpio_chip *gc,
|
2011-12-12 09:25:57 -07:00
|
|
|
const struct of_phandle_args *gpiospec,
|
|
|
|
u32 *flags)
|
2011-07-28 09:25:41 -06:00
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
|
|
|
|
2010-06-08 07:48:17 -06:00
|
|
|
static inline void of_gpiochip_add(struct gpio_chip *gc) { }
|
|
|
|
static inline void of_gpiochip_remove(struct gpio_chip *gc) { }
|
|
|
|
|
2008-04-11 07:06:45 -06:00
|
|
|
#endif /* CONFIG_OF_GPIO */
|
|
|
|
|
2013-10-17 11:21:37 -06:00
|
|
|
static inline int of_get_named_gpio_flags(struct device_node *np,
|
|
|
|
const char *list_name, int index, enum of_gpio_flags *flags)
|
|
|
|
{
|
|
|
|
struct gpio_desc *desc;
|
|
|
|
desc = of_get_named_gpiod_flags(np, list_name, index, flags);
|
|
|
|
|
|
|
|
if (IS_ERR(desc))
|
|
|
|
return PTR_ERR(desc);
|
|
|
|
else
|
|
|
|
return desc_to_gpio(desc);
|
|
|
|
}
|
|
|
|
|
2012-02-02 08:20:01 -07:00
|
|
|
/**
|
2013-02-12 10:48:37 -07:00
|
|
|
* of_gpio_named_count() - Count GPIOs for a device
|
2012-02-02 08:20:01 -07:00
|
|
|
* @np: device node to count GPIOs for
|
2013-02-12 10:48:37 -07:00
|
|
|
* @propname: property name containing gpio specifier(s)
|
2012-02-02 08:20:01 -07:00
|
|
|
*
|
|
|
|
* The function returns the count of GPIOs specified for a node.
|
2013-02-12 10:48:37 -07:00
|
|
|
* Note that the empty GPIO specifiers count too. Returns either
|
|
|
|
* Number of gpios defined in property,
|
|
|
|
* -EINVAL for an incorrectly formed gpios property, or
|
|
|
|
* -ENOENT for a missing gpios property
|
2012-02-02 08:20:01 -07:00
|
|
|
*
|
2013-02-12 10:48:37 -07:00
|
|
|
* Example:
|
2012-02-02 08:20:01 -07:00
|
|
|
* gpios = <0
|
2013-02-12 10:48:37 -07:00
|
|
|
* &gpio1 1 2
|
2012-02-02 08:20:01 -07:00
|
|
|
* 0
|
2013-02-12 10:48:37 -07:00
|
|
|
* &gpio2 3 4>;
|
|
|
|
*
|
|
|
|
* The above example defines four GPIOs, two of which are not specified.
|
|
|
|
* This function will return '4'
|
|
|
|
*/
|
|
|
|
static inline int of_gpio_named_count(struct device_node *np, const char* propname)
|
|
|
|
{
|
|
|
|
return of_count_phandle_with_args(np, propname, "#gpio-cells");
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* of_gpio_count() - Count GPIOs for a device
|
|
|
|
* @np: device node to count GPIOs for
|
2012-02-02 08:20:01 -07:00
|
|
|
*
|
2013-02-12 10:48:37 -07:00
|
|
|
* Same as of_gpio_named_count, but hard coded to use the 'gpios' property
|
2012-02-02 08:20:01 -07:00
|
|
|
*/
|
2013-02-12 10:48:37 -07:00
|
|
|
static inline int of_gpio_count(struct device_node *np)
|
2012-02-02 08:20:01 -07:00
|
|
|
{
|
|
|
|
return of_gpio_named_count(np, "gpios");
|
|
|
|
}
|
|
|
|
|
2008-11-30 23:30:04 -07:00
|
|
|
/**
|
2013-10-17 11:21:37 -06:00
|
|
|
* of_get_gpiod_flags() - Get a GPIO descriptor and flags to use with GPIO API
|
2011-06-27 17:49:57 -06:00
|
|
|
* @np: device node to get GPIO from
|
|
|
|
* @index: index of the GPIO
|
|
|
|
* @flags: a flags pointer to fill in
|
|
|
|
*
|
2013-10-17 11:21:37 -06:00
|
|
|
* Returns GPIO descriptor to use with Linux generic GPIO API, or a errno
|
2011-06-27 17:49:57 -06:00
|
|
|
* value on the error condition. If @flags is not NULL the function also fills
|
|
|
|
* in flags for the GPIO.
|
|
|
|
*/
|
2013-10-17 11:21:37 -06:00
|
|
|
static inline struct gpio_desc *of_get_gpiod_flags(struct device_node *np,
|
|
|
|
int index, enum of_gpio_flags *flags)
|
|
|
|
{
|
|
|
|
return of_get_named_gpiod_flags(np, "gpios", index, flags);
|
|
|
|
}
|
|
|
|
|
2011-06-27 17:49:57 -06:00
|
|
|
static inline int of_get_gpio_flags(struct device_node *np, int index,
|
|
|
|
enum of_gpio_flags *flags)
|
|
|
|
{
|
|
|
|
return of_get_named_gpio_flags(np, "gpios", index, flags);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* of_get_named_gpio() - Get a GPIO number to use with GPIO API
|
|
|
|
* @np: device node to get GPIO from
|
|
|
|
* @propname: Name of property containing gpio specifier(s)
|
|
|
|
* @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_named_gpio(struct device_node *np,
|
|
|
|
const char *propname, int index)
|
|
|
|
{
|
|
|
|
return of_get_named_gpio_flags(np, propname, index, NULL);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* of_get_gpio() - Get a GPIO number to use with GPIO API
|
2008-11-30 23:30:04 -07:00
|
|
|
* @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);
|
|
|
|
}
|
|
|
|
|
2008-04-11 07:06:45 -06:00
|
|
|
#endif /* __LINUX_OF_GPIO_H */
|