]>
git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/of_gpio.h
2 * OF helpers for the GPIO API
4 * Copyright (c) 2007-2008 MontaVista Software, Inc.
6 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
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.
14 #ifndef __LINUX_OF_GPIO_H
15 #define __LINUX_OF_GPIO_H
17 #include <linux/compiler.h>
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/gpio.h>
26 * This is Linux-specific flags. By default controllers' and Linux' mapping
27 * match, but GPIO controllers are free to translate their own flags to
28 * Linux-specific in their .xlate callback. Though, 1:1 mapping is recommended.
31 OF_GPIO_ACTIVE_LOW
= 0x1,
32 OF_GPIO_SINGLE_ENDED
= 0x2,
33 OF_GPIO_OPEN_DRAIN
= 0x4,
39 * OF GPIO chip for memory mapped banks
41 struct of_mm_gpio_chip
{
43 void (*save_regs
)(struct of_mm_gpio_chip
*mm_gc
);
47 static inline struct of_mm_gpio_chip
*to_of_mm_gpio_chip(struct gpio_chip
*gc
)
49 return container_of(gc
, struct of_mm_gpio_chip
, gc
);
52 extern int of_get_named_gpio_flags(struct device_node
*np
,
53 const char *list_name
, int index
, enum of_gpio_flags
*flags
);
55 extern int of_mm_gpiochip_add_data(struct device_node
*np
,
56 struct of_mm_gpio_chip
*mm_gc
,
58 static inline int of_mm_gpiochip_add(struct device_node
*np
,
59 struct of_mm_gpio_chip
*mm_gc
)
61 return of_mm_gpiochip_add_data(np
, mm_gc
, NULL
);
63 extern void of_mm_gpiochip_remove(struct of_mm_gpio_chip
*mm_gc
);
65 extern int of_gpio_simple_xlate(struct gpio_chip
*gc
,
66 const struct of_phandle_args
*gpiospec
,
69 #else /* CONFIG_OF_GPIO */
71 /* Drivers may not strictly depend on the GPIO support, so let them link. */
72 static inline int of_get_named_gpio_flags(struct device_node
*np
,
73 const char *list_name
, int index
, enum of_gpio_flags
*flags
)
81 static inline int of_gpio_simple_xlate(struct gpio_chip
*gc
,
82 const struct of_phandle_args
*gpiospec
,
88 #endif /* CONFIG_OF_GPIO */
91 * of_gpio_named_count() - Count GPIOs for a device
92 * @np: device node to count GPIOs for
93 * @propname: property name containing gpio specifier(s)
95 * The function returns the count of GPIOs specified for a node.
96 * Note that the empty GPIO specifiers count too. Returns either
97 * Number of gpios defined in property,
98 * -EINVAL for an incorrectly formed gpios property, or
99 * -ENOENT for a missing gpios property
107 * The above example defines four GPIOs, two of which are not specified.
108 * This function will return '4'
110 static inline int of_gpio_named_count(struct device_node
*np
, const char* propname
)
112 return of_count_phandle_with_args(np
, propname
, "#gpio-cells");
116 * of_gpio_count() - Count GPIOs for a device
117 * @np: device node to count GPIOs for
119 * Same as of_gpio_named_count, but hard coded to use the 'gpios' property
121 static inline int of_gpio_count(struct device_node
*np
)
123 return of_gpio_named_count(np
, "gpios");
126 static inline int of_get_gpio_flags(struct device_node
*np
, int index
,
127 enum of_gpio_flags
*flags
)
129 return of_get_named_gpio_flags(np
, "gpios", index
, flags
);
133 * of_get_named_gpio() - Get a GPIO number to use with GPIO API
134 * @np: device node to get GPIO from
135 * @propname: Name of property containing gpio specifier(s)
136 * @index: index of the GPIO
138 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
139 * value on the error condition.
141 static inline int of_get_named_gpio(struct device_node
*np
,
142 const char *propname
, int index
)
144 return of_get_named_gpio_flags(np
, propname
, index
, NULL
);
148 * of_get_gpio() - Get a GPIO number to use with GPIO API
149 * @np: device node to get GPIO from
150 * @index: index of the GPIO
152 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
153 * value on the error condition.
155 static inline int of_get_gpio(struct device_node
*np
, int index
)
157 return of_get_gpio_flags(np
, index
, NULL
);
160 #endif /* __LINUX_OF_GPIO_H */