reset.h 11.4 KB
Newer Older
1
2
3
#ifndef _LINUX_RESET_H_
#define _LINUX_RESET_H_

4
5
#include <linux/device.h>

6
7
struct reset_control;

8
9
#ifdef CONFIG_RESET_CONTROLLER

10
11
12
int reset_control_reset(struct reset_control *rstc);
int reset_control_assert(struct reset_control *rstc);
int reset_control_deassert(struct reset_control *rstc);
13
int reset_control_status(struct reset_control *rstc);
14

15
struct reset_control *__of_reset_control_get(struct device_node *node,
16
				     const char *id, int index, int shared);
17
void reset_control_put(struct reset_control *rstc);
18
struct reset_control *__devm_reset_control_get(struct device *dev,
19
				     const char *id, int index, int shared);
20

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
int __must_check device_reset(struct device *dev);

static inline int device_reset_optional(struct device *dev)
{
	return device_reset(dev);
}

#else

static inline int reset_control_reset(struct reset_control *rstc)
{
	WARN_ON(1);
	return 0;
}

static inline int reset_control_assert(struct reset_control *rstc)
{
	WARN_ON(1);
	return 0;
}

static inline int reset_control_deassert(struct reset_control *rstc)
{
	WARN_ON(1);
	return 0;
}

48
49
50
51
52
53
static inline int reset_control_status(struct reset_control *rstc)
{
	WARN_ON(1);
	return 0;
}

54
55
56
57
58
static inline void reset_control_put(struct reset_control *rstc)
{
	WARN_ON(1);
}

59
60
61
62
63
64
static inline int __must_check device_reset(struct device *dev)
{
	WARN_ON(1);
	return -ENOTSUPP;
}

65
66
static inline int device_reset_optional(struct device *dev)
{
67
	return -ENOTSUPP;
68
69
}

70
71
static inline struct reset_control *__of_reset_control_get(
					struct device_node *node,
72
					const char *id, int index, int shared)
73
74
75
76
{
	return ERR_PTR(-EINVAL);
}

77
78
static inline struct reset_control *__devm_reset_control_get(
					struct device *dev,
79
					const char *id, int index, int shared)
80
81
82
83
{
	return ERR_PTR(-EINVAL);
}

84
85
86
#endif /* CONFIG_RESET_CONTROLLER */

/**
87
88
 * reset_control_get_exclusive - Lookup and obtain an exclusive reference
 *                               to a reset controller.
89
90
91
92
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
 * Returns a struct reset_control or IS_ERR() condition containing errno.
93
94
95
96
97
 * If this function is called more then once for the same reset_control it will
 * return -EBUSY.
 *
 * See reset_control_get_shared for details on shared references to
 * reset-controls.
98
99
100
 *
 * Use of id names is optional.
 */
101
102
static inline struct reset_control *
__must_check reset_control_get_exclusive(struct device *dev, const char *id)
103
{
104
105
106
#ifndef CONFIG_RESET_CONTROLLER
	WARN_ON(1);
#endif
107
	return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 0);
108
109
}

110
/**
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 * reset_control_get_shared - Lookup and obtain a shared reference to a
 *                            reset controller.
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
 * Returns a struct reset_control or IS_ERR() condition containing errno.
 * This function is intended for use with reset-controls which are shared
 * between hardware-blocks.
 *
 * When a reset-control is shared, the behavior of reset_control_assert /
 * deassert is changed, the reset-core will keep track of a deassert_count
 * and only (re-)assert the reset after reset_control_assert has been called
 * as many times as reset_control_deassert was called. Also see the remark
 * about shared reset-controls in the reset_control_assert docs.
 *
 * Calling reset_control_assert without first calling reset_control_deassert
 * is not allowed on a shared reset control. Calling reset_control_reset is
 * also not allowed on a shared reset control.
 *
 * Use of id names is optional.
 */
static inline struct reset_control *reset_control_get_shared(
					struct device *dev, const char *id)
{
	return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 1);
}

