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