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