Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * drivers/acpi/resource.c - ACPI device resources interpretation.
4 *
5 * Copyright (C) 2012, Intel Corp.
6 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
7 *
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 *
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 */
12
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>
19
20#ifdef CONFIG_X86
21#define valid_IRQ(i) (((i) != 0) && ((i) != 2))
22static inline bool acpi_iospace_resource_valid(struct resource *res)
23{
24 /* On X86 IO space is limited to the [0 - 64K] IO port range */
25 return res->end < 0x10003;
26}
27#else
28#define valid_IRQ(i) (true)
29/*
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.
33 */
34static inline bool
35acpi_iospace_resource_valid(struct resource *res) { return true; }
36#endif
37
38#if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
39static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
40{
41 return ext_irq->resource_source.string_length == 0 &&
42 ext_irq->producer_consumer == ACPI_CONSUMER;
43}
44#else
45static inline bool is_gsi(struct acpi_resource_extended_irq *ext_irq)
46{
47 return true;
48}
49#endif
50
51static bool acpi_dev_resource_len_valid(u64 start, u64 end, u64 len, bool io)
52{
53 u64 reslen = end - start + 1;
54
55 /*
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.
61 */
62 if (len && reslen && start <= end)
63 return true;
64
65 pr_debug("ACPI: invalid or unassigned resource %s [%016llx - %016llx] length [%016llx]\n",
66 io ? "io" : "mem", start, end, len);
67
68 return false;
69}
70
71static void acpi_dev_memresource_flags(struct resource *res, u64 len,
72 u8 write_protect)
73{
74 res->flags = IORESOURCE_MEM;
75
76 if (!acpi_dev_resource_len_valid(res->start, res->end, len, false))
77 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
78
79 if (write_protect == ACPI_READ_WRITE_MEMORY)
80 res->flags |= IORESOURCE_MEM_WRITEABLE;
81}
82
83static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
84 u8 write_protect)
85{
86 res->start = start;
87 res->end = start + len - 1;
88 acpi_dev_memresource_flags(res, len, write_protect);
89}
90
91/**
92 * acpi_dev_resource_memory - Extract ACPI memory resource information.
93 * @ares: Input ACPI resource object.
94 * @res: Output generic resource object.
95 *
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.
99 *
100 * Return:
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
104 */
105bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
106{
107 struct acpi_resource_memory24 *memory24;
108 struct acpi_resource_memory32 *memory32;
109 struct acpi_resource_fixed_memory32 *fixed_memory32;
110
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);
117 break;
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);
123 break;
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);
129 break;
130 default:
131 res->flags = 0;
132 return false;
133 }
134
135 return !(res->flags & IORESOURCE_DISABLED);
136}
137EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
138
139static void acpi_dev_ioresource_flags(struct resource *res, u64 len,
140 u8 io_decode, u8 translation_type)
141{
142 res->flags = IORESOURCE_IO;
143
144 if (!acpi_dev_resource_len_valid(res->start, res->end, len, true))
145 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
146
147 if (!acpi_iospace_resource_valid(res))
148 res->flags |= IORESOURCE_DISABLED | IORESOURCE_UNSET;
149
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;
154}
155
156static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
157 u8 io_decode)
158{
159 res->start = start;
160 res->end = start + len - 1;
161 acpi_dev_ioresource_flags(res, len, io_decode, 0);
162}
163
164/**
165 * acpi_dev_resource_io - Extract ACPI I/O resource information.
166 * @ares: Input ACPI resource object.
167 * @res: Output generic resource object.
168 *
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.
172 *
173 * Return:
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
177 */
178bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
179{
180 struct acpi_resource_io *io;
181 struct acpi_resource_fixed_io *fixed_io;
182
183 switch (ares->type) {
184 case ACPI_RESOURCE_TYPE_IO:
185 io = &ares->data.io;
186 acpi_dev_get_ioresource(res, io->minimum,
187 io->address_length,
188 io->io_decode);
189 break;
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,
194 ACPI_DECODE_10);
195 break;
196 default:
197 res->flags = 0;
198 return false;
199 }
200
201 return !(res->flags & IORESOURCE_DISABLED);
202}
203EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
204
205static bool acpi_decode_space(struct resource_win *win,
206 struct acpi_resource_address *addr,
207 struct acpi_address64_attribute *attr)
208{
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;
214
215 /*
216 * Filter out invalid descriptor according to ACPI Spec 5.0, section
217 * 6.4.3.5 Address Space Resource Descriptors.
218 */
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);
223
224 /*
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.
230 */
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;
238
239 win->offset = offset;
240 res->start = start;
241 res->end = end;
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);
246 return false;
247 }
248
249 switch (addr->resource_type) {
250 case ACPI_MEMORY_RANGE:
251 acpi_dev_memresource_flags(res, len, wp);
252 break;
253 case ACPI_IO_RANGE:
254 acpi_dev_ioresource_flags(res, len, iodec,
255 addr->info.io.translation_type);
256 break;
257 case ACPI_BUS_NUMBER_RANGE:
258 res->flags = IORESOURCE_BUS;
259 break;
260 default:
261 return false;
262 }
263
264 if (addr->producer_consumer == ACPI_PRODUCER)
265 res->flags |= IORESOURCE_WINDOW;
266
267 if (addr->info.mem.caching == ACPI_PREFETCHABLE_MEMORY)
268 res->flags |= IORESOURCE_PREFETCH;
269
270 return !(res->flags & IORESOURCE_DISABLED);
271}
272
273/**
274 * acpi_dev_resource_address_space - Extract ACPI address space information.
275 * @ares: Input ACPI resource object.
276 * @win: Output generic resource object.
277 *
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.
281 *
282 * Return:
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
285 * resource
286 * 3) true: valid assigned resource
287 */
288bool acpi_dev_resource_address_space(struct acpi_resource *ares,
289 struct resource_win *win)
290{
291 struct acpi_resource_address64 addr;
292
293 win->res.flags = 0;
294 if (ACPI_FAILURE(acpi_resource_to_address64(ares, &addr)))
295 return false;
296
297 return acpi_decode_space(win, (struct acpi_resource_address *)&addr,
298 &addr.address);
299}
300EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
301
302/**
303 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
304 * @ares: Input ACPI resource object.
305 * @win: Output generic resource object.
306 *
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.
310 *
311 * Return:
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
314 * resource
315 * 3) true: valid assigned resource
316 */
317bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
318 struct resource_win *win)
319{
320 struct acpi_resource_extended_address64 *ext_addr;
321
322 win->res.flags = 0;
323 if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
324 return false;
325
326 ext_addr = &ares->data.ext_address64;
327
328 return acpi_decode_space(win, (struct acpi_resource_address *)ext_addr,
329 &ext_addr->address);
330}
331EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
332
333/**
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.
338 */
339unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
340{
341 unsigned long flags;
342
343 if (triggering == ACPI_LEVEL_SENSITIVE)
344 flags = polarity == ACPI_ACTIVE_LOW ?
345 IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
346 else
347 flags = polarity == ACPI_ACTIVE_LOW ?
348 IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
349
350 if (shareable == ACPI_SHARED)
351 flags |= IORESOURCE_IRQ_SHAREABLE;
352
353 return flags | IORESOURCE_IRQ;
354}
355EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
356
357/**
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.
361 */
362unsigned int acpi_dev_get_irq_type(int triggering, int polarity)
363{
364 switch (polarity) {
365 case ACPI_ACTIVE_LOW:
366 return triggering == ACPI_EDGE_SENSITIVE ?
367 IRQ_TYPE_EDGE_FALLING :
368 IRQ_TYPE_LEVEL_LOW;
369 case ACPI_ACTIVE_HIGH:
370 return triggering == ACPI_EDGE_SENSITIVE ?
371 IRQ_TYPE_EDGE_RISING :
372 IRQ_TYPE_LEVEL_HIGH;
373 case ACPI_ACTIVE_BOTH:
374 if (triggering == ACPI_EDGE_SENSITIVE)
375 return IRQ_TYPE_EDGE_BOTH;
376 fallthrough;
377 default:
378 return IRQ_TYPE_NONE;
379 }
380}
381EXPORT_SYMBOL_GPL(acpi_dev_get_irq_type);
382
383static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi)
384{
385 res->start = gsi;
386 res->end = gsi;
387 res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED | IORESOURCE_UNSET;
388}
389
390static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
391 u8 triggering, u8 polarity, u8 shareable,
392 bool legacy)
393{
394 int irq, p, t;
395
396 if (!valid_IRQ(gsi)) {
397 acpi_dev_irqresource_disabled(res, gsi);
398 return;
399 }
400
401 /*
402 * In IO-APIC mode, use overridden attribute. Two reasons:
403 * 1. BIOS bug in DSDT
404 * 2. BIOS uses IO-APIC mode Interrupt Source Override
405 *
406 * We do this only if we are dealing with IRQ() or IRQNoFlags()
407 * resource (the legacy ISA resources). With modern ACPI 5 devices
408 * using extended IRQ descriptors we take the IRQ configuration
409 * from _CRS directly.
410 */
411 if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
412 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
413 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
414
415 if (triggering != trig || polarity != pol) {
416 pr_warn("ACPI: IRQ %d override to %s, %s\n", gsi,
417 t ? "level" : "edge", p ? "low" : "high");
418 triggering = trig;
419 polarity = pol;
420 }
421 }
422
423 res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
424 irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
425 if (irq >= 0) {
426 res->start = irq;
427 res->end = irq;
428 } else {
429 acpi_dev_irqresource_disabled(res, gsi);
430 }
431}
432
433/**
434 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
435 * @ares: Input ACPI resource object.
436 * @index: Index into the array of GSIs represented by the resource.
437 * @res: Output generic resource object.
438 *
439 * Check if the given ACPI resource object represents an interrupt resource
440 * and @index does not exceed the resource's interrupt count (true is returned
441 * in that case regardless of the results of the other checks)). If that's the
442 * case, register the GSI corresponding to @index from the array of interrupts
443 * represented by the resource and populate the generic resource object pointed
444 * to by @res accordingly. If the registration of the GSI is not successful,
445 * IORESOURCE_DISABLED will be set it that object's flags.
446 *
447 * Return:
448 * 1) false with res->flags setting to zero: not the expected resource type
449 * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
450 * 3) true: valid assigned resource
451 */
452bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
453 struct resource *res)
454{
455 struct acpi_resource_irq *irq;
456 struct acpi_resource_extended_irq *ext_irq;
457
458 switch (ares->type) {
459 case ACPI_RESOURCE_TYPE_IRQ:
460 /*
461 * Per spec, only one interrupt per descriptor is allowed in
462 * _CRS, but some firmware violates this, so parse them all.
463 */
464 irq = &ares->data.irq;
465 if (index >= irq->interrupt_count) {
466 acpi_dev_irqresource_disabled(res, 0);
467 return false;
468 }
469 acpi_dev_get_irqresource(res, irq->interrupts[index],
470 irq->triggering, irq->polarity,
471 irq->shareable, true);
472 break;
473 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
474 ext_irq = &ares->data.extended_irq;
475 if (index >= ext_irq->interrupt_count) {
476 acpi_dev_irqresource_disabled(res, 0);
477 return false;
478 }
479 if (is_gsi(ext_irq))
480 acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
481 ext_irq->triggering, ext_irq->polarity,
482 ext_irq->shareable, false);
483 else
484 acpi_dev_irqresource_disabled(res, 0);
485 break;
486 default:
487 res->flags = 0;
488 return false;
489 }
490
491 return true;
492}
493EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
494
495/**
496 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
497 * @list: The head of the resource list to free.
498 */
499void acpi_dev_free_resource_list(struct list_head *list)
500{
501 resource_list_free(list);
502}
503EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
504
505struct res_proc_context {
506 struct list_head *list;
507 int (*preproc)(struct acpi_resource *, void *);
508 void *preproc_data;
509 int count;
510 int error;
511};
512
513static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
514 struct res_proc_context *c)
515{
516 struct resource_entry *rentry;
517
518 rentry = resource_list_create_entry(NULL, 0);
519 if (!rentry) {
520 c->error = -ENOMEM;
521 return AE_NO_MEMORY;
522 }
523 *rentry->res = win->res;
524 rentry->offset = win->offset;
525 resource_list_add_tail(rentry, c->list);
526 c->count++;
527 return AE_OK;
528}
529
530static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
531 void *context)
532{
533 struct res_proc_context *c = context;
534 struct resource_win win;
535 struct resource *res = &win.res;
536 int i;
537
538 if (c->preproc) {
539 int ret;
540
541 ret = c->preproc(ares, c->preproc_data);
542 if (ret < 0) {
543 c->error = ret;
544 return AE_CTRL_TERMINATE;
545 } else if (ret > 0) {
546 return AE_OK;
547 }
548 }
549
550 memset(&win, 0, sizeof(win));
551
552 if (acpi_dev_resource_memory(ares, res)
553 || acpi_dev_resource_io(ares, res)
554 || acpi_dev_resource_address_space(ares, &win)
555 || acpi_dev_resource_ext_address_space(ares, &win))
556 return acpi_dev_new_resource_entry(&win, c);
557
558 for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
559 acpi_status status;
560
561 status = acpi_dev_new_resource_entry(&win, c);
562 if (ACPI_FAILURE(status))
563 return status;
564 }
565
566 return AE_OK;
567}
568
569static int __acpi_dev_get_resources(struct acpi_device *adev,
570 struct list_head *list,
571 int (*preproc)(struct acpi_resource *, void *),
572 void *preproc_data, char *method)
573{
574 struct res_proc_context c;
575 acpi_status status;
576
577 if (!adev || !adev->handle || !list_empty(list))
578 return -EINVAL;
579
580 if (!acpi_has_method(adev->handle, method))
581 return 0;
582
583 c.list = list;
584 c.preproc = preproc;
585 c.preproc_data = preproc_data;
586 c.count = 0;
587 c.error = 0;
588 status = acpi_walk_resources(adev->handle, method,
589 acpi_dev_process_resource, &c);
590 if (ACPI_FAILURE(status)) {
591 acpi_dev_free_resource_list(list);
592 return c.error ? c.error : -EIO;
593 }
594
595 return c.count;
596}
597
598/**
599 * acpi_dev_get_resources - Get current resources of a device.
600 * @adev: ACPI device node to get the resources for.
601 * @list: Head of the resultant list of resources (must be empty).
602 * @preproc: The caller's preprocessing routine.
603 * @preproc_data: Pointer passed to the caller's preprocessing routine.
604 *
605 * Evaluate the _CRS method for the given device node and process its output by
606 * (1) executing the @preproc() rountine provided by the caller, passing the
607 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
608 * returned and (2) converting all of the returned ACPI resources into struct
609 * resource objects if possible. If the return value of @preproc() in step (1)
610 * is different from 0, step (2) is not applied to the given ACPI resource and
611 * if that value is negative, the whole processing is aborted and that value is
612 * returned as the final error code.
613 *
614 * The resultant struct resource objects are put on the list pointed to by
615 * @list, that must be empty initially, as members of struct resource_entry
616 * objects. Callers of this routine should use %acpi_dev_free_resource_list() to
617 * free that list.
618 *
619 * The number of resources in the output list is returned on success, an error
620 * code reflecting the error condition is returned otherwise.
621 */
622int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
623 int (*preproc)(struct acpi_resource *, void *),
624 void *preproc_data)
625{
626 return __acpi_dev_get_resources(adev, list, preproc, preproc_data,
627 METHOD_NAME__CRS);
628}
629EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
630
631static int is_memory(struct acpi_resource *ares, void *not_used)
632{
633 struct resource_win win;
634 struct resource *res = &win.res;
635
636 memset(&win, 0, sizeof(win));
637
638 return !(acpi_dev_resource_memory(ares, res)
639 || acpi_dev_resource_address_space(ares, &win)
640 || acpi_dev_resource_ext_address_space(ares, &win));
641}
642
643/**
644 * acpi_dev_get_dma_resources - Get current DMA resources of a device.
645 * @adev: ACPI device node to get the resources for.
646 * @list: Head of the resultant list of resources (must be empty).
647 *
648 * Evaluate the _DMA method for the given device node and process its
649 * output.
650 *
651 * The resultant struct resource objects are put on the list pointed to
652 * by @list, that must be empty initially, as members of struct
653 * resource_entry objects. Callers of this routine should use
654 * %acpi_dev_free_resource_list() to free that list.
655 *
656 * The number of resources in the output list is returned on success,
657 * an error code reflecting the error condition is returned otherwise.
658 */
659int acpi_dev_get_dma_resources(struct acpi_device *adev, struct list_head *list)
660{
661 return __acpi_dev_get_resources(adev, list, is_memory, NULL,
662 METHOD_NAME__DMA);
663}
664EXPORT_SYMBOL_GPL(acpi_dev_get_dma_resources);
665
666/**
667 * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
668 * types
669 * @ares: Input ACPI resource object.
670 * @types: Valid resource types of IORESOURCE_XXX
671 *
672 * This is a helper function to support acpi_dev_get_resources(), which filters
673 * ACPI resource objects according to resource types.
674 */
675int acpi_dev_filter_resource_type(struct acpi_resource *ares,
676 unsigned long types)
677{
678 unsigned long type = 0;
679
680 switch (ares->type) {
681 case ACPI_RESOURCE_TYPE_MEMORY24:
682 case ACPI_RESOURCE_TYPE_MEMORY32:
683 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
684 type = IORESOURCE_MEM;
685 break;
686 case ACPI_RESOURCE_TYPE_IO:
687 case ACPI_RESOURCE_TYPE_FIXED_IO:
688 type = IORESOURCE_IO;
689 break;
690 case ACPI_RESOURCE_TYPE_IRQ:
691 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
692 type = IORESOURCE_IRQ;
693 break;
694 case ACPI_RESOURCE_TYPE_DMA:
695 case ACPI_RESOURCE_TYPE_FIXED_DMA:
696 type = IORESOURCE_DMA;
697 break;
698 case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
699 type = IORESOURCE_REG;
700 break;
701 case ACPI_RESOURCE_TYPE_ADDRESS16:
702 case ACPI_RESOURCE_TYPE_ADDRESS32:
703 case ACPI_RESOURCE_TYPE_ADDRESS64:
704 case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
705 if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
706 type = IORESOURCE_MEM;
707 else if (ares->data.address.resource_type == ACPI_IO_RANGE)
708 type = IORESOURCE_IO;
709 else if (ares->data.address.resource_type ==
710 ACPI_BUS_NUMBER_RANGE)
711 type = IORESOURCE_BUS;
712 break;
713 default:
714 break;
715 }
716
717 return (type & types) ? 0 : 1;
718}
719EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
720
721static int acpi_dev_consumes_res(struct acpi_device *adev, struct resource *res)
722{
723 struct list_head resource_list;
724 struct resource_entry *rentry;
725 int ret, found = 0;
726
727 INIT_LIST_HEAD(&resource_list);
728 ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
729 if (ret < 0)
730 return 0;
731
732 list_for_each_entry(rentry, &resource_list, node) {
733 if (resource_contains(rentry->res, res)) {
734 found = 1;
735 break;
736 }
737
738 }
739
740 acpi_dev_free_resource_list(&resource_list);
741 return found;
742}
743
744static acpi_status acpi_res_consumer_cb(acpi_handle handle, u32 depth,
745 void *context, void **ret)
746{
747 struct resource *res = context;
748 struct acpi_device **consumer = (struct acpi_device **) ret;
749 struct acpi_device *adev;
750
751 if (acpi_bus_get_device(handle, &adev))
752 return AE_OK;
753
754 if (acpi_dev_consumes_res(adev, res)) {
755 *consumer = adev;
756 return AE_CTRL_TERMINATE;
757 }
758
759 return AE_OK;
760}
761
762/**
763 * acpi_resource_consumer - Find the ACPI device that consumes @res.
764 * @res: Resource to search for.
765 *
766 * Search the current resource settings (_CRS) of every ACPI device node
767 * for @res. If we find an ACPI device whose _CRS includes @res, return
768 * it. Otherwise, return NULL.
769 */
770struct acpi_device *acpi_resource_consumer(struct resource *res)
771{
772 struct acpi_device *consumer = NULL;
773
774 acpi_get_devices(NULL, acpi_res_consumer_cb, res, (void **) &consumer);
775 return consumer;
776}
1/*
2 * drivers/acpi/resource.c - ACPI device resources interpretation.
3 *
4 * Copyright (C) 2012, Intel Corp.
5 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
6 *
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 *
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.
12 *
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.
17 *
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.
21 *
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23 */
24
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>
30
31#ifdef CONFIG_X86
32#define valid_IRQ(i) (((i) != 0) && ((i) != 2))
33#else
34#define valid_IRQ(i) (true)
35#endif
36
37static unsigned long acpi_dev_memresource_flags(u64 len, u8 write_protect,
38 bool window)
39{
40 unsigned long flags = IORESOURCE_MEM;
41
42 if (len == 0)
43 flags |= IORESOURCE_DISABLED;
44
45 if (write_protect == ACPI_READ_WRITE_MEMORY)
46 flags |= IORESOURCE_MEM_WRITEABLE;
47
48 if (window)
49 flags |= IORESOURCE_WINDOW;
50
51 return flags;
52}
53
54static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len,
55 u8 write_protect)
56{
57 res->start = start;
58 res->end = start + len - 1;
59 res->flags = acpi_dev_memresource_flags(len, write_protect, false);
60}
61
62/**
63 * acpi_dev_resource_memory - Extract ACPI memory resource information.
64 * @ares: Input ACPI resource object.
65 * @res: Output generic resource object.
66 *
67 * Check if the given ACPI resource object represents a memory resource and
68 * if that's the case, use the information in it to populate the generic
69 * resource object pointed to by @res.
70 */
71bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res)
72{
73 struct acpi_resource_memory24 *memory24;
74 struct acpi_resource_memory32 *memory32;
75 struct acpi_resource_fixed_memory32 *fixed_memory32;
76
77 switch (ares->type) {
78 case ACPI_RESOURCE_TYPE_MEMORY24:
79 memory24 = &ares->data.memory24;
80 if (!memory24->address_length)
81 return false;
82 acpi_dev_get_memresource(res, memory24->minimum,
83 memory24->address_length,
84 memory24->write_protect);
85 break;
86 case ACPI_RESOURCE_TYPE_MEMORY32:
87 memory32 = &ares->data.memory32;
88 if (!memory32->address_length)
89 return false;
90 acpi_dev_get_memresource(res, memory32->minimum,
91 memory32->address_length,
92 memory32->write_protect);
93 break;
94 case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
95 fixed_memory32 = &ares->data.fixed_memory32;
96 if (!fixed_memory32->address_length)
97 return false;
98 acpi_dev_get_memresource(res, fixed_memory32->address,
99 fixed_memory32->address_length,
100 fixed_memory32->write_protect);
101 break;
102 default:
103 return false;
104 }
105 return true;
106}
107EXPORT_SYMBOL_GPL(acpi_dev_resource_memory);
108
109static unsigned int acpi_dev_ioresource_flags(u64 start, u64 end, u8 io_decode,
110 bool window)
111{
112 int flags = IORESOURCE_IO;
113
114 if (io_decode == ACPI_DECODE_16)
115 flags |= IORESOURCE_IO_16BIT_ADDR;
116
117 if (start > end || end >= 0x10003)
118 flags |= IORESOURCE_DISABLED;
119
120 if (window)
121 flags |= IORESOURCE_WINDOW;
122
123 return flags;
124}
125
126static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len,
127 u8 io_decode)
128{
129 u64 end = start + len - 1;
130
131 res->start = start;
132 res->end = end;
133 res->flags = acpi_dev_ioresource_flags(start, end, io_decode, false);
134}
135
136/**
137 * acpi_dev_resource_io - Extract ACPI I/O resource information.
138 * @ares: Input ACPI resource object.
139 * @res: Output generic resource object.
140 *
141 * Check if the given ACPI resource object represents an I/O resource and
142 * if that's the case, use the information in it to populate the generic
143 * resource object pointed to by @res.
144 */
145bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res)
146{
147 struct acpi_resource_io *io;
148 struct acpi_resource_fixed_io *fixed_io;
149
150 switch (ares->type) {
151 case ACPI_RESOURCE_TYPE_IO:
152 io = &ares->data.io;
153 if (!io->address_length)
154 return false;
155 acpi_dev_get_ioresource(res, io->minimum,
156 io->address_length,
157 io->io_decode);
158 break;
159 case ACPI_RESOURCE_TYPE_FIXED_IO:
160 fixed_io = &ares->data.fixed_io;
161 if (!fixed_io->address_length)
162 return false;
163 acpi_dev_get_ioresource(res, fixed_io->address,
164 fixed_io->address_length,
165 ACPI_DECODE_10);
166 break;
167 default:
168 return false;
169 }
170 return true;
171}
172EXPORT_SYMBOL_GPL(acpi_dev_resource_io);
173
174/**
175 * acpi_dev_resource_address_space - Extract ACPI address space information.
176 * @ares: Input ACPI resource object.
177 * @res: Output generic resource object.
178 *
179 * Check if the given ACPI resource object represents an address space resource
180 * and if that's the case, use the information in it to populate the generic
181 * resource object pointed to by @res.
182 */
183bool acpi_dev_resource_address_space(struct acpi_resource *ares,
184 struct resource *res)
185{
186 acpi_status status;
187 struct acpi_resource_address64 addr;
188 bool window;
189 u64 len;
190 u8 io_decode;
191
192 switch (ares->type) {
193 case ACPI_RESOURCE_TYPE_ADDRESS16:
194 case ACPI_RESOURCE_TYPE_ADDRESS32:
195 case ACPI_RESOURCE_TYPE_ADDRESS64:
196 break;
197 default:
198 return false;
199 }
200
201 status = acpi_resource_to_address64(ares, &addr);
202 if (ACPI_FAILURE(status))
203 return true;
204
205 res->start = addr.minimum;
206 res->end = addr.maximum;
207 window = addr.producer_consumer == ACPI_PRODUCER;
208
209 switch(addr.resource_type) {
210 case ACPI_MEMORY_RANGE:
211 len = addr.maximum - addr.minimum + 1;
212 res->flags = acpi_dev_memresource_flags(len,
213 addr.info.mem.write_protect,
214 window);
215 break;
216 case ACPI_IO_RANGE:
217 io_decode = addr.granularity == 0xfff ?
218 ACPI_DECODE_10 : ACPI_DECODE_16;
219 res->flags = acpi_dev_ioresource_flags(addr.minimum,
220 addr.maximum,
221 io_decode, window);
222 break;
223 case ACPI_BUS_NUMBER_RANGE:
224 res->flags = IORESOURCE_BUS;
225 break;
226 default:
227 res->flags = 0;
228 }
229
230 return true;
231}
232EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space);
233
234/**
235 * acpi_dev_resource_ext_address_space - Extract ACPI address space information.
236 * @ares: Input ACPI resource object.
237 * @res: Output generic resource object.
238 *
239 * Check if the given ACPI resource object represents an extended address space
240 * resource and if that's the case, use the information in it to populate the
241 * generic resource object pointed to by @res.
242 */
243bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
244 struct resource *res)
245{
246 struct acpi_resource_extended_address64 *ext_addr;
247 bool window;
248 u64 len;
249 u8 io_decode;
250
251 if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64)
252 return false;
253
254 ext_addr = &ares->data.ext_address64;
255
256 res->start = ext_addr->minimum;
257 res->end = ext_addr->maximum;
258 window = ext_addr->producer_consumer == ACPI_PRODUCER;
259
260 switch(ext_addr->resource_type) {
261 case ACPI_MEMORY_RANGE:
262 len = ext_addr->maximum - ext_addr->minimum + 1;
263 res->flags = acpi_dev_memresource_flags(len,
264 ext_addr->info.mem.write_protect,
265 window);
266 break;
267 case ACPI_IO_RANGE:
268 io_decode = ext_addr->granularity == 0xfff ?
269 ACPI_DECODE_10 : ACPI_DECODE_16;
270 res->flags = acpi_dev_ioresource_flags(ext_addr->minimum,
271 ext_addr->maximum,
272 io_decode, window);
273 break;
274 case ACPI_BUS_NUMBER_RANGE:
275 res->flags = IORESOURCE_BUS;
276 break;
277 default:
278 res->flags = 0;
279 }
280
281 return true;
282}
283EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space);
284
285/**
286 * acpi_dev_irq_flags - Determine IRQ resource flags.
287 * @triggering: Triggering type as provided by ACPI.
288 * @polarity: Interrupt polarity as provided by ACPI.
289 * @shareable: Whether or not the interrupt is shareable.
290 */
291unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable)
292{
293 unsigned long flags;
294
295 if (triggering == ACPI_LEVEL_SENSITIVE)
296 flags = polarity == ACPI_ACTIVE_LOW ?
297 IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL;
298 else
299 flags = polarity == ACPI_ACTIVE_LOW ?
300 IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE;
301
302 if (shareable == ACPI_SHARED)
303 flags |= IORESOURCE_IRQ_SHAREABLE;
304
305 return flags | IORESOURCE_IRQ;
306}
307EXPORT_SYMBOL_GPL(acpi_dev_irq_flags);
308
309static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi)
310{
311 res->start = gsi;
312 res->end = gsi;
313 res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED;
314}
315
316static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
317 u8 triggering, u8 polarity, u8 shareable,
318 bool legacy)
319{
320 int irq, p, t;
321
322 if (!valid_IRQ(gsi)) {
323 acpi_dev_irqresource_disabled(res, gsi);
324 return;
325 }
326
327 /*
328 * In IO-APIC mode, use overrided attribute. Two reasons:
329 * 1. BIOS bug in DSDT
330 * 2. BIOS uses IO-APIC mode Interrupt Source Override
331 *
332 * We do this only if we are dealing with IRQ() or IRQNoFlags()
333 * resource (the legacy ISA resources). With modern ACPI 5 devices
334 * using extended IRQ descriptors we take the IRQ configuration
335 * from _CRS directly.
336 */
337 if (legacy && !acpi_get_override_irq(gsi, &t, &p)) {
338 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
339 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
340
341 if (triggering != trig || polarity != pol) {
342 pr_warning("ACPI: IRQ %d override to %s, %s\n", gsi,
343 t ? "level" : "edge", p ? "low" : "high");
344 triggering = trig;
345 polarity = pol;
346 }
347 }
348
349 res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
350 irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
351 if (irq >= 0) {
352 res->start = irq;
353 res->end = irq;
354 } else {
355 acpi_dev_irqresource_disabled(res, gsi);
356 }
357}
358
359/**
360 * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
361 * @ares: Input ACPI resource object.
362 * @index: Index into the array of GSIs represented by the resource.
363 * @res: Output generic resource object.
364 *
365 * Check if the given ACPI resource object represents an interrupt resource
366 * and @index does not exceed the resource's interrupt count (true is returned
367 * in that case regardless of the results of the other checks)). If that's the
368 * case, register the GSI corresponding to @index from the array of interrupts
369 * represented by the resource and populate the generic resource object pointed
370 * to by @res accordingly. If the registration of the GSI is not successful,
371 * IORESOURCE_DISABLED will be set it that object's flags.
372 */
373bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
374 struct resource *res)
375{
376 struct acpi_resource_irq *irq;
377 struct acpi_resource_extended_irq *ext_irq;
378
379 switch (ares->type) {
380 case ACPI_RESOURCE_TYPE_IRQ:
381 /*
382 * Per spec, only one interrupt per descriptor is allowed in
383 * _CRS, but some firmware violates this, so parse them all.
384 */
385 irq = &ares->data.irq;
386 if (index >= irq->interrupt_count) {
387 acpi_dev_irqresource_disabled(res, 0);
388 return false;
389 }
390 acpi_dev_get_irqresource(res, irq->interrupts[index],
391 irq->triggering, irq->polarity,
392 irq->sharable, true);
393 break;
394 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
395 ext_irq = &ares->data.extended_irq;
396 if (index >= ext_irq->interrupt_count) {
397 acpi_dev_irqresource_disabled(res, 0);
398 return false;
399 }
400 acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
401 ext_irq->triggering, ext_irq->polarity,
402 ext_irq->sharable, false);
403 break;
404 default:
405 return false;
406 }
407
408 return true;
409}
410EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
411
412/**
413 * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
414 * @list: The head of the resource list to free.
415 */
416void acpi_dev_free_resource_list(struct list_head *list)
417{
418 struct resource_list_entry *rentry, *re;
419
420 list_for_each_entry_safe(rentry, re, list, node) {
421 list_del(&rentry->node);
422 kfree(rentry);
423 }
424}
425EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
426
427struct res_proc_context {
428 struct list_head *list;
429 int (*preproc)(struct acpi_resource *, void *);
430 void *preproc_data;
431 int count;
432 int error;
433};
434
435static acpi_status acpi_dev_new_resource_entry(struct resource *r,
436 struct res_proc_context *c)
437{
438 struct resource_list_entry *rentry;
439
440 rentry = kmalloc(sizeof(*rentry), GFP_KERNEL);
441 if (!rentry) {
442 c->error = -ENOMEM;
443 return AE_NO_MEMORY;
444 }
445 rentry->res = *r;
446 list_add_tail(&rentry->node, c->list);
447 c->count++;
448 return AE_OK;
449}
450
451static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
452 void *context)
453{
454 struct res_proc_context *c = context;
455 struct resource r;
456 int i;
457
458 if (c->preproc) {
459 int ret;
460
461 ret = c->preproc(ares, c->preproc_data);
462 if (ret < 0) {
463 c->error = ret;
464 return AE_CTRL_TERMINATE;
465 } else if (ret > 0) {
466 return AE_OK;
467 }
468 }
469
470 memset(&r, 0, sizeof(r));
471
472 if (acpi_dev_resource_memory(ares, &r)
473 || acpi_dev_resource_io(ares, &r)
474 || acpi_dev_resource_address_space(ares, &r)
475 || acpi_dev_resource_ext_address_space(ares, &r))
476 return acpi_dev_new_resource_entry(&r, c);
477
478 for (i = 0; acpi_dev_resource_interrupt(ares, i, &r); i++) {
479 acpi_status status;
480
481 status = acpi_dev_new_resource_entry(&r, c);
482 if (ACPI_FAILURE(status))
483 return status;
484 }
485
486 return AE_OK;
487}
488
489/**
490 * acpi_dev_get_resources - Get current resources of a device.
491 * @adev: ACPI device node to get the resources for.
492 * @list: Head of the resultant list of resources (must be empty).
493 * @preproc: The caller's preprocessing routine.
494 * @preproc_data: Pointer passed to the caller's preprocessing routine.
495 *
496 * Evaluate the _CRS method for the given device node and process its output by
497 * (1) executing the @preproc() rountine provided by the caller, passing the
498 * resource pointer and @preproc_data to it as arguments, for each ACPI resource
499 * returned and (2) converting all of the returned ACPI resources into struct
500 * resource objects if possible. If the return value of @preproc() in step (1)
501 * is different from 0, step (2) is not applied to the given ACPI resource and
502 * if that value is negative, the whole processing is aborted and that value is
503 * returned as the final error code.
504 *
505 * The resultant struct resource objects are put on the list pointed to by
506 * @list, that must be empty initially, as members of struct resource_list_entry
507 * objects. Callers of this routine should use %acpi_dev_free_resource_list() to
508 * free that list.
509 *
510 * The number of resources in the output list is returned on success, an error
511 * code reflecting the error condition is returned otherwise.
512 */
513int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
514 int (*preproc)(struct acpi_resource *, void *),
515 void *preproc_data)
516{
517 struct res_proc_context c;
518 acpi_status status;
519
520 if (!adev || !adev->handle || !list_empty(list))
521 return -EINVAL;
522
523 if (!acpi_has_method(adev->handle, METHOD_NAME__CRS))
524 return 0;
525
526 c.list = list;
527 c.preproc = preproc;
528 c.preproc_data = preproc_data;
529 c.count = 0;
530 c.error = 0;
531 status = acpi_walk_resources(adev->handle, METHOD_NAME__CRS,
532 acpi_dev_process_resource, &c);
533 if (ACPI_FAILURE(status)) {
534 acpi_dev_free_resource_list(list);
535 return c.error ? c.error : -EIO;
536 }
537
538 return c.count;
539}
540EXPORT_SYMBOL_GPL(acpi_dev_get_resources);