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/module.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/seq_file.h>
19 #include <linux/device.h>
20 #include <linux/pfn.h>
24 struct resource ioport_resource = {
27 .end = IO_SPACE_LIMIT,
28 .flags = IORESOURCE_IO,
30 EXPORT_SYMBOL(ioport_resource);
32 struct resource iomem_resource = {
36 .flags = IORESOURCE_MEM,
38 EXPORT_SYMBOL(iomem_resource);
40 static DEFINE_RWLOCK(resource_lock);
42 static void *r_next(struct seq_file *m, void *v, loff_t *pos)
44 struct resource *p = v;
48 while (!p->sibling && p->parent)
55 enum { MAX_IORES_LEVEL = 5 };
57 static void *r_start(struct seq_file *m, loff_t *pos)
58 __acquires(resource_lock)
60 struct resource *p = m->private;
62 read_lock(&resource_lock);
63 for (p = p->child; p && l < *pos; p = r_next(m, p, &l))
68 static void r_stop(struct seq_file *m, void *v)
69 __releases(resource_lock)
71 read_unlock(&resource_lock);
74 static int r_show(struct seq_file *m, void *v)
76 struct resource *root = m->private;
77 struct resource *r = v, *p;
78 int width = root->end < 0x10000 ? 4 : 8;
81 for (depth = 0, p = r; depth < MAX_IORES_LEVEL; depth++, p = p->parent)
82 if (p->parent == root)
84 seq_printf(m, "%*s%0*llx-%0*llx : %s\n",
86 width, (unsigned long long) r->start,
87 width, (unsigned long long) r->end,
88 r->name ? r->name : "<BAD>");
92 static const struct seq_operations resource_op = {
99 static int ioports_open(struct inode *inode, struct file *file)
101 int res = seq_open(file, &resource_op);
103 struct seq_file *m = file->private_data;
104 m->private = &ioport_resource;
109 static int iomem_open(struct inode *inode, struct file *file)
111 int res = seq_open(file, &resource_op);
113 struct seq_file *m = file->private_data;
114 m->private = &iomem_resource;
119 static const struct file_operations proc_ioports_operations = {
120 .open = ioports_open,
123 .release = seq_release,
126 static const struct file_operations proc_iomem_operations = {
130 .release = seq_release,
133 static int __init ioresources_init(void)
135 proc_create("ioports", 0, NULL, &proc_ioports_operations);
136 proc_create("iomem", 0, NULL, &proc_iomem_operations);
139 __initcall(ioresources_init);
141 #endif /* CONFIG_PROC_FS */
143 /* Return the conflict entry if you can't request it */
144 static struct resource * __request_resource(struct resource *root, struct resource *new)
146 resource_size_t start = new->start;
147 resource_size_t end = new->end;
148 struct resource *tmp, **p;
152 if (start < root->start)
159 if (!tmp || tmp->start > end) {
166 if (tmp->end < start)
172 static int __release_resource(struct resource *old)
174 struct resource *tmp, **p;
176 p = &old->parent->child;
191 static void __release_child_resources(struct resource *r)
193 struct resource *tmp, *p;
194 resource_size_t size;
204 __release_child_resources(tmp);
206 printk(KERN_DEBUG "release child resource %pR\n", tmp);
207 /* need to restore size, and keep flags */
208 size = resource_size(tmp);
214 void release_child_resources(struct resource *r)
216 write_lock(&resource_lock);
217 __release_child_resources(r);
218 write_unlock(&resource_lock);
222 * request_resource_conflict - request and reserve an I/O or memory resource
223 * @root: root resource descriptor
224 * @new: resource descriptor desired by caller
226 * Returns 0 for success, conflict resource on error.
228 struct resource *request_resource_conflict(struct resource *root, struct resource *new)
230 struct resource *conflict;
232 write_lock(&resource_lock);
233 conflict = __request_resource(root, new);
234 write_unlock(&resource_lock);
239 * request_resource - request and reserve an I/O or memory resource
240 * @root: root resource descriptor
241 * @new: resource descriptor desired by caller
243 * Returns 0 for success, negative error code on error.
245 int request_resource(struct resource *root, struct resource *new)
247 struct resource *conflict;
249 conflict = request_resource_conflict(root, new);
250 return conflict ? -EBUSY : 0;
253 EXPORT_SYMBOL(request_resource);
256 * release_resource - release a previously reserved resource
257 * @old: resource pointer
259 int release_resource(struct resource *old)
263 write_lock(&resource_lock);
264 retval = __release_resource(old);
265 write_unlock(&resource_lock);
269 EXPORT_SYMBOL(release_resource);
271 #if !defined(CONFIG_ARCH_HAS_WALK_MEMORY)
273 * Finds the lowest memory reosurce exists within [res->start.res->end)
274 * the caller must specify res->start, res->end, res->flags and "name".
275 * If found, returns 0, res is overwritten, if not found, returns -1.
277 static int find_next_system_ram(struct resource *res, char *name)
279 resource_size_t start, end;
286 BUG_ON(start >= end);
288 read_lock(&resource_lock);
289 for (p = iomem_resource.child; p ; p = p->sibling) {
290 /* system ram is just marked as IORESOURCE_MEM */
291 if (p->flags != res->flags)
293 if (name && strcmp(p->name, name))
295 if (p->start > end) {
299 if ((p->end >= start) && (p->start < end))
302 read_unlock(&resource_lock);
306 if (res->start < p->start)
307 res->start = p->start;
308 if (res->end > p->end)
314 * This function calls callback against all memory range of "System RAM"
315 * which are marked as IORESOURCE_MEM and IORESOUCE_BUSY.
316 * Now, this function is only for "System RAM".
318 int walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages,
319 void *arg, int (*func)(unsigned long, unsigned long, void *))
322 unsigned long pfn, end_pfn;
326 res.start = (u64) start_pfn << PAGE_SHIFT;
327 res.end = ((u64)(start_pfn + nr_pages) << PAGE_SHIFT) - 1;
328 res.flags = IORESOURCE_MEM | IORESOURCE_BUSY;
330 while ((res.start < res.end) &&
331 (find_next_system_ram(&res, "System RAM") >= 0)) {
332 pfn = (res.start + PAGE_SIZE - 1) >> PAGE_SHIFT;
333 end_pfn = (res.end + 1) >> PAGE_SHIFT;
335 ret = (*func)(pfn, end_pfn - pfn, arg);
338 res.start = res.end + 1;
346 static int __is_ram(unsigned long pfn, unsigned long nr_pages, void *arg)
351 * This generic page_is_ram() returns true if specified address is
352 * registered as "System RAM" in iomem_resource list.
354 int __weak page_is_ram(unsigned long pfn)
356 return walk_system_ram_range(pfn, 1, NULL, __is_ram) == 1;
360 * Find empty slot in the resource tree given range and alignment.
362 static int find_resource(struct resource *root, struct resource *new,
363 resource_size_t size, resource_size_t min,
364 resource_size_t max, resource_size_t align,
365 resource_size_t (*alignf)(void *,
366 const struct resource *,
371 struct resource *this = root->child;
372 struct resource tmp = *new;
374 tmp.start = root->start;
376 * Skip past an allocated resource that starts at 0, since the assignment
377 * of this->start - 1 to tmp->end below would cause an underflow.
379 if (this && this->start == 0) {
380 tmp.start = this->end + 1;
381 this = this->sibling;
385 tmp.end = this->start - 1;
392 tmp.start = ALIGN(tmp.start, align);
394 tmp.start = alignf(alignf_data, &tmp, size, align);
395 if (tmp.start < tmp.end && tmp.end - tmp.start >= size - 1) {
396 new->start = tmp.start;
397 new->end = tmp.start + size - 1;
402 tmp.start = this->end + 1;
403 this = this->sibling;
409 * allocate_resource - allocate empty slot in the resource tree given range & alignment
410 * @root: root resource descriptor
411 * @new: resource descriptor desired by caller
412 * @size: requested resource region size
413 * @min: minimum size to allocate
414 * @max: maximum size to allocate
415 * @align: alignment requested, in bytes
416 * @alignf: alignment function, optional, called if not NULL
417 * @alignf_data: arbitrary data to pass to the @alignf function
419 int allocate_resource(struct resource *root, struct resource *new,
420 resource_size_t size, resource_size_t min,
421 resource_size_t max, resource_size_t align,
422 resource_size_t (*alignf)(void *,
423 const struct resource *,
430 write_lock(&resource_lock);
431 err = find_resource(root, new, size, min, max, align, alignf, alignf_data);
432 if (err >= 0 && __request_resource(root, new))
434 write_unlock(&resource_lock);
438 EXPORT_SYMBOL(allocate_resource);
441 * Insert a resource into the resource tree. If successful, return NULL,
442 * otherwise return the conflicting resource (compare to __request_resource())
444 static struct resource * __insert_resource(struct resource *parent, struct resource *new)
446 struct resource *first, *next;
448 for (;; parent = first) {
449 first = __request_resource(parent, new);
456 if ((first->start > new->start) || (first->end < new->end))
458 if ((first->start == new->start) && (first->end == new->end))
462 for (next = first; ; next = next->sibling) {
463 /* Partial overlap? Bad, and unfixable */
464 if (next->start < new->start || next->end > new->end)
468 if (next->sibling->start > new->end)
472 new->parent = parent;
473 new->sibling = next->sibling;
476 next->sibling = NULL;
477 for (next = first; next; next = next->sibling)
480 if (parent->child == first) {
483 next = parent->child;
484 while (next->sibling != first)
485 next = next->sibling;
492 * insert_resource_conflict - Inserts resource in the resource tree
493 * @parent: parent of the new resource
494 * @new: new resource to insert
496 * Returns 0 on success, conflict resource if the resource can't be inserted.
498 * This function is equivalent to request_resource_conflict when no conflict
499 * happens. If a conflict happens, and the conflicting resources
500 * entirely fit within the range of the new resource, then the new
501 * resource is inserted and the conflicting resources become children of
504 struct resource *insert_resource_conflict(struct resource *parent, struct resource *new)
506 struct resource *conflict;
508 write_lock(&resource_lock);
509 conflict = __insert_resource(parent, new);
510 write_unlock(&resource_lock);
515 * insert_resource - Inserts a resource in the resource tree
516 * @parent: parent of the new resource
517 * @new: new resource to insert
519 * Returns 0 on success, -EBUSY if the resource can't be inserted.
521 int insert_resource(struct resource *parent, struct resource *new)
523 struct resource *conflict;
525 conflict = insert_resource_conflict(parent, new);
526 return conflict ? -EBUSY : 0;
530 * insert_resource_expand_to_fit - Insert a resource into the resource tree
531 * @root: root resource descriptor
532 * @new: new resource to insert
534 * Insert a resource into the resource tree, possibly expanding it in order
535 * to make it encompass any conflicting resources.
537 void insert_resource_expand_to_fit(struct resource *root, struct resource *new)
542 write_lock(&resource_lock);
544 struct resource *conflict;
546 conflict = __insert_resource(root, new);
549 if (conflict == root)
552 /* Ok, expand resource to cover the conflict, then try again .. */
553 if (conflict->start < new->start)
554 new->start = conflict->start;
555 if (conflict->end > new->end)
556 new->end = conflict->end;
558 printk("Expanded resource %s due to conflict with %s\n", new->name, conflict->name);
560 write_unlock(&resource_lock);
564 * adjust_resource - modify a resource's start and size
565 * @res: resource to modify
566 * @start: new start value
569 * Given an existing resource, change its start and size to match the
570 * arguments. Returns 0 on success, -EBUSY if it can't fit.
571 * Existing children of the resource are assumed to be immutable.
573 int adjust_resource(struct resource *res, resource_size_t start, resource_size_t size)
575 struct resource *tmp, *parent = res->parent;
576 resource_size_t end = start + size - 1;
579 write_lock(&resource_lock);
581 if ((start < parent->start) || (end > parent->end))
584 for (tmp = res->child; tmp; tmp = tmp->sibling) {
585 if ((tmp->start < start) || (tmp->end > end))
589 if (res->sibling && (res->sibling->start <= end))
594 while (tmp->sibling != res)
596 if (start <= tmp->end)
605 write_unlock(&resource_lock);
609 static void __init __reserve_region_with_split(struct resource *root,
610 resource_size_t start, resource_size_t end,
613 struct resource *parent = root;
614 struct resource *conflict;
615 struct resource *res = kzalloc(sizeof(*res), GFP_ATOMIC);
623 res->flags = IORESOURCE_BUSY;
625 conflict = __request_resource(parent, res);
629 /* failed, split and try again */
632 /* conflict covered whole area */
633 if (conflict->start <= start && conflict->end >= end)
636 if (conflict->start > start)
637 __reserve_region_with_split(root, start, conflict->start-1, name);
638 if (conflict->end < end)
639 __reserve_region_with_split(root, conflict->end+1, end, name);
642 void __init reserve_region_with_split(struct resource *root,
643 resource_size_t start, resource_size_t end,
646 write_lock(&resource_lock);
647 __reserve_region_with_split(root, start, end, name);
648 write_unlock(&resource_lock);
651 EXPORT_SYMBOL(adjust_resource);
654 * resource_alignment - calculate resource's alignment
655 * @res: resource pointer
657 * Returns alignment on success, 0 (invalid alignment) on failure.
659 resource_size_t resource_alignment(struct resource *res)
661 switch (res->flags & (IORESOURCE_SIZEALIGN | IORESOURCE_STARTALIGN)) {
662 case IORESOURCE_SIZEALIGN:
663 return resource_size(res);
664 case IORESOURCE_STARTALIGN:
672 * This is compatibility stuff for IO resources.
674 * Note how this, unlike the above, knows about
675 * the IO flag meanings (busy etc).
677 * request_region creates a new busy region.
679 * check_region returns non-zero if the area is already busy.
681 * release_region releases a matching busy region.
685 * __request_region - create a new busy resource region
686 * @parent: parent resource descriptor
687 * @start: resource start address
688 * @n: resource region size
689 * @name: reserving caller's ID string
690 * @flags: IO resource flags
692 struct resource * __request_region(struct resource *parent,
693 resource_size_t start, resource_size_t n,
694 const char *name, int flags)
696 struct resource *res = kzalloc(sizeof(*res), GFP_KERNEL);
703 res->end = start + n - 1;
704 res->flags = IORESOURCE_BUSY;
707 write_lock(&resource_lock);
710 struct resource *conflict;
712 conflict = __request_resource(parent, res);
715 if (conflict != parent) {
717 if (!(conflict->flags & IORESOURCE_BUSY))
721 /* Uhhuh, that didn't work out.. */
726 write_unlock(&resource_lock);
729 EXPORT_SYMBOL(__request_region);
732 * __check_region - check if a resource region is busy or free
733 * @parent: parent resource descriptor
734 * @start: resource start address
735 * @n: resource region size
737 * Returns 0 if the region is free at the moment it is checked,
738 * returns %-EBUSY if the region is busy.
741 * This function is deprecated because its use is racy.
742 * Even if it returns 0, a subsequent call to request_region()
743 * may fail because another driver etc. just allocated the region.
744 * Do NOT use it. It will be removed from the kernel.
746 int __check_region(struct resource *parent, resource_size_t start,
749 struct resource * res;
751 res = __request_region(parent, start, n, "check-region", 0);
755 release_resource(res);
759 EXPORT_SYMBOL(__check_region);
762 * __release_region - release a previously reserved resource region
763 * @parent: parent resource descriptor
764 * @start: resource start address
765 * @n: resource region size
767 * The described resource region must match a currently busy region.
769 void __release_region(struct resource *parent, resource_size_t start,
778 write_lock(&resource_lock);
781 struct resource *res = *p;
785 if (res->start <= start && res->end >= end) {
786 if (!(res->flags & IORESOURCE_BUSY)) {
790 if (res->start != start || res->end != end)
793 write_unlock(&resource_lock);
800 write_unlock(&resource_lock);
802 printk(KERN_WARNING "Trying to free nonexistent resource "
803 "<%016llx-%016llx>\n", (unsigned long long)start,
804 (unsigned long long)end);
806 EXPORT_SYMBOL(__release_region);
809 * Managed region resource
811 struct region_devres {
812 struct resource *parent;
813 resource_size_t start;
817 static void devm_region_release(struct device *dev, void *res)
819 struct region_devres *this = res;
821 __release_region(this->parent, this->start, this->n);
824 static int devm_region_match(struct device *dev, void *res, void *match_data)
826 struct region_devres *this = res, *match = match_data;
828 return this->parent == match->parent &&
829 this->start == match->start && this->n == match->n;
832 struct resource * __devm_request_region(struct device *dev,
833 struct resource *parent, resource_size_t start,
834 resource_size_t n, const char *name)
836 struct region_devres *dr = NULL;
837 struct resource *res;
839 dr = devres_alloc(devm_region_release, sizeof(struct region_devres),
848 res = __request_region(parent, start, n, name, 0);
856 EXPORT_SYMBOL(__devm_request_region);
858 void __devm_release_region(struct device *dev, struct resource *parent,
859 resource_size_t start, resource_size_t n)
861 struct region_devres match_data = { parent, start, n };
863 __release_region(parent, start, n);
864 WARN_ON(devres_destroy(dev, devm_region_release, devm_region_match,
867 EXPORT_SYMBOL(__devm_release_region);
870 * Called from init/main.c to reserve IO ports.
873 static int __init reserve_setup(char *str)
876 static struct resource reserve[MAXRESERVE];
879 unsigned int io_start, io_num;
882 if (get_option (&str, &io_start) != 2)
884 if (get_option (&str, &io_num) == 0)
886 if (x < MAXRESERVE) {
887 struct resource *res = reserve + x;
888 res->name = "reserved";
889 res->start = io_start;
890 res->end = io_start + io_num - 1;
891 res->flags = IORESOURCE_BUSY;
893 if (request_resource(res->start >= 0x10000 ? &iomem_resource : &ioport_resource, res) == 0)
900 __setup("reserve=", reserve_setup);
903 * Check if the requested addr and size spans more than any slot in the
904 * iomem resource tree.
906 int iomem_map_sanity_check(resource_size_t addr, unsigned long size)
908 struct resource *p = &iomem_resource;
912 read_lock(&resource_lock);
913 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
915 * We can probably skip the resources without
916 * IORESOURCE_IO attribute?
918 if (p->start >= addr + size)
922 if (PFN_DOWN(p->start) <= PFN_DOWN(addr) &&
923 PFN_DOWN(p->end) >= PFN_DOWN(addr + size - 1))
926 * if a resource is "BUSY", it's not a hardware resource
927 * but a driver mapping of such a resource; we don't want
928 * to warn for those; some drivers legitimately map only
929 * partial hardware resources. (example: vesafb)
931 if (p->flags & IORESOURCE_BUSY)
934 printk(KERN_WARNING "resource map sanity check conflict: "
935 "0x%llx 0x%llx 0x%llx 0x%llx %s\n",
936 (unsigned long long)addr,
937 (unsigned long long)(addr + size - 1),
938 (unsigned long long)p->start,
939 (unsigned long long)p->end,
944 read_unlock(&resource_lock);
949 #ifdef CONFIG_STRICT_DEVMEM
950 static int strict_iomem_checks = 1;
952 static int strict_iomem_checks;
956 * check if an address is reserved in the iomem resource tree
957 * returns 1 if reserved, 0 if not reserved.
959 int iomem_is_exclusive(u64 addr)
961 struct resource *p = &iomem_resource;
964 int size = PAGE_SIZE;
966 if (!strict_iomem_checks)
969 addr = addr & PAGE_MASK;
971 read_lock(&resource_lock);
972 for (p = p->child; p ; p = r_next(NULL, p, &l)) {
974 * We can probably skip the resources without
975 * IORESOURCE_IO attribute?
977 if (p->start >= addr + size)
981 if (p->flags & IORESOURCE_BUSY &&
982 p->flags & IORESOURCE_EXCLUSIVE) {
987 read_unlock(&resource_lock);
992 static int __init strict_iomem(char *str)
994 if (strstr(str, "relaxed"))
995 strict_iomem_checks = 0;
996 if (strstr(str, "strict"))
997 strict_iomem_checks = 1;
1001 __setup("iomem=", strict_iomem);