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/slab.h>
32 #define valid_IRQ(i) (((i) != 0) && ((i) != 2))
34 #define valid_IRQ(i) (true)
37 static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
39 u64 reslen = end - start + 1;
42 * CHECKME: len might be required to check versus a minimum
43 * length as well. 1 for io is fine, but for memory it does
44 * not make any sense at all.
46 if (len && reslen && reslen == len && start <= end)
49 pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
50 io ? "io" : "mem", start, end, len);
55 static void acpi_dev_memresource_flags(struct resource *res, u64 len,
58 res->flags = IORESOURCE_MEM;
60 if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
61 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
63 if (write_protect == ACPI_READ_WRITE_MEMORY)
64 res->flags |= IORESOURCE_MEM_WRITEABLE;
67 static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
71 res->end = start + len - 1;
72 acpi_dev_memresource_flags(res, len, write_protect);
76 * acpi_dev_resource_memory - Extract ACPI memory resource information.
77 * @ares: Input ACPI resource object.
78 * @res: Output generic resource object.
80 * Check if the given ACPI resource object represents a memory resource and
81 * if that's the case, use the information in it to populate the generic
82 * resource object pointed to by @res.
85 * 1) false with res->flags setting to zero: not the expected resource type
86 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
87 * 3) true: valid assigned resource
89 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
91 struct acpi_resource_memory24 *memory24;
92 struct acpi_resource_memory32 *memory32;
93 struct acpi_resource_fixed_memory32 *fixed_memory32;
96 case ACPI_RESOURCE_TYPE_MEMORY24:
97 memory24 = &ares->data.memory24;
98 acpi_dev_get_memresource(res, memory24->minimum << 8,
99 memory24->address_length << 8,
100 memory24->write_protect);
102 case ACPI_RESOURCE_TYPE_MEMORY32:
103 memory32 = &ares->data.memory32;
104 acpi_dev_get_memresource(res, memory32->minimum,
105 memory32->address_length,
106 memory32->write_protect);
108 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
109 fixed_memory32 = &ares->data.fixed_memory32;
110 acpi_dev_get_memresource(res, fixed_memory32->address,
111 fixed_memory32->address_length,
112 fixed_memory32->write_protect);
119 return !(res->flags & IORESOURCE_DISABLED);
121 EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
123 static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
126 res->flags = IORESOURCE_IO;
128 if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
129 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
131 if (res->end >= 0x10003)
132 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
134 if (io_decode == ACPI_DECODE_16)
135 res->flags |= IORESOURCE_IO_16BIT_ADDR;
138 static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
142 res->end = start + len - 1;
143 acpi_dev_ioresource_flags(res, len, io_decode);
147 * acpi_dev_resource_io - Extract ACPI I/O resource information.
148 * @ares: Input ACPI resource object.
149 * @res: Output generic resource object.
151 * Check if the given ACPI resource object represents an I/O resource and
152 * if that's the case, use the information in it to populate the generic
153 * resource object pointed to by @res.
156 * 1) false with res->flags setting to zero: not the expected resource type
157 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
158 * 3) true: valid assigned resource
160 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
162 struct acpi_resource_io *io;
163 struct acpi_resource_fixed_io *fixed_io;
165 switch (ares->type) {
166 case ACPI_RESOURCE_TYPE_IO:
168 acpi_dev_get_ioresource(res, io->minimum,
172 case ACPI_RESOURCE_TYPE_FIXED_IO:
173 fixed_io = &ares->data.fixed_io;
174 acpi_dev_get_ioresource(res, fixed_io->address,
175 fixed_io->address_length,
183 return !(res->flags & IORESOURCE_DISABLED);
185 EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
187 static bool acpi_decode_space(struct resource_win *win,
188 struct acpi_resource_address *addr,
189 struct acpi_address64_attribute *attr)
191 u8 iodec = attr->granularity == 0xfff ? ACPI_DECODE_10 : ACPI_DECODE_16;
192 bool wp = addr->info.mem.write_protect;
193 u64 len = attr->address_length;
194 struct resource *res = &win->res;
197 * Filter out invalid descriptor according to ACPI Spec 5.0, section
198 * 6.4.3.5 Address Space Resource Descriptors.
200 if ((addr->min_address_fixed != addr->max_address_fixed && len) ||
201 (addr->min_address_fixed && addr->max_address_fixed && !len))
202 pr_debug("ACPI: Invalid address space min_addr_fix %d, max_addr_fix %d, len %llx\n",
203 addr->min_address_fixed, addr->max_address_fixed, len);
205 res->start = attr->minimum;
206 res->end = attr->maximum;
209 * For bridges that translate addresses across the bridge,
210 * translation_offset is the offset that must be added to the
211 * address on the secondary side to obtain the address on the
212 * primary side. Non-bridge devices must list 0 for all Address
213 * Translation offset bits.
215 if (addr->producer_consumer == ACPI_PRODUCER) {
216 res->start += attr->translation_offset;
217 res->end += 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);
223 switch (addr->resource_type) {
224 case ACPI_MEMORY_RANGE:
225 acpi_dev_memresource_flags(res, len, wp);
228 acpi_dev_ioresource_flags(res, len, iodec);
230 case ACPI_BUS_NUMBER_RANGE:
231 res->flags = IORESOURCE_BUS;
237 win->offset = attr->translation_offset;
239 if (addr->producer_consumer == ACPI_PRODUCER)
240 res->flags |= IORESOURCE_WINDOW;
242 if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
243 res->flags |= IORESOURCE_PREFETCH;
245 return !(res->flags & IORESOURCE_DISABLED);
249 * acpi_dev_resource_address_space - Extract ACPI address space information.
250 * @ares: Input ACPI resource object.
251 * @win: Output generic resource object.
253 * Check if the given ACPI resource object represents an address space resource
254 * and if that's the case, use the information in it to populate the generic
255 * resource object pointed to by @win.
258 * 1) false with win->res.flags setting to zero: not the expected resource type
259 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
261 * 3) true: valid assigned resource
263 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
264 struct resource_win *win)
266 struct acpi_resource_address64 addr;
269 if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
272 return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
275 EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
278 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
279 * @ares: Input ACPI resource object.
280 * @win: Output generic resource object.
282 * Check if the given ACPI resource object represents an extended address space
283 * resource and if that's the case, use the information in it to populate the
284 * generic resource object pointed to by @win.
287 * 1) false with win->res.flags setting to zero: not the expected resource type
288 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
290 * 3) true: valid assigned resource
292 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
293 struct resource_win *win)
295 struct acpi_resource_extended_address64 *ext_addr;
298 if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
301 ext_addr = &ares->data.ext_address64;
303 return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
306 EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
309 * acpi_dev_irq_flags - Determine IRQ resource flags.
310 * @triggering: Triggering type as provided by ACPI.
311 * @polarity: Interrupt polarity as provided by ACPI.
312 * @shareable: Whether or not the interrupt is shareable.
314 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
318 if (triggering == ACPI_LEVEL_SENSITIVE)
319 flags = polarity == ACPI_ACTIVE_LOW ?
320 IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
322 flags = polarity == ACPI_ACTIVE_LOW ?
323 IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
325 if (shareable == ACPI_SHARED)
326 flags |= IORESOURCE_IRQ_SHAREABLE;
328 return flags | IORESOURCE_IRQ;
330 EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
332 static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi)
336 res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
339 static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
340 u8 triggering, u8 polarity, u8 shareable,
345 if (!valid_IRQ(gsi)) {
346 acpi_dev_irqresource_disabled(res, gsi);
351 * In IO-APIC mode, use overrided attribute. Two reasons:
352 * 1. BIOS bug in DSDT
353 * 2. BIOS uses IO-APIC mode Interrupt Source Override
355 * We do this only if we are dealing with IRQ() or IRQNoFlags()
356 * resource (the legacy ISA resources). With modern ACPI 5 devices
357 * using extended IRQ descriptors we take the IRQ configuration
358 * from _CRS directly.
360 if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
361 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
362 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
364 if (triggering != trig || polarity != pol) {
365 pr_warning("ACPI: IRQ %d override to %s, %s\n", gsi,
366 t ? "level" : "edge", p ? "low" : "high");
372 res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
373 irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
378 acpi_dev_irqresource_disabled(res, gsi);
383 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
384 * @ares: Input ACPI resource object.
385 * @index: Index into the array of GSIs represented by the resource.
386 * @res: Output generic resource object.
388 * Check if the given ACPI resource object represents an interrupt resource
389 * and @index does not exceed the resource's interrupt count (true is returned
390 * in that case regardless of the results of the other checks)). If that's the
391 * case, register the GSI corresponding to @index from the array of interrupts
392 * represented by the resource and populate the generic resource object pointed
393 * to by @res accordingly. If the registration of the GSI is not successful,
394 * IORESOURCE_DISABLED will be set it that object's flags.
397 * 1) false with res->flags setting to zero: not the expected resource type
398 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
399 * 3) true: valid assigned resource
401 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
402 struct resource *res)
404 struct acpi_resource_irq *irq;
405 struct acpi_resource_extended_irq *ext_irq;
407 switch (ares->type) {
408 case ACPI_RESOURCE_TYPE_IRQ:
410 * Per spec, only one interrupt per descriptor is allowed in
411 * _CRS, but some firmware violates this, so parse them all.
413 irq = &ares->data.irq;
414 if (index >= irq->interrupt_count) {
415 acpi_dev_irqresource_disabled(res, 0);
418 acpi_dev_get_irqresource(res, irq->interrupts[index],
419 irq->triggering, irq->polarity,
420 irq->sharable, true);
422 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
423 ext_irq = &ares->data.extended_irq;
424 if (index >= ext_irq->interrupt_count) {
425 acpi_dev_irqresource_disabled(res, 0);
428 acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
429 ext_irq->triggering, ext_irq->polarity,
430 ext_irq->sharable, false);
439 EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
442 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
443 * @list: The head of the resource list to free.
445 void acpi_dev_free_resource_list(struct list_head *list)
447 resource_list_free(list);
449 EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
451 struct res_proc_context {
452 struct list_head *list;
453 int (*preproc)(struct acpi_resource *, void *);
459 static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
460 struct res_proc_context *c)
462 struct resource_entry *rentry;
464 rentry = resource_list_create_entry(NULL, 0);
469 *rentry->res = win->res;
470 rentry->offset = win->offset;
471 resource_list_add_tail(rentry, c->list);
476 static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
479 struct res_proc_context *c = context;
480 struct resource_win win;
481 struct resource *res = &win.res;
487 ret = c->preproc(ares, c->preproc_data);
490 return AE_CTRL_TERMINATE;
491 } else if (ret > 0) {
496 memset(&win, 0, sizeof(win));
498 if (acpi_dev_resource_memory(ares, res)
499 || acpi_dev_resource_io(ares, res)
500 || acpi_dev_resource_address_space(ares, &win)
501 || acpi_dev_resource_ext_address_space(ares, &win))
502 return acpi_dev_new_resource_entry(&win, c);
504 for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
507 status = acpi_dev_new_resource_entry(&win, c);
508 if (ACPI_FAILURE(status))
516 * acpi_dev_get_resources - Get current resources of a device.
517 * @adev: ACPI device node to get the resources for.
518 * @list: Head of the resultant list of resources (must be empty).
519 * @preproc: The caller's preprocessing routine.
520 * @preproc_data: Pointer passed to the caller's preprocessing routine.
522 * Evaluate the _CRS method for the given device node and process its output by
523 * (1) executing the @preproc() rountine provided by the caller, passing the
524 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
525 * returned and (2) converting all of the returned ACPI resources into struct
526 * resource objects if possible. If the return value of @preproc() in step (1)
527 * is different from 0, step (2) is not applied to the given ACPI resource and
528 * if that value is negative, the whole processing is aborted and that value is
529 * returned as the final error code.
531 * The resultant struct resource objects are put on the list pointed to by
532 * @list, that must be empty initially, as members of struct resource_entry
533 * objects. Callers of this routine should use %acpi_dev_free_resource_list() to
536 * The number of resources in the output list is returned on success, an error
537 * code reflecting the error condition is returned otherwise.
539 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
540 int (*preproc)(struct acpi_resource *, void *),
543 struct res_proc_context c;
546 if (!adev || !adev->handle || !list_empty(list))
549 if (!acpi_has_method(adev->handle, METHOD_NAME__CRS))
554 c.preproc_data = preproc_data;
557 status = acpi_walk_resources(adev->handle, METHOD_NAME__CRS,
558 acpi_dev_process_resource, &c);
559 if (ACPI_FAILURE(status)) {
560 acpi_dev_free_resource_list(list);
561 return c.error ? c.error : -EIO;
566 EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
569 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
571 * @ares: Input ACPI resource object.
572 * @types: Valid resource types of IORESOURCE_XXX
574 * This is a hepler function to support acpi_dev_get_resources(), which filters
575 * ACPI resource objects according to resource types.
577 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
580 unsigned long type = 0;
582 switch (ares->type) {
583 case ACPI_RESOURCE_TYPE_MEMORY24:
584 case ACPI_RESOURCE_TYPE_MEMORY32:
585 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
586 type = IORESOURCE_MEM;
588 case ACPI_RESOURCE_TYPE_IO:
589 case ACPI_RESOURCE_TYPE_FIXED_IO:
590 type = IORESOURCE_IO;
592 case ACPI_RESOURCE_TYPE_IRQ:
593 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
594 type = IORESOURCE_IRQ;
596 case ACPI_RESOURCE_TYPE_DMA:
597 case ACPI_RESOURCE_TYPE_FIXED_DMA:
598 type = IORESOURCE_DMA;
600 case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
601 type = IORESOURCE_REG;
603 case ACPI_RESOURCE_TYPE_ADDRESS16:
604 case ACPI_RESOURCE_TYPE_ADDRESS32:
605 case ACPI_RESOURCE_TYPE_ADDRESS64:
606 case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
607 if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
608 type = IORESOURCE_MEM;
609 else if (ares->data.address.resource_type == ACPI_IO_RANGE)
610 type = IORESOURCE_IO;
611 else if (ares->data.address.resource_type ==
612 ACPI_BUS_NUMBER_RANGE)
613 type = IORESOURCE_BUS;
619 return (type & types) ? 0 : 1;
621 EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);