1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2015 Masahiro Yamada <yamada.masahiro@socionext.com>
5 * Based on the original work in Linux by
6 * Copyright (c) 2006 SUSE Linux Products GmbH
7 * Copyright (c) 2006 Tejun Heo <teheo@suse.de>
10 #define LOG_CATEGORY LOGC_DEVRES
13 #include <linux/compat.h>
14 #include <linux/kernel.h>
15 #include <linux/list.h>
16 #include <dm/device.h>
20 /** enum devres_phase - Shows where resource was allocated
22 * DEVRES_PHASE_BIND: In the bind() method
23 * DEVRES_PHASE_OFDATA: In the ofdata_to_platdata() method
24 * DEVRES_PHASE_PROBE: In the probe() method
33 * struct devres - Bookkeeping info for managed device resource
34 * @entry: List to associate this structure with a device
35 * @release: Callback invoked when this resource is released
36 * @probe: Show where this resource was allocated
37 * @name: Name of release function
38 * @size: Size of resource data
39 * @data: Resource data
42 struct list_head entry;
44 enum devres_phase phase;
45 #ifdef CONFIG_DEBUG_DEVRES
49 unsigned long long data[];
52 #ifdef CONFIG_DEBUG_DEVRES
53 static void set_node_dbginfo(struct devres *dr, const char *name, size_t size)
59 static void devres_log(struct udevice *dev, struct devres *dr,
62 log_debug("%s: DEVRES %3s %p %s (%lu bytes)\n", dev->name, op, dr,
63 dr->name, (unsigned long)dr->size);
65 #else /* CONFIG_DEBUG_DEVRES */
66 #define set_node_dbginfo(dr, n, s) do {} while (0)
67 #define devres_log(dev, dr, op) do {} while (0)
70 #if CONFIG_DEBUG_DEVRES
71 void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
74 void *_devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
77 size_t tot_size = sizeof(struct devres) + size;
80 dr = kmalloc(tot_size, gfp);
84 INIT_LIST_HEAD(&dr->entry);
85 dr->release = release;
86 set_node_dbginfo(dr, name, size);
91 void devres_free(void *res)
94 struct devres *dr = container_of(res, struct devres, data);
96 assert_noisy(list_empty(&dr->entry));
101 void devres_add(struct udevice *dev, void *res)
103 struct devres *dr = container_of(res, struct devres, data);
105 devres_log(dev, dr, "ADD");
106 assert_noisy(list_empty(&dr->entry));
107 if (dev->flags & DM_FLAG_PLATDATA_VALID)
108 dr->phase = DEVRES_PHASE_PROBE;
109 else if (dev->flags & DM_FLAG_BOUND)
110 dr->phase = DEVRES_PHASE_OFDATA;
112 dr->phase = DEVRES_PHASE_BIND;
113 list_add_tail(&dr->entry, &dev->devres_head);
116 void *devres_find(struct udevice *dev, dr_release_t release,
117 dr_match_t match, void *match_data)
121 list_for_each_entry_reverse(dr, &dev->devres_head, entry) {
122 if (dr->release != release)
124 if (match && !match(dev, dr->data, match_data))
132 void *devres_get(struct udevice *dev, void *new_res,
133 dr_match_t match, void *match_data)
135 struct devres *new_dr = container_of(new_res, struct devres, data);
138 res = devres_find(dev, new_dr->release, match, match_data);
140 devres_add(dev, new_res);
144 devres_free(new_res);
149 void *devres_remove(struct udevice *dev, dr_release_t release,
150 dr_match_t match, void *match_data)
154 res = devres_find(dev, release, match, match_data);
156 struct devres *dr = container_of(res, struct devres, data);
158 list_del_init(&dr->entry);
159 devres_log(dev, dr, "REM");
165 int devres_destroy(struct udevice *dev, dr_release_t release,
166 dr_match_t match, void *match_data)
170 res = devres_remove(dev, release, match, match_data);
178 int devres_release(struct udevice *dev, dr_release_t release,
179 dr_match_t match, void *match_data)
183 res = devres_remove(dev, release, match, match_data);
187 (*release)(dev, res);
192 static void release_nodes(struct udevice *dev, struct list_head *head,
193 bool probe_and_ofdata_only)
195 struct devres *dr, *tmp;
197 list_for_each_entry_safe_reverse(dr, tmp, head, entry) {
198 if (probe_and_ofdata_only && dr->phase == DEVRES_PHASE_BIND)
200 devres_log(dev, dr, "REL");
201 dr->release(dev, dr->data);
202 list_del(&dr->entry);
207 void devres_release_probe(struct udevice *dev)
209 release_nodes(dev, &dev->devres_head, true);
212 void devres_release_all(struct udevice *dev)
214 release_nodes(dev, &dev->devres_head, false);
217 #ifdef CONFIG_DEBUG_DEVRES
218 static char *const devres_phase_name[] = {"BIND", "OFDATA", "PROBE"};
220 static void dump_resources(struct udevice *dev, int depth)
223 struct udevice *child;
225 printf("- %s\n", dev->name);
227 list_for_each_entry(dr, &dev->devres_head, entry)
228 printf(" %p (%lu byte) %s %s\n", dr,
229 (unsigned long)dr->size, dr->name,
230 devres_phase_name[dr->phase]);
232 list_for_each_entry(child, &dev->child_head, sibling_node)
233 dump_resources(child, depth + 1);
236 void dm_dump_devres(void)
238 struct udevice *root;
242 dump_resources(root, 0);
245 void devres_get_stats(const struct udevice *dev, struct devres_stats *stats)
250 stats->total_size = 0;
251 list_for_each_entry(dr, &dev->devres_head, entry) {
253 stats->total_size += dr->size;
260 * Managed kmalloc/kfree
262 static void devm_kmalloc_release(struct udevice *dev, void *res)
267 static int devm_kmalloc_match(struct udevice *dev, void *res, void *data)
272 void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp)
276 data = _devres_alloc(devm_kmalloc_release, size, gfp);
280 devres_add(dev, data);
285 void devm_kfree(struct udevice *dev, void *p)
289 rc = devres_destroy(dev, devm_kmalloc_release, devm_kmalloc_match, p);