blob: 33eaf11dabe26d85eb2b456d3d73fdf6c9d029b7 [file] [log] [blame]
Philipp Zabel61fc4132012-11-19 17:23:13 +01001#ifndef _LINUX_RESET_H_
2#define _LINUX_RESET_H_
3
Hans de Goede6c96f052016-02-23 18:46:24 +01004#include <linux/device.h>
5
Philipp Zabel61fc4132012-11-19 17:23:13 +01006struct reset_control;
7
Philipp Zabelb4240802014-03-07 15:18:47 +01008#ifdef CONFIG_RESET_CONTROLLER
9
Philipp Zabel61fc4132012-11-19 17:23:13 +010010int reset_control_reset(struct reset_control *rstc);
11int reset_control_assert(struct reset_control *rstc);
12int reset_control_deassert(struct reset_control *rstc);
Dinh Nguyen729de412014-10-10 10:21:14 -050013int reset_control_status(struct reset_control *rstc);
Philipp Zabel61fc4132012-11-19 17:23:13 +010014
Hans de Goede6c96f052016-02-23 18:46:24 +010015struct reset_control *__of_reset_control_get(struct device_node *node,
Hans de Goede0b522972016-02-23 18:46:26 +010016 const char *id, int index, int shared);
Philipp Zabel61fc4132012-11-19 17:23:13 +010017void reset_control_put(struct reset_control *rstc);
Hans de Goede6c96f052016-02-23 18:46:24 +010018struct reset_control *__devm_reset_control_get(struct device *dev,
Hans de Goede0b522972016-02-23 18:46:26 +010019 const char *id, int index, int shared);
Philipp Zabel61fc4132012-11-19 17:23:13 +010020
Philipp Zabelb4240802014-03-07 15:18:47 +010021int __must_check device_reset(struct device *dev);
22
23static inline int device_reset_optional(struct device *dev)
24{
25 return device_reset(dev);
26}
27
Philipp Zabelb4240802014-03-07 15:18:47 +010028#else
29
30static inline int reset_control_reset(struct reset_control *rstc)
31{
32 WARN_ON(1);
33 return 0;
34}
35
36static inline int reset_control_assert(struct reset_control *rstc)
37{
38 WARN_ON(1);
39 return 0;
40}
41
42static inline int reset_control_deassert(struct reset_control *rstc)
43{
44 WARN_ON(1);
45 return 0;
46}
47
Dinh Nguyen729de412014-10-10 10:21:14 -050048static inline int reset_control_status(struct reset_control *rstc)
49{
50 WARN_ON(1);
51 return 0;
52}
53
Philipp Zabelb4240802014-03-07 15:18:47 +010054static inline void reset_control_put(struct reset_control *rstc)
55{
56 WARN_ON(1);
57}
58
Daniel Lezcano41136522016-04-01 21:38:16 +020059static inline int __must_check device_reset(struct device *dev)
60{
61 WARN_ON(1);
62 return -ENOTSUPP;
63}
64
Philipp Zabelb4240802014-03-07 15:18:47 +010065static inline int device_reset_optional(struct device *dev)
66{
Philipp Zabel39b4da72015-10-29 09:55:00 +010067 return -ENOTSUPP;
Philipp Zabelb4240802014-03-07 15:18:47 +010068}
69
Hans de Goede6c96f052016-02-23 18:46:24 +010070static inline struct reset_control *__of_reset_control_get(
71 struct device_node *node,
Hans de Goede0b522972016-02-23 18:46:26 +010072 const char *id, int index, int shared)
Axel Lin5bcd0b72015-09-01 07:56:38 +080073{
Axel Lin5bcd0b72015-09-01 07:56:38 +080074 return ERR_PTR(-EINVAL);
75}
76
Hans de Goede6c96f052016-02-23 18:46:24 +010077static inline struct reset_control *__devm_reset_control_get(
78 struct device *dev,
Hans de Goede0b522972016-02-23 18:46:26 +010079 const char *id, int index, int shared)
Hans de Goede6c96f052016-02-23 18:46:24 +010080{
81 return ERR_PTR(-EINVAL);
82}
83
84#endif /* CONFIG_RESET_CONTROLLER */
85
86/**
Hans de Goede0b522972016-02-23 18:46:26 +010087 * reset_control_get - Lookup and obtain an exclusive reference to a
88 * reset controller.
Hans de Goede6c96f052016-02-23 18:46:24 +010089 * @dev: device to be reset by the controller
90 * @id: reset line name
91 *
92 * Returns a struct reset_control or IS_ERR() condition containing errno.
Hans de Goede0b522972016-02-23 18:46:26 +010093 * If this function is called more then once for the same reset_control it will
94 * return -EBUSY.
95 *
96 * See reset_control_get_shared for details on shared references to
97 * reset-controls.
Hans de Goede6c96f052016-02-23 18:46:24 +010098 *
99 * Use of id names is optional.
100 */
101static inline struct reset_control *__must_check reset_control_get(
Axel Lin5bcd0b72015-09-01 07:56:38 +0800102 struct device *dev, const char *id)
103{
Hans de Goede6c96f052016-02-23 18:46:24 +0100104#ifndef CONFIG_RESET_CONTROLLER
Axel Lin5bcd0b72015-09-01 07:56:38 +0800105 WARN_ON(1);
Hans de Goede6c96f052016-02-23 18:46:24 +0100106#endif
Hans de Goede0b522972016-02-23 18:46:26 +0100107 return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 0);
Axel Lin5bcd0b72015-09-01 07:56:38 +0800108}
109
Hans de Goede6c96f052016-02-23 18:46:24 +0100110/**
Hans de Goede0b522972016-02-23 18:46:26 +0100111 * reset_control_get_shared - Lookup and obtain a shared reference to a
112 * reset controller.
113 * @dev: device to be reset by the controller
114 * @id: reset line name
115 *
116 * Returns a struct reset_control or IS_ERR() condition containing errno.
117 * This function is intended for use with reset-controls which are shared
118 * between hardware-blocks.
119 *
120 * When a reset-control is shared, the behavior of reset_control_assert /
121 * deassert is changed, the reset-core will keep track of a deassert_count
122 * and only (re-)assert the reset after reset_control_assert has been called
123 * as many times as reset_control_deassert was called. Also see the remark
124 * about shared reset-controls in the reset_control_assert docs.
125 *
126 * Calling reset_control_assert without first calling reset_control_deassert
127 * is not allowed on a shared reset control. Calling reset_control_reset is
128 * also not allowed on a shared reset control.
129 *
130 * Use of id names is optional.
131 */
132static inline struct reset_control *reset_control_get_shared(
133 struct device *dev, const char *id)
134{
135 return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 1);
136}
137
Lee Jones3c35f6e2016-06-06 16:56:49 +0100138static inline struct reset_control *reset_control_get_optional(
139 struct device *dev, const char *id)
140{
141 return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 0);
142}
143
Hans de Goede0b522972016-02-23 18:46:26 +0100144/**
145 * of_reset_control_get - Lookup and obtain an exclusive reference to a
146 * reset controller.
Hans de Goede6c96f052016-02-23 18:46:24 +0100147 * @node: device to be reset by the controller
148 * @id: reset line name
149 *
150 * Returns a struct reset_control or IS_ERR() condition containing errno.
151 *
152 * Use of id names is optional.
153 */
154static inline struct reset_control *of_reset_control_get(
155 struct device_node *node, const char *id)
156{
Hans de Goede0b522972016-02-23 18:46:26 +0100157 return __of_reset_control_get(node, id, 0, 0);
Hans de Goede6c96f052016-02-23 18:46:24 +0100158}
159
160/**
Hans de Goede0b522972016-02-23 18:46:26 +0100161 * of_reset_control_get_by_index - Lookup and obtain an exclusive reference to
162 * a reset controller by index.
Hans de Goede6c96f052016-02-23 18:46:24 +0100163 * @node: device to be reset by the controller
164 * @index: index of the reset controller
165 *
166 * This is to be used to perform a list of resets for a device or power domain
167 * in whatever order. Returns a struct reset_control or IS_ERR() condition
168 * containing errno.
169 */
170static inline struct reset_control *of_reset_control_get_by_index(
171 struct device_node *node, int index)
172{
Hans de Goede0b522972016-02-23 18:46:26 +0100173 return __of_reset_control_get(node, NULL, index, 0);
Hans de Goede6c96f052016-02-23 18:46:24 +0100174}
175
176/**
177 * devm_reset_control_get - resource managed reset_control_get()
178 * @dev: device to be reset by the controller
179 * @id: reset line name
180 *
181 * Managed reset_control_get(). For reset controllers returned from this
182 * function, reset_control_put() is called automatically on driver detach.
183 * See reset_control_get() for more information.
184 */
185static inline struct reset_control *__must_check devm_reset_control_get(
186 struct device *dev, const char *id)
187{
188#ifndef CONFIG_RESET_CONTROLLER
189 WARN_ON(1);
190#endif
Hans de Goede0b522972016-02-23 18:46:26 +0100191 return __devm_reset_control_get(dev, id, 0, 0);
Philipp Zabelb4240802014-03-07 15:18:47 +0100192}
193
Lee Jones3c35f6e2016-06-06 16:56:49 +0100194/**
195 * devm_reset_control_get_shared - resource managed reset_control_get_shared()
196 * @dev: device to be reset by the controller
197 * @id: reset line name
198 *
199 * Managed reset_control_get_shared(). For reset controllers returned from
200 * this function, reset_control_put() is called automatically on driver detach.
201 * See reset_control_get_shared() for more information.
202 */
203static inline struct reset_control *devm_reset_control_get_shared(
204 struct device *dev, const char *id)
205{
206 return __devm_reset_control_get(dev, id, 0, 1);
207}
208
Philipp Zabelb4240802014-03-07 15:18:47 +0100209static inline struct reset_control *devm_reset_control_get_optional(
210 struct device *dev, const char *id)
211{
Hans de Goede0b522972016-02-23 18:46:26 +0100212 return __devm_reset_control_get(dev, id, 0, 0);
Philipp Zabelb4240802014-03-07 15:18:47 +0100213}
214
Hans de Goede6c96f052016-02-23 18:46:24 +0100215/**
216 * devm_reset_control_get_by_index - resource managed reset_control_get
217 * @dev: device to be reset by the controller
218 * @index: index of the reset controller
219 *
220 * Managed reset_control_get(). For reset controllers returned from this
221 * function, reset_control_put() is called automatically on driver detach.
222 * See reset_control_get() for more information.
223 */
224static inline struct reset_control *devm_reset_control_get_by_index(
225 struct device *dev, int index)
Hans de Goedee3ec0a82014-04-13 14:09:15 +0200226{
Hans de Goede0b522972016-02-23 18:46:26 +0100227 return __devm_reset_control_get(dev, NULL, index, 0);
228}
229
230/**
Hans de Goede0b522972016-02-23 18:46:26 +0100231 * devm_reset_control_get_shared_by_index - resource managed
232 * reset_control_get_shared
233 * @dev: device to be reset by the controller
234 * @index: index of the reset controller
235 *
236 * Managed reset_control_get_shared(). For reset controllers returned from
237 * this function, reset_control_put() is called automatically on driver detach.
238 * See reset_control_get_shared() for more information.
239 */
240static inline struct reset_control *devm_reset_control_get_shared_by_index(
241 struct device *dev, int index)
242{
243 return __devm_reset_control_get(dev, NULL, index, 1);
Hans de Goedee3ec0a82014-04-13 14:09:15 +0200244}
245
Philipp Zabel61fc4132012-11-19 17:23:13 +0100246#endif