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
;
186 p
= &old
->parent
->child
;
202 * request_resource - request and reserve an I/O or memory resource
203 * @root: root resource descriptor
204 * @new: resource descriptor desired by caller
206 * Returns 0 for success, negative error code on error.
208 int request_resource(struct resource
*root
, struct resource
*new)
210 struct resource
*conflict
;
212 write_lock(&resource_lock
);
213 conflict
= __request_resource(root
, new);
214 write_unlock(&resource_lock
);
215 return conflict
? -EBUSY
: 0;
218 EXPORT_SYMBOL(request_resource
);
221 * release_resource - release a previously reserved resource
222 * @old: resource pointer
224 int release_resource(struct resource
*old
)
228 write_lock(&resource_lock
);
229 retval
= __release_resource(old
);
230 write_unlock(&resource_lock
);
234 EXPORT_SYMBOL(release_resource
);
236 #if !defined(CONFIG_ARCH_HAS_WALK_MEMORY)
238 * Finds the lowest memory reosurce exists within [res->start.res->end)
239 * the caller must specify res->start, res->end, res->flags and "name".
240 * If found, returns 0, res is overwritten, if not found, returns -1.
242 static int find_next_system_ram(struct resource
*res
, char *name
)
244 resource_size_t start
, end
;
251 BUG_ON(start
>= end
);
253 read_lock(&resource_lock
);
254 for (p
= iomem_resource
.child
; p
; p
= p
->sibling
) {
255 /* system ram is just marked as IORESOURCE_MEM */
256 if (p
->flags
!= res
->flags
)
258 if (name
&& strcmp(p
->name
, name
))
260 if (p
->start
> end
) {
264 if ((p
->end
>= start
) && (p
->start
< end
))
267 read_unlock(&resource_lock
);
271 if (res
->start
< p
->start
)
272 res
->start
= p
->start
;
273 if (res
->end
> p
->end
)
279 * This function calls callback against all memory range of "System RAM"
280 * which are marked as IORESOURCE_MEM and IORESOUCE_BUSY.
281 * Now, this function is only for "System RAM".
283 int walk_system_ram_range(unsigned long start_pfn
, unsigned long nr_pages
,
284 void *arg
, int (*func
)(unsigned long, unsigned long, void *))
287 unsigned long pfn
, len
;
291 res
.start
= (u64
) start_pfn
<< PAGE_SHIFT
;
292 res
.end
= ((u64
)(start_pfn
+ nr_pages
) << PAGE_SHIFT
) - 1;
293 res
.flags
= IORESOURCE_MEM
| IORESOURCE_BUSY
;
295 while ((res
.start
< res
.end
) &&
296 (find_next_system_ram(&res
, "System RAM") >= 0)) {
297 pfn
= (unsigned long)(res
.start
>> PAGE_SHIFT
);
298 len
= (unsigned long)((res
.end
+ 1 - res
.start
) >> PAGE_SHIFT
);
299 ret
= (*func
)(pfn
, len
, arg
);
302 res
.start
= res
.end
+ 1;
311 * Find empty slot in the resource tree given range and alignment.
313 static int find_resource(struct resource
*root
, struct resource
*new,
314 resource_size_t size
, resource_size_t min
,
315 resource_size_t max
, resource_size_t align
,
316 void (*alignf
)(void *, struct resource
*,
317 resource_size_t
, resource_size_t
),
320 struct resource
*this = root
->child
;
322 new->start
= root
->start
;
324 * Skip past an allocated resource that starts at 0, since the assignment
325 * of this->start - 1 to new->end below would cause an underflow.
327 if (this && this->start
== 0) {
328 new->start
= this->end
+ 1;
329 this = this->sibling
;
333 new->end
= this->start
- 1;
335 new->end
= root
->end
;
336 if (new->start
< min
)
340 new->start
= ALIGN(new->start
, align
);
342 alignf(alignf_data
, new, size
, align
);
343 if (new->start
< new->end
&& new->end
- new->start
>= size
- 1) {
344 new->end
= new->start
+ size
- 1;
349 new->start
= this->end
+ 1;
350 this = this->sibling
;
356 * allocate_resource - allocate empty slot in the resource tree given range & alignment
357 * @root: root resource descriptor
358 * @new: resource descriptor desired by caller
359 * @size: requested resource region size
360 * @min: minimum size to allocate
361 * @max: maximum size to allocate
362 * @align: alignment requested, in bytes
363 * @alignf: alignment function, optional, called if not NULL
364 * @alignf_data: arbitrary data to pass to the @alignf function
366 int allocate_resource(struct resource
*root
, struct resource
*new,
367 resource_size_t size
, resource_size_t min
,
368 resource_size_t max
, resource_size_t align
,
369 void (*alignf
)(void *, struct resource
*,
370 resource_size_t
, resource_size_t
),
375 write_lock(&resource_lock
);
376 err
= find_resource(root
, new, size
, min
, max
, align
, alignf
, alignf_data
);
377 if (err
>= 0 && __request_resource(root
, new))
379 write_unlock(&resource_lock
);
383 EXPORT_SYMBOL(allocate_resource
);
386 * Insert a resource into the resource tree. If successful, return NULL,
387 * otherwise return the conflicting resource (compare to __request_resource())
389 static struct resource
* __insert_resource(struct resource
*parent
, struct resource
*new)
391 struct resource
*first
, *next
;
393 for (;; parent
= first
) {
394 first
= __request_resource(parent
, new);
401 if ((first
->start
> new->start
) || (first
->end
< new->end
))
403 if ((first
->start
== new->start
) && (first
->end
== new->end
))
407 for (next
= first
; ; next
= next
->sibling
) {
408 /* Partial overlap? Bad, and unfixable */
409 if (next
->start
< new->start
|| next
->end
> new->end
)
413 if (next
->sibling
->start
> new->end
)
417 new->parent
= parent
;
418 new->sibling
= next
->sibling
;
421 next
->sibling
= NULL
;
422 for (next
= first
; next
; next
= next
->sibling
)
425 if (parent
->child
== first
) {
428 next
= parent
->child
;
429 while (next
->sibling
!= first
)
430 next
= next
->sibling
;
437 * insert_resource - Inserts a resource in the resource tree
438 * @parent: parent of the new resource
439 * @new: new resource to insert
441 * Returns 0 on success, -EBUSY if the resource can't be inserted.
443 * This function is equivalent to request_resource when no conflict
444 * happens. If a conflict happens, and the conflicting resources
445 * entirely fit within the range of the new resource, then the new
446 * resource is inserted and the conflicting resources become children of
449 int insert_resource(struct resource
*parent
, struct resource
*new)
451 struct resource
*conflict
;
453 write_lock(&resource_lock
);
454 conflict
= __insert_resource(parent
, new);
455 write_unlock(&resource_lock
);
456 return conflict
? -EBUSY
: 0;
460 * insert_resource_expand_to_fit - Insert a resource into the resource tree
461 * @root: root resource descriptor
462 * @new: new resource to insert
464 * Insert a resource into the resource tree, possibly expanding it in order
465 * to make it encompass any conflicting resources.
467 void insert_resource_expand_to_fit(struct resource
*root
, struct resource
*new)
472 write_lock(&resource_lock
);
474 struct resource
*conflict
;
476 conflict
= __insert_resource(root
, new);
479 if (conflict
== root
)
482 /* Ok, expand resource to cover the conflict, then try again .. */
483 if (conflict
->start
< new->start
)
484 new->start
= conflict
->start
;
485 if (conflict
->end
> new->end
)
486 new->end
= conflict
->end
;
488 printk("Expanded resource %s due to conflict with %s\n", new->name
, conflict
->name
);
490 write_unlock(&resource_lock
);
494 * adjust_resource - modify a resource's start and size
495 * @res: resource to modify
496 * @start: new start value
499 * Given an existing resource, change its start and size to match the
500 * arguments. Returns 0 on success, -EBUSY if it can't fit.
501 * Existing children of the resource are assumed to be immutable.
503 int adjust_resource(struct resource
*res
, resource_size_t start
, resource_size_t size
)
505 struct resource
*tmp
, *parent
= res
->parent
;
506 resource_size_t end
= start
+ size
- 1;
509 write_lock(&resource_lock
);
511 if ((start
< parent
->start
) || (end
> parent
->end
))
514 for (tmp
= res
->child
; tmp
; tmp
= tmp
->sibling
) {
515 if ((tmp
->start
< start
) || (tmp
->end
> end
))
519 if (res
->sibling
&& (res
->sibling
->start
<= end
))
524 while (tmp
->sibling
!= res
)
526 if (start
<= tmp
->end
)
535 write_unlock(&resource_lock
);
539 static void __init
__reserve_region_with_split(struct resource
*root
,
540 resource_size_t start
, resource_size_t end
,
543 struct resource
*parent
= root
;
544 struct resource
*conflict
;
545 struct resource
*res
= kzalloc(sizeof(*res
), GFP_ATOMIC
);
553 res
->flags
= IORESOURCE_BUSY
;
555 conflict
= __request_resource(parent
, res
);
559 /* failed, split and try again */
562 /* conflict covered whole area */
563 if (conflict
->start
<= start
&& conflict
->end
>= end
)
566 if (conflict
->start
> start
)
567 __reserve_region_with_split(root
, start
, conflict
->start
-1, name
);
568 if (conflict
->end
< end
)
569 __reserve_region_with_split(root
, conflict
->end
+1, end
, name
);
572 void __init
reserve_region_with_split(struct resource
*root
,
573 resource_size_t start
, resource_size_t end
,
576 write_lock(&resource_lock
);
577 __reserve_region_with_split(root
, start
, end
, name
);
578 write_unlock(&resource_lock
);
581 EXPORT_SYMBOL(adjust_resource
);
584 * resource_alignment - calculate resource's alignment
585 * @res: resource pointer
587 * Returns alignment on success, 0 (invalid alignment) on failure.
589 resource_size_t
resource_alignment(struct resource
*res
)
591 switch (res
->flags
& (IORESOURCE_SIZEALIGN
| IORESOURCE_STARTALIGN
)) {
592 case IORESOURCE_SIZEALIGN
:
593 return resource_size(res
);
594 case IORESOURCE_STARTALIGN
:
602 * This is compatibility stuff for IO resources.
604 * Note how this, unlike the above, knows about
605 * the IO flag meanings (busy etc).
607 * request_region creates a new busy region.
609 * check_region returns non-zero if the area is already busy.
611 * release_region releases a matching busy region.
615 * __request_region - create a new busy resource region
616 * @parent: parent resource descriptor
617 * @start: resource start address
618 * @n: resource region size
619 * @name: reserving caller's ID string
620 * @flags: IO resource flags
622 struct resource
* __request_region(struct resource
*parent
,
623 resource_size_t start
, resource_size_t n
,
624 const char *name
, int flags
)
626 struct resource
*res
= kzalloc(sizeof(*res
), GFP_KERNEL
);
633 res
->end
= start
+ n
- 1;
634 res
->flags
= IORESOURCE_BUSY
;
637 write_lock(&resource_lock
);
640 struct resource
*conflict
;
642 conflict
= __request_resource(parent
, res
);
645 if (conflict
!= parent
) {
647 if (!(conflict
->flags
& IORESOURCE_BUSY
))
651 /* Uhhuh, that didn't work out.. */
656 write_unlock(&resource_lock
);
659 EXPORT_SYMBOL(__request_region
);
662 * __check_region - check if a resource region is busy or free
663 * @parent: parent resource descriptor
664 * @start: resource start address
665 * @n: resource region size
667 * Returns 0 if the region is free at the moment it is checked,
668 * returns %-EBUSY if the region is busy.
671 * This function is deprecated because its use is racy.
672 * Even if it returns 0, a subsequent call to request_region()
673 * may fail because another driver etc. just allocated the region.
674 * Do NOT use it. It will be removed from the kernel.
676 int __check_region(struct resource
*parent
, resource_size_t start
,
679 struct resource
* res
;
681 res
= __request_region(parent
, start
, n
, "check-region", 0);
685 release_resource(res
);
689 EXPORT_SYMBOL(__check_region
);
692 * __release_region - release a previously reserved resource region
693 * @parent: parent resource descriptor
694 * @start: resource start address
695 * @n: resource region size
697 * The described resource region must match a currently busy region.
699 void __release_region(struct resource
*parent
, resource_size_t start
,
708 write_lock(&resource_lock
);
711 struct resource
*res
= *p
;
715 if (res
->start
<= start
&& res
->end
>= end
) {
716 if (!(res
->flags
& IORESOURCE_BUSY
)) {
720 if (res
->start
!= start
|| res
->end
!= end
)
723 write_unlock(&resource_lock
);
730 write_unlock(&resource_lock
);
732 printk(KERN_WARNING
"Trying to free nonexistent resource "
733 "<%016llx-%016llx>\n", (unsigned long long)start
,
734 (unsigned long long)end
);
736 EXPORT_SYMBOL(__release_region
);
739 * Managed region resource
741 struct region_devres
{
742 struct resource
*parent
;
743 resource_size_t start
;
747 static void devm_region_release(struct device
*dev
, void *res
)
749 struct region_devres
*this = res
;
751 __release_region(this->parent
, this->start
, this->n
);
754 static int devm_region_match(struct device
*dev
, void *res
, void *match_data
)
756 struct region_devres
*this = res
, *match
= match_data
;
758 return this->parent
== match
->parent
&&
759 this->start
== match
->start
&& this->n
== match
->n
;
762 struct resource
* __devm_request_region(struct device
*dev
,
763 struct resource
*parent
, resource_size_t start
,
764 resource_size_t n
, const char *name
)
766 struct region_devres
*dr
= NULL
;
767 struct resource
*res
;
769 dr
= devres_alloc(devm_region_release
, sizeof(struct region_devres
),
778 res
= __request_region(parent
, start
, n
, name
, 0);
786 EXPORT_SYMBOL(__devm_request_region
);
788 void __devm_release_region(struct device
*dev
, struct resource
*parent
,
789 resource_size_t start
, resource_size_t n
)
791 struct region_devres match_data
= { parent
, start
, n
};
793 __release_region(parent
, start
, n
);
794 WARN_ON(devres_destroy(dev
, devm_region_release
, devm_region_match
,
797 EXPORT_SYMBOL(__devm_release_region
);
800 * Called from init/main.c to reserve IO ports.
803 static int __init
reserve_setup(char *str
)
806 static struct resource reserve
[MAXRESERVE
];
809 unsigned int io_start
, io_num
;
812 if (get_option (&str
, &io_start
) != 2)
814 if (get_option (&str
, &io_num
) == 0)
816 if (x
< MAXRESERVE
) {
817 struct resource
*res
= reserve
+ x
;
818 res
->name
= "reserved";
819 res
->start
= io_start
;
820 res
->end
= io_start
+ io_num
- 1;
821 res
->flags
= IORESOURCE_BUSY
;
823 if (request_resource(res
->start
>= 0x10000 ? &iomem_resource
: &ioport_resource
, res
) == 0)
830 __setup("reserve=", reserve_setup
);
833 * Check if the requested addr and size spans more than any slot in the
834 * iomem resource tree.
836 int iomem_map_sanity_check(resource_size_t addr
, unsigned long size
)
838 struct resource
*p
= &iomem_resource
;
842 read_lock(&resource_lock
);
843 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
845 * We can probably skip the resources without
846 * IORESOURCE_IO attribute?
848 if (p
->start
>= addr
+ size
)
852 if (PFN_DOWN(p
->start
) <= PFN_DOWN(addr
) &&
853 PFN_DOWN(p
->end
) >= PFN_DOWN(addr
+ size
- 1))
856 * if a resource is "BUSY", it's not a hardware resource
857 * but a driver mapping of such a resource; we don't want
858 * to warn for those; some drivers legitimately map only
859 * partial hardware resources. (example: vesafb)
861 if (p
->flags
& IORESOURCE_BUSY
)
864 printk(KERN_WARNING
"resource map sanity check conflict: "
865 "0x%llx 0x%llx 0x%llx 0x%llx %s\n",
866 (unsigned long long)addr
,
867 (unsigned long long)(addr
+ size
- 1),
868 (unsigned long long)p
->start
,
869 (unsigned long long)p
->end
,
874 read_unlock(&resource_lock
);
879 #ifdef CONFIG_STRICT_DEVMEM
880 static int strict_iomem_checks
= 1;
882 static int strict_iomem_checks
;
886 * check if an address is reserved in the iomem resource tree
887 * returns 1 if reserved, 0 if not reserved.
889 int iomem_is_exclusive(u64 addr
)
891 struct resource
*p
= &iomem_resource
;
894 int size
= PAGE_SIZE
;
896 if (!strict_iomem_checks
)
899 addr
= addr
& PAGE_MASK
;
901 read_lock(&resource_lock
);
902 for (p
= p
->child
; p
; p
= r_next(NULL
, p
, &l
)) {
904 * We can probably skip the resources without
905 * IORESOURCE_IO attribute?
907 if (p
->start
>= addr
+ size
)
911 if (p
->flags
& IORESOURCE_BUSY
&&
912 p
->flags
& IORESOURCE_EXCLUSIVE
) {
917 read_unlock(&resource_lock
);
922 static int __init
strict_iomem(char *str
)
924 if (strstr(str
, "relaxed"))
925 strict_iomem_checks
= 0;
926 if (strstr(str
, "strict"))
927 strict_iomem_checks
= 1;
931 __setup("iomem=", strict_iomem
);