1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/kernel/resource.c
5 * Copyright (C) 1999 Linus Torvalds
6 * Copyright (C) 1999 Martin Mares <mj@ucw.cz>
8 * Arbitrary resource management.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/export.h>
14 #include <linux/errno.h>
15 #include <linux/ioport.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/spinlock.h>
20 #include <linux/proc_fs.h>
21 #include <linux/sched.h>
22 #include <linux/seq_file.h>
23 #include <linux/device.h>
24 #include <linux/pfn.h>
26 #include <linux/resource_ext.h>
30 struct resource ioport_resource = {
33 .end = IO_SPACE_LIMIT,
34 .flags = IORESOURCE_IO,
36 EXPORT_SYMBOL(ioport_resource);
38 struct resource iomem_resource = {
42 .flags = IORESOURCE_MEM,
44 EXPORT_SYMBOL(iomem_resource);
46 /* constraints to be met while allocating resources */
47 struct resource_constraint {
48 resource_size_t min, max, align;
49 resource_size_t (*alignf)(void *, const struct resource *,
50 resource_size_t, resource_size_t);
54 static DEFINE_RWLOCK(resource_lock);
57 * For memory hotplug, there is no way to free resource entries allocated
58 * by boot mem after the system is up. So for reusing the resource entry
59 * we need to remember the resource.
61 static struct resource *bootmem_resource_free;
62 static DEFINE_SPINLOCK(bootmem_resource_lock);
64 static struct resource *next_resource(struct resource *p, bool sibling_only)
66 /* Caller wants to traverse through siblings only */
72 while (!p->sibling && p->parent)
77 static void *r_next(struct seq_file *m, void *v, loff_t *pos)
79 struct resource *p = v;
81 return (void *)next_resource(p, false);
86 enum { MAX_IORES_LEVEL = 5 };
88 static void *r_start(struct seq_file *m, loff_t *pos)
89 __acquires(resource_lock)
91 struct resource *p = PDE_DATA(file_inode(m->file));
93 read_lock(&resource_lock);
94 for (p = p->child; p && l < *pos; p = r_next(m, p, &l))
99 static void r_stop(struct seq_file *m, void *v)
100 __releases(resource_lock)
102 read_unlock(&resource_lock);
105 static int r_show(struct seq_file *m, void *v)
107 struct resource *root = PDE_DATA(file_inode(m->file));
108 struct resource *r = v, *p;
109 unsigned long long start, end;
110 int width = root->end < 0x10000 ? 4 : 8;
113 for (depth = 0, p = r; depth < MAX_IORES_LEVEL; depth++, p = p->parent)
114 if (p->parent == root)
117 if (file_ns_capable(m->file, &init_user_ns, CAP_SYS_ADMIN)) {
124 seq_printf(m, "%*s%0*llx-%0*llx : %s\n",
128 r->name ? r->name : "<BAD>");
132 static const struct seq_operations resource_op = {
139 static int __init ioresources_init(void)
141 proc_create_seq_data("ioports", 0, NULL, &resource_op,
143 proc_create_seq_data("iomem", 0, NULL, &resource_op, &iomem_resource);
146 __initcall(ioresources_init);
148 #endif /* CONFIG_PROC_FS */
150 static void free_resource(struct resource *res)
155 if (!PageSlab(virt_to_head_page(res))) {
156 spin_lock(&bootmem_resource_lock);
157 res->sibling = bootmem_resource_free;
158 bootmem_resource_free = res;
159 spin_unlock(&bootmem_resource_lock);
165 static struct resource *alloc_resource(gfp_t flags)
167 struct resource *res = NULL;
169 spin_lock(&bootmem_resource_lock);
170 if (bootmem_resource_free) {
171 res = bootmem_resource_free;
172 bootmem_resource_free = res->sibling;
174 spin_unlock(&bootmem_resource_lock);
177 memset(res, 0, sizeof(struct resource));
179 res = kzalloc(sizeof(struct resource), flags);
184 /* Return the conflict entry if you can't request it */
185 static struct resource * __request_resource(struct resource *root, struct resource *new)
187 resource_size_t start = new->start;
188 resource_size_t end = new->end;
189 struct resource *tmp, **p;
193 if (start < root->start)
200 if (!tmp || tmp->start > end) {
207 if (tmp->end < start)
213 static int __release_resource(struct resource *old, bool release_child)
215 struct resource *tmp, **p, *chd;
218 WARN(old->sibling, "sibling but no parent");
223 p = &old->parent->child;
229 if (release_child || !(tmp->child)) {
232 for (chd = tmp->child;; chd = chd->sibling) {
233 chd->parent = tmp->parent;
238 chd->sibling = tmp->sibling;
248 static void __release_child_resources(struct resource *r)
250 struct resource *tmp, *p;
251 resource_size_t size;
261 __release_child_resources(tmp);
263 printk(KERN_DEBUG "release child resource %pR\n", tmp);
264 /* need to restore size, and keep flags */
265 size = resource_size(tmp);
271 void release_child_resources(struct resource *r)
273 write_lock(&resource_lock);
274 __release_child_resources(r);
275 write_unlock(&resource_lock);
279 * request_resource_conflict - request and reserve an I/O or memory resource
280 * @root: root resource descriptor
281 * @new: resource descriptor desired by caller
283 * Returns 0 for success, conflict resource on error.
285 struct resource *request_resource_conflict(struct resource *root, struct resource *new)
287 struct resource *conflict;
289 write_lock(&resource_lock);
290 conflict = __request_resource(root, new);
291 write_unlock(&resource_lock);
296 * request_resource - request and reserve an I/O or memory resource
297 * @root: root resource descriptor
298 * @new: resource descriptor desired by caller
300 * Returns 0 for success, negative error code on error.
302 int request_resource(struct resource *root, struct resource *new)
304 struct resource *conflict;
306 conflict = request_resource_conflict(root, new);
307 return conflict ? -EBUSY : 0;
310 EXPORT_SYMBOL(request_resource);
313 * release_resource - release a previously reserved resource
314 * @old: resource pointer
316 int release_resource(struct resource *old)
320 write_lock(&resource_lock);
321 retval = __release_resource(old, true);
322 write_unlock(&resource_lock);
326 EXPORT_SYMBOL(release_resource);
329 * Finds the lowest iomem resource that covers part of [@start..@end]. The
330 * caller must specify @start, @end, @flags, and @desc (which may be
333 * If a resource is found, returns 0 and @*res is overwritten with the part
334 * of the resource that's within [@start..@end]; if none is found, returns
335 * -ENODEV. Returns -EINVAL for invalid parameters.
337 * This function walks the whole tree and not just first level children
338 * unless @first_lvl is true.
340 * @start: start address of the resource searched for
341 * @end: end address of same resource
342 * @flags: flags which the resource must have
343 * @desc: descriptor the resource must have
344 * @first_lvl: walk only the first level children, if set
345 * @res: return ptr, if resource found
347 static int find_next_iomem_res(resource_size_t start, resource_size_t end,
348 unsigned long flags, unsigned long desc,
349 bool first_lvl, struct resource *res)
351 bool siblings_only = true;
360 read_lock(&resource_lock);
362 for (p = iomem_resource.child; p; p = next_resource(p, siblings_only)) {
363 /* If we passed the resource we are looking for, stop */
364 if (p->start > end) {
369 /* Skip until we find a range that matches what we look for */
374 * Now that we found a range that matches what we look for,
375 * check the flags and the descriptor. If we were not asked to
376 * use only the first level, start looking at children as well.
378 siblings_only = first_lvl;
380 if ((p->flags & flags) != flags)
382 if ((desc != IORES_DESC_NONE) && (desc != p->desc))
385 /* Found a match, break */
391 *res = (struct resource) {
392 .start = max(start, p->start),
393 .end = min(end, p->end),
400 read_unlock(&resource_lock);
401 return p ? 0 : -ENODEV;
404 static int __walk_iomem_res_desc(resource_size_t start, resource_size_t end,
405 unsigned long flags, unsigned long desc,
406 bool first_lvl, void *arg,
407 int (*func)(struct resource *, void *))
412 while (start < end &&
413 !find_next_iomem_res(start, end, flags, desc, first_lvl, &res)) {
414 ret = (*func)(&res, arg);
425 * Walks through iomem resources and calls func() with matching resource
426 * ranges. This walks through whole tree and not just first level children.
427 * All the memory ranges which overlap start,end and also match flags and
428 * desc are valid candidates.
430 * @desc: I/O resource descriptor. Use IORES_DESC_NONE to skip @desc check.
431 * @flags: I/O resource flags
434 * @arg: function argument for the callback @func
435 * @func: callback function that is called for each qualifying resource area
437 * NOTE: For a new descriptor search, define a new IORES_DESC in
438 * <linux/ioport.h> and set it in 'desc' of a target resource entry.
440 int walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start,
441 u64 end, void *arg, int (*func)(struct resource *, void *))
443 return __walk_iomem_res_desc(start, end, flags, desc, false, arg, func);
445 EXPORT_SYMBOL_GPL(walk_iomem_res_desc);
448 * This function calls the @func callback against all memory ranges of type
449 * System RAM which are marked as IORESOURCE_SYSTEM_RAM and IORESOUCE_BUSY.
450 * Now, this function is only for System RAM, it deals with full ranges and
451 * not PFNs. If resources are not PFN-aligned, dealing with PFNs can truncate
454 int walk_system_ram_res(u64 start, u64 end, void *arg,
455 int (*func)(struct resource *, void *))
457 unsigned long flags = IORESOURCE_SYSTEM_RAM | IORESOURCE_BUSY;
459 return __walk_iomem_res_desc(start, end, flags, IORES_DESC_NONE, true,
464 * This function calls the @func callback against all memory ranges, which
465 * are ranges marked as IORESOURCE_MEM and IORESOUCE_BUSY.
467 int walk_mem_res(u64 start, u64 end, void *arg,
468 int (*func)(struct resource *, void *))
470 unsigned long flags = IORESOURCE_MEM | IORESOURCE_BUSY;
472 return __walk_iomem_res_desc(start, end, flags, IORES_DESC_NONE, true,
477 * This function calls the @func callback against all memory ranges of type
478 * System RAM which are marked as IORESOURCE_SYSTEM_RAM and IORESOUCE_BUSY.
479 * It is to be used only for System RAM.
481 * This will find System RAM ranges that are children of top-level resources
482 * in addition to top-level System RAM resources.
484 int walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
485 void *arg, int (*func)(unsigned long, unsigned long, void *))
487 resource_size_t start, end;
490 unsigned long pfn, end_pfn;
493 start = (u64) start_pfn << PAGE_SHIFT;
494 end = ((u64)(start_pfn + nr_pages) << PAGE_SHIFT) - 1;
495 flags = IORESOURCE_SYSTEM_RAM | IORESOURCE_BUSY;
496 while (start < end &&
497 !find_next_iomem_res(start, end, flags, IORES_DESC_NONE,
499 pfn = PFN_UP(res.start);
500 end_pfn = PFN_DOWN(res.end + 1);
502 ret = (*func)(pfn, end_pfn - pfn, arg);
510 static int __is_ram(unsigned long pfn, unsigned long nr_pages, void *arg)
516 * This generic page_is_ram() returns true if specified address is
517 * registered as System RAM in iomem_resource list.
519 int __weak page_is_ram(unsigned long pfn)
521 return walk_system_ram_range(pfn, 1, NULL, __is_ram) == 1;
523 EXPORT_SYMBOL_GPL(page_is_ram);
526 * region_intersects() - determine intersection of region with known resources
527 * @start: region start address
528 * @size: size of region
529 * @flags: flags of resource (in iomem_resource)
530 * @desc: descriptor of resource (in iomem_resource) or IORES_DESC_NONE
532 * Check if the specified region partially overlaps or fully eclipses a
533 * resource identified by @flags and @desc (optional with IORES_DESC_NONE).
534 * Return REGION_DISJOINT if the region does not overlap @flags/@desc,
535 * return REGION_MIXED if the region overlaps @flags/@desc and another
536 * resource, and return REGION_INTERSECTS if the region overlaps @flags/@desc
537 * and no other defined resource. Note that REGION_INTERSECTS is also
538 * returned in the case when the specified region overlaps RAM and undefined
541 * region_intersect() is used by memory remapping functions to ensure
542 * the user is not remapping RAM and is a vast speed up over walking
543 * through the resource table page by page.
545 int region_intersects(resource_size_t start, size_t size, unsigned long flags,
549 int type = 0; int other = 0;
553 res.end = start + size - 1;
555 read_lock(&resource_lock);
556 for (p = iomem_resource.child; p ; p = p->sibling) {
557 bool is_type = (((p->flags & flags) == flags) &&
558 ((desc == IORES_DESC_NONE) ||
561 if (resource_overlaps(p, &res))
562 is_type ? type++ : other++;
564 read_unlock(&resource_lock);
567 return type ? REGION_INTERSECTS : REGION_DISJOINT;
572 return REGION_DISJOINT;
574 EXPORT_SYMBOL_GPL(region_intersects);
576 void __weak arch_remove_reservations(struct resource *avail)
580 static resource_size_t simple_align_resource(void *data,
581 const struct resource *avail,
582 resource_size_t size,
583 resource_size_t align)
588 static void resource_clip(struct resource *res, resource_size_t min,
591 if (res->start < min)
598 * Find empty slot in the resource tree with the given range and
599 * alignment constraints
601 static int __find_resource(struct resource *root, struct resource *old,
602 struct resource *new,
603 resource_size_t size,
604 struct resource_constraint *constraint)
606 struct resource *this = root->child;
607 struct resource tmp = *new, avail, alloc;
609 tmp.start = root->start;
611 * Skip past an allocated resource that starts at 0, since the assignment
612 * of this->start - 1 to tmp->end below would cause an underflow.
614 if (this && this->start == root->start) {
615 tmp.start = (this == old) ? old->start : this->end + 1;
616 this = this->sibling;
620 tmp.end = (this == old) ? this->end : this->start - 1;
624 if (tmp.end < tmp.start)
627 resource_clip(&tmp, constraint->min, constraint->max);
628 arch_remove_reservations(&tmp);
630 /* Check for overflow after ALIGN() */
631 avail.start = ALIGN(tmp.start, constraint->align);
633 avail.flags = new->flags & ~IORESOURCE_UNSET;
634 if (avail.start >= tmp.start) {
635 alloc.flags = avail.flags;
636 alloc.start = constraint->alignf(constraint->alignf_data, &avail,
637 size, constraint->align);
638 alloc.end = alloc.start + size - 1;
639 if (alloc.start <= alloc.end &&
640 resource_contains(&avail, &alloc)) {
641 new->start = alloc.start;
642 new->end = alloc.end;
647 next: if (!this || this->end == root->end)
651 tmp.start = this->end + 1;
652 this = this->sibling;
658 * Find empty slot in the resource tree given range and alignment.
660 static int find_resource(struct resource *root, struct resource *new,
661 resource_size_t size,
662 struct resource_constraint *constraint)
664 return __find_resource(root, NULL, new, size, constraint);
668 * reallocate_resource - allocate a slot in the resource tree given range & alignment.
669 * The resource will be relocated if the new size cannot be reallocated in the
672 * @root: root resource descriptor
673 * @old: resource descriptor desired by caller
674 * @newsize: new size of the resource descriptor
675 * @constraint: the size and alignment constraints to be met.
677 static int reallocate_resource(struct resource *root, struct resource *old,
678 resource_size_t newsize,
679 struct resource_constraint *constraint)
682 struct resource new = *old;
683 struct resource *conflict;
685 write_lock(&resource_lock);
687 if ((err = __find_resource(root, old, &new, newsize, constraint)))
690 if (resource_contains(&new, old)) {
691 old->start = new.start;
701 if (resource_contains(old, &new)) {
702 old->start = new.start;
705 __release_resource(old, true);
707 conflict = __request_resource(root, old);
711 write_unlock(&resource_lock);
717 * allocate_resource - allocate empty slot in the resource tree given range & alignment.
718 * The resource will be reallocated with a new size if it was already allocated
719 * @root: root resource descriptor
720 * @new: resource descriptor desired by caller
721 * @size: requested resource region size
722 * @min: minimum boundary to allocate
723 * @max: maximum boundary to allocate
724 * @align: alignment requested, in bytes
725 * @alignf: alignment function, optional, called if not NULL
726 * @alignf_data: arbitrary data to pass to the @alignf function
728 int allocate_resource(struct resource *root, struct resource *new,
729 resource_size_t size, resource_size_t min,
730 resource_size_t max, resource_size_t align,
731 resource_size_t (*alignf)(void *,
732 const struct resource *,
738 struct resource_constraint constraint;
741 alignf = simple_align_resource;
743 constraint.min = min;
744 constraint.max = max;
745 constraint.align = align;
746 constraint.alignf = alignf;
747 constraint.alignf_data = alignf_data;
750 /* resource is already allocated, try reallocating with
751 the new constraints */
752 return reallocate_resource(root, new, size, &constraint);
755 write_lock(&resource_lock);
756 err = find_resource(root, new, size, &constraint);
757 if (err >= 0 && __request_resource(root, new))
759 write_unlock(&resource_lock);
763 EXPORT_SYMBOL(allocate_resource);
766 * lookup_resource - find an existing resource by a resource start address
767 * @root: root resource descriptor
768 * @start: resource start address
770 * Returns a pointer to the resource if found, NULL otherwise
772 struct resource *lookup_resource(struct resource *root, resource_size_t start)
774 struct resource *res;
776 read_lock(&resource_lock);
777 for (res = root->child; res; res = res->sibling) {
778 if (res->start == start)
781 read_unlock(&resource_lock);
787 * Insert a resource into the resource tree. If successful, return NULL,
788 * otherwise return the conflicting resource (compare to __request_resource())
790 static struct resource * __insert_resource(struct resource *parent, struct resource *new)
792 struct resource *first, *next;
794 for (;; parent = first) {
795 first = __request_resource(parent, new);
801 if (WARN_ON(first == new)) /* duplicated insertion */
804 if ((first->start > new->start) || (first->end < new->end))
806 if ((first->start == new->start) && (first->end == new->end))
810 for (next = first; ; next = next->sibling) {
811 /* Partial overlap? Bad, and unfixable */
812 if (next->start < new->start || next->end > new->end)
816 if (next->sibling->start > new->end)
820 new->parent = parent;
821 new->sibling = next->sibling;
824 next->sibling = NULL;
825 for (next = first; next; next = next->sibling)
828 if (parent->child == first) {
831 next = parent->child;
832 while (next->sibling != first)
833 next = next->sibling;
840 * insert_resource_conflict - Inserts resource in the resource tree
841 * @parent: parent of the new resource
842 * @new: new resource to insert
844 * Returns 0 on success, conflict resource if the resource can't be inserted.
846 * This function is equivalent to request_resource_conflict when no conflict
847 * happens. If a conflict happens, and the conflicting resources
848 * entirely fit within the range of the new resource, then the new
849 * resource is inserted and the conflicting resources become children of
852 * This function is intended for producers of resources, such as FW modules
855 struct resource *insert_resource_conflict(struct resource *parent, struct resource *new)
857 struct resource *conflict;
859 write_lock(&resource_lock);
860 conflict = __insert_resource(parent, new);
861 write_unlock(&resource_lock);
866 * insert_resource - Inserts a resource in the resource tree
867 * @parent: parent of the new resource
868 * @new: new resource to insert
870 * Returns 0 on success, -EBUSY if the resource can't be inserted.
872 * This function is intended for producers of resources, such as FW modules
875 int insert_resource(struct resource *parent, struct resource *new)
877 struct resource *conflict;
879 conflict = insert_resource_conflict(parent, new);
880 return conflict ? -EBUSY : 0;
882 EXPORT_SYMBOL_GPL(insert_resource);
885 * insert_resource_expand_to_fit - Insert a resource into the resource tree
886 * @root: root resource descriptor
887 * @new: new resource to insert
889 * Insert a resource into the resource tree, possibly expanding it in order
890 * to make it encompass any conflicting resources.
892 void insert_resource_expand_to_fit(struct resource *root, struct resource *new)
897 write_lock(&resource_lock);
899 struct resource *conflict;
901 conflict = __insert_resource(root, new);
904 if (conflict == root)
907 /* Ok, expand resource to cover the conflict, then try again .. */
908 if (conflict->start < new->start)
909 new->start = conflict->start;
910 if (conflict->end > new->end)
911 new->end = conflict->end;
913 printk("Expanded resource %s due to conflict with %s\n", new->name, conflict->name);
915 write_unlock(&resource_lock);
919 * remove_resource - Remove a resource in the resource tree
920 * @old: resource to remove
922 * Returns 0 on success, -EINVAL if the resource is not valid.
924 * This function removes a resource previously inserted by insert_resource()
925 * or insert_resource_conflict(), and moves the children (if any) up to
926 * where they were before. insert_resource() and insert_resource_conflict()
927 * insert a new resource, and move any conflicting resources down to the
928 * children of the new resource.
930 * insert_resource(), insert_resource_conflict() and remove_resource() are
931 * intended for producers of resources, such as FW modules and bus drivers.
933 int remove_resource(struct resource *old)
937 write_lock(&resource_lock);
938 retval = __release_resource(old, false);
939 write_unlock(&resource_lock);
942 EXPORT_SYMBOL_GPL(remove_resource);
944 static int __adjust_resource(struct resource *res, resource_size_t start,
945 resource_size_t size)
947 struct resource *tmp, *parent = res->parent;
948 resource_size_t end = start + size - 1;
954 if ((start < parent->start) || (end > parent->end))
957 if (res->sibling && (res->sibling->start <= end))
962 while (tmp->sibling != res)
964 if (start <= tmp->end)
969 for (tmp = res->child; tmp; tmp = tmp->sibling)
970 if ((tmp->start < start) || (tmp->end > end))
982 * adjust_resource - modify a resource's start and size
983 * @res: resource to modify
984 * @start: new start value
987 * Given an existing resource, change its start and size to match the
988 * arguments. Returns 0 on success, -EBUSY if it can't fit.
989 * Existing children of the resource are assumed to be immutable.
991 int adjust_resource(struct resource *res, resource_size_t start,
992 resource_size_t size)
996 write_lock(&resource_lock);
997 result = __adjust_resource(res, start, size);
998 write_unlock(&resource_lock);
1001 EXPORT_SYMBOL(adjust_resource);
1004 __reserve_region_with_split(struct resource *root, resource_size_t start,
1005 resource_size_t end, const char *name)
1007 struct resource *parent = root;
1008 struct resource *conflict;
1009 struct resource *res = alloc_resource(GFP_ATOMIC);
1010 struct resource *next_res = NULL;
1011 int type = resource_type(root);
1019 res->flags = type | IORESOURCE_BUSY;
1020 res->desc = IORES_DESC_NONE;
1024 conflict = __request_resource(parent, res);
1033 /* conflict covered whole area */
1034 if (conflict->start <= res->start &&
1035 conflict->end >= res->end) {
1041 /* failed, split and try again */
1042 if (conflict->start > res->start) {
1044 res->end = conflict->start - 1;
1045 if (conflict->end < end) {
1046 next_res = alloc_resource(GFP_ATOMIC);
1051 next_res->name = name;
1052 next_res->start = conflict->end + 1;
1053 next_res->end = end;
1054 next_res->flags = type | IORESOURCE_BUSY;
1055 next_res->desc = IORES_DESC_NONE;
1058 res->start = conflict->end + 1;
1065 reserve_region_with_split(struct resource *root, resource_size_t start,
1066 resource_size_t end, const char *name)
1070 write_lock(&resource_lock);
1071 if (root->start > start || root->end < end) {
1072 pr_err("requested range [0x%llx-0x%llx] not in root %pr\n",
1073 (unsigned long long)start, (unsigned long long)end,
1075 if (start > root->end || end < root->start)
1078 if (end > root->end)
1080 if (start < root->start)
1081 start = root->start;
1082 pr_err("fixing request to [0x%llx-0x%llx]\n",
1083 (unsigned long long)start,
1084 (unsigned long long)end);
1089 __reserve_region_with_split(root, start, end, name);
1090 write_unlock(&resource_lock);
1094 * resource_alignment - calculate resource's alignment
1095 * @res: resource pointer
1097 * Returns alignment on success, 0 (invalid alignment) on failure.
1099 resource_size_t resource_alignment(struct resource *res)
1101 switch (res->flags & (IORESOURCE_SIZEALIGN | IORESOURCE_STARTALIGN)) {
1102 case IORESOURCE_SIZEALIGN:
1103 return resource_size(res);
1104 case IORESOURCE_STARTALIGN:
1112 * This is compatibility stuff for IO resources.
1114 * Note how this, unlike the above, knows about
1115 * the IO flag meanings (busy etc).
1117 * request_region creates a new busy region.
1119 * release_region releases a matching busy region.
1122 static DECLARE_WAIT_QUEUE_HEAD(muxed_resource_wait);
1125 * __request_region - create a new busy resource region
1126 * @parent: parent resource descriptor
1127 * @start: resource start address
1128 * @n: resource region size
1129 * @name: reserving caller's ID string
1130 * @flags: IO resource flags
1132 struct resource * __request_region(struct resource *parent,
1133 resource_size_t start, resource_size_t n,
1134 const char *name, int flags)
1136 DECLARE_WAITQUEUE(wait, current);
1137 struct resource *res = alloc_resource(GFP_KERNEL);
1138 struct resource *orig_parent = parent;
1145 res->end = start + n - 1;
1147 write_lock(&resource_lock);
1150 struct resource *conflict;
1152 res->flags = resource_type(parent) | resource_ext_type(parent);
1153 res->flags |= IORESOURCE_BUSY | flags;
1154 res->desc = parent->desc;
1156 conflict = __request_resource(parent, res);
1160 * mm/hmm.c reserves physical addresses which then
1161 * become unavailable to other users. Conflicts are
1162 * not expected. Warn to aid debugging if encountered.
1164 if (conflict->desc == IORES_DESC_DEVICE_PRIVATE_MEMORY) {
1165 pr_warn("Unaddressable device %s %pR conflicts with %pR",
1166 conflict->name, conflict, res);
1168 if (conflict != parent) {
1169 if (!(conflict->flags & IORESOURCE_BUSY)) {
1174 if (conflict->flags & flags & IORESOURCE_MUXED) {
1175 add_wait_queue(&muxed_resource_wait, &wait);
1176 write_unlock(&resource_lock);
1177 set_current_state(TASK_UNINTERRUPTIBLE);
1179 remove_wait_queue(&muxed_resource_wait, &wait);
1180 write_lock(&resource_lock);
1183 /* Uhhuh, that didn't work out.. */
1188 write_unlock(&resource_lock);
1190 if (res && orig_parent == &iomem_resource)
1195 EXPORT_SYMBOL(__request_region);
1198 * __release_region - release a previously reserved resource region
1199 * @parent: parent resource descriptor
1200 * @start: resource start address
1201 * @n: resource region size
1203 * The described resource region must match a currently busy region.
1205 void __release_region(struct resource *parent, resource_size_t start,
1208 struct resource **p;
1209 resource_size_t end;
1212 end = start + n - 1;
1214 write_lock(&resource_lock);
1217 struct resource *res = *p;
1221 if (res->start <= start && res->end >= end) {
1222 if (!(res->flags & IORESOURCE_BUSY)) {
1226 if (res->start != start || res->end != end)
1229 write_unlock(&resource_lock);
1230 if (res->flags & IORESOURCE_MUXED)
1231 wake_up(&muxed_resource_wait);
1238 write_unlock(&resource_lock);
1240 printk(KERN_WARNING "Trying to free nonexistent resource "
1241 "<%016llx-%016llx>\n", (unsigned long long)start,
1242 (unsigned long long)end);
1244 EXPORT_SYMBOL(__release_region);
1246 #ifdef CONFIG_MEMORY_HOTREMOVE
1248 * release_mem_region_adjustable - release a previously reserved memory region
1249 * @start: resource start address
1250 * @size: resource region size
1252 * This interface is intended for memory hot-delete. The requested region
1253 * is released from a currently busy memory resource. The requested region
1254 * must either match exactly or fit into a single busy resource entry. In
1255 * the latter case, the remaining resource is adjusted accordingly.
1256 * Existing children of the busy memory resource must be immutable in the
1260 * - Additional release conditions, such as overlapping region, can be
1261 * supported after they are confirmed as valid cases.
1262 * - When a busy memory resource gets split into two entries, the code
1263 * assumes that all children remain in the lower address entry for
1264 * simplicity. Enhance this logic when necessary.
1266 void release_mem_region_adjustable(resource_size_t start, resource_size_t size)
1268 struct resource *parent = &iomem_resource;
1269 struct resource *new_res = NULL;
1270 bool alloc_nofail = false;
1271 struct resource **p;
1272 struct resource *res;
1273 resource_size_t end;
1275 end = start + size - 1;
1276 if (WARN_ON_ONCE((start < parent->start) || (end > parent->end)))
1280 * We free up quite a lot of memory on memory hotunplug (esp., memap),
1281 * just before releasing the region. This is highly unlikely to
1282 * fail - let's play save and make it never fail as the caller cannot
1283 * perform any error handling (e.g., trying to re-add memory will fail
1287 new_res = alloc_resource(GFP_KERNEL | (alloc_nofail ? __GFP_NOFAIL : 0));
1290 write_lock(&resource_lock);
1292 while ((res = *p)) {
1293 if (res->start >= end)
1296 /* look for the next resource if it does not fit into */
1297 if (res->start > start || res->end < end) {
1303 * All memory regions added from memory-hotplug path have the
1304 * flag IORESOURCE_SYSTEM_RAM. If the resource does not have
1305 * this flag, we know that we are dealing with a resource coming
1306 * from HMM/devm. HMM/devm use another mechanism to add/release
1307 * a resource. This goes via devm_request_mem_region and
1308 * devm_release_mem_region.
1309 * HMM/devm take care to release their resources when they want,
1310 * so if we are dealing with them, let us just back off here.
1312 if (!(res->flags & IORESOURCE_SYSRAM)) {
1316 if (!(res->flags & IORESOURCE_MEM))
1319 if (!(res->flags & IORESOURCE_BUSY)) {
1324 /* found the target resource; let's adjust accordingly */
1325 if (res->start == start && res->end == end) {
1326 /* free the whole entry */
1329 } else if (res->start == start && res->end != end) {
1330 /* adjust the start */
1331 WARN_ON_ONCE(__adjust_resource(res, end + 1,
1333 } else if (res->start != start && res->end == end) {
1334 /* adjust the end */
1335 WARN_ON_ONCE(__adjust_resource(res, res->start,
1336 start - res->start));
1338 /* split into two entries - we need a new resource */
1340 new_res = alloc_resource(GFP_ATOMIC);
1342 alloc_nofail = true;
1343 write_unlock(&resource_lock);
1347 new_res->name = res->name;
1348 new_res->start = end + 1;
1349 new_res->end = res->end;
1350 new_res->flags = res->flags;
1351 new_res->desc = res->desc;
1352 new_res->parent = res->parent;
1353 new_res->sibling = res->sibling;
1354 new_res->child = NULL;
1356 if (WARN_ON_ONCE(__adjust_resource(res, res->start,
1357 start - res->start)))
1359 res->sibling = new_res;
1366 write_unlock(&resource_lock);
1367 free_resource(new_res);
1369 #endif /* CONFIG_MEMORY_HOTREMOVE */
1371 #ifdef CONFIG_MEMORY_HOTPLUG
1372 static bool system_ram_resources_mergeable(struct resource *r1,
1373 struct resource *r2)
1375 /* We assume either r1 or r2 is IORESOURCE_SYSRAM_MERGEABLE. */
1376 return r1->flags == r2->flags && r1->end + 1 == r2->start &&
1377 r1->name == r2->name && r1->desc == r2->desc &&
1378 !r1->child && !r2->child;
1382 * merge_system_ram_resource - mark the System RAM resource mergeable and try to
1383 * merge it with adjacent, mergeable resources
1384 * @res: resource descriptor
1386 * This interface is intended for memory hotplug, whereby lots of contiguous
1387 * system ram resources are added (e.g., via add_memory*()) by a driver, and
1388 * the actual resource boundaries are not of interest (e.g., it might be
1389 * relevant for DIMMs). Only resources that are marked mergeable, that have the
1390 * same parent, and that don't have any children are considered. All mergeable
1391 * resources must be immutable during the request.
1394 * - The caller has to make sure that no pointers to resources that are
1395 * marked mergeable are used anymore after this call - the resource might
1396 * be freed and the pointer might be stale!
1397 * - release_mem_region_adjustable() will split on demand on memory hotunplug
1399 void merge_system_ram_resource(struct resource *res)
1401 const unsigned long flags = IORESOURCE_SYSTEM_RAM | IORESOURCE_BUSY;
1402 struct resource *cur;
1404 if (WARN_ON_ONCE((res->flags & flags) != flags))
1407 write_lock(&resource_lock);
1408 res->flags |= IORESOURCE_SYSRAM_MERGEABLE;
1410 /* Try to merge with next item in the list. */
1412 if (cur && system_ram_resources_mergeable(res, cur)) {
1413 res->end = cur->end;
1414 res->sibling = cur->sibling;
1418 /* Try to merge with previous item in the list. */
1419 cur = res->parent->child;
1420 while (cur && cur->sibling != res)
1422 if (cur && system_ram_resources_mergeable(cur, res)) {
1423 cur->end = res->end;
1424 cur->sibling = res->sibling;
1427 write_unlock(&resource_lock);
1429 #endif /* CONFIG_MEMORY_HOTPLUG */
1432 * Managed region resource
1434 static void devm_resource_release(struct device *dev, void *ptr)
1436 struct resource **r = ptr;
1438 release_resource(*r);
1442 * devm_request_resource() - request and reserve an I/O or memory resource
1443 * @dev: device for which to request the resource
1444 * @root: root of the resource tree from which to request the resource
1445 * @new: descriptor of the resource to request
1447 * This is a device-managed version of request_resource(). There is usually
1448 * no need to release resources requested by this function explicitly since
1449 * that will be taken care of when the device is unbound from its driver.
1450 * If for some reason the resource needs to be released explicitly, because
1451 * of ordering issues for example, drivers must call devm_release_resource()
1452 * rather than the regular release_resource().
1454 * When a conflict is detected between any existing resources and the newly
1455 * requested resource, an error message will be printed.
1457 * Returns 0 on success or a negative error code on failure.
1459 int devm_request_resource(struct device *dev, struct resource *root,
1460 struct resource *new)
1462 struct resource *conflict, **ptr;
1464 ptr = devres_alloc(devm_resource_release, sizeof(*ptr), GFP_KERNEL);
1470 conflict = request_resource_conflict(root, new);
1472 dev_err(dev, "resource collision: %pR conflicts with %s %pR\n",
1473 new, conflict->name, conflict);
1478 devres_add(dev, ptr);
1481 EXPORT_SYMBOL(devm_request_resource);
1483 static int devm_resource_match(struct device *dev, void *res, void *data)
1485 struct resource **ptr = res;
1487 return *ptr == data;
1491 * devm_release_resource() - release a previously requested resource
1492 * @dev: device for which to release the resource
1493 * @new: descriptor of the resource to release
1495 * Releases a resource previously requested using devm_request_resource().
1497 void devm_release_resource(struct device *dev, struct resource *new)
1499 WARN_ON(devres_release(dev, devm_resource_release, devm_resource_match,
1502 EXPORT_SYMBOL(devm_release_resource);
1504 struct region_devres {
1505 struct resource *parent;
1506 resource_size_t start;
1510 static void devm_region_release(struct device *dev, void *res)
1512 struct region_devres *this = res;
1514 __release_region(this->parent, this->start, this->n);
1517 static int devm_region_match(struct device *dev, void *res, void *match_data)
1519 struct region_devres *this = res, *match = match_data;
1521 return this->parent == match->parent &&
1522 this->start == match->start && this->n == match->n;
1526 __devm_request_region(struct device *dev, struct resource *parent,
1527 resource_size_t start, resource_size_t n, const char *name)
1529 struct region_devres *dr = NULL;
1530 struct resource *res;
1532 dr = devres_alloc(devm_region_release, sizeof(struct region_devres),
1537 dr->parent = parent;
1541 res = __request_region(parent, start, n, name, 0);
1543 devres_add(dev, dr);
1549 EXPORT_SYMBOL(__devm_request_region);
1551 void __devm_release_region(struct device *dev, struct resource *parent,
1552 resource_size_t start, resource_size_t n)
1554 struct region_devres match_data = { parent, start, n };
1556 __release_region(parent, start, n);
1557 WARN_ON(devres_destroy(dev, devm_region_release, devm_region_match,
1560 EXPORT_SYMBOL(__devm_release_region);
1563 * Reserve I/O ports or memory based on "reserve=" kernel parameter.
1565 #define MAXRESERVE 4
1566 static int __init reserve_setup(char *str)
1568 static int reserved;
1569 static struct resource reserve[MAXRESERVE];
1572 unsigned int io_start, io_num;
1574 struct resource *parent;
1576 if (get_option(&str, &io_start) != 2)
1578 if (get_option(&str, &io_num) == 0)
1580 if (x < MAXRESERVE) {
1581 struct resource *res = reserve + x;
1584 * If the region starts below 0x10000, we assume it's
1585 * I/O port space; otherwise assume it's memory.
1587 if (io_start < 0x10000) {
1588 res->flags = IORESOURCE_IO;
1589 parent = &ioport_resource;
1591 res->flags = IORESOURCE_MEM;
1592 parent = &iomem_resource;
1594 res->name = "reserved";
1595 res->start = io_start;
1596 res->end = io_start + io_num - 1;
1597 res->flags |= IORESOURCE_BUSY;
1598 res->desc = IORES_DESC_NONE;
1600 if (request_resource(parent, res) == 0)
1606 __setup("reserve=", reserve_setup);
1609 * Check if the requested addr and size spans more than any slot in the
1610 * iomem resource tree.
1612 int iomem_map_sanity_check(resource_size_t addr, unsigned long size)
1614 struct resource *p = &iomem_resource;
1618 read_lock(&resource_lock);
1619 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
1621 * We can probably skip the resources without
1622 * IORESOURCE_IO attribute?
1624 if (p->start >= addr + size)
1628 if (PFN_DOWN(p->start) <= PFN_DOWN(addr) &&
1629 PFN_DOWN(p->end) >= PFN_DOWN(addr + size - 1))
1632 * if a resource is "BUSY", it's not a hardware resource
1633 * but a driver mapping of such a resource; we don't want
1634 * to warn for those; some drivers legitimately map only
1635 * partial hardware resources. (example: vesafb)
1637 if (p->flags & IORESOURCE_BUSY)
1640 printk(KERN_WARNING "resource sanity check: requesting [mem %#010llx-%#010llx], which spans more than %s %pR\n",
1641 (unsigned long long)addr,
1642 (unsigned long long)(addr + size - 1),
1647 read_unlock(&resource_lock);
1652 #ifdef CONFIG_STRICT_DEVMEM
1653 static int strict_iomem_checks = 1;
1655 static int strict_iomem_checks;
1659 * check if an address is reserved in the iomem resource tree
1660 * returns true if reserved, false if not reserved.
1662 bool iomem_is_exclusive(u64 addr)
1664 struct resource *p = &iomem_resource;
1667 int size = PAGE_SIZE;
1669 if (!strict_iomem_checks)
1672 addr = addr & PAGE_MASK;
1674 read_lock(&resource_lock);
1675 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
1677 * We can probably skip the resources without
1678 * IORESOURCE_IO attribute?
1680 if (p->start >= addr + size)
1685 * A resource is exclusive if IORESOURCE_EXCLUSIVE is set
1686 * or CONFIG_IO_STRICT_DEVMEM is enabled and the
1689 if ((p->flags & IORESOURCE_BUSY) == 0)
1691 if (IS_ENABLED(CONFIG_IO_STRICT_DEVMEM)
1692 || p->flags & IORESOURCE_EXCLUSIVE) {
1697 read_unlock(&resource_lock);
1702 struct resource_entry *resource_list_create_entry(struct resource *res,
1705 struct resource_entry *entry;
1707 entry = kzalloc(sizeof(*entry) + extra_size, GFP_KERNEL);
1709 INIT_LIST_HEAD(&entry->node);
1710 entry->res = res ? res : &entry->__res;
1715 EXPORT_SYMBOL(resource_list_create_entry);
1717 void resource_list_free(struct list_head *head)
1719 struct resource_entry *entry, *tmp;
1721 list_for_each_entry_safe(entry, tmp, head, node)
1722 resource_list_destroy_entry(entry);
1724 EXPORT_SYMBOL(resource_list_free);
1726 #ifdef CONFIG_DEVICE_PRIVATE
1727 static struct resource *__request_free_mem_region(struct device *dev,
1728 struct resource *base, unsigned long size, const char *name)
1730 resource_size_t end, addr;
1731 struct resource *res;
1733 size = ALIGN(size, 1UL << PA_SECTION_SHIFT);
1734 end = min_t(unsigned long, base->end, (1UL << MAX_PHYSMEM_BITS) - 1);
1735 addr = end - size + 1UL;
1737 for (; addr > size && addr >= base->start; addr -= size) {
1738 if (region_intersects(addr, size, 0, IORES_DESC_NONE) !=
1743 res = devm_request_mem_region(dev, addr, size, name);
1745 res = request_mem_region(addr, size, name);
1747 return ERR_PTR(-ENOMEM);
1748 res->desc = IORES_DESC_DEVICE_PRIVATE_MEMORY;
1752 return ERR_PTR(-ERANGE);
1756 * devm_request_free_mem_region - find free region for device private memory
1758 * @dev: device struct to bind the resource to
1759 * @size: size in bytes of the device memory to add
1760 * @base: resource tree to look in
1762 * This function tries to find an empty range of physical address big enough to
1763 * contain the new resource, so that it can later be hotplugged as ZONE_DEVICE
1764 * memory, which in turn allocates struct pages.
1766 struct resource *devm_request_free_mem_region(struct device *dev,
1767 struct resource *base, unsigned long size)
1769 return __request_free_mem_region(dev, base, size, dev_name(dev));
1771 EXPORT_SYMBOL_GPL(devm_request_free_mem_region);
1773 struct resource *request_free_mem_region(struct resource *base,
1774 unsigned long size, const char *name)
1776 return __request_free_mem_region(NULL, base, size, name);
1778 EXPORT_SYMBOL_GPL(request_free_mem_region);
1780 #endif /* CONFIG_DEVICE_PRIVATE */
1782 static int __init strict_iomem(char *str)
1784 if (strstr(str, "relaxed"))
1785 strict_iomem_checks = 0;
1786 if (strstr(str, "strict"))
1787 strict_iomem_checks = 1;
1791 __setup("iomem=", strict_iomem);