blob: 092186c62ff4dec0edfad460b8fda06229dcd04f [file] [log] [blame]
Anton Vorontsov863fbf42008-04-11 23:06:45 +10001/*
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
Anton Vorontsovb908b532008-12-01 06:30:04 +000017#include <linux/compiler.h>
18#include <linux/kernel.h>
Anton Vorontsov863fbf42008-04-11 23:06:45 +100019#include <linux/errno.h>
Wolfgang Grandegger18ad7a62008-05-30 22:51:33 +100020#include <linux/gpio.h>
Grant Likely15c9a0a2011-12-12 09:25:57 -070021#include <linux/of.h>
Anton Vorontsov863fbf42008-04-11 23:06:45 +100022
Anton Vorontsovb908b532008-12-01 06:30:04 +000023struct device_node;
24
25/*
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.
29 */
30enum of_gpio_flags {
31 OF_GPIO_ACTIVE_LOW = 0x1,
Laurent Pinchart90b665f2015-10-13 00:20:21 +030032 OF_GPIO_SINGLE_ENDED = 0x2,
Anton Vorontsovb908b532008-12-01 06:30:04 +000033};
34
Anton Vorontsov863fbf42008-04-11 23:06:45 +100035#ifdef CONFIG_OF_GPIO
36
37/*
Anton Vorontsov863fbf42008-04-11 23:06:45 +100038 * OF GPIO chip for memory mapped banks
39 */
40struct of_mm_gpio_chip {
Anton Vorontsova19e3da2010-06-08 07:48:16 -060041 struct gpio_chip gc;
Anton Vorontsov863fbf42008-04-11 23:06:45 +100042 void (*save_regs)(struct of_mm_gpio_chip *mm_gc);
43 void __iomem *regs;
44};
45
46static inline struct of_mm_gpio_chip *to_of_mm_gpio_chip(struct gpio_chip *gc)
47{
Anton Vorontsova19e3da2010-06-08 07:48:16 -060048 return container_of(gc, struct of_mm_gpio_chip, gc);
Anton Vorontsov863fbf42008-04-11 23:06:45 +100049}
50
Alexandre Courbotf01d9072014-05-17 14:54:50 +090051extern int of_get_named_gpio_flags(struct device_node *np,
John Bonesioa6b09192011-06-27 16:49:57 -070052 const char *list_name, int index, enum of_gpio_flags *flags);
53
Linus Walleij3208b0f2015-12-04 15:13:53 +010054extern int of_mm_gpiochip_add_data(struct device_node *np,
55 struct of_mm_gpio_chip *mm_gc,
56 void *data);
57static inline int of_mm_gpiochip_add(struct device_node *np,
58 struct of_mm_gpio_chip *mm_gc)
59{
60 return of_mm_gpiochip_add_data(np, mm_gc, NULL);
61}
Ricardo Ribalda Delgadod621e8b2014-12-17 16:51:13 +010062extern void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc);
Grant Likely594fa262010-06-08 07:48:16 -060063
Tomeu Vizoso28355f82015-07-14 10:29:54 +020064extern int of_gpiochip_add(struct gpio_chip *gc);
Anton Vorontsov391c9702010-06-08 07:48:17 -060065extern void of_gpiochip_remove(struct gpio_chip *gc);
Grant Likely15c9a0a2011-12-12 09:25:57 -070066extern int of_gpio_simple_xlate(struct gpio_chip *gc,
67 const struct of_phandle_args *gpiospec,
68 u32 *flags);
Grant Likely594fa262010-06-08 07:48:16 -060069
Anton Vorontsova19e3da2010-06-08 07:48:16 -060070#else /* CONFIG_OF_GPIO */
Anton Vorontsov863fbf42008-04-11 23:06:45 +100071
72/* Drivers may not strictly depend on the GPIO support, so let them link. */
Alexandre Courbotf01d9072014-05-17 14:54:50 +090073static inline int of_get_named_gpio_flags(struct device_node *np,
John Bonesioa6b09192011-06-27 16:49:57 -070074 const char *list_name, int index, enum of_gpio_flags *flags)
Anton Vorontsov863fbf42008-04-11 23:06:45 +100075{
Arnd Bergmann427e0dc2016-01-01 23:40:46 +010076 if (flags)
77 *flags = 0;
78
Alexandre Courbotf01d9072014-05-17 14:54:50 +090079 return -ENOSYS;
Anton Vorontsov863fbf42008-04-11 23:06:45 +100080}
81
Jamie Iles3038bbd2011-07-28 16:25:41 +010082static inline int of_gpio_simple_xlate(struct gpio_chip *gc,
Grant Likely15c9a0a2011-12-12 09:25:57 -070083 const struct of_phandle_args *gpiospec,
84 u32 *flags)
Jamie Iles3038bbd2011-07-28 16:25:41 +010085{
86 return -ENOSYS;
87}
88
Tomeu Vizoso28355f82015-07-14 10:29:54 +020089static inline int of_gpiochip_add(struct gpio_chip *gc) { return 0; }
Anton Vorontsov391c9702010-06-08 07:48:17 -060090static inline void of_gpiochip_remove(struct gpio_chip *gc) { }
91
Anton Vorontsov863fbf42008-04-11 23:06:45 +100092#endif /* CONFIG_OF_GPIO */
93
Anton Vorontsovb908b532008-12-01 06:30:04 +000094/**
Grant Likelye80beb22013-02-12 17:48:37 +000095 * of_gpio_named_count() - Count GPIOs for a device
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +010096 * @np: device node to count GPIOs for
Grant Likelye80beb22013-02-12 17:48:37 +000097 * @propname: property name containing gpio specifier(s)
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +010098 *
99 * The function returns the count of GPIOs specified for a node.
Grant Likelye80beb22013-02-12 17:48:37 +0000100 * Note that the empty GPIO specifiers count too. Returns either
101 * Number of gpios defined in property,
102 * -EINVAL for an incorrectly formed gpios property, or
103 * -ENOENT for a missing gpios property
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100104 *
Grant Likelye80beb22013-02-12 17:48:37 +0000105 * Example:
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100106 * gpios = <0
Grant Likelye80beb22013-02-12 17:48:37 +0000107 * &gpio1 1 2
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100108 * 0
Grant Likelye80beb22013-02-12 17:48:37 +0000109 * &gpio2 3 4>;
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100110 *
Grant Likelye80beb22013-02-12 17:48:37 +0000111 * The above example defines four GPIOs, two of which are not specified.
112 * This function will return '4'
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100113 */
Grant Likelye80beb22013-02-12 17:48:37 +0000114static inline int of_gpio_named_count(struct device_node *np, const char* propname)
115{
116 return of_count_phandle_with_args(np, propname, "#gpio-cells");
117}
118
119/**
120 * of_gpio_count() - Count GPIOs for a device
121 * @np: device node to count GPIOs for
122 *
123 * Same as of_gpio_named_count, but hard coded to use the 'gpios' property
124 */
125static inline int of_gpio_count(struct device_node *np)
Jean-Christophe PLAGNIOL-VILLARDff64abe2012-02-02 16:20:01 +0100126{
127 return of_gpio_named_count(np, "gpios");
128}
129
John Bonesioa6b09192011-06-27 16:49:57 -0700130static inline int of_get_gpio_flags(struct device_node *np, int index,
131 enum of_gpio_flags *flags)
132{
133 return of_get_named_gpio_flags(np, "gpios", index, flags);
134}
135
136/**
137 * of_get_named_gpio() - Get a GPIO number to use with GPIO API
138 * @np: device node to get GPIO from
139 * @propname: Name of property containing gpio specifier(s)
140 * @index: index of the GPIO
141 *
142 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
143 * value on the error condition.
144 */
145static inline int of_get_named_gpio(struct device_node *np,
146 const char *propname, int index)
147{
148 return of_get_named_gpio_flags(np, propname, index, NULL);
149}
150
151/**
152 * of_get_gpio() - Get a GPIO number to use with GPIO API
Anton Vorontsovb908b532008-12-01 06:30:04 +0000153 * @np: device node to get GPIO from
154 * @index: index of the GPIO
155 *
156 * Returns GPIO number to use with Linux generic GPIO API, or one of the errno
157 * value on the error condition.
158 */
159static inline int of_get_gpio(struct device_node *np, int index)
160{
161 return of_get_gpio_flags(np, index, NULL);
162}
163
Anton Vorontsov863fbf42008-04-11 23:06:45 +1000164#endif /* __LINUX_OF_GPIO_H */