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;
361 * Find empty slot in the resource tree given range and alignment.
363 static int find_resource(struct resource
*root
, struct resource
*new,
364 resource_size_t size
, resource_size_t min
,
365 resource_size_t max
, resource_size_t align
,
366 resource_size_t (*alignf
)(void *,
367 const struct resource
*,
372 struct resource
*this = root
->child
;
373 struct resource tmp
= *new;
375 tmp
.start
= root
->start
;
377 * Skip past an allocated resource that starts at 0, since the assignment
378 * of this->start - 1 to tmp->end below would cause an underflow.
380 if (this && this->start
== 0) {
381 tmp
.start
= this->end
+ 1;
382 this = this->sibling
;
386 tmp
.end
= this->start
- 1;
393 tmp
.start
= ALIGN(tmp
.start
, align
);
395 tmp
.start
= alignf(alignf_data
, &tmp
, size
, align
);
396 if (tmp
.start
< tmp
.end
&& tmp
.end
- tmp
.start
>= size
- 1) {
397 new->start
= tmp
.start
;
398 new->end
= tmp
.start
+ size
- 1;
403 tmp
.start
= this->end
+ 1;
404 this = this->sibling
;
410 * allocate_resource - allocate empty slot in the resource tree given range & alignment
411 * @root: root resource descriptor
412 * @new: resource descriptor desired by caller
413 * @size: requested resource region size
414 * @min: minimum size to allocate
415 * @max: maximum size to allocate
416 * @align: alignment requested, in bytes
417 * @alignf: alignment function, optional, called if not NULL
418 * @alignf_data: arbitrary data to pass to the @alignf function
420 int allocate_resource(struct resource
*root
, struct resource
*new,
421 resource_size_t size
, resource_size_t min
,
422 resource_size_t max
, resource_size_t align
,
423 resource_size_t (*alignf
)(void *,
424 const struct resource
*,
431 write_lock(&resource_lock
);
432 err
= find_resource(root
, new, size
, min
, max
, align
, alignf
, alignf_data
);
433 if (err
>= 0 && __request_resource(root
, new))
435 write_unlock(&resource_lock
);
439 EXPORT_SYMBOL(allocate_resource
);
442 * Insert a resource into the resource tree. If successful, return NULL,
443 * otherwise return the conflicting resource (compare to __request_resource())
445 static struct resource
* __insert_resource(struct resource
*parent
, struct resource
*new)
447 struct resource
*first
, *next
;
449 for (;; parent
= first
) {
450 first
= __request_resource(parent
, new);
456 if (WARN_ON(first
== new)) /* duplicated insertion */
459 if ((first
->start
> new->start
) || (first
->end
< new->end
))
461 if ((first
->start
== new->start
) && (first
->end
== new->end
))
465 for (next
= first
; ; next
= next
->sibling
) {
466 /* Partial overlap? Bad, and unfixable */
467 if (next
->start
< new->start
|| next
->end
> new->end
)
471 if (next
->sibling
->start
> new->end
)
475 new->parent
= parent
;
476 new->sibling
= next
->sibling
;
479 next
->sibling
= NULL
;
480 for (next
= first
; next
; next
= next
->sibling
)
483 if (parent
->child
== first
) {
486 next
= parent
->child
;
487 while (next
->sibling
!= first
)
488 next
= next
->sibling
;
495 * insert_resource_conflict - Inserts resource in the resource tree
496 * @parent: parent of the new resource
497 * @new: new resource to insert
499 * Returns 0 on success, conflict resource if the resource can't be inserted.
501 * This function is equivalent to request_resource_conflict when no conflict
502 * happens. If a conflict happens, and the conflicting resources
503 * entirely fit within the range of the new resource, then the new
504 * resource is inserted and the conflicting resources become children of
507 struct resource
*insert_resource_conflict(struct resource
*parent
, struct resource
*new)
509 struct resource
*conflict
;
511 write_lock(&resource_lock
);
512 conflict
= __insert_resource(parent
, new);
513 write_unlock(&resource_lock
);
518 * insert_resource - Inserts a resource in the resource tree
519 * @parent: parent of the new resource
520 * @new: new resource to insert
522 * Returns 0 on success, -EBUSY if the resource can't be inserted.
524 int insert_resource(struct resource
*parent
, struct resource
*new)
526 struct resource
*conflict
;
528 conflict
= insert_resource_conflict(parent
, new);
529 return conflict
? -EBUSY
: 0;
533 * insert_resource_expand_to_fit - Insert a resource into the resource tree
534 * @root: root resource descriptor
535 * @new: new resource to insert
537 * Insert a resource into the resource tree, possibly expanding it in order
538 * to make it encompass any conflicting resources.
540 void insert_resource_expand_to_fit(struct resource
*root
, struct resource
*new)
545 write_lock(&resource_lock
);
547 struct resource
*conflict
;
549 conflict
= __insert_resource(root
, new);
552 if (conflict
== root
)
555 /* Ok, expand resource to cover the conflict, then try again .. */
556 if (conflict
->start
< new->start
)
557 new->start
= conflict
->start
;
558 if (conflict
->end
> new->end
)
559 new->end
= conflict
->end
;
561 printk("Expanded resource %s due to conflict with %s\n", new->name
, conflict
->name
);
563 write_unlock(&resource_lock
);
567 * adjust_resource - modify a resource's start and size
568 * @res: resource to modify
569 * @start: new start value
572 * Given an existing resource, change its start and size to match the
573 * arguments. Returns 0 on success, -EBUSY if it can't fit.
574 * Existing children of the resource are assumed to be immutable.
576 int adjust_resource(struct resource
*res
, resource_size_t start
, resource_size_t size
)
578 struct resource
*tmp
, *parent
= res
->parent
;
579 resource_size_t end
= start
+ size
- 1;
582 write_lock(&resource_lock
);
584 if ((start
< parent
->start
) || (end
> parent
->end
))
587 for (tmp
= res
->child
; tmp
; tmp
= tmp
->sibling
) {
588 if ((tmp
->start
< start
) || (tmp
->end
> end
))
592 if (res
->sibling
&& (res
->sibling
->start
<= end
))
597 while (tmp
->sibling
!= res
)
599 if (start
<= tmp
->end
)
608 write_unlock(&resource_lock
);
612 static void __init
__reserve_region_with_split(struct resource
*root
,
613 resource_size_t start
, resource_size_t end
,
616 struct resource
*parent
= root
;
617 struct resource
*conflict
;
618 struct resource
*res
= kzalloc(sizeof(*res
), GFP_ATOMIC
);
626 res
->flags
= IORESOURCE_BUSY
;
628 conflict
= __request_resource(parent
, res
);
632 /* failed, split and try again */
635 /* conflict covered whole area */
636 if (conflict
->start
<= start
&& conflict
->end
>= end
)
639 if (conflict
->start
> start
)
640 __reserve_region_with_split(root
, start
, conflict
->start
-1, name
);
641 if (conflict
->end
< end
)
642 __reserve_region_with_split(root
, conflict
->end
+1, end
, name
);
645 void __init
reserve_region_with_split(struct resource
*root
,
646 resource_size_t start
, resource_size_t end
,
649 write_lock(&resource_lock
);
650 __reserve_region_with_split(root
, start
, end
, name
);
651 write_unlock(&resource_lock
);
654 EXPORT_SYMBOL(adjust_resource
);
657 * resource_alignment - calculate resource's alignment
658 * @res: resource pointer
660 * Returns alignment on success, 0 (invalid alignment) on failure.
662 resource_size_t
resource_alignment(struct resource
*res
)
664 switch (res
->flags
& (IORESOURCE_SIZEALIGN
| IORESOURCE_STARTALIGN
)) {
665 case IORESOURCE_SIZEALIGN
:
666 return resource_size(res
);
667 case IORESOURCE_STARTALIGN
:
675 * This is compatibility stuff for IO resources.
677 * Note how this, unlike the above, knows about
678 * the IO flag meanings (busy etc).
680 * request_region creates a new busy region.
682 * check_region returns non-zero if the area is already busy.
684 * release_region releases a matching busy region.
687 static DECLARE_WAIT_QUEUE_HEAD(muxed_resource_wait
);
690 * __request_region - create a new busy resource region
691 * @parent: parent resource descriptor
692 * @start: resource start address
693 * @n: resource region size
694 * @name: reserving caller's ID string
695 * @flags: IO resource flags
697 struct resource
* __request_region(struct resource
*parent
,
698 resource_size_t start
, resource_size_t n
,
699 const char *name
, int flags
)
701 DECLARE_WAITQUEUE(wait
, current
);
702 struct resource
*res
= kzalloc(sizeof(*res
), GFP_KERNEL
);
709 res
->end
= start
+ n
- 1;
710 res
->flags
= IORESOURCE_BUSY
;
713 write_lock(&resource_lock
);
716 struct resource
*conflict
;
718 conflict
= __request_resource(parent
, res
);
721 if (conflict
!= parent
) {
723 if (!(conflict
->flags
& IORESOURCE_BUSY
))
726 if (conflict
->flags
& flags
& IORESOURCE_MUXED
) {
727 add_wait_queue(&muxed_resource_wait
, &wait
);
728 write_unlock(&resource_lock
);
729 set_current_state(TASK_UNINTERRUPTIBLE
);
731 remove_wait_queue(&muxed_resource_wait
, &wait
);
732 write_lock(&resource_lock
);
735 /* Uhhuh, that didn't work out.. */
740 write_unlock(&resource_lock
);
743 EXPORT_SYMBOL(__request_region
);
746 * __check_region - check if a resource region is busy or free
747 * @parent: parent resource descriptor
748 * @start: resource start address
749 * @n: resource region size
751 * Returns 0 if the region is free at the moment it is checked,
752 * returns %-EBUSY if the region is busy.
755 * This function is deprecated because its use is racy.
756 * Even if it returns 0, a subsequent call to request_region()
757 * may fail because another driver etc. just allocated the region.
758 * Do NOT use it. It will be removed from the kernel.
760 int __check_region(struct resource
*parent
, resource_size_t start
,
763 struct resource
* res
;
765 res
= __request_region(parent
, start
, n
, "check-region", 0);
769 release_resource(res
);
773 EXPORT_SYMBOL(__check_region
);
776 * __release_region - release a previously reserved resource region
777 * @parent: parent resource descriptor
778 * @start: resource start address
779 * @n: resource region size
781 * The described resource region must match a currently busy region.
783 void __release_region(struct resource
*parent
, resource_size_t start
,
792 write_lock(&resource_lock
);
795 struct resource
*res
= *p
;
799 if (res
->start
<= start
&& res
->end
>= end
) {
800 if (!(res
->flags
& IORESOURCE_BUSY
)) {
804 if (res
->start
!= start
|| res
->end
!= end
)
807 write_unlock(&resource_lock
);
808 if (res
->flags
& IORESOURCE_MUXED
)
809 wake_up(&muxed_resource_wait
);
816 write_unlock(&resource_lock
);
818 printk(KERN_WARNING
"Trying to free nonexistent resource "
819 "<%016llx-%016llx>\n", (unsigned long long)start
,
820 (unsigned long long)end
);
822 EXPORT_SYMBOL(__release_region
);
825 * Managed region resource
827 struct region_devres
{
828 struct resource
*parent
;
829 resource_size_t start
;
833 static void devm_region_release(struct device
*dev
, void *res
)
835 struct region_devres
*this = res
;
837 __release_region(this->parent
, this->start
, this->n
);
840 static int devm_region_match(struct device
*dev
, void *res
, void *match_data
)
842 struct region_devres
*this = res
, *match
= match_data
;
844 return this->parent
== match
->parent
&&
845 this->start
== match
->start
&& this->n
== match
->n
;
848 struct resource
* __devm_request_region(struct device
*dev
,
849 struct resource
*parent
, resource_size_t start
,
850 resource_size_t n
, const char *name
)
852 struct region_devres
*dr
= NULL
;
853 struct resource
*res
;
855 dr
= devres_alloc(devm_region_release
, sizeof(struct region_devres
),
864 res
= __request_region(parent
, start
, n
, name
, 0);
872 EXPORT_SYMBOL(__devm_request_region
);
874 void __devm_release_region(struct device
*dev
, struct resource
*parent
,
875 resource_size_t start
, resource_size_t n
)
877 struct region_devres match_data
= { parent
, start
, n
};
879 __release_region(parent
, start
, n
);
880 WARN_ON(devres_destroy(dev
, devm_region_release
, devm_region_match
,
883 EXPORT_SYMBOL(__devm_release_region
);
886 * Called from init/main.c to reserve IO ports.
889 static int __init
reserve_setup(char *str
)
892 static struct resource reserve
[MAXRESERVE
];
895 unsigned int io_start
, io_num
;
898 if (get_option (&str
, &io_start
) != 2)
900 if (get_option (&str
, &io_num
) == 0)
902 if (x
< MAXRESERVE
) {
903 struct resource
*res
= reserve
+ x
;
904 res
->name
= "reserved";
905 res
->start
= io_start
;
906 res
->end
= io_start
+ io_num
- 1;
907 res
->flags
= IORESOURCE_BUSY
;
909 if (request_resource(res
->start
>= 0x10000 ? &iomem_resource
: &ioport_resource
, res
) == 0)
916 __setup("reserve=", reserve_setup
);
919 * Check if the requested addr and size spans more than any slot in the
920 * iomem resource tree.
922 int iomem_map_sanity_check(resource_size_t addr
, unsigned long size
)
924 struct resource
*p
= &iomem_resource
;
928 read_lock(&resource_lock
);
929 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
931 * We can probably skip the resources without
932 * IORESOURCE_IO attribute?
934 if (p
->start
>= addr
+ size
)
938 if (PFN_DOWN(p
->start
) <= PFN_DOWN(addr
) &&
939 PFN_DOWN(p
->end
) >= PFN_DOWN(addr
+ size
- 1))
942 * if a resource is "BUSY", it's not a hardware resource
943 * but a driver mapping of such a resource; we don't want
944 * to warn for those; some drivers legitimately map only
945 * partial hardware resources. (example: vesafb)
947 if (p
->flags
& IORESOURCE_BUSY
)
950 printk(KERN_WARNING
"resource map sanity check conflict: "
951 "0x%llx 0x%llx 0x%llx 0x%llx %s\n",
952 (unsigned long long)addr
,
953 (unsigned long long)(addr
+ size
- 1),
954 (unsigned long long)p
->start
,
955 (unsigned long long)p
->end
,
960 read_unlock(&resource_lock
);
965 #ifdef CONFIG_STRICT_DEVMEM
966 static int strict_iomem_checks
= 1;
968 static int strict_iomem_checks
;
972 * check if an address is reserved in the iomem resource tree
973 * returns 1 if reserved, 0 if not reserved.
975 int iomem_is_exclusive(u64 addr
)
977 struct resource
*p
= &iomem_resource
;
980 int size
= PAGE_SIZE
;
982 if (!strict_iomem_checks
)
985 addr
= addr
& PAGE_MASK
;
987 read_lock(&resource_lock
);
988 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
990 * We can probably skip the resources without
991 * IORESOURCE_IO attribute?
993 if (p
->start
>= addr
+ size
)
997 if (p
->flags
& IORESOURCE_BUSY
&&
998 p
->flags
& IORESOURCE_EXCLUSIVE
) {
1003 read_unlock(&resource_lock
);
1008 static int __init
strict_iomem(char *str
)
1010 if (strstr(str
, "relaxed"))
1011 strict_iomem_checks
= 0;
1012 if (strstr(str
, "strict"))
1013 strict_iomem_checks
= 1;
1017 __setup("iomem=", strict_iomem
);