1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Consumer interface the pin control subsystem
4 *
5 * Copyright (C) 2012 ST-Ericsson SA
6 * Written on behalf of Linaro for ST-Ericsson
7 * Based on bits of regulator core, gpio core and clk core
8 *
9 * Author: Linus Walleij <linus.walleij@linaro.org>
10 */
11 #ifndef __LINUX_PINCTRL_CONSUMER_H
12 #define __LINUX_PINCTRL_CONSUMER_H
13
14 #include <linux/err.h>
15 #include <linux/list.h>
16 #include <linux/seq_file.h>
17 #include <linux/pinctrl/pinctrl-state.h>
18
19 /* This struct is private to the core and should be regarded as a cookie */
20 struct pinctrl;
21 struct pinctrl_state;
22 struct device;
23
24 #ifdef CONFIG_PINCTRL
25
26 /* External interface to pin control */
27 extern bool pinctrl_gpio_can_use_line(unsigned gpio);
28 extern int pinctrl_gpio_request(unsigned gpio);
29 extern void pinctrl_gpio_free(unsigned gpio);
30 extern int pinctrl_gpio_direction_input(unsigned gpio);
31 extern int pinctrl_gpio_direction_output(unsigned gpio);
32 extern int pinctrl_gpio_set_config(unsigned gpio, unsigned long config);
33
34 extern struct pinctrl * __must_check pinctrl_get(struct device *dev);
35 extern void pinctrl_put(struct pinctrl *p);
36 extern struct pinctrl_state * __must_check pinctrl_lookup_state(
37 struct pinctrl *p,
38 const char *name);
39 extern int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *s);
40
41 extern struct pinctrl * __must_check devm_pinctrl_get(struct device *dev);
42 extern void devm_pinctrl_put(struct pinctrl *p);
43
44 #ifdef CONFIG_PM
45 extern int pinctrl_pm_select_default_state(struct device *dev);
46 extern int pinctrl_pm_select_sleep_state(struct device *dev);
47 extern int pinctrl_pm_select_idle_state(struct device *dev);
48 #else
pinctrl_pm_select_default_state(struct device * dev)49 static inline int pinctrl_pm_select_default_state(struct device *dev)
50 {
51 return 0;
52 }
pinctrl_pm_select_sleep_state(struct device * dev)53 static inline int pinctrl_pm_select_sleep_state(struct device *dev)
54 {
55 return 0;
56 }
pinctrl_pm_select_idle_state(struct device * dev)57 static inline int pinctrl_pm_select_idle_state(struct device *dev)
58 {
59 return 0;
60 }
61 #endif
62
63 #else /* !CONFIG_PINCTRL */
64
pinctrl_gpio_can_use_line(unsigned gpio)65 static inline bool pinctrl_gpio_can_use_line(unsigned gpio)
66 {
67 return true;
68 }
69
pinctrl_gpio_request(unsigned gpio)70 static inline int pinctrl_gpio_request(unsigned gpio)
71 {
72 return 0;
73 }
74
pinctrl_gpio_free(unsigned gpio)75 static inline void pinctrl_gpio_free(unsigned gpio)
76 {
77 }
78
pinctrl_gpio_direction_input(unsigned gpio)79 static inline int pinctrl_gpio_direction_input(unsigned gpio)
80 {
81 return 0;
82 }
83
pinctrl_gpio_direction_output(unsigned gpio)84 static inline int pinctrl_gpio_direction_output(unsigned gpio)
85 {
86 return 0;
87 }
88
pinctrl_gpio_set_config(unsigned gpio,unsigned long config)89 static inline int pinctrl_gpio_set_config(unsigned gpio, unsigned long config)
90 {
91 return 0;
92 }
93
pinctrl_get(struct device * dev)94 static inline struct pinctrl * __must_check pinctrl_get(struct device *dev)
95 {
96 return NULL;
97 }
98
pinctrl_put(struct pinctrl * p)99 static inline void pinctrl_put(struct pinctrl *p)
100 {
101 }
102
pinctrl_lookup_state(struct pinctrl * p,const char * name)103 static inline struct pinctrl_state * __must_check pinctrl_lookup_state(
104 struct pinctrl *p,
105 const char *name)
106 {
107 return NULL;
108 }
109
pinctrl_select_state(struct pinctrl * p,struct pinctrl_state * s)110 static inline int pinctrl_select_state(struct pinctrl *p,
111 struct pinctrl_state *s)
112 {
113 return 0;
114 }
115
devm_pinctrl_get(struct device * dev)116 static inline struct pinctrl * __must_check devm_pinctrl_get(struct device *dev)
117 {
118 return NULL;
119 }
120
devm_pinctrl_put(struct pinctrl * p)121 static inline void devm_pinctrl_put(struct pinctrl *p)
122 {
123 }
124
pinctrl_pm_select_default_state(struct device * dev)125 static inline int pinctrl_pm_select_default_state(struct device *dev)
126 {
127 return 0;
128 }
129
pinctrl_pm_select_sleep_state(struct device * dev)130 static inline int pinctrl_pm_select_sleep_state(struct device *dev)
131 {
132 return 0;
133 }
134
pinctrl_pm_select_idle_state(struct device * dev)135 static inline int pinctrl_pm_select_idle_state(struct device *dev)
136 {
137 return 0;
138 }
139
140 #endif /* CONFIG_PINCTRL */
141
pinctrl_get_select(struct device * dev,const char * name)142 static inline struct pinctrl * __must_check pinctrl_get_select(
143 struct device *dev, const char *name)
144 {
145 struct pinctrl *p;
146 struct pinctrl_state *s;
147 int ret;
148
149 p = pinctrl_get(dev);
150 if (IS_ERR(p))
151 return p;
152
153 s = pinctrl_lookup_state(p, name);
154 if (IS_ERR(s)) {
155 pinctrl_put(p);
156 return ERR_CAST(s);
157 }
158
159 ret = pinctrl_select_state(p, s);
160 if (ret < 0) {
161 pinctrl_put(p);
162 return ERR_PTR(ret);
163 }
164
165 return p;
166 }
167
pinctrl_get_select_default(struct device * dev)168 static inline struct pinctrl * __must_check pinctrl_get_select_default(
169 struct device *dev)
170 {
171 return pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
172 }
173
devm_pinctrl_get_select(struct device * dev,const char * name)174 static inline struct pinctrl * __must_check devm_pinctrl_get_select(
175 struct device *dev, const char *name)
176 {
177 struct pinctrl *p;
178 struct pinctrl_state *s;
179 int ret;
180
181 p = devm_pinctrl_get(dev);
182 if (IS_ERR(p))
183 return p;
184
185 s = pinctrl_lookup_state(p, name);
186 if (IS_ERR(s)) {
187 devm_pinctrl_put(p);
188 return ERR_CAST(s);
189 }
190
191 ret = pinctrl_select_state(p, s);
192 if (ret < 0) {
193 devm_pinctrl_put(p);
194 return ERR_PTR(ret);
195 }
196
197 return p;
198 }
199
devm_pinctrl_get_select_default(struct device * dev)200 static inline struct pinctrl * __must_check devm_pinctrl_get_select_default(
201 struct device *dev)
202 {
203 return devm_pinctrl_get_select(dev, PINCTRL_STATE_DEFAULT);
204 }
205
206 #endif /* __LINUX_PINCTRL_CONSUMER_H */
207
