2 * drivers/acpi/resource.c - ACPI device resources interpretation.
4 * Copyright (C) 2012, Intel Corp.
5 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as published
11 * by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 #include <linux/acpi.h>
26 #include <linux/device.h>
27 #include <linux/export.h>
28 #include <linux/ioport.h>
29 #include <linux/list.h>
30 #include <linux/slab.h>
33 #define valid_IRQ(i) (((i) != 0) && ((i) != 2))
35 #define valid_IRQ(i) (true)
38 static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
40 u64 reslen = end - start + 1;
43 * CHECKME: len might be required to check versus a minimum
44 * length as well. 1 for io is fine, but for memory it does
45 * not make any sense at all.
46 * Note: some BIOSes report incorrect length for ACPI address space
47 * descriptor, so remove check of 'reslen == len' to avoid regression.
49 if (len && reslen && start <= end)
52 pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
53 io ? "io" : "mem", start, end, len);
58 static void acpi_dev_memresource_flags(struct resource *res, u64 len,
61 res->flags = IORESOURCE_MEM;
63 if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
64 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
66 if (write_protect == ACPI_READ_WRITE_MEMORY)
67 res->flags |= IORESOURCE_MEM_WRITEABLE;
70 static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
74 res->end = start + len - 1;
75 acpi_dev_memresource_flags(res, len, write_protect);
79 * acpi_dev_resource_memory - Extract ACPI memory resource information.
80 * @ares: Input ACPI resource object.
81 * @res: Output generic resource object.
83 * Check if the given ACPI resource object represents a memory resource and
84 * if that's the case, use the information in it to populate the generic
85 * resource object pointed to by @res.
88 * 1) false with res->flags setting to zero: not the expected resource type
89 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
90 * 3) true: valid assigned resource
92 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
94 struct acpi_resource_memory24 *memory24;
95 struct acpi_resource_memory32 *memory32;
96 struct acpi_resource_fixed_memory32 *fixed_memory32;
99 case ACPI_RESOURCE_TYPE_MEMORY24:
100 memory24 = &ares->data.memory24;
101 acpi_dev_get_memresource(res, memory24->minimum << 8,
102 memory24->address_length << 8,
103 memory24->write_protect);
105 case ACPI_RESOURCE_TYPE_MEMORY32:
106 memory32 = &ares->data.memory32;
107 acpi_dev_get_memresource(res, memory32->minimum,
108 memory32->address_length,
109 memory32->write_protect);
111 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
112 fixed_memory32 = &ares->data.fixed_memory32;
113 acpi_dev_get_memresource(res, fixed_memory32->address,
114 fixed_memory32->address_length,
115 fixed_memory32->write_protect);
122 return !(res->flags & IORESOURCE_DISABLED);
124 EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
126 static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
129 res->flags = IORESOURCE_IO;
131 if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
132 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
134 if (res->end >= 0x10003)
135 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
137 if (io_decode == ACPI_DECODE_16)
138 res->flags |= IORESOURCE_IO_16BIT_ADDR;
141 static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
145 res->end = start + len - 1;
146 acpi_dev_ioresource_flags(res, len, io_decode);
150 * acpi_dev_resource_io - Extract ACPI I/O resource information.
151 * @ares: Input ACPI resource object.
152 * @res: Output generic resource object.
154 * Check if the given ACPI resource object represents an I/O resource and
155 * if that's the case, use the information in it to populate the generic
156 * resource object pointed to by @res.
159 * 1) false with res->flags setting to zero: not the expected resource type
160 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
161 * 3) true: valid assigned resource
163 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
165 struct acpi_resource_io *io;
166 struct acpi_resource_fixed_io *fixed_io;
168 switch (ares->type) {
169 case ACPI_RESOURCE_TYPE_IO:
171 acpi_dev_get_ioresource(res, io->minimum,
175 case ACPI_RESOURCE_TYPE_FIXED_IO:
176 fixed_io = &ares->data.fixed_io;
177 acpi_dev_get_ioresource(res, fixed_io->address,
178 fixed_io->address_length,
186 return !(res->flags & IORESOURCE_DISABLED);
188 EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
190 static bool acpi_decode_space(struct resource_win *win,
191 struct acpi_resource_address *addr,
192 struct acpi_address64_attribute *attr)
194 u8 iodec = attr->granularity == 0xfff ? ACPI_DECODE_10 : ACPI_DECODE_16;
195 bool wp = addr->info.mem.write_protect;
196 u64 len = attr->address_length;
197 u64 start, end, offset = 0;
198 struct resource *res = &win->res;
201 * Filter out invalid descriptor according to ACPI Spec 5.0, section
202 * 6.4.3.5 Address Space Resource Descriptors.
204 if ((addr->min_address_fixed != addr->max_address_fixed && len) ||
205 (addr->min_address_fixed && addr->max_address_fixed && !len))
206 pr_debug("ACPI: Invalid address space min_addr_fix %d, max_addr_fix %d, len %llx\n",
207 addr->min_address_fixed, addr->max_address_fixed, len);
210 * For bridges that translate addresses across the bridge,
211 * translation_offset is the offset that must be added to the
212 * address on the secondary side to obtain the address on the
213 * primary side. Non-bridge devices must list 0 for all Address
214 * Translation offset bits.
216 if (addr->producer_consumer == ACPI_PRODUCER)
217 offset = attr->translation_offset;
218 else if (attr->translation_offset)
219 pr_debug("ACPI: translation_offset(%lld) is invalid for non-bridge device.\n",
220 attr->translation_offset);
221 start = attr->minimum + offset;
222 end = attr->maximum + offset;
224 win->offset = offset;
227 if (sizeof(resource_size_t) < sizeof(u64) &&
228 (offset != win->offset || start != res->start || end != res->end)) {
229 pr_warn("acpi resource window ([%#llx-%#llx] ignored, not CPU addressable)\n",
230 attr->minimum, attr->maximum);
234 switch (addr->resource_type) {
235 case ACPI_MEMORY_RANGE:
236 acpi_dev_memresource_flags(res, len, wp);
239 acpi_dev_ioresource_flags(res, len, iodec);
241 case ACPI_BUS_NUMBER_RANGE:
242 res->flags = IORESOURCE_BUS;
248 if (addr->producer_consumer == ACPI_PRODUCER)
249 res->flags |= IORESOURCE_WINDOW;
251 if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
252 res->flags |= IORESOURCE_PREFETCH;
254 return !(res->flags & IORESOURCE_DISABLED);
258 * acpi_dev_resource_address_space - Extract ACPI address space information.
259 * @ares: Input ACPI resource object.
260 * @win: Output generic resource object.
262 * Check if the given ACPI resource object represents an address space resource
263 * and if that's the case, use the information in it to populate the generic
264 * resource object pointed to by @win.
267 * 1) false with win->res.flags setting to zero: not the expected resource type
268 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
270 * 3) true: valid assigned resource
272 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
273 struct resource_win *win)
275 struct acpi_resource_address64 addr;
278 if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
281 return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
284 EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
287 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
288 * @ares: Input ACPI resource object.
289 * @win: Output generic resource object.
291 * Check if the given ACPI resource object represents an extended address space
292 * resource and if that's the case, use the information in it to populate the
293 * generic resource object pointed to by @win.
296 * 1) false with win->res.flags setting to zero: not the expected resource type
297 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
299 * 3) true: valid assigned resource
301 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
302 struct resource_win *win)
304 struct acpi_resource_extended_address64 *ext_addr;
307 if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
310 ext_addr = &ares->data.ext_address64;
312 return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
315 EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
318 * acpi_dev_irq_flags - Determine IRQ resource flags.
319 * @triggering: Triggering type as provided by ACPI.
320 * @polarity: Interrupt polarity as provided by ACPI.
321 * @shareable: Whether or not the interrupt is shareable.
323 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
327 if (triggering == ACPI_LEVEL_SENSITIVE)
328 flags = polarity == ACPI_ACTIVE_LOW ?
329 IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
331 flags = polarity == ACPI_ACTIVE_LOW ?
332 IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
334 if (shareable == ACPI_SHARED)
335 flags |= IORESOURCE_IRQ_SHAREABLE;
337 return flags | IORESOURCE_IRQ;
339 EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
341 static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi)
345 res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
348 static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
349 u8 triggering, u8 polarity, u8 shareable,
354 if (!valid_IRQ(gsi)) {
355 acpi_dev_irqresource_disabled(res, gsi);
360 * In IO-APIC mode, use overrided attribute. Two reasons:
361 * 1. BIOS bug in DSDT
362 * 2. BIOS uses IO-APIC mode Interrupt Source Override
364 * We do this only if we are dealing with IRQ() or IRQNoFlags()
365 * resource (the legacy ISA resources). With modern ACPI 5 devices
366 * using extended IRQ descriptors we take the IRQ configuration
367 * from _CRS directly.
369 if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
370 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
371 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
373 if (triggering != trig || polarity != pol) {
374 pr_warning("ACPI: IRQ %d override to %s, %s\n", gsi,
375 t ? "level" : "edge", p ? "low" : "high");
381 res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
382 irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
387 acpi_dev_irqresource_disabled(res, gsi);
392 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
393 * @ares: Input ACPI resource object.
394 * @index: Index into the array of GSIs represented by the resource.
395 * @res: Output generic resource object.
397 * Check if the given ACPI resource object represents an interrupt resource
398 * and @index does not exceed the resource's interrupt count (true is returned
399 * in that case regardless of the results of the other checks)). If that's the
400 * case, register the GSI corresponding to @index from the array of interrupts
401 * represented by the resource and populate the generic resource object pointed
402 * to by @res accordingly. If the registration of the GSI is not successful,
403 * IORESOURCE_DISABLED will be set it that object's flags.
406 * 1) false with res->flags setting to zero: not the expected resource type
407 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
408 * 3) true: valid assigned resource
410 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
411 struct resource *res)
413 struct acpi_resource_irq *irq;
414 struct acpi_resource_extended_irq *ext_irq;
416 switch (ares->type) {
417 case ACPI_RESOURCE_TYPE_IRQ:
419 * Per spec, only one interrupt per descriptor is allowed in
420 * _CRS, but some firmware violates this, so parse them all.
422 irq = &ares->data.irq;
423 if (index >= irq->interrupt_count) {
424 acpi_dev_irqresource_disabled(res, 0);
427 acpi_dev_get_irqresource(res, irq->interrupts[index],
428 irq->triggering, irq->polarity,
429 irq->sharable, true);
431 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
432 ext_irq = &ares->data.extended_irq;
433 if (index >= ext_irq->interrupt_count) {
434 acpi_dev_irqresource_disabled(res, 0);
437 acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
438 ext_irq->triggering, ext_irq->polarity,
439 ext_irq->sharable, false);
448 EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
451 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
452 * @list: The head of the resource list to free.
454 void acpi_dev_free_resource_list(struct list_head *list)
456 resource_list_free(list);
458 EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
460 struct res_proc_context {
461 struct list_head *list;
462 int (*preproc)(struct acpi_resource *, void *);
468 static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
469 struct res_proc_context *c)
471 struct resource_entry *rentry;
473 rentry = resource_list_create_entry(NULL, 0);
478 *rentry->res = win->res;
479 rentry->offset = win->offset;
480 resource_list_add_tail(rentry, c->list);
485 static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
488 struct res_proc_context *c = context;
489 struct resource_win win;
490 struct resource *res = &win.res;
496 ret = c->preproc(ares, c->preproc_data);
499 return AE_CTRL_TERMINATE;
500 } else if (ret > 0) {
505 memset(&win, 0, sizeof(win));
507 if (acpi_dev_resource_memory(ares, res)
508 || acpi_dev_resource_io(ares, res)
509 || acpi_dev_resource_address_space(ares, &win)
510 || acpi_dev_resource_ext_address_space(ares, &win))
511 return acpi_dev_new_resource_entry(&win, c);
513 for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
516 status = acpi_dev_new_resource_entry(&win, c);
517 if (ACPI_FAILURE(status))
525 * acpi_dev_get_resources - Get current resources of a device.
526 * @adev: ACPI device node to get the resources for.
527 * @list: Head of the resultant list of resources (must be empty).
528 * @preproc: The caller's preprocessing routine.
529 * @preproc_data: Pointer passed to the caller's preprocessing routine.
531 * Evaluate the _CRS method for the given device node and process its output by
532 * (1) executing the @preproc() rountine provided by the caller, passing the
533 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
534 * returned and (2) converting all of the returned ACPI resources into struct
535 * resource objects if possible. If the return value of @preproc() in step (1)
536 * is different from 0, step (2) is not applied to the given ACPI resource and
537 * if that value is negative, the whole processing is aborted and that value is
538 * returned as the final error code.
540 * The resultant struct resource objects are put on the list pointed to by
541 * @list, that must be empty initially, as members of struct resource_entry
542 * objects. Callers of this routine should use %acpi_dev_free_resource_list() to
545 * The number of resources in the output list is returned on success, an error
546 * code reflecting the error condition is returned otherwise.
548 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
549 int (*preproc)(struct acpi_resource *, void *),
552 struct res_proc_context c;
555 if (!adev || !adev->handle || !list_empty(list))
558 if (!acpi_has_method(adev->handle, METHOD_NAME__CRS))
563 c.preproc_data = preproc_data;
566 status = acpi_walk_resources(adev->handle, METHOD_NAME__CRS,
567 acpi_dev_process_resource, &c);
568 if (ACPI_FAILURE(status)) {
569 acpi_dev_free_resource_list(list);
570 return c.error ? c.error : -EIO;
575 EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
578 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
580 * @ares: Input ACPI resource object.
581 * @types: Valid resource types of IORESOURCE_XXX
583 * This is a helper function to support acpi_dev_get_resources(), which filters
584 * ACPI resource objects according to resource types.
586 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
589 unsigned long type = 0;
591 switch (ares->type) {
592 case ACPI_RESOURCE_TYPE_MEMORY24:
593 case ACPI_RESOURCE_TYPE_MEMORY32:
594 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
595 type = IORESOURCE_MEM;
597 case ACPI_RESOURCE_TYPE_IO:
598 case ACPI_RESOURCE_TYPE_FIXED_IO:
599 type = IORESOURCE_IO;
601 case ACPI_RESOURCE_TYPE_IRQ:
602 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
603 type = IORESOURCE_IRQ;
605 case ACPI_RESOURCE_TYPE_DMA:
606 case ACPI_RESOURCE_TYPE_FIXED_DMA:
607 type = IORESOURCE_DMA;
609 case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
610 type = IORESOURCE_REG;
612 case ACPI_RESOURCE_TYPE_ADDRESS16:
613 case ACPI_RESOURCE_TYPE_ADDRESS32:
614 case ACPI_RESOURCE_TYPE_ADDRESS64:
615 case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
616 if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
617 type = IORESOURCE_MEM;
618 else if (ares->data.address.resource_type == ACPI_IO_RANGE)
619 type = IORESOURCE_IO;
620 else if (ares->data.address.resource_type ==
621 ACPI_BUS_NUMBER_RANGE)
622 type = IORESOURCE_BUS;
628 return (type & types) ? 0 : 1;
630 EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
632 struct reserved_region {
633 struct list_head node;
638 static LIST_HEAD(reserved_io_regions);
639 static LIST_HEAD(reserved_mem_regions);
641 static int request_range(u64 start, u64 end, u8 space_id, unsigned long flags,
644 unsigned int length = end - start + 1;
645 struct resource *res;
647 res = space_id == ACPI_ADR_SPACE_SYSTEM_IO ?
648 request_region(start, length, desc) :
649 request_mem_region(start, length, desc);
653 res->flags &= ~flags;
657 static int add_region_before(u64 start, u64 end, u8 space_id,
658 unsigned long flags, char *desc,
659 struct list_head *head)
661 struct reserved_region *reg;
664 reg = kmalloc(sizeof(*reg), GFP_KERNEL);
668 error = request_range(start, end, space_id, flags, desc);
676 list_add_tail(®->node, head);
681 * acpi_reserve_region - Reserve an I/O or memory region as a system resource.
682 * @start: Starting address of the region.
683 * @length: Length of the region.
684 * @space_id: Identifier of address space to reserve the region from.
685 * @flags: Resource flags to clear for the region after requesting it.
686 * @desc: Region description (for messages).
688 * Reserve an I/O or memory region as a system resource to prevent others from
689 * using it. If the new region overlaps with one of the regions (in the given
690 * address space) already reserved by this routine, only the non-overlapping
691 * parts of it will be reserved.
693 * Returned is either 0 (success) or a negative error code indicating a resource
694 * reservation problem. It is the code of the first encountered error, but the
695 * routine doesn't abort until it has attempted to request all of the parts of
696 * the new region that don't overlap with other regions reserved previously.
698 * The resources requested by this routine are never released.
700 int acpi_reserve_region(u64 start, unsigned int length, u8 space_id,
701 unsigned long flags, char *desc)
703 struct list_head *regions;
704 struct reserved_region *reg;
705 u64 end = start + length - 1;
706 int ret = 0, error = 0;
708 if (space_id == ACPI_ADR_SPACE_SYSTEM_IO)
709 regions = &reserved_io_regions;
710 else if (space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
711 regions = &reserved_mem_regions;
715 if (list_empty(regions))
716 return add_region_before(start, end, space_id, flags, desc, regions);
718 list_for_each_entry(reg, regions, node)
719 if (reg->start == end + 1) {
720 /* The new region can be prepended to this one. */
721 ret = request_range(start, end, space_id, flags, desc);
726 } else if (reg->start > end) {
727 /* No overlap. Add the new region here and get out. */
728 return add_region_before(start, end, space_id, flags,
730 } else if (reg->end == start - 1) {
732 } else if (reg->end >= start) {
736 /* The new region goes after the last existing one. */
737 return add_region_before(start, end, space_id, flags, desc, regions);
741 * The new region overlaps an existing one.
743 * The head part of the new region immediately preceding the existing
744 * overlapping one can be combined with it right away.
746 if (reg->start > start) {
747 error = request_range(start, reg->start - 1, space_id, flags, desc);
756 * The new region is adjacent to an existing one. If it extends beyond
757 * that region all the way to the next one, it is possible to combine
760 while (reg->end < end) {
761 struct reserved_region *next = NULL;
762 u64 a = reg->end + 1, b = end;
764 if (!list_is_last(®->node, regions)) {
765 next = list_next_entry(reg, node);
766 if (next->start <= end)
769 error = request_range(a, b, space_id, flags, desc);
771 if (next && next->start == b + 1) {
772 reg->end = next->end;
773 list_del(&next->node);
789 return ret ? ret : error;
791 EXPORT_SYMBOL_GPL(acpi_reserve_region);