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