reset.h 13.4 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4
#ifndef _LINUX_RESET_H_
#define _LINUX_RESET_H_

5
#include <linux/types.h>
6

7 8
struct device;
struct device_node;
9 10
struct reset_control;

11 12
#ifdef CONFIG_RESET_CONTROLLER

13 14 15
int reset_control_reset(struct reset_control *rstc);
int reset_control_assert(struct reset_control *rstc);
int reset_control_deassert(struct reset_control *rstc);
16
int reset_control_status(struct reset_control *rstc);
17

18
struct reset_control *__of_reset_control_get(struct device_node *node,
19 20
				     const char *id, int index, bool shared,
				     bool optional);
21 22 23
struct reset_control *__reset_control_get(struct device *dev, const char *id,
					  int index, bool shared,
					  bool optional);
24
void reset_control_put(struct reset_control *rstc);
25
int __device_reset(struct device *dev, bool optional);
26
struct reset_control *__devm_reset_control_get(struct device *dev,
27 28
				     const char *id, int index, bool shared,
				     bool optional);
29

30 31 32 33 34
struct reset_control *devm_reset_control_array_get(struct device *dev,
						   bool shared, bool optional);
struct reset_control *of_reset_control_array_get(struct device_node *np,
						 bool shared, bool optional);

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#else

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

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

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

52 53 54 55 56
static inline int reset_control_status(struct reset_control *rstc)
{
	return 0;
}

57 58 59 60
static inline void reset_control_put(struct reset_control *rstc)
{
}

61
static inline int __device_reset(struct device *dev, bool optional)
62
{
63
	return optional ? 0 : -ENOTSUPP;
64 65
}

66 67
static inline struct reset_control *__of_reset_control_get(
					struct device_node *node,
68 69
					const char *id, int index, bool shared,
					bool optional)
70
{
71
	return optional ? NULL : ERR_PTR(-ENOTSUPP);
72 73
}

74 75 76 77 78 79 80
static inline struct reset_control *__reset_control_get(
					struct device *dev, const char *id,
					int index, bool shared, bool optional)
{
	return optional ? NULL : ERR_PTR(-ENOTSUPP);
}

81
static inline struct reset_control *__devm_reset_control_get(
82 83
					struct device *dev, const char *id,
					int index, bool shared, bool optional)
84
{
85
	return optional ? NULL : ERR_PTR(-ENOTSUPP);
86 87
}

88 89 90 91 92 93 94 95 96 97 98 99
static inline struct reset_control *
devm_reset_control_array_get(struct device *dev, bool shared, bool optional)
{
	return optional ? NULL : ERR_PTR(-ENOTSUPP);
}

static inline struct reset_control *
of_reset_control_array_get(struct device_node *np, bool shared, bool optional)
{
	return optional ? NULL : ERR_PTR(-ENOTSUPP);
}

100 101
#endif /* CONFIG_RESET_CONTROLLER */

102 103 104 105 106 107 108 109 110 111
static inline int __must_check device_reset(struct device *dev)
{
	return __device_reset(dev, false);
}

static inline int device_reset_optional(struct device *dev)
{
	return __device_reset(dev, true);
}

112
/**
113 114
 * reset_control_get_exclusive - Lookup and obtain an exclusive reference
 *                               to a reset controller.
115 116 117 118
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
 * Returns a struct reset_control or IS_ERR() condition containing errno.
119
 * If this function is called more than once for the same reset_control it will
120 121 122 123
 * return -EBUSY.
 *
 * See reset_control_get_shared for details on shared references to
 * reset-controls.
124 125 126
 *
 * Use of id names is optional.
 */
127 128
static inline struct reset_control *
__must_check reset_control_get_exclusive(struct device *dev, const char *id)
129
{
130
	return __reset_control_get(dev, id, 0, false, false);
131 132
}

133
/**
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
 * 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)
{
158
	return __reset_control_get(dev, id, 0, true, false);
159 160
}

161
static inline struct reset_control *reset_control_get_optional_exclusive(
162 163
					struct device *dev, const char *id)
{
164
	return __reset_control_get(dev, id, 0, false, true);
165 166
}

167 168 169
static inline struct reset_control *reset_control_get_optional_shared(
					struct device *dev, const char *id)
{
170
	return __reset_control_get(dev, id, 0, true, true);
171 172
}

173
/**
174 175
 * of_reset_control_get_exclusive - Lookup and obtain an exclusive reference
 *                                  to a reset controller.
176 177 178 179 180 181 182
 * @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.
 */
