2 * linux/kernel/resource.c
4 * Copyright (C) 1999 Linus Torvalds
5 * Copyright (C) 1999 Martin Mares <mj@ucw.cz>
7 * Arbitrary resource management.
10 #include <linux/export.h>
11 #include <linux/errno.h>
12 #include <linux/ioport.h>
13 #include <linux/init.h>
14 #include <linux/slab.h>
15 #include <linux/spinlock.h>
17 #include <linux/proc_fs.h>
18 #include <linux/sched.h>
19 #include <linux/seq_file.h>
20 #include <linux/device.h>
21 #include <linux/pfn.h>
25 struct resource ioport_resource = {
28 .end = IO_SPACE_LIMIT,
29 .flags = IORESOURCE_IO,
31 EXPORT_SYMBOL(ioport_resource);
33 struct resource iomem_resource = {
37 .flags = IORESOURCE_MEM,
39 EXPORT_SYMBOL(iomem_resource);
41 /* constraints to be met while allocating resources */
42 struct resource_constraint {
43 resource_size_t min, max, align;
44 resource_size_t (*alignf)(void *, const struct resource *,
45 resource_size_t, resource_size_t);
49 static DEFINE_RWLOCK(resource_lock);
51 static void *r_next(struct seq_file *m, void *v, loff_t *pos)
53 struct resource *p = v;
57 while (!p->sibling && p->parent)
64 enum { MAX_IORES_LEVEL = 5 };
66 static void *r_start(struct seq_file *m, loff_t *pos)
67 __acquires(resource_lock)
69 struct resource *p = m->private;
71 read_lock(&resource_lock);
72 for (p = p->child; p && l < *pos; p = r_next(m, p, &l))
77 static void r_stop(struct seq_file *m, void *v)
78 __releases(resource_lock)
80 read_unlock(&resource_lock);
83 static int r_show(struct seq_file *m, void *v)
85 struct resource *root = m->private;
86 struct resource *r = v, *p;
87 int width = root->end < 0x10000 ? 4 : 8;
90 for (depth = 0, p = r; depth < MAX_IORES_LEVEL; depth++, p = p->parent)
91 if (p->parent == root)
93 seq_printf(m, "%*s%0*llx-%0*llx : %s\n",
95 width, (unsigned long long) r->start,
96 width, (unsigned long long) r->end,
97 r->name ? r->name : "<BAD>");
101 static const struct seq_operations resource_op = {
108 static int ioports_open(struct inode *inode, struct file *file)
110 int res = seq_open(file, &resource_op);
112 struct seq_file *m = file->private_data;
113 m->private = &ioport_resource;
118 static int iomem_open(struct inode *inode, struct file *file)
120 int res = seq_open(file, &resource_op);
122 struct seq_file *m = file->private_data;
123 m->private = &iomem_resource;
128 static const struct file_operations proc_ioports_operations = {
129 .open = ioports_open,
132 .release = seq_release,
135 static const struct file_operations proc_iomem_operations = {
139 .release = seq_release,
142 static int __init ioresources_init(void)
144 proc_create("ioports", 0, NULL, &proc_ioports_operations);
145 proc_create("iomem", 0, NULL, &proc_iomem_operations);
148 __initcall(ioresources_init);
150 #endif /* CONFIG_PROC_FS */
152 /* Return the conflict entry if you can't request it */
153 static struct resource * __request_resource(struct resource *root, struct resource *new)
155 resource_size_t start = new->start;
156 resource_size_t end = new->end;
157 struct resource *tmp, **p;
161 if (start < root->start)
168 if (!tmp || tmp->start > end) {
175 if (tmp->end < start)
181 static int __release_resource(struct resource *old)
183 struct resource *tmp, **p;
185 p = &old->parent->child;
200 static void __release_child_resources(struct resource *r)
202 struct resource *tmp, *p;
203 resource_size_t size;
213 __release_child_resources(tmp);
215 printk(KERN_DEBUG "release child resource %pR\n", tmp);
216 /* need to restore size, and keep flags */
217 size = resource_size(tmp);
223 void release_child_resources(struct resource *r)
225 write_lock(&resource_lock);
226 __release_child_resources(r);
227 write_unlock(&resource_lock);
231 * request_resource_conflict - request and reserve an I/O or memory resource
232 * @root: root resource descriptor
233 * @new: resource descriptor desired by caller
235 * Returns 0 for success, conflict resource on error.
237 struct resource *request_resource_conflict(struct resource *root, struct resource *new)
239 struct resource *conflict;
241 write_lock(&resource_lock);
242 conflict = __request_resource(root, new);
243 write_unlock(&resource_lock);
248 * request_resource - request and reserve an I/O or memory resource
249 * @root: root resource descriptor
250 * @new: resource descriptor desired by caller
252 * Returns 0 for success, negative error code on error.
254 int request_resource(struct resource *root, struct resource *new)
256 struct resource *conflict;
258 conflict = request_resource_conflict(root, new);
259 return conflict ? -EBUSY : 0;
262 EXPORT_SYMBOL(request_resource);
265 * release_resource - release a previously reserved resource
266 * @old: resource pointer
268 int release_resource(struct resource *old)
272 write_lock(&resource_lock);
273 retval = __release_resource(old);
274 write_unlock(&resource_lock);
278 EXPORT_SYMBOL(release_resource);
280 #if !defined(CONFIG_ARCH_HAS_WALK_MEMORY)
282 * Finds the lowest memory reosurce exists within [res->start.res->end)
283 * the caller must specify res->start, res->end, res->flags and "name".
284 * If found, returns 0, res is overwritten, if not found, returns -1.
286 static int find_next_system_ram(struct resource *res, char *name)
288 resource_size_t start, end;
295 BUG_ON(start >= end);
297 read_lock(&resource_lock);
298 for (p = iomem_resource.child; p ; p = p->sibling) {
299 /* system ram is just marked as IORESOURCE_MEM */
300 if (p->flags != res->flags)
302 if (name && strcmp(p->name, name))
304 if (p->start > end) {
308 if ((p->end >= start) && (p->start < end))
311 read_unlock(&resource_lock);
315 if (res->start < p->start)
316 res->start = p->start;
317 if (res->end > p->end)
323 * This function calls callback against all memory range of "System RAM"
324 * which are marked as IORESOURCE_MEM and IORESOUCE_BUSY.
325 * Now, this function is only for "System RAM".
327 int walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
328 void *arg, int (*func)(unsigned long, unsigned long, void *))
331 unsigned long pfn, end_pfn;
335 res.start = (u64) start_pfn << PAGE_SHIFT;
336 res.end = ((u64)(start_pfn + nr_pages) << PAGE_SHIFT) - 1;
337 res.flags = IORESOURCE_MEM | IORESOURCE_BUSY;
339 while ((res.start < res.end) &&
340 (find_next_system_ram(&res, "System RAM") >= 0)) {
341 pfn = (res.start + PAGE_SIZE - 1) >> PAGE_SHIFT;
342 end_pfn = (res.end + 1) >> PAGE_SHIFT;
344 ret = (*func)(pfn, end_pfn - pfn, arg);
347 res.start = res.end + 1;
355 static int __is_ram(unsigned long pfn, unsigned long nr_pages, void *arg)
360 * This generic page_is_ram() returns true if specified address is
361 * registered as "System RAM" in iomem_resource list.
363 int __weak page_is_ram(unsigned long pfn)
365 return walk_system_ram_range(pfn, 1, NULL, __is_ram) == 1;
368 void __weak arch_remove_reservations(struct resource *avail)
372 static resource_size_t simple_align_resource(void *data,
373 const struct resource *avail,
374 resource_size_t size,
375 resource_size_t align)
380 static void resource_clip(struct resource *res, resource_size_t min,
383 if (res->start < min)
389 static bool resource_contains(struct resource *res1, struct resource *res2)
391 return res1->start <= res2->start && res1->end >= res2->end;
395 * Find empty slot in the resource tree with the given range and
396 * alignment constraints
398 static int __find_resource(struct resource *root, struct resource *old,
399 struct resource *new,
400 resource_size_t size,
401 struct resource_constraint *constraint)
403 struct resource *this = root->child;
404 struct resource tmp = *new, avail, alloc;
406 tmp.flags = new->flags;
407 tmp.start = root->start;
409 * Skip past an allocated resource that starts at 0, since the assignment
410 * of this->start - 1 to tmp->end below would cause an underflow.
412 if (this && this->start == root->start) {
413 tmp.start = (this == old) ? old->start : this->end + 1;
414 this = this->sibling;
418 tmp.end = (this == old) ? this->end : this->start - 1;
422 if (tmp.end < tmp.start)
425 resource_clip(&tmp, constraint->min, constraint->max);
426 arch_remove_reservations(&tmp);
428 /* Check for overflow after ALIGN() */
430 avail.start = ALIGN(tmp.start, constraint->align);
432 if (avail.start >= tmp.start) {
433 alloc.start = constraint->alignf(constraint->alignf_data, &avail,
434 size, constraint->align);
435 alloc.end = alloc.start + size - 1;
436 if (resource_contains(&avail, &alloc)) {
437 new->start = alloc.start;
438 new->end = alloc.end;
443 next: if (!this || this->end == root->end)
447 tmp.start = this->end + 1;
448 this = this->sibling;
454 * Find empty slot in the resource tree given range and alignment.
456 static int find_resource(struct resource *root, struct resource *new,
457 resource_size_t size,
458 struct resource_constraint *constraint)
460 return __find_resource(root, NULL, new, size, constraint);
464 * reallocate_resource - allocate a slot in the resource tree given range & alignment.
465 * The resource will be relocated if the new size cannot be reallocated in the
468 * @root: root resource descriptor
469 * @old: resource descriptor desired by caller
470 * @newsize: new size of the resource descriptor
471 * @constraint: the size and alignment constraints to be met.
473 int reallocate_resource(struct resource *root, struct resource *old,
474 resource_size_t newsize,
475 struct resource_constraint *constraint)
478 struct resource new = *old;
479 struct resource *conflict;
481 write_lock(&resource_lock);
483 if ((err = __find_resource(root, old, &new, newsize, constraint)))
486 if (resource_contains(&new, old)) {
487 old->start = new.start;
497 if (resource_contains(old, &new)) {
498 old->start = new.start;
501 __release_resource(old);
503 conflict = __request_resource(root, old);
507 write_unlock(&resource_lock);
513 * allocate_resource - allocate empty slot in the resource tree given range & alignment.
514 * The resource will be reallocated with a new size if it was already allocated
515 * @root: root resource descriptor
516 * @new: resource descriptor desired by caller
517 * @size: requested resource region size
518 * @min: minimum size to allocate
519 * @max: maximum size to allocate
520 * @align: alignment requested, in bytes
521 * @alignf: alignment function, optional, called if not NULL
522 * @alignf_data: arbitrary data to pass to the @alignf function
524 int allocate_resource(struct resource *root, struct resource *new,
525 resource_size_t size, resource_size_t min,
526 resource_size_t max, resource_size_t align,
527 resource_size_t (*alignf)(void *,
528 const struct resource *,
534 struct resource_constraint constraint;
537 alignf = simple_align_resource;
539 constraint.min = min;
540 constraint.max = max;
541 constraint.align = align;
542 constraint.alignf = alignf;
543 constraint.alignf_data = alignf_data;
546 /* resource is already allocated, try reallocating with
547 the new constraints */
548 return reallocate_resource(root, new, size, &constraint);
551 write_lock(&resource_lock);
552 err = find_resource(root, new, size, &constraint);
553 if (err >= 0 && __request_resource(root, new))
555 write_unlock(&resource_lock);
559 EXPORT_SYMBOL(allocate_resource);
562 * lookup_resource - find an existing resource by a resource start address
563 * @root: root resource descriptor
564 * @start: resource start address
566 * Returns a pointer to the resource if found, NULL otherwise
568 struct resource *lookup_resource(struct resource *root, resource_size_t start)
570 struct resource *res;
572 read_lock(&resource_lock);
573 for (res = root->child; res; res = res->sibling) {
574 if (res->start == start)
577 read_unlock(&resource_lock);
583 * Insert a resource into the resource tree. If successful, return NULL,
584 * otherwise return the conflicting resource (compare to __request_resource())
586 static struct resource * __insert_resource(struct resource *parent, struct resource *new)
588 struct resource *first, *next;
590 for (;; parent = first) {
591 first = __request_resource(parent, new);
597 if (WARN_ON(first == new)) /* duplicated insertion */
600 if ((first->start > new->start) || (first->end < new->end))
602 if ((first->start == new->start) && (first->end == new->end))
606 for (next = first; ; next = next->sibling) {
607 /* Partial overlap? Bad, and unfixable */
608 if (next->start < new->start || next->end > new->end)
612 if (next->sibling->start > new->end)
616 new->parent = parent;
617 new->sibling = next->sibling;
620 next->sibling = NULL;
621 for (next = first; next; next = next->sibling)
624 if (parent->child == first) {
627 next = parent->child;
628 while (next->sibling != first)
629 next = next->sibling;
636 * insert_resource_conflict - Inserts resource in the resource tree
637 * @parent: parent of the new resource
638 * @new: new resource to insert
640 * Returns 0 on success, conflict resource if the resource can't be inserted.
642 * This function is equivalent to request_resource_conflict when no conflict
643 * happens. If a conflict happens, and the conflicting resources
644 * entirely fit within the range of the new resource, then the new
645 * resource is inserted and the conflicting resources become children of
648 struct resource *insert_resource_conflict(struct resource *parent, struct resource *new)
650 struct resource *conflict;
652 write_lock(&resource_lock);
653 conflict = __insert_resource(parent, new);
654 write_unlock(&resource_lock);
659 * insert_resource - Inserts a resource in the resource tree
660 * @parent: parent of the new resource
661 * @new: new resource to insert
663 * Returns 0 on success, -EBUSY if the resource can't be inserted.
665 int insert_resource(struct resource *parent, struct resource *new)
667 struct resource *conflict;
669 conflict = insert_resource_conflict(parent, new);
670 return conflict ? -EBUSY : 0;
674 * insert_resource_expand_to_fit - Insert a resource into the resource tree
675 * @root: root resource descriptor
676 * @new: new resource to insert
678 * Insert a resource into the resource tree, possibly expanding it in order
679 * to make it encompass any conflicting resources.
681 void insert_resource_expand_to_fit(struct resource *root, struct resource *new)
686 write_lock(&resource_lock);
688 struct resource *conflict;
690 conflict = __insert_resource(root, new);
693 if (conflict == root)
696 /* Ok, expand resource to cover the conflict, then try again .. */
697 if (conflict->start < new->start)
698 new->start = conflict->start;
699 if (conflict->end > new->end)
700 new->end = conflict->end;
702 printk("Expanded resource %s due to conflict with %s\n", new->name, conflict->name);
704 write_unlock(&resource_lock);
708 * adjust_resource - modify a resource's start and size
709 * @res: resource to modify
710 * @start: new start value
713 * Given an existing resource, change its start and size to match the
714 * arguments. Returns 0 on success, -EBUSY if it can't fit.
715 * Existing children of the resource are assumed to be immutable.
717 int adjust_resource(struct resource *res, resource_size_t start, resource_size_t size)
719 struct resource *tmp, *parent = res->parent;
720 resource_size_t end = start + size - 1;
723 write_lock(&resource_lock);
725 if ((start < parent->start) || (end > parent->end))
728 for (tmp = res->child; tmp; tmp = tmp->sibling) {
729 if ((tmp->start < start) || (tmp->end > end))
733 if (res->sibling && (res->sibling->start <= end))
738 while (tmp->sibling != res)
740 if (start <= tmp->end)
749 write_unlock(&resource_lock);
752 EXPORT_SYMBOL(adjust_resource);
754 static void __init __reserve_region_with_split(struct resource *root,
755 resource_size_t start, resource_size_t end,
758 struct resource *parent = root;
759 struct resource *conflict;
760 struct resource *res = kzalloc(sizeof(*res), GFP_ATOMIC);
768 res->flags = IORESOURCE_BUSY;
770 conflict = __request_resource(parent, res);
774 /* failed, split and try again */
777 /* conflict covered whole area */
778 if (conflict->start <= start && conflict->end >= end)
781 if (conflict->start > start)
782 __reserve_region_with_split(root, start, conflict->start-1, name);
783 if (conflict->end < end)
784 __reserve_region_with_split(root, conflict->end+1, end, name);
787 void __init reserve_region_with_split(struct resource *root,
788 resource_size_t start, resource_size_t end,
791 write_lock(&resource_lock);
792 __reserve_region_with_split(root, start, end, name);
793 write_unlock(&resource_lock);
797 * resource_alignment - calculate resource's alignment
798 * @res: resource pointer
800 * Returns alignment on success, 0 (invalid alignment) on failure.
802 resource_size_t resource_alignment(struct resource *res)
804 switch (res->flags & (IORESOURCE_SIZEALIGN | IORESOURCE_STARTALIGN)) {
805 case IORESOURCE_SIZEALIGN:
806 return resource_size(res);
807 case IORESOURCE_STARTALIGN:
815 * This is compatibility stuff for IO resources.
817 * Note how this, unlike the above, knows about
818 * the IO flag meanings (busy etc).
820 * request_region creates a new busy region.
822 * check_region returns non-zero if the area is already busy.
824 * release_region releases a matching busy region.
827 static DECLARE_WAIT_QUEUE_HEAD(muxed_resource_wait);
830 * __request_region - create a new busy resource region
831 * @parent: parent resource descriptor
832 * @start: resource start address
833 * @n: resource region size
834 * @name: reserving caller's ID string
835 * @flags: IO resource flags
837 struct resource * __request_region(struct resource *parent,
838 resource_size_t start, resource_size_t n,
839 const char *name, int flags)
841 DECLARE_WAITQUEUE(wait, current);
842 struct resource *res = kzalloc(sizeof(*res), GFP_KERNEL);
849 res->end = start + n - 1;
850 res->flags = IORESOURCE_BUSY;
853 write_lock(&resource_lock);
856 struct resource *conflict;
858 conflict = __request_resource(parent, res);
861 if (conflict != parent) {
863 if (!(conflict->flags & IORESOURCE_BUSY))
866 if (conflict->flags & flags & IORESOURCE_MUXED) {
867 add_wait_queue(&muxed_resource_wait, &wait);
868 write_unlock(&resource_lock);
869 set_current_state(TASK_UNINTERRUPTIBLE);
871 remove_wait_queue(&muxed_resource_wait, &wait);
872 write_lock(&resource_lock);
875 /* Uhhuh, that didn't work out.. */
880 write_unlock(&resource_lock);
883 EXPORT_SYMBOL(__request_region);
886 * __check_region - check if a resource region is busy or free
887 * @parent: parent resource descriptor
888 * @start: resource start address
889 * @n: resource region size
891 * Returns 0 if the region is free at the moment it is checked,
892 * returns %-EBUSY if the region is busy.
895 * This function is deprecated because its use is racy.
896 * Even if it returns 0, a subsequent call to request_region()
897 * may fail because another driver etc. just allocated the region.
898 * Do NOT use it. It will be removed from the kernel.
900 int __check_region(struct resource *parent, resource_size_t start,
903 struct resource * res;
905 res = __request_region(parent, start, n, "check-region", 0);
909 release_resource(res);
913 EXPORT_SYMBOL(__check_region);
916 * __release_region - release a previously reserved resource region
917 * @parent: parent resource descriptor
918 * @start: resource start address
919 * @n: resource region size
921 * The described resource region must match a currently busy region.
923 void __release_region(struct resource *parent, resource_size_t start,
932 write_lock(&resource_lock);
935 struct resource *res = *p;
939 if (res->start <= start && res->end >= end) {
940 if (!(res->flags & IORESOURCE_BUSY)) {
944 if (res->start != start || res->end != end)
947 write_unlock(&resource_lock);
948 if (res->flags & IORESOURCE_MUXED)
949 wake_up(&muxed_resource_wait);
956 write_unlock(&resource_lock);
958 printk(KERN_WARNING "Trying to free nonexistent resource "
959 "<%016llx-%016llx>\n", (unsigned long long)start,
960 (unsigned long long)end);
962 EXPORT_SYMBOL(__release_region);
965 * Managed region resource
967 struct region_devres {
968 struct resource *parent;
969 resource_size_t start;
973 static void devm_region_release(struct device *dev, void *res)
975 struct region_devres *this = res;
977 __release_region(this->parent, this->start, this->n);
980 static int devm_region_match(struct device *dev, void *res, void *match_data)
982 struct region_devres *this = res, *match = match_data;
984 return this->parent == match->parent &&
985 this->start == match->start && this->n == match->n;
988 struct resource * __devm_request_region(struct device *dev,
989 struct resource *parent, resource_size_t start,
990 resource_size_t n, const char *name)
992 struct region_devres *dr = NULL;
993 struct resource *res;
995 dr = devres_alloc(devm_region_release, sizeof(struct region_devres),
1000 dr->parent = parent;
1004 res = __request_region(parent, start, n, name, 0);
1006 devres_add(dev, dr);
1012 EXPORT_SYMBOL(__devm_request_region);
1014 void __devm_release_region(struct device *dev, struct resource *parent,
1015 resource_size_t start, resource_size_t n)
1017 struct region_devres match_data = { parent, start, n };
1019 __release_region(parent, start, n);
1020 WARN_ON(devres_destroy(dev, devm_region_release, devm_region_match,
1023 EXPORT_SYMBOL(__devm_release_region);
1026 * Called from init/main.c to reserve IO ports.
1028 #define MAXRESERVE 4
1029 static int __init reserve_setup(char *str)
1031 static int reserved;
1032 static struct resource reserve[MAXRESERVE];
1035 unsigned int io_start, io_num;
1038 if (get_option (&str, &io_start) != 2)
1040 if (get_option (&str, &io_num) == 0)
1042 if (x < MAXRESERVE) {
1043 struct resource *res = reserve + x;
1044 res->name = "reserved";
1045 res->start = io_start;
1046 res->end = io_start + io_num - 1;
1047 res->flags = IORESOURCE_BUSY;
1049 if (request_resource(res->start >= 0x10000 ? &iomem_resource : &ioport_resource, res) == 0)
1056 __setup("reserve=", reserve_setup);
1059 * Check if the requested addr and size spans more than any slot in the
1060 * iomem resource tree.
1062 int iomem_map_sanity_check(resource_size_t addr, unsigned long size)
1064 struct resource *p = &iomem_resource;
1068 read_lock(&resource_lock);
1069 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
1071 * We can probably skip the resources without
1072 * IORESOURCE_IO attribute?
1074 if (p->start >= addr + size)
1078 if (PFN_DOWN(p->start) <= PFN_DOWN(addr) &&
1079 PFN_DOWN(p->end) >= PFN_DOWN(addr + size - 1))
1082 * if a resource is "BUSY", it's not a hardware resource
1083 * but a driver mapping of such a resource; we don't want
1084 * to warn for those; some drivers legitimately map only
1085 * partial hardware resources. (example: vesafb)
1087 if (p->flags & IORESOURCE_BUSY)
1090 printk(KERN_WARNING "resource map sanity check conflict: "
1091 "0x%llx 0x%llx 0x%llx 0x%llx %s\n",
1092 (unsigned long long)addr,
1093 (unsigned long long)(addr + size - 1),
1094 (unsigned long long)p->start,
1095 (unsigned long long)p->end,
1100 read_unlock(&resource_lock);
1105 #ifdef CONFIG_STRICT_DEVMEM
1106 static int strict_iomem_checks = 1;
1108 static int strict_iomem_checks;
1112 * check if an address is reserved in the iomem resource tree
1113 * returns 1 if reserved, 0 if not reserved.
1115 int iomem_is_exclusive(u64 addr)
1117 struct resource *p = &iomem_resource;
1120 int size = PAGE_SIZE;
1122 if (!strict_iomem_checks)
1125 addr = addr & PAGE_MASK;
1127 read_lock(&resource_lock);
1128 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
1130 * We can probably skip the resources without
1131 * IORESOURCE_IO attribute?
1133 if (p->start >= addr + size)
1137 if (p->flags & IORESOURCE_BUSY &&
1138 p->flags & IORESOURCE_EXCLUSIVE) {
1143 read_unlock(&resource_lock);
1148 static int __init strict_iomem(char *str)
1150 if (strstr(str, "relaxed"))
1151 strict_iomem_checks = 0;
1152 if (strstr(str, "strict"))
1153 strict_iomem_checks = 1;
1157 __setup("iomem=", strict_iomem);