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/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 static DEFINE_RWLOCK(resource_lock
);
43 static void *r_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
45 struct resource
*p
= v
;
49 while (!p
->sibling
&& p
->parent
)
56 enum { MAX_IORES_LEVEL
= 5 };
58 static void *r_start(struct seq_file
*m
, loff_t
*pos
)
59 __acquires(resource_lock
)
61 struct resource
*p
= m
->private;
63 read_lock(&resource_lock
);
64 for (p
= p
->child
; p
&& l
< *pos
; p
= r_next(m
, p
, &l
))
69 static void r_stop(struct seq_file
*m
, void *v
)
70 __releases(resource_lock
)
72 read_unlock(&resource_lock
);
75 static int r_show(struct seq_file
*m
, void *v
)
77 struct resource
*root
= m
->private;
78 struct resource
*r
= v
, *p
;
79 int width
= root
->end
< 0x10000 ? 4 : 8;
82 for (depth
= 0, p
= r
; depth
< MAX_IORES_LEVEL
; depth
++, p
= p
->parent
)
83 if (p
->parent
== root
)
85 seq_printf(m
, "%*s%0*llx-%0*llx : %s\n",
87 width
, (unsigned long long) r
->start
,
88 width
, (unsigned long long) r
->end
,
89 r
->name
? r
->name
: "<BAD>");
93 static const struct seq_operations resource_op
= {
100 static int ioports_open(struct inode
*inode
, struct file
*file
)
102 int res
= seq_open(file
, &resource_op
);
104 struct seq_file
*m
= file
->private_data
;
105 m
->private = &ioport_resource
;
110 static int iomem_open(struct inode
*inode
, struct file
*file
)
112 int res
= seq_open(file
, &resource_op
);
114 struct seq_file
*m
= file
->private_data
;
115 m
->private = &iomem_resource
;
120 static const struct file_operations proc_ioports_operations
= {
121 .open
= ioports_open
,
124 .release
= seq_release
,
127 static const struct file_operations proc_iomem_operations
= {
131 .release
= seq_release
,
134 static int __init
ioresources_init(void)
136 proc_create("ioports", 0, NULL
, &proc_ioports_operations
);
137 proc_create("iomem", 0, NULL
, &proc_iomem_operations
);
140 __initcall(ioresources_init
);
142 #endif /* CONFIG_PROC_FS */
144 /* Return the conflict entry if you can't request it */
145 static struct resource
* __request_resource(struct resource
*root
, struct resource
*new)
147 resource_size_t start
= new->start
;
148 resource_size_t end
= new->end
;
149 struct resource
*tmp
, **p
;
153 if (start
< root
->start
)
160 if (!tmp
|| tmp
->start
> end
) {
167 if (tmp
->end
< start
)
173 static int __release_resource(struct resource
*old
)
175 struct resource
*tmp
, **p
;
177 p
= &old
->parent
->child
;
192 static void __release_child_resources(struct resource
*r
)
194 struct resource
*tmp
, *p
;
195 resource_size_t size
;
205 __release_child_resources(tmp
);
207 printk(KERN_DEBUG
"release child resource %pR\n", tmp
);
208 /* need to restore size, and keep flags */
209 size
= resource_size(tmp
);
215 void release_child_resources(struct resource
*r
)
217 write_lock(&resource_lock
);
218 __release_child_resources(r
);
219 write_unlock(&resource_lock
);
223 * request_resource_conflict - request and reserve an I/O or memory resource
224 * @root: root resource descriptor
225 * @new: resource descriptor desired by caller
227 * Returns 0 for success, conflict resource on error.
229 struct resource
*request_resource_conflict(struct resource
*root
, struct resource
*new)
231 struct resource
*conflict
;
233 write_lock(&resource_lock
);
234 conflict
= __request_resource(root
, new);
235 write_unlock(&resource_lock
);
240 * request_resource - request and reserve an I/O or memory resource
241 * @root: root resource descriptor
242 * @new: resource descriptor desired by caller
244 * Returns 0 for success, negative error code on error.
246 int request_resource(struct resource
*root
, struct resource
*new)
248 struct resource
*conflict
;
250 conflict
= request_resource_conflict(root
, new);
251 return conflict
? -EBUSY
: 0;
254 EXPORT_SYMBOL(request_resource
);
257 * release_resource - release a previously reserved resource
258 * @old: resource pointer
260 int release_resource(struct resource
*old
)
264 write_lock(&resource_lock
);
265 retval
= __release_resource(old
);
266 write_unlock(&resource_lock
);
270 EXPORT_SYMBOL(release_resource
);
272 #if !defined(CONFIG_ARCH_HAS_WALK_MEMORY)
274 * Finds the lowest memory reosurce exists within [res->start.res->end)
275 * the caller must specify res->start, res->end, res->flags and "name".
276 * If found, returns 0, res is overwritten, if not found, returns -1.
278 static int find_next_system_ram(struct resource
*res
, char *name
)
280 resource_size_t start
, end
;
287 BUG_ON(start
>= end
);
289 read_lock(&resource_lock
);
290 for (p
= iomem_resource
.child
; p
; p
= p
->sibling
) {
291 /* system ram is just marked as IORESOURCE_MEM */
292 if (p
->flags
!= res
->flags
)
294 if (name
&& strcmp(p
->name
, name
))
296 if (p
->start
> end
) {
300 if ((p
->end
>= start
) && (p
->start
< end
))
303 read_unlock(&resource_lock
);
307 if (res
->start
< p
->start
)
308 res
->start
= p
->start
;
309 if (res
->end
> p
->end
)
315 * This function calls callback against all memory range of "System RAM"
316 * which are marked as IORESOURCE_MEM and IORESOUCE_BUSY.
317 * Now, this function is only for "System RAM".
319 int walk_system_ram_range(unsigned long start_pfn
, unsigned long nr_pages
,
320 void *arg
, int (*func
)(unsigned long, unsigned long, void *))
323 unsigned long pfn
, end_pfn
;
327 res
.start
= (u64
) start_pfn
<< PAGE_SHIFT
;
328 res
.end
= ((u64
)(start_pfn
+ nr_pages
) << PAGE_SHIFT
) - 1;
329 res
.flags
= IORESOURCE_MEM
| IORESOURCE_BUSY
;
331 while ((res
.start
< res
.end
) &&
332 (find_next_system_ram(&res
, "System RAM") >= 0)) {
333 pfn
= (res
.start
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
334 end_pfn
= (res
.end
+ 1) >> PAGE_SHIFT
;
336 ret
= (*func
)(pfn
, end_pfn
- pfn
, arg
);
339 res
.start
= res
.end
+ 1;
347 static int __is_ram(unsigned long pfn
, unsigned long nr_pages
, void *arg
)
352 * This generic page_is_ram() returns true if specified address is
353 * registered as "System RAM" in iomem_resource list.
355 int __weak
page_is_ram(unsigned long pfn
)
357 return walk_system_ram_range(pfn
, 1, NULL
, __is_ram
) == 1;
360 void __weak
arch_remove_reservations(struct resource
*avail
)
364 static resource_size_t
simple_align_resource(void *data
,
365 const struct resource
*avail
,
366 resource_size_t size
,
367 resource_size_t align
)
372 static void resource_clip(struct resource
*res
, resource_size_t min
,
375 if (res
->start
< min
)
381 static bool resource_contains(struct resource
*res1
, struct resource
*res2
)
383 return res1
->start
<= res2
->start
&& res1
->end
>= res2
->end
;
387 * Find empty slot in the resource tree given range and alignment.
389 static int find_resource(struct resource
*root
, struct resource
*new,
390 resource_size_t size
, resource_size_t min
,
391 resource_size_t max
, resource_size_t align
,
392 resource_size_t (*alignf
)(void *,
393 const struct resource
*,
398 struct resource
*this = root
->child
;
399 struct resource tmp
= *new, avail
, alloc
;
401 tmp
.flags
= new->flags
;
402 tmp
.start
= root
->start
;
404 * Skip past an allocated resource that starts at 0, since the assignment
405 * of this->start - 1 to tmp->end below would cause an underflow.
407 if (this && this->start
== 0) {
408 tmp
.start
= this->end
+ 1;
409 this = this->sibling
;
413 tmp
.end
= this->start
- 1;
417 resource_clip(&tmp
, min
, max
);
418 arch_remove_reservations(&tmp
);
420 /* Check for overflow after ALIGN() */
422 avail
.start
= ALIGN(tmp
.start
, align
);
424 if (avail
.start
>= tmp
.start
) {
425 alloc
.start
= alignf(alignf_data
, &avail
, size
, align
);
426 alloc
.end
= alloc
.start
+ size
- 1;
427 if (resource_contains(&avail
, &alloc
)) {
428 new->start
= alloc
.start
;
429 new->end
= alloc
.end
;
435 tmp
.start
= this->end
+ 1;
436 this = this->sibling
;
442 * allocate_resource - allocate empty slot in the resource tree given range & alignment
443 * @root: root resource descriptor
444 * @new: resource descriptor desired by caller
445 * @size: requested resource region size
446 * @min: minimum size to allocate
447 * @max: maximum size to allocate
448 * @align: alignment requested, in bytes
449 * @alignf: alignment function, optional, called if not NULL
450 * @alignf_data: arbitrary data to pass to the @alignf function
452 int allocate_resource(struct resource
*root
, struct resource
*new,
453 resource_size_t size
, resource_size_t min
,
454 resource_size_t max
, resource_size_t align
,
455 resource_size_t (*alignf
)(void *,
456 const struct resource
*,
464 alignf
= simple_align_resource
;
466 write_lock(&resource_lock
);
467 err
= find_resource(root
, new, size
, min
, max
, align
, alignf
, alignf_data
);
468 if (err
>= 0 && __request_resource(root
, new))
470 write_unlock(&resource_lock
);
474 EXPORT_SYMBOL(allocate_resource
);
477 * Insert a resource into the resource tree. If successful, return NULL,
478 * otherwise return the conflicting resource (compare to __request_resource())
480 static struct resource
* __insert_resource(struct resource
*parent
, struct resource
*new)
482 struct resource
*first
, *next
;
484 for (;; parent
= first
) {
485 first
= __request_resource(parent
, new);
491 if (WARN_ON(first
== new)) /* duplicated insertion */
494 if ((first
->start
> new->start
) || (first
->end
< new->end
))
496 if ((first
->start
== new->start
) && (first
->end
== new->end
))
500 for (next
= first
; ; next
= next
->sibling
) {
501 /* Partial overlap? Bad, and unfixable */
502 if (next
->start
< new->start
|| next
->end
> new->end
)
506 if (next
->sibling
->start
> new->end
)
510 new->parent
= parent
;
511 new->sibling
= next
->sibling
;
514 next
->sibling
= NULL
;
515 for (next
= first
; next
; next
= next
->sibling
)
518 if (parent
->child
== first
) {
521 next
= parent
->child
;
522 while (next
->sibling
!= first
)
523 next
= next
->sibling
;
530 * insert_resource_conflict - Inserts resource in the resource tree
531 * @parent: parent of the new resource
532 * @new: new resource to insert
534 * Returns 0 on success, conflict resource if the resource can't be inserted.
536 * This function is equivalent to request_resource_conflict when no conflict
537 * happens. If a conflict happens, and the conflicting resources
538 * entirely fit within the range of the new resource, then the new
539 * resource is inserted and the conflicting resources become children of
542 struct resource
*insert_resource_conflict(struct resource
*parent
, struct resource
*new)
544 struct resource
*conflict
;
546 write_lock(&resource_lock
);
547 conflict
= __insert_resource(parent
, new);
548 write_unlock(&resource_lock
);
553 * insert_resource - Inserts a resource in the resource tree
554 * @parent: parent of the new resource
555 * @new: new resource to insert
557 * Returns 0 on success, -EBUSY if the resource can't be inserted.
559 int insert_resource(struct resource
*parent
, struct resource
*new)
561 struct resource
*conflict
;
563 conflict
= insert_resource_conflict(parent
, new);
564 return conflict
? -EBUSY
: 0;
568 * insert_resource_expand_to_fit - Insert a resource into the resource tree
569 * @root: root resource descriptor
570 * @new: new resource to insert
572 * Insert a resource into the resource tree, possibly expanding it in order
573 * to make it encompass any conflicting resources.
575 void insert_resource_expand_to_fit(struct resource
*root
, struct resource
*new)
580 write_lock(&resource_lock
);
582 struct resource
*conflict
;
584 conflict
= __insert_resource(root
, new);
587 if (conflict
== root
)
590 /* Ok, expand resource to cover the conflict, then try again .. */
591 if (conflict
->start
< new->start
)
592 new->start
= conflict
->start
;
593 if (conflict
->end
> new->end
)
594 new->end
= conflict
->end
;
596 printk("Expanded resource %s due to conflict with %s\n", new->name
, conflict
->name
);
598 write_unlock(&resource_lock
);
602 * adjust_resource - modify a resource's start and size
603 * @res: resource to modify
604 * @start: new start value
607 * Given an existing resource, change its start and size to match the
608 * arguments. Returns 0 on success, -EBUSY if it can't fit.
609 * Existing children of the resource are assumed to be immutable.
611 int adjust_resource(struct resource
*res
, resource_size_t start
, resource_size_t size
)
613 struct resource
*tmp
, *parent
= res
->parent
;
614 resource_size_t end
= start
+ size
- 1;
617 write_lock(&resource_lock
);
619 if ((start
< parent
->start
) || (end
> parent
->end
))
622 for (tmp
= res
->child
; tmp
; tmp
= tmp
->sibling
) {
623 if ((tmp
->start
< start
) || (tmp
->end
> end
))
627 if (res
->sibling
&& (res
->sibling
->start
<= end
))
632 while (tmp
->sibling
!= res
)
634 if (start
<= tmp
->end
)
643 write_unlock(&resource_lock
);
647 static void __init
__reserve_region_with_split(struct resource
*root
,
648 resource_size_t start
, resource_size_t end
,
651 struct resource
*parent
= root
;
652 struct resource
*conflict
;
653 struct resource
*res
= kzalloc(sizeof(*res
), GFP_ATOMIC
);
661 res
->flags
= IORESOURCE_BUSY
;
663 conflict
= __request_resource(parent
, res
);
667 /* failed, split and try again */
670 /* conflict covered whole area */
671 if (conflict
->start
<= start
&& conflict
->end
>= end
)
674 if (conflict
->start
> start
)
675 __reserve_region_with_split(root
, start
, conflict
->start
-1, name
);
676 if (conflict
->end
< end
)
677 __reserve_region_with_split(root
, conflict
->end
+1, end
, name
);
680 void __init
reserve_region_with_split(struct resource
*root
,
681 resource_size_t start
, resource_size_t end
,
684 write_lock(&resource_lock
);
685 __reserve_region_with_split(root
, start
, end
, name
);
686 write_unlock(&resource_lock
);
689 EXPORT_SYMBOL(adjust_resource
);
692 * resource_alignment - calculate resource's alignment
693 * @res: resource pointer
695 * Returns alignment on success, 0 (invalid alignment) on failure.
697 resource_size_t
resource_alignment(struct resource
*res
)
699 switch (res
->flags
& (IORESOURCE_SIZEALIGN
| IORESOURCE_STARTALIGN
)) {
700 case IORESOURCE_SIZEALIGN
:
701 return resource_size(res
);
702 case IORESOURCE_STARTALIGN
:
710 * This is compatibility stuff for IO resources.
712 * Note how this, unlike the above, knows about
713 * the IO flag meanings (busy etc).
715 * request_region creates a new busy region.
717 * check_region returns non-zero if the area is already busy.
719 * release_region releases a matching busy region.
722 static DECLARE_WAIT_QUEUE_HEAD(muxed_resource_wait
);
725 * __request_region - create a new busy resource region
726 * @parent: parent resource descriptor
727 * @start: resource start address
728 * @n: resource region size
729 * @name: reserving caller's ID string
730 * @flags: IO resource flags
732 struct resource
* __request_region(struct resource
*parent
,
733 resource_size_t start
, resource_size_t n
,
734 const char *name
, int flags
)
736 DECLARE_WAITQUEUE(wait
, current
);
737 struct resource
*res
= kzalloc(sizeof(*res
), GFP_KERNEL
);
744 res
->end
= start
+ n
- 1;
745 res
->flags
= IORESOURCE_BUSY
;
748 write_lock(&resource_lock
);
751 struct resource
*conflict
;
753 conflict
= __request_resource(parent
, res
);
756 if (conflict
!= parent
) {
758 if (!(conflict
->flags
& IORESOURCE_BUSY
))
761 if (conflict
->flags
& flags
& IORESOURCE_MUXED
) {
762 add_wait_queue(&muxed_resource_wait
, &wait
);
763 write_unlock(&resource_lock
);
764 set_current_state(TASK_UNINTERRUPTIBLE
);
766 remove_wait_queue(&muxed_resource_wait
, &wait
);
767 write_lock(&resource_lock
);
770 /* Uhhuh, that didn't work out.. */
775 write_unlock(&resource_lock
);
778 EXPORT_SYMBOL(__request_region
);
781 * __check_region - check if a resource region is busy or free
782 * @parent: parent resource descriptor
783 * @start: resource start address
784 * @n: resource region size
786 * Returns 0 if the region is free at the moment it is checked,
787 * returns %-EBUSY if the region is busy.
790 * This function is deprecated because its use is racy.
791 * Even if it returns 0, a subsequent call to request_region()
792 * may fail because another driver etc. just allocated the region.
793 * Do NOT use it. It will be removed from the kernel.
795 int __check_region(struct resource
*parent
, resource_size_t start
,
798 struct resource
* res
;
800 res
= __request_region(parent
, start
, n
, "check-region", 0);
804 release_resource(res
);
808 EXPORT_SYMBOL(__check_region
);
811 * __release_region - release a previously reserved resource region
812 * @parent: parent resource descriptor
813 * @start: resource start address
814 * @n: resource region size
816 * The described resource region must match a currently busy region.
818 void __release_region(struct resource
*parent
, resource_size_t start
,
827 write_lock(&resource_lock
);
830 struct resource
*res
= *p
;
834 if (res
->start
<= start
&& res
->end
>= end
) {
835 if (!(res
->flags
& IORESOURCE_BUSY
)) {
839 if (res
->start
!= start
|| res
->end
!= end
)
842 write_unlock(&resource_lock
);
843 if (res
->flags
& IORESOURCE_MUXED
)
844 wake_up(&muxed_resource_wait
);
851 write_unlock(&resource_lock
);
853 printk(KERN_WARNING
"Trying to free nonexistent resource "
854 "<%016llx-%016llx>\n", (unsigned long long)start
,
855 (unsigned long long)end
);
857 EXPORT_SYMBOL(__release_region
);
860 * Managed region resource
862 struct region_devres
{
863 struct resource
*parent
;
864 resource_size_t start
;
868 static void devm_region_release(struct device
*dev
, void *res
)
870 struct region_devres
*this = res
;
872 __release_region(this->parent
, this->start
, this->n
);
875 static int devm_region_match(struct device
*dev
, void *res
, void *match_data
)
877 struct region_devres
*this = res
, *match
= match_data
;
879 return this->parent
== match
->parent
&&
880 this->start
== match
->start
&& this->n
== match
->n
;
883 struct resource
* __devm_request_region(struct device
*dev
,
884 struct resource
*parent
, resource_size_t start
,
885 resource_size_t n
, const char *name
)
887 struct region_devres
*dr
= NULL
;
888 struct resource
*res
;
890 dr
= devres_alloc(devm_region_release
, sizeof(struct region_devres
),
899 res
= __request_region(parent
, start
, n
, name
, 0);
907 EXPORT_SYMBOL(__devm_request_region
);
909 void __devm_release_region(struct device
*dev
, struct resource
*parent
,
910 resource_size_t start
, resource_size_t n
)
912 struct region_devres match_data
= { parent
, start
, n
};
914 __release_region(parent
, start
, n
);
915 WARN_ON(devres_destroy(dev
, devm_region_release
, devm_region_match
,
918 EXPORT_SYMBOL(__devm_release_region
);
921 * Called from init/main.c to reserve IO ports.
924 static int __init
reserve_setup(char *str
)
927 static struct resource reserve
[MAXRESERVE
];
930 unsigned int io_start
, io_num
;
933 if (get_option (&str
, &io_start
) != 2)
935 if (get_option (&str
, &io_num
) == 0)
937 if (x
< MAXRESERVE
) {
938 struct resource
*res
= reserve
+ x
;
939 res
->name
= "reserved";
940 res
->start
= io_start
;
941 res
->end
= io_start
+ io_num
- 1;
942 res
->flags
= IORESOURCE_BUSY
;
944 if (request_resource(res
->start
>= 0x10000 ? &iomem_resource
: &ioport_resource
, res
) == 0)
951 __setup("reserve=", reserve_setup
);
954 * Check if the requested addr and size spans more than any slot in the
955 * iomem resource tree.
957 int iomem_map_sanity_check(resource_size_t addr
, unsigned long size
)
959 struct resource
*p
= &iomem_resource
;
963 read_lock(&resource_lock
);
964 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
966 * We can probably skip the resources without
967 * IORESOURCE_IO attribute?
969 if (p
->start
>= addr
+ size
)
973 if (PFN_DOWN(p
->start
) <= PFN_DOWN(addr
) &&
974 PFN_DOWN(p
->end
) >= PFN_DOWN(addr
+ size
- 1))
977 * if a resource is "BUSY", it's not a hardware resource
978 * but a driver mapping of such a resource; we don't want
979 * to warn for those; some drivers legitimately map only
980 * partial hardware resources. (example: vesafb)
982 if (p
->flags
& IORESOURCE_BUSY
)
985 printk(KERN_WARNING
"resource map sanity check conflict: "
986 "0x%llx 0x%llx 0x%llx 0x%llx %s\n",
987 (unsigned long long)addr
,
988 (unsigned long long)(addr
+ size
- 1),
989 (unsigned long long)p
->start
,
990 (unsigned long long)p
->end
,
995 read_unlock(&resource_lock
);
1000 #ifdef CONFIG_STRICT_DEVMEM
1001 static int strict_iomem_checks
= 1;
1003 static int strict_iomem_checks
;
1007 * check if an address is reserved in the iomem resource tree
1008 * returns 1 if reserved, 0 if not reserved.
1010 int iomem_is_exclusive(u64 addr
)
1012 struct resource
*p
= &iomem_resource
;
1015 int size
= PAGE_SIZE
;
1017 if (!strict_iomem_checks
)
1020 addr
= addr
& PAGE_MASK
;
1022 read_lock(&resource_lock
);
1023 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
1025 * We can probably skip the resources without
1026 * IORESOURCE_IO attribute?
1028 if (p
->start
>= addr
+ size
)
1032 if (p
->flags
& IORESOURCE_BUSY
&&
1033 p
->flags
& IORESOURCE_EXCLUSIVE
) {
1038 read_unlock(&resource_lock
);
1043 static int __init
strict_iomem(char *str
)
1045 if (strstr(str
, "relaxed"))
1046 strict_iomem_checks
= 0;
1047 if (strstr(str
, "strict"))
1048 strict_iomem_checks
= 1;
1052 __setup("iomem=", strict_iomem
);