183
static inline struct reset_control *of_reset_control_get_exclusive(
184 185
				struct device_node *node, const char *id)
{
186
	return __of_reset_control_get(node, id, 0, false, false);
187 188
}

189
/**
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
 * 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)
{
211
	return __of_reset_control_get(node, id, 0, true, false);
212 213
}

214
/**
215 216 217
 * of_reset_control_get_exclusive_by_index - Lookup and obtain an exclusive
 *                                           reference to a reset controller
 *                                           by index.
218 219 220 221 222 223 224
 * @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.
 */
225
static inline struct reset_control *of_reset_control_get_exclusive_by_index(
226
					struct device_node *node, int index)
227
{
228
	return __of_reset_control_get(node, NULL, index, false, false);
229 230
}

231
/**
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
 * 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.
248
 *
249 250 251
 * 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.
252
 */
253 254
static inline struct reset_control *of_reset_control_get_shared_by_index(
					struct device_node *node, int index)
255
{
256
	return __of_reset_control_get(node, NULL, index, true, false);
257 258 259
}

/**
260 261
 * devm_reset_control_get_exclusive - resource managed
 *                                    reset_control_get_exclusive()
262 263 264
 * @dev: device to be reset by the controller
 * @id: reset line name
 *
265 266 267 268 269
 * 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.
270
 */
271 272 273
static inline struct reset_control *
__must_check devm_reset_control_get_exclusive(struct device *dev,
					      const char *id)
274
{
275
	return __devm_reset_control_get(dev, id, 0, false, false);
276 277 278 279 280 281 282 283 284 285 286 287 288 289
}

/**
 * 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)
{
290
	return __devm_reset_control_get(dev, id, 0, true, false);
291 292
}

293
static inline struct reset_control *devm_reset_control_get_optional_exclusive(
294 295
					struct device *dev, const char *id)
{
296
	return __devm_reset_control_get(dev, id, 0, false, true);
297 298
}

299 300 301
static inline struct reset_control *devm_reset_control_get_optional_shared(
					struct device *dev, const char *id)
{
302
	return __devm_reset_control_get(dev, id, 0, true, true);
303 304
}

305
/**
306 307
 * devm_reset_control_get_exclusive_by_index - resource managed
 *                                             reset_control_get_exclusive()
308 309 310
 * @dev: device to be reset by the controller
 * @index: index of the reset controller
 *
311 312 313 314 315
 * 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.
316
 */
317 318
static inline struct reset_control *
devm_reset_control_get_exclusive_by_index(struct device *dev, int index)
319
{
320
	return __devm_reset_control_get(dev, NULL, index, false, false);
321 322 323 324 325 326 327 328 329 330 331 332
}

/**
 * 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.
 */
333 334
static inline struct reset_control *
devm_reset_control_get_shared_by_index(struct device *dev, int index)
335
{
336
	return __devm_reset_control_get(dev, NULL, index, true, false);
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 369 370 371 372 373 374 375 376
/*
 * 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 *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);
}
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

/*
 * APIs to manage a list of reset controllers
 */
static inline struct reset_control *
devm_reset_control_array_get_exclusive(struct device *dev)
{
	return devm_reset_control_array_get(dev, false, false);
}

static inline struct reset_control *
devm_reset_control_array_get_shared(struct device *dev)
{
	return devm_reset_control_array_get(dev, true, false);
}

static inline struct reset_control *
devm_reset_control_array_get_optional_exclusive(struct device *dev)
{
	return devm_reset_control_array_get(dev, false, true);
}

static inline struct reset_control *
devm_reset_control_array_get_optional_shared(struct device *dev)
{
	return devm_reset_control_array_get(dev, true, true);
}

static inline struct reset_control *
of_reset_control_array_get_exclusive(struct device_node *node)
{
	return of_reset_control_array_get(node, false, false);
}

static inline struct reset_control *
of_reset_control_array_get_shared(struct device_node *node)
{
	return of_reset_control_array_get(node, true, false);
}

static inline struct reset_control *
of_reset_control_array_get_optional_exclusive(struct device_node *node)
{
	return of_reset_control_array_get(node, false, true);
}

static inline struct reset_control *
of_reset_control_array_get_optional_shared(struct device_node *node)
{
	return of_reset_control_array_get(node, true, true);
}
428
#endif