138
static inline struct reset_control *reset_control_get_optional_exclusive(
139
140
141
142
143
					struct device *dev, const char *id)
{
	return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 0);
}

144
145
146
147
148
149
static inline struct reset_control *reset_control_get_optional_shared(
					struct device *dev, const char *id)
{
	return __of_reset_control_get(dev ? dev->of_node : NULL, id, 0, 1);
}

150
/**
151
152
 * of_reset_control_get_exclusive - Lookup and obtain an exclusive reference
 *                                  to a reset controller.
153
154
155
156
157
158
159
 * @node: device to be reset by the controller
 * @id: reset line name
 *
 * Returns a struct reset_control or IS_ERR() condition containing errno.
 *
 * Use of id names is optional.
 */
160
static inline struct reset_control *of_reset_control_get_exclusive(
161
162
				struct device_node *node, const char *id)
{
163
	return __of_reset_control_get(node, id, 0, 0);
164
165
}

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/**
 * of_reset_control_get_shared - Lookup and obtain an shared reference
 *                               to a reset controller.
 * @node: device to be reset by the controller
 * @id: reset line name
 *
 * When a reset-control is shared, the behavior of reset_control_assert /
 * deassert is changed, the reset-core will keep track of a deassert_count
 * and only (re-)assert the reset after reset_control_assert has been called
 * as many times as reset_control_deassert was called. Also see the remark
 * about shared reset-controls in the reset_control_assert docs.
 *
 * Calling reset_control_assert without first calling reset_control_deassert
 * is not allowed on a shared reset control. Calling reset_control_reset is
 * also not allowed on a shared reset control.
 * Returns a struct reset_control or IS_ERR() condition containing errno.
 *
 * Use of id names is optional.
 */
static inline struct reset_control *of_reset_control_get_shared(
				struct device_node *node, const char *id)
{
	return __of_reset_control_get(node, id, 0, 1);
}

191
/**
192
193
194
 * of_reset_control_get_exclusive_by_index - Lookup and obtain an exclusive
 *                                           reference to a reset controller
 *                                           by index.
195
196
197
198
199
200
201
 * @node: device to be reset by the controller
 * @index: index of the reset controller
 *
 * This is to be used to perform a list of resets for a device or power domain
 * in whatever order. Returns a struct reset_control or IS_ERR() condition
 * containing errno.
 */
202
static inline struct reset_control *of_reset_control_get_exclusive_by_index(
203
					struct device_node *node, int index)
204
{
205
	return __of_reset_control_get(node, NULL, index, 0);
206
207
}

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/**
 * of_reset_control_get_shared_by_index - Lookup and obtain an shared
 *                                        reference to a reset controller
 *                                        by index.
 * @node: device to be reset by the controller
 * @index: index of the reset controller
 *
 * When a reset-control is shared, the behavior of reset_control_assert /
 * deassert is changed, the reset-core will keep track of a deassert_count
 * and only (re-)assert the reset after reset_control_assert has been called
 * as many times as reset_control_deassert was called. Also see the remark
 * about shared reset-controls in the reset_control_assert docs.
 *
 * Calling reset_control_assert without first calling reset_control_deassert
 * is not allowed on a shared reset control. Calling reset_control_reset is
 * also not allowed on a shared reset control.
 * Returns a struct reset_control or IS_ERR() condition containing errno.
 *
 * This is to be used to perform a list of resets for a device or power domain
 * in whatever order. Returns a struct reset_control or IS_ERR() condition
 * containing errno.
 */
static inline struct reset_control *of_reset_control_get_shared_by_index(
					struct device_node *node, int index)
{
	return __of_reset_control_get(node, NULL, index, 1);
}

236
/**
237
238
 * devm_reset_control_get_exclusive - resource managed
 *                                    reset_control_get_exclusive()
239
240
241
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
242
243
244
245
246
 * Managed reset_control_get_exclusive(). For reset controllers returned
 * from this function, reset_control_put() is called automatically on driver
 * detach.
 *
 * See reset_control_get_exclusive() for more information.
247
 */
