GNU Linux-libre 5.10.215-gnu1
[releases.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 static const struct dmi_system_id asus_laptop[] = {
396         {
397                 .ident = "Asus Vivobook K3402ZA",
398                 .matches = {
399                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
400                         DMI_MATCH(DMI_BOARD_NAME, "K3402ZA"),
401                 },
402         },
403         {
404                 .ident = "Asus Vivobook K3502ZA",
405                 .matches = {
406                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
407                         DMI_MATCH(DMI_BOARD_NAME, "K3502ZA"),
408                 },
409         },
410         {
411                 .ident = "Asus Vivobook S5402ZA",
412                 .matches = {
413                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
414                         DMI_MATCH(DMI_BOARD_NAME, "S5402ZA"),
415                 },
416         },
417         {
418                 .ident = "Asus Vivobook S5602ZA",
419                 .matches = {
420                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
421                         DMI_MATCH(DMI_BOARD_NAME, "S5602ZA"),
422                 },
423         },
424         {
425                 .ident = "Asus ExpertBook B1402CBA",
426                 .matches = {
427                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
428                         DMI_MATCH(DMI_BOARD_NAME, "B1402CBA"),
429                 },
430         },
431         {
432                 .ident = "Asus ExpertBook B1502CBA",
433                 .matches = {
434                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
435                         DMI_MATCH(DMI_BOARD_NAME, "B1502CBA"),
436                 },
437         },
438         {
439                 .ident = "Asus ExpertBook B2402CBA",
440                 .matches = {
441                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
442                         DMI_MATCH(DMI_BOARD_NAME, "B2402CBA"),
443                 },
444         },
445         {
446                 /* TongFang GMxXGxx/TUXEDO Polaris 15 Gen5 AMD */
447                 .matches = {
448                         DMI_MATCH(DMI_BOARD_NAME, "GMxXGxx"),
449                 },
450         },
451         {
452                 /* Asus ExpertBook B1402CVA */
453                 .matches = {
454                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
455                         DMI_MATCH(DMI_BOARD_NAME, "B1402CVA"),
456                 },
457         },
458         {
459                 /* TongFang GMxXGxx sold as Eluktronics Inc. RP-15 */
460                 .matches = {
461                         DMI_MATCH(DMI_SYS_VENDOR, "Eluktronics Inc."),
462                         DMI_MATCH(DMI_BOARD_NAME, "RP-15"),
463                 },
464         },
465         {
466                 /* TongFang GM6XGxX/TUXEDO Stellaris 16 Gen5 AMD */
467                 .matches = {
468                         DMI_MATCH(DMI_BOARD_NAME, "GM6XGxX"),
469                 },
470         },
471         {
472                 .ident = "Asus ExpertBook B2502",
473                 .matches = {
474                         DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
475                         DMI_MATCH(DMI_BOARD_NAME, "B2502CBA"),
476                 },
477         },
478         { }
479 };
480
481 struct irq_override_cmp {
482         const struct dmi_system_id *system;
483         unsigned char irq;
484         unsigned char triggering;
485         unsigned char polarity;
486         unsigned char shareable;
487 };
488
489 static const struct irq_override_cmp skip_override_table[] = {
490         { medion_laptop, 1, ACPI_LEVEL_SENSITIVE, ACPI_ACTIVE_LOW, 0 },
491         { asus_laptop, 1, ACPI_LEVEL_SENSITIVE, ACPI_ACTIVE_LOW, 0 },
492 };
493
494 static bool acpi_dev_irq_override(u32 gsi, u8 triggering, u8 polarity,
495                                   u8 shareable)
496 {
497         int i;
498
499         for (i = 0; i < ARRAY_SIZE(skip_override_table); i++) {
500                 const struct irq_override_cmp *entry = &skip_override_table[i];
501
502                 if (dmi_check_system(entry->system) &&
503                     entry->irq == gsi &&
504                     entry->triggering == triggering &&
505                     entry->polarity == polarity &&
506                     entry->shareable == shareable)
507                         return false;
508         }
509
510         return true;
511 }
512
513 static void acpi_dev_get_irqresource(struct resource *res, u32 gsi,
514                                      u8 triggering, u8 polarity, u8 shareable,
515                                      bool check_override)
516 {
517         int irq, p, t;
518
519         if (!valid_IRQ(gsi)) {
520                 irqresource_disabled(res, gsi);
521                 return;
522         }
523
524         /*
525          * In IO-APIC mode, use overridden attribute. Two reasons:
526          * 1. BIOS bug in DSDT
527          * 2. BIOS uses IO-APIC mode Interrupt Source Override
528          *
529          * We do this only if we are dealing with IRQ() or IRQNoFlags()
530          * resource (the legacy ISA resources). With modern ACPI 5 devices
531          * using extended IRQ descriptors we take the IRQ configuration
532          * from _CRS directly.
533          */
534         if (check_override &&
535             acpi_dev_irq_override(gsi, triggering, polarity, shareable) &&
536             !acpi_get_override_irq(gsi, &t, &p)) {
537                 u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE;
538                 u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH;
539
540                 if (triggering != trig || polarity != pol) {
541                         pr_warn("ACPI: IRQ %d override to %s, %s\n", gsi,
542                                 t ? "level" : "edge", p ? "low" : "high");
543                         triggering = trig;
544                         polarity = pol;
545                 }
546         }
547
548         res->flags = acpi_dev_irq_flags(triggering, polarity, shareable);
549         irq = acpi_register_gsi(NULL, gsi, triggering, polarity);
550         if (irq >= 0) {
551                 res->start = irq;
552                 res->end = irq;
553         } else {
554                 irqresource_disabled(res, gsi);
555         }
556 }
557
558 /**
559  * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information.
560  * @ares: Input ACPI resource object.
561  * @index: Index into the array of GSIs represented by the resource.
562  * @res: Output generic resource object.
563  *
564  * Check if the given ACPI resource object represents an interrupt resource
565  * and @index does not exceed the resource's interrupt count (true is returned
566  * in that case regardless of the results of the other checks)).  If that's the
567  * case, register the GSI corresponding to @index from the array of interrupts
568  * represented by the resource and populate the generic resource object pointed
569  * to by @res accordingly.  If the registration of the GSI is not successful,
570  * IORESOURCE_DISABLED will be set it that object's flags.
571  *
572  * Return:
573  * 1) false with res->flags setting to zero: not the expected resource type
574  * 2) false with IORESOURCE_DISABLED in res->flags: valid unassigned resource
575  * 3) true: valid assigned resource
576  */
577 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
578                                  struct resource *res)
579 {
580         struct acpi_resource_irq *irq;
581         struct acpi_resource_extended_irq *ext_irq;
582
583         switch (ares->type) {
584         case ACPI_RESOURCE_TYPE_IRQ:
585                 /*
586                  * Per spec, only one interrupt per descriptor is allowed in
587                  * _CRS, but some firmware violates this, so parse them all.
588                  */
589                 irq = &ares->data.irq;
590                 if (index >= irq->interrupt_count) {
591                         irqresource_disabled(res, 0);
592                         return false;
593                 }
594                 acpi_dev_get_irqresource(res, irq->interrupts[index],
595                                          irq->triggering, irq->polarity,
596                                          irq->shareable, true);
597                 break;
598         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
599                 ext_irq = &ares->data.extended_irq;
600                 if (index >= ext_irq->interrupt_count) {
601                         irqresource_disabled(res, 0);
602                         return false;
603                 }
604                 if (is_gsi(ext_irq))
605                         acpi_dev_get_irqresource(res, ext_irq->interrupts[index],
606                                          ext_irq->triggering, ext_irq->polarity,
607                                          ext_irq->shareable, false);
608                 else
609                         irqresource_disabled(res, 0);
610                 break;
611         default:
612                 res->flags = 0;
613                 return false;
614         }
615
616         return true;
617 }
618 EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt);
619
620 /**
621  * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources().
622  * @list: The head of the resource list to free.
623  */
624 void acpi_dev_free_resource_list(struct list_head *list)
625 {
626         resource_list_free(list);
627 }
628 EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list);
629
630 struct res_proc_context {
631         struct list_head *list;
632         int (*preproc)(struct acpi_resource *, void *);
633         void *preproc_data;
634         int count;
635         int error;
636 };
637
638 static acpi_status acpi_dev_new_resource_entry(struct resource_win *win,
639                                                struct res_proc_context *c)
640 {
641         struct resource_entry *rentry;
642
643         rentry = resource_list_create_entry(NULL, 0);
644         if (!rentry) {
645                 c->error = -ENOMEM;
646                 return AE_NO_MEMORY;
647         }
648         *rentry->res = win->res;
649         rentry->offset = win->offset;
650         resource_list_add_tail(rentry, c->list);
651         c->count++;
652         return AE_OK;
653 }
654
655 static acpi_status acpi_dev_process_resource(struct acpi_resource *ares,
656                                              void *context)
657 {
658         struct res_proc_context *c = context;
659         struct resource_win win;
660         struct resource *res = &win.res;
661         int i;
662
663         if (c->preproc) {
664                 int ret;
665
666                 ret = c->preproc(ares, c->preproc_data);
667                 if (ret < 0) {
668                         c->error = ret;
669                         return AE_ABORT_METHOD;
670                 } else if (ret > 0) {
671                         return AE_OK;
672                 }
673         }
674
675         memset(&win, 0, sizeof(win));
676
677         if (acpi_dev_resource_memory(ares, res)
678             || acpi_dev_resource_io(ares, res)
679             || acpi_dev_resource_address_space(ares, &win)
680             || acpi_dev_resource_ext_address_space(ares, &win))
681                 return acpi_dev_new_resource_entry(&win, c);
682
683         for (i = 0; acpi_dev_resource_interrupt(ares, i, res); i++) {
684                 acpi_status status;
685
686                 status = acpi_dev_new_resource_entry(&win, c);
687                 if (ACPI_FAILURE(status))
688                         return status;
689         }
690
691         return AE_OK;
692 }
693
694 static int __acpi_dev_get_resources(struct acpi_device *adev,
695                                     struct list_head *list,
696                                     int (*preproc)(struct acpi_resource *, void *),
697                                     void *preproc_data, char *method)
698 {
699         struct res_proc_context c;
700         acpi_status status;
701
702         if (!adev || !adev->handle || !list_empty(list))
703                 return -EINVAL;
704
705         if (!acpi_has_method(adev->handle, method))
706                 return 0;
707
708         c.list = list;
709         c.preproc = preproc;
710         c.preproc_data = preproc_data;
711         c.count = 0;
712         c.error = 0;
713         status = acpi_walk_resources(adev->handle, method,
714                                      acpi_dev_process_resource, &c);
715         if (ACPI_FAILURE(status)) {
716                 acpi_dev_free_resource_list(list);
717                 return c.error ? c.error : -EIO;
718         }
719
720         return c.count;
721 }
722
723 /**
724  * acpi_dev_get_resources - Get current resources of a device.
725  * @adev: ACPI device node to get the resources for.
726  * @list: Head of the resultant list of resources (must be empty).
727  * @preproc: The caller's preprocessing routine.
728  * @preproc_data: Pointer passed to the caller's preprocessing routine.
729  *
730  * Evaluate the _CRS method for the given device node and process its output by
731  * (1) executing the @preproc() rountine provided by the caller, passing the
732  * resource pointer and @preproc_data to it as arguments, for each ACPI resource
733  * returned and (2) converting all of the returned ACPI resources into struct
734  * resource objects if possible.  If the return value of @preproc() in step (1)
735  * is different from 0, step (2) is not applied to the given ACPI resource and
736  * if that value is negative, the whole processing is aborted and that value is
737  * returned as the final error code.
738  *
739  * The resultant struct resource objects are put on the list pointed to by
740  * @list, that must be empty initially, as members of struct resource_entry
741  * objects.  Callers of this routine should use %acpi_dev_free_resource_list() to
742  * free that list.
743  *
744  * The number of resources in the output list is returned on success, an error
745  * code reflecting the error condition is returned otherwise.
746  */
747 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
748                            int (*preproc)(struct acpi_resource *, void *),
749                            void *preproc_data)
750 {
751         return __acpi_dev_get_resources(adev, list, preproc, preproc_data,
752                                         METHOD_NAME__CRS);
753 }
754 EXPORT_SYMBOL_GPL(acpi_dev_get_resources);
755
756 static int is_memory(struct acpi_resource *ares, void *not_used)
757 {
758         struct resource_win win;
759         struct resource *res = &win.res;
760
761         memset(&win, 0, sizeof(win));
762
763         return !(acpi_dev_resource_memory(ares, res)
764                || acpi_dev_resource_address_space(ares, &win)
765                || acpi_dev_resource_ext_address_space(ares, &win));
766 }
767
768 /**
769  * acpi_dev_get_dma_resources - Get current DMA resources of a device.
770  * @adev: ACPI device node to get the resources for.
771  * @list: Head of the resultant list of resources (must be empty).
772  *
773  * Evaluate the _DMA method for the given device node and process its
774  * output.
775  *
776  * The resultant struct resource objects are put on the list pointed to
777  * by @list, that must be empty initially, as members of struct
778  * resource_entry objects.  Callers of this routine should use
779  * %acpi_dev_free_resource_list() to free that list.
780  *
781  * The number of resources in the output list is returned on success,
782  * an error code reflecting the error condition is returned otherwise.
783  */
784 int acpi_dev_get_dma_resources(struct acpi_device *adev, struct list_head *list)
785 {
786         return __acpi_dev_get_resources(adev, list, is_memory, NULL,
787                                         METHOD_NAME__DMA);
788 }
789 EXPORT_SYMBOL_GPL(acpi_dev_get_dma_resources);
790
791 /**
792  * acpi_dev_filter_resource_type - Filter ACPI resource according to resource
793  *                                 types
794  * @ares: Input ACPI resource object.
795  * @types: Valid resource types of IORESOURCE_XXX
796  *
797  * This is a helper function to support acpi_dev_get_resources(), which filters
798  * ACPI resource objects according to resource types.
799  */
800 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
801                                   unsigned long types)
802 {
803         unsigned long type = 0;
804
805         switch (ares->type) {
806         case ACPI_RESOURCE_TYPE_MEMORY24:
807         case ACPI_RESOURCE_TYPE_MEMORY32:
808         case ACPI_RESOURCE_TYPE_FIXED_MEMORY32:
809                 type = IORESOURCE_MEM;
810                 break;
811         case ACPI_RESOURCE_TYPE_IO:
812         case ACPI_RESOURCE_TYPE_FIXED_IO:
813                 type = IORESOURCE_IO;
814                 break;
815         case ACPI_RESOURCE_TYPE_IRQ:
816         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
817                 type = IORESOURCE_IRQ;
818                 break;
819         case ACPI_RESOURCE_TYPE_DMA:
820         case ACPI_RESOURCE_TYPE_FIXED_DMA:
821                 type = IORESOURCE_DMA;
822                 break;
823         case ACPI_RESOURCE_TYPE_GENERIC_REGISTER:
824                 type = IORESOURCE_REG;
825                 break;
826         case ACPI_RESOURCE_TYPE_ADDRESS16:
827         case ACPI_RESOURCE_TYPE_ADDRESS32:
828         case ACPI_RESOURCE_TYPE_ADDRESS64:
829         case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
830                 if (ares->data.address.resource_type == ACPI_MEMORY_RANGE)
831                         type = IORESOURCE_MEM;
832                 else if (ares->data.address.resource_type == ACPI_IO_RANGE)
833                         type = IORESOURCE_IO;
834                 else if (ares->data.address.resource_type ==
835                          ACPI_BUS_NUMBER_RANGE)
836                         type = IORESOURCE_BUS;
837                 break;
838         default:
839                 break;
840         }
841
842         return (type & types) ? 0 : 1;
843 }
844 EXPORT_SYMBOL_GPL(acpi_dev_filter_resource_type);
845
846 static int acpi_dev_consumes_res(struct acpi_device *adev, struct resource *res)
847 {
848         struct list_head resource_list;
849         struct resource_entry *rentry;
850         int ret, found = 0;
851
852         INIT_LIST_HEAD(&resource_list);
853         ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
854         if (ret < 0)
855                 return 0;
856
857         list_for_each_entry(rentry, &resource_list, node) {
858                 if (resource_contains(rentry->res, res)) {
859                         found = 1;
860                         break;
861                 }
862
863         }
864
865         acpi_dev_free_resource_list(&resource_list);
866         return found;
867 }
868
869 static acpi_status acpi_res_consumer_cb(acpi_handle handle, u32 depth,
870                                          void *context, void **ret)
871 {
872         struct resource *res = context;
873         struct acpi_device **consumer = (struct acpi_device **) ret;
874         struct acpi_device *adev;
875
876         if (acpi_bus_get_device(handle, &adev))
877                 return AE_OK;
878
879         if (acpi_dev_consumes_res(adev, res)) {
880                 *consumer = adev;
881                 return AE_CTRL_TERMINATE;
882         }
883
884         return AE_OK;
885 }
886
887 /**
888  * acpi_resource_consumer - Find the ACPI device that consumes @res.
889  * @res: Resource to search for.
890  *
891  * Search the current resource settings (_CRS) of every ACPI device node
892  * for @res.  If we find an ACPI device whose _CRS includes @res, return
893  * it.  Otherwise, return NULL.
894  */
895 struct acpi_device *acpi_resource_consumer(struct resource *res)
896 {
897         struct acpi_device *consumer = NULL;
898
899         acpi_get_devices(NULL, acpi_res_consumer_cb, res, (void **) &consumer);
900         return consumer;
901 }