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/sched.h>
12 #include <linux/errno.h>
13 #include <linux/ioport.h>
14 #include <linux/init.h>
15 #include <linux/slab.h>
16 #include <linux/spinlock.h>
18 #include <linux/proc_fs.h>
19 #include <linux/seq_file.h>
23 struct resource ioport_resource = {
26 .end = IO_SPACE_LIMIT,
27 .flags = IORESOURCE_IO,
29 EXPORT_SYMBOL(ioport_resource);
31 struct resource iomem_resource = {
35 .flags = IORESOURCE_MEM,
37 EXPORT_SYMBOL(iomem_resource);
39 static DEFINE_RWLOCK(resource_lock);
43 enum { MAX_IORES_LEVEL = 5 };
45 static void *r_next(struct seq_file *m, void *v, loff_t *pos)
47 struct resource *p = v;
51 while (!p->sibling && p->parent)
56 static void *r_start(struct seq_file *m, loff_t *pos)
57 __acquires(resource_lock)
59 struct resource *p = m->private;
61 read_lock(&resource_lock);
62 for (p = p->child; p && l < *pos; p = r_next(m, p, &l))
67 static void r_stop(struct seq_file *m, void *v)
68 __releases(resource_lock)
70 read_unlock(&resource_lock);
73 static int r_show(struct seq_file *m, void *v)
75 struct resource *root = m->private;
76 struct resource *r = v, *p;
77 int width = root->end < 0x10000 ? 4 : 8;
80 for (depth = 0, p = r; depth < MAX_IORES_LEVEL; depth++, p = p->parent)
81 if (p->parent == root)
83 seq_printf(m, "%*s%0*llx-%0*llx : %s\n",
85 width, (unsigned long long) r->start,
86 width, (unsigned long long) r->end,
87 r->name ? r->name : "<BAD>");
91 static const struct seq_operations resource_op = {
98 static int ioports_open(struct inode *inode, struct file *file)
100 int res = seq_open(file, &resource_op);
102 struct seq_file *m = file->private_data;
103 m->private = &ioport_resource;
108 static int iomem_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 = &iomem_resource;
118 static const struct file_operations proc_ioports_operations = {
119 .open = ioports_open,
122 .release = seq_release,
125 static const struct file_operations proc_iomem_operations = {
129 .release = seq_release,
132 static int __init ioresources_init(void)
134 struct proc_dir_entry *entry;
136 entry = create_proc_entry("ioports", 0, NULL);
138 entry->proc_fops = &proc_ioports_operations;
139 entry = create_proc_entry("iomem", 0, NULL);
141 entry->proc_fops = &proc_iomem_operations;
144 __initcall(ioresources_init);
146 #endif /* CONFIG_PROC_FS */
148 /* Return the conflict entry if you can't request it */
149 static struct resource * __request_resource(struct resource *root, struct resource *new)
151 resource_size_t start = new->start;
152 resource_size_t end = new->end;
153 struct resource *tmp, **p;
157 if (start < root->start)
164 if (!tmp || tmp->start > end) {
171 if (tmp->end < start)
177 static int __release_resource(struct resource *old)
179 struct resource *tmp, **p;
181 p = &old->parent->child;
197 * request_resource - request and reserve an I/O or memory resource
198 * @root: root resource descriptor
199 * @new: resource descriptor desired by caller
201 * Returns 0 for success, negative error code on error.
203 int request_resource(struct resource *root, struct resource *new)
205 struct resource *conflict;
207 write_lock(&resource_lock);
208 conflict = __request_resource(root, new);
209 write_unlock(&resource_lock);
210 return conflict ? -EBUSY : 0;
213 EXPORT_SYMBOL(request_resource);
216 * ____request_resource - reserve a resource, with resource conflict returned
217 * @root: root resource descriptor
218 * @new: resource descriptor desired by caller
221 * On success, NULL is returned.
222 * On error, a pointer to the conflicting resource is returned.
224 struct resource *____request_resource(struct resource *root, struct resource *new)
226 struct resource *conflict;
228 write_lock(&resource_lock);
229 conflict = __request_resource(root, new);
230 write_unlock(&resource_lock);
234 EXPORT_SYMBOL(____request_resource);
237 * release_resource - release a previously reserved resource
238 * @old: resource pointer
240 int release_resource(struct resource *old)
244 write_lock(&resource_lock);
245 retval = __release_resource(old);
246 write_unlock(&resource_lock);
250 EXPORT_SYMBOL(release_resource);
252 #ifdef CONFIG_MEMORY_HOTPLUG
254 * Finds the lowest memory reosurce exists within [res->start.res->end)
255 * the caller must specify res->start, res->end, res->flags.
256 * If found, returns 0, res is overwritten, if not found, returns -1.
258 int find_next_system_ram(struct resource *res)
260 resource_size_t start, end;
267 BUG_ON(start >= end);
269 read_lock(&resource_lock);
270 for (p = iomem_resource.child; p ; p = p->sibling) {
271 /* system ram is just marked as IORESOURCE_MEM */
272 if (p->flags != res->flags)
274 if (p->start > end) {
278 if ((p->end >= start) && (p->start < end))
281 read_unlock(&resource_lock);
285 if (res->start < p->start)
286 res->start = p->start;
287 if (res->end > p->end)
294 * Find empty slot in the resource tree given range and alignment.
296 static int find_resource(struct resource *root, struct resource *new,
297 resource_size_t size, resource_size_t min,
298 resource_size_t max, resource_size_t align,
299 void (*alignf)(void *, struct resource *,
300 resource_size_t, resource_size_t),
303 struct resource *this = root->child;
305 new->start = root->start;
307 * Skip past an allocated resource that starts at 0, since the assignment
308 * of this->start - 1 to new->end below would cause an underflow.
310 if (this && this->start == 0) {
311 new->start = this->end + 1;
312 this = this->sibling;
316 new->end = this->start - 1;
318 new->end = root->end;
319 if (new->start < min)
323 new->start = ALIGN(new->start, align);
325 alignf(alignf_data, new, size, align);
326 if (new->start < new->end && new->end - new->start >= size - 1) {
327 new->end = new->start + size - 1;
332 new->start = this->end + 1;
333 this = this->sibling;
339 * allocate_resource - allocate empty slot in the resource tree given range & alignment
340 * @root: root resource descriptor
341 * @new: resource descriptor desired by caller
342 * @size: requested resource region size
343 * @min: minimum size to allocate
344 * @max: maximum size to allocate
345 * @align: alignment requested, in bytes
346 * @alignf: alignment function, optional, called if not NULL
347 * @alignf_data: arbitrary data to pass to the @alignf function
349 int allocate_resource(struct resource *root, struct resource *new,
350 resource_size_t size, resource_size_t min,
351 resource_size_t max, resource_size_t align,
352 void (*alignf)(void *, struct resource *,
353 resource_size_t, resource_size_t),
358 write_lock(&resource_lock);
359 err = find_resource(root, new, size, min, max, align, alignf, alignf_data);
360 if (err >= 0 && __request_resource(root, new))
362 write_unlock(&resource_lock);
366 EXPORT_SYMBOL(allocate_resource);
369 * insert_resource - Inserts a resource in the resource tree
370 * @parent: parent of the new resource
371 * @new: new resource to insert
373 * Returns 0 on success, -EBUSY if the resource can't be inserted.
375 * This function is equivalent to request_resource when no conflict
376 * happens. If a conflict happens, and the conflicting resources
377 * entirely fit within the range of the new resource, then the new
378 * resource is inserted and the conflicting resources become children of
381 int insert_resource(struct resource *parent, struct resource *new)
384 struct resource *first, *next;
386 write_lock(&resource_lock);
388 for (;; parent = first) {
390 first = __request_resource(parent, new);
398 if ((first->start > new->start) || (first->end < new->end))
400 if ((first->start == new->start) && (first->end == new->end))
404 for (next = first; ; next = next->sibling) {
405 /* Partial overlap? Bad, and unfixable */
406 if (next->start < new->start || next->end > new->end)
410 if (next->sibling->start > new->end)
416 new->parent = parent;
417 new->sibling = next->sibling;
420 next->sibling = NULL;
421 for (next = first; next; next = next->sibling)
424 if (parent->child == first) {
427 next = parent->child;
428 while (next->sibling != first)
429 next = next->sibling;
434 write_unlock(&resource_lock);
439 * adjust_resource - modify a resource's start and size
440 * @res: resource to modify
441 * @start: new start value
444 * Given an existing resource, change its start and size to match the
445 * arguments. Returns 0 on success, -EBUSY if it can't fit.
446 * Existing children of the resource are assumed to be immutable.
448 int adjust_resource(struct resource *res, resource_size_t start, resource_size_t size)
450 struct resource *tmp, *parent = res->parent;
451 resource_size_t end = start + size - 1;
454 write_lock(&resource_lock);
456 if ((start < parent->start) || (end > parent->end))
459 for (tmp = res->child; tmp; tmp = tmp->sibling) {
460 if ((tmp->start < start) || (tmp->end > end))
464 if (res->sibling && (res->sibling->start <= end))
469 while (tmp->sibling != res)
471 if (start <= tmp->end)
480 write_unlock(&resource_lock);
484 EXPORT_SYMBOL(adjust_resource);
487 * This is compatibility stuff for IO resources.
489 * Note how this, unlike the above, knows about
490 * the IO flag meanings (busy etc).
492 * request_region creates a new busy region.
494 * check_region returns non-zero if the area is already busy.
496 * release_region releases a matching busy region.
500 * __request_region - create a new busy resource region
501 * @parent: parent resource descriptor
502 * @start: resource start address
503 * @n: resource region size
504 * @name: reserving caller's ID string
506 struct resource * __request_region(struct resource *parent,
507 resource_size_t start, resource_size_t n,
510 struct resource *res = kzalloc(sizeof(*res), GFP_KERNEL);
515 res->end = start + n - 1;
516 res->flags = IORESOURCE_BUSY;
518 write_lock(&resource_lock);
521 struct resource *conflict;
523 conflict = __request_resource(parent, res);
526 if (conflict != parent) {
528 if (!(conflict->flags & IORESOURCE_BUSY))
532 /* Uhhuh, that didn't work out.. */
537 write_unlock(&resource_lock);
541 EXPORT_SYMBOL(__request_region);
544 * __check_region - check if a resource region is busy or free
545 * @parent: parent resource descriptor
546 * @start: resource start address
547 * @n: resource region size
549 * Returns 0 if the region is free at the moment it is checked,
550 * returns %-EBUSY if the region is busy.
553 * This function is deprecated because its use is racy.
554 * Even if it returns 0, a subsequent call to request_region()
555 * may fail because another driver etc. just allocated the region.
556 * Do NOT use it. It will be removed from the kernel.
558 int __check_region(struct resource *parent, resource_size_t start,
561 struct resource * res;
563 res = __request_region(parent, start, n, "check-region");
567 release_resource(res);
571 EXPORT_SYMBOL(__check_region);
574 * __release_region - release a previously reserved resource region
575 * @parent: parent resource descriptor
576 * @start: resource start address
577 * @n: resource region size
579 * The described resource region must match a currently busy region.
581 void __release_region(struct resource *parent, resource_size_t start,
590 write_lock(&resource_lock);
593 struct resource *res = *p;
597 if (res->start <= start && res->end >= end) {
598 if (!(res->flags & IORESOURCE_BUSY)) {
602 if (res->start != start || res->end != end)
605 write_unlock(&resource_lock);
612 write_unlock(&resource_lock);
614 printk(KERN_WARNING "Trying to free nonexistent resource "
615 "<%016llx-%016llx>\n", (unsigned long long)start,
616 (unsigned long long)end);
618 EXPORT_SYMBOL(__release_region);
621 * Called from init/main.c to reserve IO ports.
624 static int __init reserve_setup(char *str)
627 static struct resource reserve[MAXRESERVE];
630 int io_start, io_num;
633 if (get_option (&str, &io_start) != 2)
635 if (get_option (&str, &io_num) == 0)
637 if (x < MAXRESERVE) {
638 struct resource *res = reserve + x;
639 res->name = "reserved";
640 res->start = io_start;
641 res->end = io_start + io_num - 1;
642 res->flags = IORESOURCE_BUSY;
644 if (request_resource(res->start >= 0x10000 ? &iomem_resource : &ioport_resource, res) == 0)
651 __setup("reserve=", reserve_setup);