1 // SPDX-License-Identifier: GPL-2.0+
3 * Device tree based initialization code for reserved memory.
5 * Copyright (c) 2013, 2015 The Linux Foundation. All Rights Reserved.
6 * Copyright (c) 2013,2014 Samsung Electronics Co., Ltd.
7 * http://www.samsung.com
8 * Author: Marek Szyprowski <m.szyprowski@samsung.com>
9 * Author: Josh Cartwright <joshc@codeaurora.org>
12 #define pr_fmt(fmt) "OF: reserved mem: " fmt
14 #include <linux/err.h>
16 #include <linux/of_fdt.h>
17 #include <linux/of_platform.h>
19 #include <linux/sizes.h>
20 #include <linux/of_reserved_mem.h>
21 #include <linux/sort.h>
22 #include <linux/slab.h>
23 #include <linux/memblock.h>
25 #include "of_private.h"
27 #define MAX_RESERVED_REGIONS 64
28 static struct reserved_mem reserved_mem[MAX_RESERVED_REGIONS];
29 static int reserved_mem_count;
31 static int __init early_init_dt_alloc_reserved_memory_arch(phys_addr_t size,
32 phys_addr_t align, phys_addr_t start, phys_addr_t end, bool nomap,
33 phys_addr_t *res_base)
37 end = !end ? MEMBLOCK_ALLOC_ANYWHERE : end;
38 align = !align ? SMP_CACHE_BYTES : align;
39 base = memblock_find_in_range(start, end, size, align);
45 return memblock_mark_nomap(base, size);
47 return memblock_reserve(base, size);
51 * fdt_reserved_mem_save_node() - save fdt node for second pass initialization
53 void __init fdt_reserved_mem_save_node(unsigned long node, const char *uname,
54 phys_addr_t base, phys_addr_t size)
56 struct reserved_mem *rmem = &reserved_mem[reserved_mem_count];
58 if (reserved_mem_count == ARRAY_SIZE(reserved_mem)) {
59 pr_err("not enough space for all defined regions.\n");
63 rmem->fdt_node = node;
73 * __reserved_mem_alloc_size() - allocate reserved memory described by
74 * 'size', 'alignment' and 'alloc-ranges' properties.
76 static int __init __reserved_mem_alloc_size(unsigned long node,
77 const char *uname, phys_addr_t *res_base, phys_addr_t *res_size)
79 int t_len = (dt_root_addr_cells + dt_root_size_cells) * sizeof(__be32);
80 phys_addr_t start = 0, end = 0;
81 phys_addr_t base = 0, align = 0, size;
87 prop = of_get_flat_dt_prop(node, "size", &len);
91 if (len != dt_root_size_cells * sizeof(__be32)) {
92 pr_err("invalid size property in '%s' node.\n", uname);
95 size = dt_mem_next_cell(dt_root_size_cells, &prop);
97 prop = of_get_flat_dt_prop(node, "alignment", &len);
99 if (len != dt_root_addr_cells * sizeof(__be32)) {
100 pr_err("invalid alignment property in '%s' node.\n",
104 align = dt_mem_next_cell(dt_root_addr_cells, &prop);
107 nomap = of_get_flat_dt_prop(node, "no-map", NULL) != NULL;
109 /* Need adjust the alignment to satisfy the CMA requirement */
110 if (IS_ENABLED(CONFIG_CMA)
111 && of_flat_dt_is_compatible(node, "shared-dma-pool")
112 && of_get_flat_dt_prop(node, "reusable", NULL)
114 unsigned long order =
115 max_t(unsigned long, MAX_ORDER - 1, pageblock_order);
117 align = max(align, (phys_addr_t)PAGE_SIZE << order);
120 prop = of_get_flat_dt_prop(node, "alloc-ranges", &len);
123 if (len % t_len != 0) {
124 pr_err("invalid alloc-ranges property in '%s', skipping node.\n",
132 start = dt_mem_next_cell(dt_root_addr_cells, &prop);
133 end = start + dt_mem_next_cell(dt_root_size_cells,
136 ret = early_init_dt_alloc_reserved_memory_arch(size,
137 align, start, end, nomap, &base);
139 pr_debug("allocated memory for '%s' node: base %pa, size %lu MiB\n",
141 (unsigned long)(size / SZ_1M));
148 ret = early_init_dt_alloc_reserved_memory_arch(size, align,
151 pr_debug("allocated memory for '%s' node: base %pa, size %lu MiB\n",
152 uname, &base, (unsigned long)(size / SZ_1M));
156 pr_info("failed to allocate memory for node '%s'\n", uname);
166 static const struct of_device_id __rmem_of_table_sentinel
167 __used __section("__reservedmem_of_table_end");
170 * __reserved_mem_init_node() - call region specific reserved memory init code
172 static int __init __reserved_mem_init_node(struct reserved_mem *rmem)
174 extern const struct of_device_id __reservedmem_of_table[];
175 const struct of_device_id *i;
178 for (i = __reservedmem_of_table; i < &__rmem_of_table_sentinel; i++) {
179 reservedmem_of_init_fn initfn = i->data;
180 const char *compat = i->compatible;
182 if (!of_flat_dt_is_compatible(rmem->fdt_node, compat))
187 pr_info("initialized node %s, compatible id %s\n",
195 static int __init __rmem_cmp(const void *a, const void *b)
197 const struct reserved_mem *ra = a, *rb = b;
199 if (ra->base < rb->base)
202 if (ra->base > rb->base)
206 * Put the dynamic allocations (address == 0, size == 0) before static
207 * allocations at address 0x0 so that overlap detection works
210 if (ra->size < rb->size)
212 if (ra->size > rb->size)
218 static void __init __rmem_check_for_overlap(void)
222 if (reserved_mem_count < 2)
225 sort(reserved_mem, reserved_mem_count, sizeof(reserved_mem[0]),
227 for (i = 0; i < reserved_mem_count - 1; i++) {
228 struct reserved_mem *this, *next;
230 this = &reserved_mem[i];
231 next = &reserved_mem[i + 1];
233 if (this->base + this->size > next->base) {
234 phys_addr_t this_end, next_end;
236 this_end = this->base + this->size;
237 next_end = next->base + next->size;
238 pr_err("OVERLAP DETECTED!\n%s (%pa--%pa) overlaps with %s (%pa--%pa)\n",
239 this->name, &this->base, &this_end,
240 next->name, &next->base, &next_end);
246 * fdt_init_reserved_mem() - allocate and init all saved reserved memory regions
248 void __init fdt_init_reserved_mem(void)
252 /* check for overlapping reserved regions */
253 __rmem_check_for_overlap();
255 for (i = 0; i < reserved_mem_count; i++) {
256 struct reserved_mem *rmem = &reserved_mem[i];
257 unsigned long node = rmem->fdt_node;
263 nomap = of_get_flat_dt_prop(node, "no-map", NULL) != NULL;
264 prop = of_get_flat_dt_prop(node, "phandle", &len);
266 prop = of_get_flat_dt_prop(node, "linux,phandle", &len);
268 rmem->phandle = of_read_number(prop, len/4);
271 err = __reserved_mem_alloc_size(node, rmem->name,
272 &rmem->base, &rmem->size);
274 err = __reserved_mem_init_node(rmem);
275 if (err != 0 && err != -ENOENT) {
276 pr_info("node %s compatible matching fail\n",
279 memblock_clear_nomap(rmem->base, rmem->size);
281 memblock_free(rmem->base, rmem->size);
287 static inline struct reserved_mem *__find_rmem(struct device_node *node)
294 for (i = 0; i < reserved_mem_count; i++)
295 if (reserved_mem[i].phandle == node->phandle)
296 return &reserved_mem[i];
300 struct rmem_assigned_device {
302 struct reserved_mem *rmem;
303 struct list_head list;
306 static LIST_HEAD(of_rmem_assigned_device_list);
307 static DEFINE_MUTEX(of_rmem_assigned_device_mutex);
310 * of_reserved_mem_device_init_by_idx() - assign reserved memory region to
312 * @dev: Pointer to the device to configure
313 * @np: Pointer to the device_node with 'reserved-memory' property
314 * @idx: Index of selected region
316 * This function assigns respective DMA-mapping operations based on reserved
317 * memory region specified by 'memory-region' property in @np node to the @dev
318 * device. When driver needs to use more than one reserved memory region, it
319 * should allocate child devices and initialize regions by name for each of
322 * Returns error code or zero on success.
324 int of_reserved_mem_device_init_by_idx(struct device *dev,
325 struct device_node *np, int idx)
327 struct rmem_assigned_device *rd;
328 struct device_node *target;
329 struct reserved_mem *rmem;
335 target = of_parse_phandle(np, "memory-region", idx);
339 if (!of_device_is_available(target)) {
344 rmem = __find_rmem(target);
347 if (!rmem || !rmem->ops || !rmem->ops->device_init)
350 rd = kmalloc(sizeof(struct rmem_assigned_device), GFP_KERNEL);
354 ret = rmem->ops->device_init(rmem, dev);
359 mutex_lock(&of_rmem_assigned_device_mutex);
360 list_add(&rd->list, &of_rmem_assigned_device_list);
361 mutex_unlock(&of_rmem_assigned_device_mutex);
363 dev_info(dev, "assigned reserved memory node %s\n", rmem->name);
370 EXPORT_SYMBOL_GPL(of_reserved_mem_device_init_by_idx);
373 * of_reserved_mem_device_init_by_name() - assign named reserved memory region
375 * @dev: pointer to the device to configure
376 * @np: pointer to the device node with 'memory-region' property
377 * @name: name of the selected memory region
379 * Returns: 0 on success or a negative error-code on failure.
381 int of_reserved_mem_device_init_by_name(struct device *dev,
382 struct device_node *np,
385 int idx = of_property_match_string(np, "memory-region-names", name);
387 return of_reserved_mem_device_init_by_idx(dev, np, idx);
389 EXPORT_SYMBOL_GPL(of_reserved_mem_device_init_by_name);
392 * of_reserved_mem_device_release() - release reserved memory device structures
393 * @dev: Pointer to the device to deconfigure
395 * This function releases structures allocated for memory region handling for
398 void of_reserved_mem_device_release(struct device *dev)
400 struct rmem_assigned_device *rd, *tmp;
401 LIST_HEAD(release_list);
403 mutex_lock(&of_rmem_assigned_device_mutex);
404 list_for_each_entry_safe(rd, tmp, &of_rmem_assigned_device_list, list) {
406 list_move_tail(&rd->list, &release_list);
408 mutex_unlock(&of_rmem_assigned_device_mutex);
410 list_for_each_entry_safe(rd, tmp, &release_list, list) {
411 if (rd->rmem && rd->rmem->ops && rd->rmem->ops->device_release)
412 rd->rmem->ops->device_release(rd->rmem, dev);
417 EXPORT_SYMBOL_GPL(of_reserved_mem_device_release);
420 * of_reserved_mem_lookup() - acquire reserved_mem from a device node
421 * @np: node pointer of the desired reserved-memory region
423 * This function allows drivers to acquire a reference to the reserved_mem
424 * struct based on a device node handle.
426 * Returns a reserved_mem reference, or NULL on error.
428 struct reserved_mem *of_reserved_mem_lookup(struct device_node *np)
436 name = kbasename(np->full_name);
437 for (i = 0; i < reserved_mem_count; i++)
438 if (!strcmp(reserved_mem[i].name, name))
439 return &reserved_mem[i];
443 EXPORT_SYMBOL_GPL(of_reserved_mem_lookup);