1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Reset Controller framework
5 * Copyright 2013 Philipp Zabel, Pengutronix
7 #include <linux/atomic.h>
8 #include <linux/device.h>
10 #include <linux/export.h>
11 #include <linux/kernel.h>
12 #include <linux/kref.h>
13 #include <linux/module.h>
15 #include <linux/reset.h>
16 #include <linux/reset-controller.h>
17 #include <linux/slab.h>
19 static DEFINE_MUTEX(reset_list_mutex);
20 static LIST_HEAD(reset_controller_list);
22 static DEFINE_MUTEX(reset_lookup_mutex);
23 static LIST_HEAD(reset_lookup_list);
26 * struct reset_control - a reset control
27 * @rcdev: a pointer to the reset controller device
28 * this reset control belongs to
29 * @list: list entry for the rcdev's reset controller list
30 * @id: ID of the reset controller in the reset
32 * @refcnt: Number of gets of this reset_control
33 * @acquired: Only one reset_control may be acquired for a given rcdev and id.
34 * @shared: Is this a shared (1), or an exclusive (0) reset_control?
35 * @deassert_cnt: Number of times this reset line has been deasserted
36 * @triggered_count: Number of times this reset line has been reset. Currently
37 * only used for shared resets, which means that the value
38 * will be either 0 or 1.
40 struct reset_control {
41 struct reset_controller_dev *rcdev;
42 struct list_head list;
48 atomic_t deassert_count;
49 atomic_t triggered_count;
53 * struct reset_control_array - an array of reset controls
54 * @base: reset control for compatibility with reset control API functions
55 * @num_rstcs: number of reset controls
56 * @rstc: array of reset controls
58 struct reset_control_array {
59 struct reset_control base;
60 unsigned int num_rstcs;
61 struct reset_control *rstc[];
64 static const char *rcdev_name(struct reset_controller_dev *rcdev)
67 return dev_name(rcdev->dev);
70 return rcdev->of_node->full_name;
76 * of_reset_simple_xlate - translate reset_spec to the reset line number
77 * @rcdev: a pointer to the reset controller device
78 * @reset_spec: reset line specifier as found in the device tree
80 * This static translation function is used by default if of_xlate in
81 * :c:type:`reset_controller_dev` is not set. It is useful for all reset
82 * controllers with 1:1 mapping, where reset lines can be indexed by number
85 static int of_reset_simple_xlate(struct reset_controller_dev *rcdev,
86 const struct of_phandle_args *reset_spec)
88 if (reset_spec->args[0] >= rcdev->nr_resets)
91 return reset_spec->args[0];
95 * reset_controller_register - register a reset controller device
96 * @rcdev: a pointer to the initialized reset controller device
98 int reset_controller_register(struct reset_controller_dev *rcdev)
100 if (!rcdev->of_xlate) {
101 rcdev->of_reset_n_cells = 1;
102 rcdev->of_xlate = of_reset_simple_xlate;
105 INIT_LIST_HEAD(&rcdev->reset_control_head);
107 mutex_lock(&reset_list_mutex);
108 list_add(&rcdev->list, &reset_controller_list);
109 mutex_unlock(&reset_list_mutex);
113 EXPORT_SYMBOL_GPL(reset_controller_register);
116 * reset_controller_unregister - unregister a reset controller device
117 * @rcdev: a pointer to the reset controller device
119 void reset_controller_unregister(struct reset_controller_dev *rcdev)
121 mutex_lock(&reset_list_mutex);
122 list_del(&rcdev->list);
123 mutex_unlock(&reset_list_mutex);
125 EXPORT_SYMBOL_GPL(reset_controller_unregister);
127 static void devm_reset_controller_release(struct device *dev, void *res)
129 reset_controller_unregister(*(struct reset_controller_dev **)res);
133 * devm_reset_controller_register - resource managed reset_controller_register()
134 * @dev: device that is registering this reset controller
135 * @rcdev: a pointer to the initialized reset controller device
137 * Managed reset_controller_register(). For reset controllers registered by
138 * this function, reset_controller_unregister() is automatically called on
139 * driver detach. See reset_controller_register() for more information.
141 int devm_reset_controller_register(struct device *dev,
142 struct reset_controller_dev *rcdev)
144 struct reset_controller_dev **rcdevp;
147 rcdevp = devres_alloc(devm_reset_controller_release, sizeof(*rcdevp),
152 ret = reset_controller_register(rcdev);
159 devres_add(dev, rcdevp);
163 EXPORT_SYMBOL_GPL(devm_reset_controller_register);
166 * reset_controller_add_lookup - register a set of lookup entries
167 * @lookup: array of reset lookup entries
168 * @num_entries: number of entries in the lookup array
170 void reset_controller_add_lookup(struct reset_control_lookup *lookup,
171 unsigned int num_entries)
173 struct reset_control_lookup *entry;
176 mutex_lock(&reset_lookup_mutex);
177 for (i = 0; i < num_entries; i++) {
180 if (!entry->dev_id || !entry->provider) {
181 pr_warn("%s(): reset lookup entry badly specified, skipping\n",
186 list_add_tail(&entry->list, &reset_lookup_list);
188 mutex_unlock(&reset_lookup_mutex);
190 EXPORT_SYMBOL_GPL(reset_controller_add_lookup);
192 static inline struct reset_control_array *
193 rstc_to_array(struct reset_control *rstc) {
194 return container_of(rstc, struct reset_control_array, base);
197 static int reset_control_array_reset(struct reset_control_array *resets)
201 for (i = 0; i < resets->num_rstcs; i++) {
202 ret = reset_control_reset(resets->rstc[i]);
210 static int reset_control_array_assert(struct reset_control_array *resets)
214 for (i = 0; i < resets->num_rstcs; i++) {
215 ret = reset_control_assert(resets->rstc[i]);
224 reset_control_deassert(resets->rstc[i]);
228 static int reset_control_array_deassert(struct reset_control_array *resets)
232 for (i = 0; i < resets->num_rstcs; i++) {
233 ret = reset_control_deassert(resets->rstc[i]);
242 reset_control_assert(resets->rstc[i]);
246 static int reset_control_array_acquire(struct reset_control_array *resets)
251 for (i = 0; i < resets->num_rstcs; i++) {
252 err = reset_control_acquire(resets->rstc[i]);
261 reset_control_release(resets->rstc[i]);
266 static void reset_control_array_release(struct reset_control_array *resets)
270 for (i = 0; i < resets->num_rstcs; i++)
271 reset_control_release(resets->rstc[i]);
274 static inline bool reset_control_is_array(struct reset_control *rstc)
280 * reset_control_reset - reset the controlled device
281 * @rstc: reset controller
283 * On a shared reset line the actual reset pulse is only triggered once for the
284 * lifetime of the reset_control instance: for all but the first caller this is
286 * Consumers must not use reset_control_(de)assert on shared reset lines when
287 * reset_control_reset has been used.
289 * If rstc is NULL it is an optional reset and the function will just
292 int reset_control_reset(struct reset_control *rstc)
299 if (WARN_ON(IS_ERR(rstc)))
302 if (reset_control_is_array(rstc))
303 return reset_control_array_reset(rstc_to_array(rstc));
305 if (!rstc->rcdev->ops->reset)
309 if (WARN_ON(atomic_read(&rstc->deassert_count) != 0))
312 if (atomic_inc_return(&rstc->triggered_count) != 1)
319 ret = rstc->rcdev->ops->reset(rstc->rcdev, rstc->id);
320 if (rstc->shared && ret)
321 atomic_dec(&rstc->triggered_count);
325 EXPORT_SYMBOL_GPL(reset_control_reset);
328 * reset_control_assert - asserts the reset line
329 * @rstc: reset controller
331 * Calling this on an exclusive reset controller guarantees that the reset
332 * will be asserted. When called on a shared reset controller the line may
333 * still be deasserted, as long as other users keep it so.
335 * For shared reset controls a driver cannot expect the hw's registers and
336 * internal state to be reset, but must be prepared for this to happen.
337 * Consumers must not use reset_control_reset on shared reset lines when
338 * reset_control_(de)assert has been used.
340 * If rstc is NULL it is an optional reset and the function will just
343 int reset_control_assert(struct reset_control *rstc)
348 if (WARN_ON(IS_ERR(rstc)))
351 if (reset_control_is_array(rstc))
352 return reset_control_array_assert(rstc_to_array(rstc));
355 if (WARN_ON(atomic_read(&rstc->triggered_count) != 0))
358 if (WARN_ON(atomic_read(&rstc->deassert_count) == 0))
361 if (atomic_dec_return(&rstc->deassert_count) != 0)
365 * Shared reset controls allow the reset line to be in any state
366 * after this call, so doing nothing is a valid option.
368 if (!rstc->rcdev->ops->assert)
372 * If the reset controller does not implement .assert(), there
373 * is no way to guarantee that the reset line is asserted after
376 if (!rstc->rcdev->ops->assert)
379 if (!rstc->acquired) {
380 WARN(1, "reset %s (ID: %u) is not acquired\n",
381 rcdev_name(rstc->rcdev), rstc->id);
386 return rstc->rcdev->ops->assert(rstc->rcdev, rstc->id);
388 EXPORT_SYMBOL_GPL(reset_control_assert);
391 * reset_control_deassert - deasserts the reset line
392 * @rstc: reset controller
394 * After calling this function, the reset is guaranteed to be deasserted.
395 * Consumers must not use reset_control_reset on shared reset lines when
396 * reset_control_(de)assert has been used.
398 * If rstc is NULL it is an optional reset and the function will just
401 int reset_control_deassert(struct reset_control *rstc)
406 if (WARN_ON(IS_ERR(rstc)))
409 if (reset_control_is_array(rstc))
410 return reset_control_array_deassert(rstc_to_array(rstc));
413 if (WARN_ON(atomic_read(&rstc->triggered_count) != 0))
416 if (atomic_inc_return(&rstc->deassert_count) != 1)
419 if (!rstc->acquired) {
420 WARN(1, "reset %s (ID: %u) is not acquired\n",
421 rcdev_name(rstc->rcdev), rstc->id);
427 * If the reset controller does not implement .deassert(), we assume
428 * that it handles self-deasserting reset lines via .reset(). In that
429 * case, the reset lines are deasserted by default. If that is not the
430 * case, the reset controller driver should implement .deassert() and
433 if (!rstc->rcdev->ops->deassert)
436 return rstc->rcdev->ops->deassert(rstc->rcdev, rstc->id);
438 EXPORT_SYMBOL_GPL(reset_control_deassert);
441 * reset_control_status - returns a negative errno if not supported, a
442 * positive value if the reset line is asserted, or zero if the reset
443 * line is not asserted or if the desc is NULL (optional reset).
444 * @rstc: reset controller
446 int reset_control_status(struct reset_control *rstc)
451 if (WARN_ON(IS_ERR(rstc)) || reset_control_is_array(rstc))
454 if (rstc->rcdev->ops->status)
455 return rstc->rcdev->ops->status(rstc->rcdev, rstc->id);
459 EXPORT_SYMBOL_GPL(reset_control_status);
462 * reset_control_acquire() - acquires a reset control for exclusive use
463 * @rstc: reset control
465 * This is used to explicitly acquire a reset control for exclusive use. Note
466 * that exclusive resets are requested as acquired by default. In order for a
467 * second consumer to be able to control the reset, the first consumer has to
468 * release it first. Typically the easiest way to achieve this is to call the
469 * reset_control_get_exclusive_released() to obtain an instance of the reset
470 * control. Such reset controls are not acquired by default.
472 * Consumers implementing shared access to an exclusive reset need to follow
473 * a specific protocol in order to work together. Before consumers can change
474 * a reset they must acquire exclusive access using reset_control_acquire().
475 * After they are done operating the reset, they must release exclusive access
476 * with a call to reset_control_release(). Consumers are not granted exclusive
477 * access to the reset as long as another consumer hasn't released a reset.
479 * See also: reset_control_release()
481 int reset_control_acquire(struct reset_control *rstc)
483 struct reset_control *rc;
488 if (WARN_ON(IS_ERR(rstc)))
491 if (reset_control_is_array(rstc))
492 return reset_control_array_acquire(rstc_to_array(rstc));
494 mutex_lock(&reset_list_mutex);
496 if (rstc->acquired) {
497 mutex_unlock(&reset_list_mutex);
501 list_for_each_entry(rc, &rstc->rcdev->reset_control_head, list) {
502 if (rstc != rc && rstc->id == rc->id) {
504 mutex_unlock(&reset_list_mutex);
510 rstc->acquired = true;
512 mutex_unlock(&reset_list_mutex);
515 EXPORT_SYMBOL_GPL(reset_control_acquire);
518 * reset_control_release() - releases exclusive access to a reset control
519 * @rstc: reset control
521 * Releases exclusive access right to a reset control previously obtained by a
522 * call to reset_control_acquire(). Until a consumer calls this function, no
523 * other consumers will be granted exclusive access.
525 * See also: reset_control_acquire()
527 void reset_control_release(struct reset_control *rstc)
529 if (!rstc || WARN_ON(IS_ERR(rstc)))
532 if (reset_control_is_array(rstc))
533 reset_control_array_release(rstc_to_array(rstc));
535 rstc->acquired = false;
537 EXPORT_SYMBOL_GPL(reset_control_release);
539 static struct reset_control *__reset_control_get_internal(
540 struct reset_controller_dev *rcdev,
541 unsigned int index, bool shared, bool acquired)
543 struct reset_control *rstc;
545 lockdep_assert_held(&reset_list_mutex);
547 list_for_each_entry(rstc, &rcdev->reset_control_head, list) {
548 if (rstc->id == index) {
550 * Allow creating a secondary exclusive reset_control
551 * that is initially not acquired for an already
552 * controlled reset line.
554 if (!rstc->shared && !shared && !acquired)
557 if (WARN_ON(!rstc->shared || !shared))
558 return ERR_PTR(-EBUSY);
560 kref_get(&rstc->refcnt);
565 rstc = kzalloc(sizeof(*rstc), GFP_KERNEL);
567 return ERR_PTR(-ENOMEM);
569 try_module_get(rcdev->owner);
572 list_add(&rstc->list, &rcdev->reset_control_head);
574 kref_init(&rstc->refcnt);
575 rstc->acquired = acquired;
576 rstc->shared = shared;
581 static void __reset_control_release(struct kref *kref)
583 struct reset_control *rstc = container_of(kref, struct reset_control,
586 lockdep_assert_held(&reset_list_mutex);
588 module_put(rstc->rcdev->owner);
590 list_del(&rstc->list);
594 static void __reset_control_put_internal(struct reset_control *rstc)
596 lockdep_assert_held(&reset_list_mutex);
598 kref_put(&rstc->refcnt, __reset_control_release);
601 struct reset_control *__of_reset_control_get(struct device_node *node,
602 const char *id, int index, bool shared,
603 bool optional, bool acquired)
605 struct reset_control *rstc;
606 struct reset_controller_dev *r, *rcdev;
607 struct of_phandle_args args;
612 return ERR_PTR(-EINVAL);
615 index = of_property_match_string(node,
617 if (index == -EILSEQ)
618 return ERR_PTR(index);
620 return optional ? NULL : ERR_PTR(-ENOENT);
623 ret = of_parse_phandle_with_args(node, "resets", "#reset-cells",
628 return optional ? NULL : ERR_PTR(ret);
630 mutex_lock(&reset_list_mutex);
632 list_for_each_entry(r, &reset_controller_list, list) {
633 if (args.np == r->of_node) {
640 rstc = ERR_PTR(-EPROBE_DEFER);
644 if (WARN_ON(args.args_count != rcdev->of_reset_n_cells)) {
645 rstc = ERR_PTR(-EINVAL);
649 rstc_id = rcdev->of_xlate(rcdev, &args);
651 rstc = ERR_PTR(rstc_id);
655 /* reset_list_mutex also protects the rcdev's reset_control list */
656 rstc = __reset_control_get_internal(rcdev, rstc_id, shared, acquired);
659 mutex_unlock(&reset_list_mutex);
660 of_node_put(args.np);
664 EXPORT_SYMBOL_GPL(__of_reset_control_get);
666 static struct reset_controller_dev *
667 __reset_controller_by_name(const char *name)
669 struct reset_controller_dev *rcdev;
671 lockdep_assert_held(&reset_list_mutex);
673 list_for_each_entry(rcdev, &reset_controller_list, list) {
677 if (!strcmp(name, dev_name(rcdev->dev)))
684 static struct reset_control *
685 __reset_control_get_from_lookup(struct device *dev, const char *con_id,
686 bool shared, bool optional, bool acquired)
688 const struct reset_control_lookup *lookup;
689 struct reset_controller_dev *rcdev;
690 const char *dev_id = dev_name(dev);
691 struct reset_control *rstc = NULL;
693 mutex_lock(&reset_lookup_mutex);
695 list_for_each_entry(lookup, &reset_lookup_list, list) {
696 if (strcmp(lookup->dev_id, dev_id))
699 if ((!con_id && !lookup->con_id) ||
700 ((con_id && lookup->con_id) &&
701 !strcmp(con_id, lookup->con_id))) {
702 mutex_lock(&reset_list_mutex);
703 rcdev = __reset_controller_by_name(lookup->provider);
705 mutex_unlock(&reset_list_mutex);
706 mutex_unlock(&reset_lookup_mutex);
707 /* Reset provider may not be ready yet. */
708 return ERR_PTR(-EPROBE_DEFER);
711 rstc = __reset_control_get_internal(rcdev,
714 mutex_unlock(&reset_list_mutex);
719 mutex_unlock(&reset_lookup_mutex);
722 return optional ? NULL : ERR_PTR(-ENOENT);
727 struct reset_control *__reset_control_get(struct device *dev, const char *id,
728 int index, bool shared, bool optional,
731 if (WARN_ON(shared && acquired))
732 return ERR_PTR(-EINVAL);
735 return __of_reset_control_get(dev->of_node, id, index, shared,
738 return __reset_control_get_from_lookup(dev, id, shared, optional,
741 EXPORT_SYMBOL_GPL(__reset_control_get);
743 static void reset_control_array_put(struct reset_control_array *resets)
747 mutex_lock(&reset_list_mutex);
748 for (i = 0; i < resets->num_rstcs; i++)
749 __reset_control_put_internal(resets->rstc[i]);
750 mutex_unlock(&reset_list_mutex);
755 * reset_control_put - free the reset controller
756 * @rstc: reset controller
758 void reset_control_put(struct reset_control *rstc)
760 if (IS_ERR_OR_NULL(rstc))
763 if (reset_control_is_array(rstc)) {
764 reset_control_array_put(rstc_to_array(rstc));
768 mutex_lock(&reset_list_mutex);
769 __reset_control_put_internal(rstc);
770 mutex_unlock(&reset_list_mutex);
772 EXPORT_SYMBOL_GPL(reset_control_put);
774 static void devm_reset_control_release(struct device *dev, void *res)
776 reset_control_put(*(struct reset_control **)res);
779 struct reset_control *__devm_reset_control_get(struct device *dev,
780 const char *id, int index, bool shared,
781 bool optional, bool acquired)
783 struct reset_control **ptr, *rstc;
785 ptr = devres_alloc(devm_reset_control_release, sizeof(*ptr),
788 return ERR_PTR(-ENOMEM);
790 rstc = __reset_control_get(dev, id, index, shared, optional, acquired);
791 if (IS_ERR_OR_NULL(rstc)) {
797 devres_add(dev, ptr);
801 EXPORT_SYMBOL_GPL(__devm_reset_control_get);
804 * device_reset - find reset controller associated with the device
806 * @dev: device to be reset by the controller
807 * @optional: whether it is optional to reset the device
809 * Convenience wrapper for __reset_control_get() and reset_control_reset().
810 * This is useful for the common case of devices with single, dedicated reset
813 int __device_reset(struct device *dev, bool optional)
815 struct reset_control *rstc;
818 rstc = __reset_control_get(dev, NULL, 0, 0, optional, true);
820 return PTR_ERR(rstc);
822 ret = reset_control_reset(rstc);
824 reset_control_put(rstc);
828 EXPORT_SYMBOL_GPL(__device_reset);
831 * APIs to manage an array of reset controls.
835 * of_reset_control_get_count - Count number of resets available with a device
837 * @node: device node that contains 'resets'.
839 * Returns positive reset count on success, or error number on failure and
840 * on count being zero.
842 static int of_reset_control_get_count(struct device_node *node)
849 count = of_count_phandle_with_args(node, "resets", "#reset-cells");
857 * of_reset_control_array_get - Get a list of reset controls using
860 * @np: device node for the device that requests the reset controls array
861 * @shared: whether reset controls are shared or not
862 * @optional: whether it is optional to get the reset controls
863 * @acquired: only one reset control may be acquired for a given controller
866 * Returns pointer to allocated reset_control on success or error on failure
868 struct reset_control *
869 of_reset_control_array_get(struct device_node *np, bool shared, bool optional,
872 struct reset_control_array *resets;
873 struct reset_control *rstc;
876 num = of_reset_control_get_count(np);
878 return optional ? NULL : ERR_PTR(num);
880 resets = kzalloc(struct_size(resets, rstc, num), GFP_KERNEL);
882 return ERR_PTR(-ENOMEM);
884 for (i = 0; i < num; i++) {
885 rstc = __of_reset_control_get(np, NULL, i, shared, optional,
889 resets->rstc[i] = rstc;
891 resets->num_rstcs = num;
892 resets->base.array = true;
894 return &resets->base;
897 mutex_lock(&reset_list_mutex);
899 __reset_control_put_internal(resets->rstc[i]);
900 mutex_unlock(&reset_list_mutex);
906 EXPORT_SYMBOL_GPL(of_reset_control_array_get);
909 * devm_reset_control_array_get - Resource managed reset control array get
911 * @dev: device that requests the list of reset controls
912 * @shared: whether reset controls are shared or not
913 * @optional: whether it is optional to get the reset controls
915 * The reset control array APIs are intended for a list of resets
916 * that just have to be asserted or deasserted, without any
917 * requirements on the order.
919 * Returns pointer to allocated reset_control on success or error on failure
921 struct reset_control *
922 devm_reset_control_array_get(struct device *dev, bool shared, bool optional)
924 struct reset_control **ptr, *rstc;
926 ptr = devres_alloc(devm_reset_control_release, sizeof(*ptr),
929 return ERR_PTR(-ENOMEM);
931 rstc = of_reset_control_array_get(dev->of_node, shared, optional, true);
932 if (IS_ERR_OR_NULL(rstc)) {
938 devres_add(dev, ptr);
942 EXPORT_SYMBOL_GPL(devm_reset_control_array_get);
944 static int reset_control_get_count_from_lookup(struct device *dev)
946 const struct reset_control_lookup *lookup;
953 dev_id = dev_name(dev);
954 mutex_lock(&reset_lookup_mutex);
956 list_for_each_entry(lookup, &reset_lookup_list, list) {
957 if (!strcmp(lookup->dev_id, dev_id))
961 mutex_unlock(&reset_lookup_mutex);
970 * reset_control_get_count - Count number of resets available with a device
972 * @dev: device for which to return the number of resets
974 * Returns positive reset count on success, or error number on failure and
975 * on count being zero.
977 int reset_control_get_count(struct device *dev)
980 return of_reset_control_get_count(dev->of_node);
982 return reset_control_get_count_from_lookup(dev);
984 EXPORT_SYMBOL_GPL(reset_control_get_count);