blob: 0f32f10e347d9dbd7e3a7411054873bf7d294b0f [file] [log] [blame]
Linus Walleij28a8d142012-02-09 01:52:22 +01001/*
2 * Consumer interface the pin control subsystem
3 *
4 * Copyright (C) 2012 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
6 * Based on bits of regulator core, gpio core and clk core
7 *
8 * Author: Linus Walleij <linus.walleij@linaro.org>
9 *
10 * License terms: GNU General Public License (GPL) version 2
11 */
12#ifndef __LINUX_PINCTRL_CONSUMER_H
13#define __LINUX_PINCTRL_CONSUMER_H
14
Stephen Warren6e5e9592012-03-02 13:05:47 -070015#include <linux/err.h>
Linus Walleij28a8d142012-02-09 01:52:22 +010016#include <linux/list.h>
17#include <linux/seq_file.h>
David Howellsa1ce3922012-10-02 18:01:25 +010018#include <linux/pinctrl/pinctrl-state.h>
Linus Walleij28a8d142012-02-09 01:52:22 +010019
20/* This struct is private to the core and should be regarded as a cookie */
Linus Walleije93bcee2012-02-09 07:23:28 +010021struct pinctrl;
Stephen Warren6e5e9592012-03-02 13:05:47 -070022struct pinctrl_state;
Richard Genoudac5aa7f2012-08-10 16:52:58 +020023struct device;
Linus Walleij28a8d142012-02-09 01:52:22 +010024
Linus Walleijbefe5bd2012-02-09 19:47:48 +010025#ifdef CONFIG_PINCTRL
Linus Walleij28a8d142012-02-09 01:52:22 +010026
Linus Walleijbefe5bd2012-02-09 19:47:48 +010027/* External interface to pin control */
Linus Walleije93bcee2012-02-09 07:23:28 +010028extern int pinctrl_request_gpio(unsigned gpio);
29extern void pinctrl_free_gpio(unsigned gpio);
30extern int pinctrl_gpio_direction_input(unsigned gpio);
31extern int pinctrl_gpio_direction_output(unsigned gpio);
Stephen Warren6e5e9592012-03-02 13:05:47 -070032
33extern struct pinctrl * __must_check pinctrl_get(struct device *dev);
Linus Walleije93bcee2012-02-09 07:23:28 +010034extern void pinctrl_put(struct pinctrl *p);
Stephen Warren6e5e9592012-03-02 13:05:47 -070035extern struct pinctrl_state * __must_check pinctrl_lookup_state(
36 struct pinctrl *p,
37 const char *name);
38extern int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *s);
Linus Walleij28a8d142012-02-09 01:52:22 +010039
Stephen Warren6d4ca1f2012-04-16 10:51:00 -060040extern struct pinctrl * __must_check devm_pinctrl_get(struct device *dev);
41extern void devm_pinctrl_put(struct pinctrl *p);
42
Linus Walleij14005ee2013-06-05 15:30:33 +020043#ifdef CONFIG_PM
44extern int pinctrl_pm_select_default_state(struct device *dev);
45extern int pinctrl_pm_select_sleep_state(struct device *dev);
46extern int pinctrl_pm_select_idle_state(struct device *dev);
47#else
48static inline int pinctrl_pm_select_default_state(struct device *dev)
49{
50 return 0;
51}
52static inline int pinctrl_pm_select_sleep_state(struct device *dev)
53{
54 return 0;
55}
56static inline int pinctrl_pm_select_idle_state(struct device *dev)
57{
58 return 0;
59}
60#endif
61
Linus Walleijbefe5bd2012-02-09 19:47:48 +010062#else /* !CONFIG_PINCTRL */
Linus Walleij28a8d142012-02-09 01:52:22 +010063
Linus Walleije93bcee2012-02-09 07:23:28 +010064static inline int pinctrl_request_gpio(unsigned gpio)
Linus Walleij28a8d142012-02-09 01:52:22 +010065{
66 return 0;
67}
68
Linus Walleije93bcee2012-02-09 07:23:28 +010069static inline void pinctrl_free_gpio(unsigned gpio)
Linus Walleij28a8d142012-02-09 01:52:22 +010070{
71}
72
Linus Walleije93bcee2012-02-09 07:23:28 +010073static inline int pinctrl_gpio_direction_input(unsigned gpio)
Linus Walleij28a8d142012-02-09 01:52:22 +010074{
75 return 0;
76}
77
Linus Walleije93bcee2012-02-09 07:23:28 +010078static inline int pinctrl_gpio_direction_output(unsigned gpio)
Linus Walleij28a8d142012-02-09 01:52:22 +010079{
80 return 0;
81}
82
Stephen Warren6e5e9592012-03-02 13:05:47 -070083static inline struct pinctrl * __must_check pinctrl_get(struct device *dev)
Linus Walleij28a8d142012-02-09 01:52:22 +010084{
85 return NULL;
86}
87
Linus Walleije93bcee2012-02-09 07:23:28 +010088static inline void pinctrl_put(struct pinctrl *p)
Linus Walleij28a8d142012-02-09 01:52:22 +010089{
90}
91
Stephen Warren6e5e9592012-03-02 13:05:47 -070092static inline struct pinctrl_state * __must_check pinctrl_lookup_state(
93 struct pinctrl *p,
94 const char *name)
95{
96 return NULL;
97}
98
99static inline int pinctrl_select_state(struct pinctrl *p,
100 struct pinctrl_state *s)
Linus Walleij28a8d142012-02-09 01:52:22 +0100101{
102 return 0;
103}
104
Stephen Warren6d4ca1f2012-04-16 10:51:00 -0600105static inline struct pinctrl * __must_check devm_pinctrl_get(struct device *dev)
106{
107 return NULL;
108}
109
110static inline void devm_pinctrl_put(struct pinctrl *p)
111{
112}
113
Stephen Warren6e5e9592012-03-02 13:05:47 -0700114#endif /* CONFIG_PINCTRL */
115
116static inline struct pinctrl * __must_check pinctrl_get_select(
117 struct device *dev, const char *name)
Linus Walleij28a8d142012-02-09 01:52:22 +0100118{
Stephen Warren6e5e9592012-03-02 13:05:47 -0700119 struct pinctrl *p;
120 struct pinctrl_state *s;
121 int ret;
122
123 p = pinctrl_get(dev);
124 if (IS_ERR(p))
125 return p;
126
127 s = pinctrl_lookup_state(p, name);
128 if (IS_ERR(s)) {
129 pinctrl_put(p);
130 return ERR_PTR(PTR_ERR(s));
131 }
132
133 ret = pinctrl_select_state(p, s);
134 if (ret < 0) {
135 pinctrl_put(p);
136 return ERR_PTR(ret);
137 }
138
139 return p;
Linus Walleij28a8d142012-02-09 01:52:22 +0100140}
141
Stephen Warren6e5e9592012-03-02 13:05:47 -0700142static inline struct pinctrl * __must_check pinctrl_get_select_default(
143 struct device *dev)
144{
145 return pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
146}
Linus Walleij28a8d142012-02-09 01:52:22 +0100147
Stephen Warren6d4ca1f2012-04-16 10:51:00 -0600148static inline struct pinctrl * __must_check devm_pinctrl_get_select(
149 struct device *dev, const char *name)
150{
151 struct pinctrl *p;
152 struct pinctrl_state *s;
153 int ret;
154
155 p = devm_pinctrl_get(dev);
156 if (IS_ERR(p))
157 return p;
158
159 s = pinctrl_lookup_state(p, name);
160 if (IS_ERR(s)) {
161 devm_pinctrl_put(p);
Uwe Kleine-Könige60bc2d2012-07-30 18:38:33 +0200162 return ERR_CAST(s);
Stephen Warren6d4ca1f2012-04-16 10:51:00 -0600163 }
164
165 ret = pinctrl_select_state(p, s);
166 if (ret < 0) {
167 devm_pinctrl_put(p);
168 return ERR_PTR(ret);
169 }
170
171 return p;
172}
173
174static inline struct pinctrl * __must_check devm_pinctrl_get_select_default(
175 struct device *dev)
176{
177 return devm_pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
178}
179
Linus Walleij28a8d142012-02-09 01:52:22 +0100180#ifdef CONFIG_PINCONF
181
182extern int pin_config_get(const char *dev_name, const char *name,
183 unsigned long *config);
184extern int pin_config_set(const char *dev_name, const char *name,
185 unsigned long config);
186extern int pin_config_group_get(const char *dev_name,
187 const char *pin_group,
188 unsigned long *config);
189extern int pin_config_group_set(const char *dev_name,
190 const char *pin_group,
191 unsigned long config);
192
193#else
194
195static inline int pin_config_get(const char *dev_name, const char *name,
196 unsigned long *config)
197{
198 return 0;
199}
200
201static inline int pin_config_set(const char *dev_name, const char *name,
202 unsigned long config)
203{
204 return 0;
205}
206
207static inline int pin_config_group_get(const char *dev_name,
208 const char *pin_group,
209 unsigned long *config)
210{
211 return 0;
212}
213
214static inline int pin_config_group_set(const char *dev_name,
215 const char *pin_group,
216 unsigned long config)
217{
218 return 0;
219}
220
Linus Walleij14005ee2013-06-05 15:30:33 +0200221static inline int pinctrl_pm_select_default_state(struct device *dev)
222{
223 return 0;
224}
225
226static inline int pinctrl_pm_select_sleep_state(struct device *dev)
227{
228 return 0;
229}
230
231static inline int pinctrl_pm_select_idle_state(struct device *dev)
232{
233 return 0;
234}
235
Linus Walleij28a8d142012-02-09 01:52:22 +0100236#endif
237
238#endif /* __LINUX_PINCTRL_CONSUMER_H */