1 // SPDX-License-Identifier: GPL-2.0-only
3 * drivers/acpi/resource.c - ACPI device resources interpretation.
5 * Copyright (C) 2012, Intel Corp.
6 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 #include <linux/acpi.h>
14 #include <linux/device.h>
15 #include <linux/export.h>
16 #include <linux/ioport.h>
17 #include <linux/slab.h>
18 #include <linux/irq.h>
21 #define valid_IRQ(i) (((i) != 0) && ((i) != 2))
22 static inline bool acpi_iospace_resource_valid(struct resource *res)
24 /* On X86 IO space is limited to the [0 - 64K] IO port range */
25 return res->end < 0x10003;
28 #define valid_IRQ(i) (true)
30 * ACPI IO descriptors on arches other than X86 contain MMIO CPU physical
31 * addresses mapping IO space in CPU physical address space, IO space
32 * resources can be placed anywhere in the 64-bit physical address space.
35 acpi_iospace_resource_valid(struct resource *res) { return true; }
38 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
39 static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
41 return ext_irq->resource_source.string_length == 0 &&
42 ext_irq->producer_consumer == ACPI_CONSUMER;
45 static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
51 static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
53 u64 reslen = end - start + 1;
56 * CHECKME: len might be required to check versus a minimum
57 * length as well. 1 for io is fine, but for memory it does
58 * not make any sense at all.
59 * Note: some BIOSes report incorrect length for ACPI address space
60 * descriptor, so remove check of 'reslen == len' to avoid regression.
62 if (len && reslen && start <= end)
65 pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
66 io ? "io" : "mem", start, end, len);
71 static void acpi_dev_memresource_flags(struct resource *res, u64 len,
74 res->flags = IORESOURCE_MEM;
76 if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
77 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
79 if (write_protect == ACPI_READ_WRITE_MEMORY)
80 res->flags |= IORESOURCE_MEM_WRITEABLE;
83 static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
87 res->end = start + len - 1;
88 acpi_dev_memresource_flags(res, len, write_protect);
92 * acpi_dev_resource_memory - Extract ACPI memory resource information.
93 * @ares: Input ACPI resource object.
94 * @res: Output generic resource object.
96 * Check if the given ACPI resource object represents a memory resource and
97 * if that's the case, use the information in it to populate the generic
98 * resource object pointed to by @res.
101 * 1) false with res->flags setting to zero: not the expected resource type
102 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
103 * 3) true: valid assigned resource
105 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
107 struct acpi_resource_memory24 *memory24;
108 struct acpi_resource_memory32 *memory32;
109 struct acpi_resource_fixed_memory32 *fixed_memory32;
111 switch (ares->type) {
112 case ACPI_RESOURCE_TYPE_MEMORY24:
113 memory24 = &ares->data.memory24;
114 acpi_dev_get_memresource(res, memory24->minimum << 8,
115 memory24->address_length << 8,
116 memory24->write_protect);
118 case ACPI_RESOURCE_TYPE_MEMORY32:
119 memory32 = &ares->data.memory32;
120 acpi_dev_get_memresource(res, memory32->minimum,
121 memory32->address_length,
122 memory32->write_protect);
124 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
125 fixed_memory32 = &ares->data.fixed_memory32;
126 acpi_dev_get_memresource(res, fixed_memory32->address,
127 fixed_memory32->address_length,
128 fixed_memory32->write_protect);
135 return !(res->flags & IORESOURCE_DISABLED);
137 EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
139 static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
140 u8 io_decode, u8 translation_type)
142 res->flags = IORESOURCE_IO;
144 if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
145 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
147 if (!acpi_iospace_resource_valid(res))
148 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
150 if (io_decode == ACPI_DECODE_16)
151 res->flags |= IORESOURCE_IO_16BIT_ADDR;
152 if (translation_type == ACPI_SPARSE_TRANSLATION)
153 res->flags |= IORESOURCE_IO_SPARSE;
156 static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
160 res->end = start + len - 1;
161 acpi_dev_ioresource_flags(res, len, io_decode, 0);
165 * acpi_dev_resource_io - Extract ACPI I/O resource information.
166 * @ares: Input ACPI resource object.
167 * @res: Output generic resource object.
169 * Check if the given ACPI resource object represents an I/O resource and
170 * if that's the case, use the information in it to populate the generic
171 * resource object pointed to by @res.
174 * 1) false with res->flags setting to zero: not the expected resource type
175 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
176 * 3) true: valid assigned resource
178 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
180 struct acpi_resource_io *io;
181 struct acpi_resource_fixed_io *fixed_io;
183 switch (ares->type) {
184 case ACPI_RESOURCE_TYPE_IO:
186 acpi_dev_get_ioresource(res, io->minimum,
190 case ACPI_RESOURCE_TYPE_FIXED_IO:
191 fixed_io = &ares->data.fixed_io;
192 acpi_dev_get_ioresource(res, fixed_io->address,
193 fixed_io->address_length,
201 return !(res->flags & IORESOURCE_DISABLED);
203 EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
205 static bool acpi_decode_space(struct resource_win *win,
206 struct acpi_resource_address *addr,
207 struct acpi_address64_attribute *attr)
209 u8 iodec = attr->granularity == 0xfff ? ACPI_DECODE_10 : ACPI_DECODE_16;
210 bool wp = addr->info.mem.write_protect;
211 u64 len = attr->address_length;
212 u64 start, end, offset = 0;
213 struct resource *res = &win->res;
216 * Filter out invalid descriptor according to ACPI Spec 5.0, section
217 * 6.4.3.5 Address Space Resource Descriptors.
219 if ((addr->min_address_fixed != addr->max_address_fixed && len) ||
220 (addr->min_address_fixed && addr->max_address_fixed && !len))
221 pr_debug("ACPI: Invalid address space min_addr_fix %d, max_addr_fix %d, len %llx\n",
222 addr->min_address_fixed, addr->max_address_fixed, len);
225 * For bridges that translate addresses across the bridge,
226 * translation_offset is the offset that must be added to the
227 * address on the secondary side to obtain the address on the
228 * primary side. Non-bridge devices must list 0 for all Address
229 * Translation offset bits.
231 if (addr->producer_consumer == ACPI_PRODUCER)
232 offset = attr->translation_offset;
233 else if (attr->translation_offset)
234 pr_debug("ACPI: translation_offset(%lld) is invalid for non-bridge device.\n",
235 attr->translation_offset);
236 start = attr->minimum + offset;
237 end = attr->maximum + offset;
239 win->offset = offset;
242 if (sizeof(resource_size_t) < sizeof(u64) &&
243 (offset != win->offset || start != res->start || end != res->end)) {
244 pr_warn("acpi resource window ([%#llx-%#llx] ignored, not CPU addressable)\n",
245 attr->minimum, attr->maximum);
249 switch (addr->resource_type) {
250 case ACPI_MEMORY_RANGE:
251 acpi_dev_memresource_flags(res, len, wp);
254 acpi_dev_ioresource_flags(res, len, iodec,
255 addr->info.io.translation_type);
257 case ACPI_BUS_NUMBER_RANGE:
258 res->flags = IORESOURCE_BUS;
264 if (addr->producer_consumer == ACPI_PRODUCER)
265 res->flags |= IORESOURCE_WINDOW;
267 if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
268 res->flags |= IORESOURCE_PREFETCH;
270 return !(res->flags & IORESOURCE_DISABLED);
274 * acpi_dev_resource_address_space - Extract ACPI address space information.
275 * @ares: Input ACPI resource object.
276 * @win: Output generic resource object.
278 * Check if the given ACPI resource object represents an address space resource
279 * and if that's the case, use the information in it to populate the generic
280 * resource object pointed to by @win.
283 * 1) false with win->res.flags setting to zero: not the expected resource type
284 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
286 * 3) true: valid assigned resource
288 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
289 struct resource_win *win)
291 struct acpi_resource_address64 addr;
294 if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
297 return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
300 EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
303 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
304 * @ares: Input ACPI resource object.
305 * @win: Output generic resource object.
307 * Check if the given ACPI resource object represents an extended address space
308 * resource and if that's the case, use the information in it to populate the
309 * generic resource object pointed to by @win.
312 * 1) false with win->res.flags setting to zero: not the expected resource type
313 * 2) false with IORESOURCE_DISABLED in win->res.flags: valid unassigned
315 * 3) true: valid assigned resource
317 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
318 struct resource_win *win)
320 struct acpi_resource_extended_address64 *ext_addr;
323 if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
326 ext_addr = &ares->data.ext_address64;
328 return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
331 EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
334 * acpi_dev_irq_flags - Determine IRQ resource flags.
335 * @triggering: Triggering type as provided by ACPI.
336 * @polarity: Interrupt polarity as provided by ACPI.
337 * @shareable: Whether or not the interrupt is shareable.
339 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
343 if (triggering == ACPI_LEVEL_SENSITIVE)
344 flags = polarity == ACPI_ACTIVE_LOW ?
345 IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
347 flags = polarity == ACPI_ACTIVE_LOW ?
348 IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
350 if (shareable == ACPI_SHARED)
351 flags |= IORESOURCE_IRQ_SHAREABLE;
353 return flags | IORESOURCE_IRQ;
355 EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
358 * acpi_dev_get_irq_type - Determine irq type.
359 * @triggering: Triggering type as provided by ACPI.
360 * @polarity: Interrupt polarity as provided by ACPI.
362 unsigned int acpi_dev_get_irq_type(int triggering, int polarity)
365 case ACPI_ACTIVE_LOW:
366 return triggering == ACPI_EDGE_SENSITIVE ?
367 IRQ_TYPE_EDGE_FALLING :
369 case ACPI_ACTIVE_HIGH:
370 return triggering == ACPI_EDGE_SENSITIVE ?
371 IRQ_TYPE_EDGE_RISING :
373 case ACPI_ACTIVE_BOTH:
374 if (triggering == ACPI_EDGE_SENSITIVE)
375 return IRQ_TYPE_EDGE_BOTH;
378 return IRQ_TYPE_NONE;
381 EXPORT_SYMBOL_GPL(acpi_dev_get_irq_type);
383 static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
384 u8 triggering, u8 polarity, u8 shareable,
389 if (!valid_IRQ(gsi)) {
390 irqresource_disabled(res, gsi);
395 * In IO-APIC mode, use overridden attribute. Two reasons:
396 * 1. BIOS bug in DSDT
397 * 2. BIOS uses IO-APIC mode Interrupt Source Override
399 * We do this only if we are dealing with IRQ() or IRQNoFlags()
400 * resource (the legacy ISA resources). With modern ACPI 5 devices
401 * using extended IRQ descriptors we take the IRQ configuration
402 * from _CRS directly.
404 if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
405 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
406 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
408 if (triggering != trig || polarity != pol) {
409 pr_warn("ACPI: IRQ %d override to %s, %s\n", gsi,
410 t ? "level" : "edge", p ? "low" : "high");
416 res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
417 irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
422 irqresource_disabled(res, gsi);
427 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
428 * @ares: Input ACPI resource object.
429 * @index: Index into the array of GSIs represented by the resource.
430 * @res: Output generic resource object.
432 * Check if the given ACPI resource object represents an interrupt resource
433 * and @index does not exceed the resource's interrupt count (true is returned
434 * in that case regardless of the results of the other checks)). If that's the
435 * case, register the GSI corresponding to @index from the array of interrupts
436 * represented by the resource and populate the generic resource object pointed
437 * to by @res accordingly. If the registration of the GSI is not successful,
438 * IORESOURCE_DISABLED will be set it that object's flags.
441 * 1) false with res->flags setting to zero: not the expected resource type
442 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
443 * 3) true: valid assigned resource
445 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
446 struct resource *res)
448 struct acpi_resource_irq *irq;
449 struct acpi_resource_extended_irq *ext_irq;
451 switch (ares->type) {
452 case ACPI_RESOURCE_TYPE_IRQ:
454 * Per spec, only one interrupt per descriptor is allowed in
455 * _CRS, but some firmware violates this, so parse them all.
457 irq = &ares->data.irq;
458 if (index >= irq->interrupt_count) {
459 irqresource_disabled(res, 0);
462 acpi_dev_get_irqresource(res, irq->interrupts[index],
463 irq->triggering, irq->polarity,
464 irq->shareable, true);
466 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
467 ext_irq = &ares->data.extended_irq;
468 if (index >= ext_irq->interrupt_count) {
469 irqresource_disabled(res, 0);
473 acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
474 ext_irq->triggering, ext_irq->polarity,
475 ext_irq->shareable, false);
477 irqresource_disabled(res, 0);
486 EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
489 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
490 * @list: The head of the resource list to free.
492 void acpi_dev_free_resource_list(struct list_head *list)
494 resource_list_free(list);
496 EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
498 struct res_proc_context {
499 struct list_head *list;
500 int (*preproc)(struct acpi_resource *, void *);
506 static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
507 struct res_proc_context *c)
509 struct resource_entry *rentry;
511 rentry = resource_list_create_entry(NULL, 0);
516 *rentry->res = win->res;
517 rentry->offset = win->offset;
518 resource_list_add_tail(rentry, c->list);
523 static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
526 struct res_proc_context *c = context;
527 struct resource_win win;
528 struct resource *res = &win.res;
534 ret = c->preproc(ares, c->preproc_data);
537 return AE_ABORT_METHOD;
538 } else if (ret > 0) {
543 memset(&win, 0, sizeof(win));
545 if (acpi_dev_resource_memory(ares, res)
546 || acpi_dev_resource_io(ares, res)
547 || acpi_dev_resource_address_space(ares, &win)
548 || acpi_dev_resource_ext_address_space(ares, &win))
549 return acpi_dev_new_resource_entry(&win, c);
551 for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
554 status = acpi_dev_new_resource_entry(&win, c);
555 if (ACPI_FAILURE(status))
562 static int __acpi_dev_get_resources(struct acpi_device *adev,
563 struct list_head *list,
564 int (*preproc)(struct acpi_resource *, void *),
565 void *preproc_data, char *method)
567 struct res_proc_context c;
570 if (!adev || !adev->handle || !list_empty(list))
573 if (!acpi_has_method(adev->handle, method))
578 c.preproc_data = preproc_data;
581 status = acpi_walk_resources(adev->handle, method,
582 acpi_dev_process_resource, &c);
583 if (ACPI_FAILURE(status)) {
584 acpi_dev_free_resource_list(list);
585 return c.error ? c.error : -EIO;
592 * acpi_dev_get_resources - Get current resources of a device.
593 * @adev: ACPI device node to get the resources for.
594 * @list: Head of the resultant list of resources (must be empty).
595 * @preproc: The caller's preprocessing routine.
596 * @preproc_data: Pointer passed to the caller's preprocessing routine.
598 * Evaluate the _CRS method for the given device node and process its output by
599 * (1) executing the @preproc() routine provided by the caller, passing the
600 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
601 * returned and (2) converting all of the returned ACPI resources into struct
602 * resource objects if possible. If the return value of @preproc() in step (1)
603 * is different from 0, step (2) is not applied to the given ACPI resource and
604 * if that value is negative, the whole processing is aborted and that value is
605 * returned as the final error code.
607 * The resultant struct resource objects are put on the list pointed to by
608 * @list, that must be empty initially, as members of struct resource_entry
609 * objects. Callers of this routine should use %acpi_dev_free_resource_list() to
612 * The number of resources in the output list is returned on success, an error
613 * code reflecting the error condition is returned otherwise.
615 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
616 int (*preproc)(struct acpi_resource *, void *),
619 return __acpi_dev_get_resources(adev, list, preproc, preproc_data,
622 EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
624 static int is_memory(struct acpi_resource *ares, void *not_used)
626 struct resource_win win;
627 struct resource *res = &win.res;
629 memset(&win, 0, sizeof(win));
631 return !(acpi_dev_resource_memory(ares, res)
632 || acpi_dev_resource_address_space(ares, &win)
633 || acpi_dev_resource_ext_address_space(ares, &win));
637 * acpi_dev_get_dma_resources - Get current DMA resources of a device.
638 * @adev: ACPI device node to get the resources for.
639 * @list: Head of the resultant list of resources (must be empty).
641 * Evaluate the _DMA method for the given device node and process its
644 * The resultant struct resource objects are put on the list pointed to
645 * by @list, that must be empty initially, as members of struct
646 * resource_entry objects. Callers of this routine should use
647 * %acpi_dev_free_resource_list() to free that list.
649 * The number of resources in the output list is returned on success,
650 * an error code reflecting the error condition is returned otherwise.
652 int acpi_dev_get_dma_resources(struct acpi_device *adev, struct list_head *list)
654 return __acpi_dev_get_resources(adev, list, is_memory, NULL,
657 EXPORT_SYMBOL_GPL(acpi_dev_get_dma_resources);
660 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
662 * @ares: Input ACPI resource object.
663 * @types: Valid resource types of IORESOURCE_XXX
665 * This is a helper function to support acpi_dev_get_resources(), which filters
666 * ACPI resource objects according to resource types.
668 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
671 unsigned long type = 0;
673 switch (ares->type) {
674 case ACPI_RESOURCE_TYPE_MEMORY24:
675 case ACPI_RESOURCE_TYPE_MEMORY32:
676 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
677 type = IORESOURCE_MEM;
679 case ACPI_RESOURCE_TYPE_IO:
680 case ACPI_RESOURCE_TYPE_FIXED_IO:
681 type = IORESOURCE_IO;
683 case ACPI_RESOURCE_TYPE_IRQ:
684 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
685 type = IORESOURCE_IRQ;
687 case ACPI_RESOURCE_TYPE_DMA:
688 case ACPI_RESOURCE_TYPE_FIXED_DMA:
689 type = IORESOURCE_DMA;
691 case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
692 type = IORESOURCE_REG;
694 case ACPI_RESOURCE_TYPE_ADDRESS16:
695 case ACPI_RESOURCE_TYPE_ADDRESS32:
696 case ACPI_RESOURCE_TYPE_ADDRESS64:
697 case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
698 if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
699 type = IORESOURCE_MEM;
700 else if (ares->data.address.resource_type == ACPI_IO_RANGE)
701 type = IORESOURCE_IO;
702 else if (ares->data.address.resource_type ==
703 ACPI_BUS_NUMBER_RANGE)
704 type = IORESOURCE_BUS;
710 return (type & types) ? 0 : 1;
712 EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
714 static int acpi_dev_consumes_res(struct acpi_device *adev, struct resource *res)
716 struct list_head resource_list;
717 struct resource_entry *rentry;
720 INIT_LIST_HEAD(&resource_list);
721 ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
725 list_for_each_entry(rentry, &resource_list, node) {
726 if (resource_contains(rentry->res, res)) {
733 acpi_dev_free_resource_list(&resource_list);
737 static acpi_status acpi_res_consumer_cb(acpi_handle handle, u32 depth,
738 void *context, void **ret)
740 struct resource *res = context;
741 struct acpi_device **consumer = (struct acpi_device **) ret;
742 struct acpi_device *adev;
744 if (acpi_bus_get_device(handle, &adev))
747 if (acpi_dev_consumes_res(adev, res)) {
749 return AE_CTRL_TERMINATE;
756 * acpi_resource_consumer - Find the ACPI device that consumes @res.
757 * @res: Resource to search for.
759 * Search the current resource settings (_CRS) of every ACPI device node
760 * for @res. If we find an ACPI device whose _CRS includes @res, return
761 * it. Otherwise, return NULL.
763 struct acpi_device *acpi_resource_consumer(struct resource *res)
765 struct acpi_device *consumer = NULL;
767 acpi_get_devices(NULL, acpi_res_consumer_cb, res, (void **) &consumer);