248
249
250
static inline struct reset_control *
__must_check devm_reset_control_get_exclusive(struct device *dev,
					      const char *id)
251
252
253
254
{
#ifndef CONFIG_RESET_CONTROLLER
	WARN_ON(1);
#endif
255
	return __devm_reset_control_get(dev, id, 0, 0);
256
257
}

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/**
 * devm_reset_control_get_shared - resource managed reset_control_get_shared()
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
 * Managed reset_control_get_shared(). For reset controllers returned from
 * this function, reset_control_put() is called automatically on driver detach.
 * See reset_control_get_shared() for more information.
 */
static inline struct reset_control *devm_reset_control_get_shared(
					struct device *dev, const char *id)
{
	return __devm_reset_control_get(dev, id, 0, 1);
}

273
static inline struct reset_control *devm_reset_control_get_optional_exclusive(
274
275
					struct device *dev, const char *id)
{
276
	return __devm_reset_control_get(dev, id, 0, 0);
277
278
}

279
280
281
282
283
284
static inline struct reset_control *devm_reset_control_get_optional_shared(
					struct device *dev, const char *id)
{
	return __devm_reset_control_get(dev, id, 0, 1);
}

285
/**
286
287
 * devm_reset_control_get_exclusive_by_index - resource managed
 *                                             reset_control_get_exclusive()
288
289
290
 * @dev: device to be reset by the controller
 * @index: index of the reset controller
 *
291
292
293
294
295
 * Managed reset_control_get_exclusive(). For reset controllers returned from
 * this function, reset_control_put() is called automatically on driver
 * detach.
 *
 * See reset_control_get_exclusive() for more information.
296
 */
297
298
static inline struct reset_control *
devm_reset_control_get_exclusive_by_index(struct device *dev, int index)
299
{
300
301
302
303
304
305
306
307
308
309
310
311
312
	return __devm_reset_control_get(dev, NULL, index, 0);
}

/**
 * devm_reset_control_get_shared_by_index - resource managed
 * reset_control_get_shared
 * @dev: device to be reset by the controller
 * @index: index of the reset controller
 *
 * Managed reset_control_get_shared(). For reset controllers returned from
 * this function, reset_control_put() is called automatically on driver detach.
 * See reset_control_get_shared() for more information.
 */
313
314
static inline struct reset_control *
devm_reset_control_get_shared_by_index(struct device *dev, int index)
315
316
{
	return __devm_reset_control_get(dev, NULL, index, 1);
317
}
318

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
/*
 * TEMPORARY calls to use during transition:
 *
 *   of_reset_control_get() => of_reset_control_get_exclusive()
 *
 * These inline function calls will be removed once all consumers
 * have been moved over to the new explicit API.
 */
static inline struct reset_control *reset_control_get(
				struct device *dev, const char *id)
{
	return reset_control_get_exclusive(dev, id);
}

static inline struct reset_control *reset_control_get_optional(
					struct device *dev, const char *id)
{
	return reset_control_get_optional_exclusive(dev, id);
}

static inline struct reset_control *of_reset_control_get(
				struct device_node *node, const char *id)
{
	return of_reset_control_get_exclusive(node, id);
}

static inline struct reset_control *of_reset_control_get_by_index(
				struct device_node *node, int index)
{
	return of_reset_control_get_exclusive_by_index(node, index);
}

static inline struct reset_control *devm_reset_control_get(
				struct device *dev, const char *id)
{
	return devm_reset_control_get_exclusive(dev, id);
}

static inline struct reset_control *devm_reset_control_get_optional(
				struct device *dev, const char *id)
{
	return devm_reset_control_get_optional_exclusive(dev, id);

}

static inline struct reset_control *devm_reset_control_get_by_index(
				struct device *dev, int index)
{
	return devm_reset_control_get_exclusive_by_index(dev, index);
}
369
#endif