xref: /openbmc/linux/drivers/acpi/tables.c (revision a8da474e)
1 /*
2  *  acpi_tables.c - ACPI Boot-Time Table Parsing
3  *
4  *  Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
5  *
6  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19  *
20  */
21 
22 /* Uncomment next line to get verbose printout */
23 /* #define DEBUG */
24 #define pr_fmt(fmt) "ACPI: " fmt
25 
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/smp.h>
29 #include <linux/string.h>
30 #include <linux/types.h>
31 #include <linux/irq.h>
32 #include <linux/errno.h>
33 #include <linux/acpi.h>
34 #include <linux/bootmem.h>
35 
36 #define ACPI_MAX_TABLES		128
37 
38 static char *mps_inti_flags_polarity[] = { "dfl", "high", "res", "low" };
39 static char *mps_inti_flags_trigger[] = { "dfl", "edge", "res", "level" };
40 
41 static struct acpi_table_desc initial_tables[ACPI_MAX_TABLES] __initdata;
42 
43 static int acpi_apic_instance __initdata;
44 
45 /*
46  * Disable table checksum verification for the early stage due to the size
47  * limitation of the current x86 early mapping implementation.
48  */
49 static bool acpi_verify_table_checksum __initdata = false;
50 
51 void acpi_table_print_madt_entry(struct acpi_subtable_header *header)
52 {
53 	if (!header)
54 		return;
55 
56 	switch (header->type) {
57 
58 	case ACPI_MADT_TYPE_LOCAL_APIC:
59 		{
60 			struct acpi_madt_local_apic *p =
61 			    (struct acpi_madt_local_apic *)header;
62 			pr_debug("LAPIC (acpi_id[0x%02x] lapic_id[0x%02x] %s)\n",
63 				 p->processor_id, p->id,
64 				 (p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
65 		}
66 		break;
67 
68 	case ACPI_MADT_TYPE_LOCAL_X2APIC:
69 		{
70 			struct acpi_madt_local_x2apic *p =
71 			    (struct acpi_madt_local_x2apic *)header;
72 			pr_debug("X2APIC (apic_id[0x%02x] uid[0x%02x] %s)\n",
73 				 p->local_apic_id, p->uid,
74 				 (p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
75 		}
76 		break;
77 
78 	case ACPI_MADT_TYPE_IO_APIC:
79 		{
80 			struct acpi_madt_io_apic *p =
81 			    (struct acpi_madt_io_apic *)header;
82 			pr_debug("IOAPIC (id[0x%02x] address[0x%08x] gsi_base[%d])\n",
83 				 p->id, p->address, p->global_irq_base);
84 		}
85 		break;
86 
87 	case ACPI_MADT_TYPE_INTERRUPT_OVERRIDE:
88 		{
89 			struct acpi_madt_interrupt_override *p =
90 			    (struct acpi_madt_interrupt_override *)header;
91 			pr_info("INT_SRC_OVR (bus %d bus_irq %d global_irq %d %s %s)\n",
92 				p->bus, p->source_irq, p->global_irq,
93 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
94 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2]);
95 			if (p->inti_flags  &
96 			    ~(ACPI_MADT_POLARITY_MASK | ACPI_MADT_TRIGGER_MASK))
97 				pr_info("INT_SRC_OVR unexpected reserved flags: 0x%x\n",
98 					p->inti_flags  &
99 					~(ACPI_MADT_POLARITY_MASK | ACPI_MADT_TRIGGER_MASK));
100 		}
101 		break;
102 
103 	case ACPI_MADT_TYPE_NMI_SOURCE:
104 		{
105 			struct acpi_madt_nmi_source *p =
106 			    (struct acpi_madt_nmi_source *)header;
107 			pr_info("NMI_SRC (%s %s global_irq %d)\n",
108 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
109 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
110 				p->global_irq);
111 		}
112 		break;
113 
114 	case ACPI_MADT_TYPE_LOCAL_APIC_NMI:
115 		{
116 			struct acpi_madt_local_apic_nmi *p =
117 			    (struct acpi_madt_local_apic_nmi *)header;
118 			pr_info("LAPIC_NMI (acpi_id[0x%02x] %s %s lint[0x%x])\n",
119 				p->processor_id,
120 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK	],
121 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
122 				p->lint);
123 		}
124 		break;
125 
126 	case ACPI_MADT_TYPE_LOCAL_X2APIC_NMI:
127 		{
128 			u16 polarity, trigger;
129 			struct acpi_madt_local_x2apic_nmi *p =
130 			    (struct acpi_madt_local_x2apic_nmi *)header;
131 
132 			polarity = p->inti_flags & ACPI_MADT_POLARITY_MASK;
133 			trigger = (p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2;
134 
135 			pr_info("X2APIC_NMI (uid[0x%02x] %s %s lint[0x%x])\n",
136 				p->uid,
137 				mps_inti_flags_polarity[polarity],
138 				mps_inti_flags_trigger[trigger],
139 				p->lint);
140 		}
141 		break;
142 
143 	case ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE:
144 		{
145 			struct acpi_madt_local_apic_override *p =
146 			    (struct acpi_madt_local_apic_override *)header;
147 			pr_info("LAPIC_ADDR_OVR (address[%p])\n",
148 				(void *)(unsigned long)p->address);
149 		}
150 		break;
151 
152 	case ACPI_MADT_TYPE_IO_SAPIC:
153 		{
154 			struct acpi_madt_io_sapic *p =
155 			    (struct acpi_madt_io_sapic *)header;
156 			pr_debug("IOSAPIC (id[0x%x] address[%p] gsi_base[%d])\n",
157 				 p->id, (void *)(unsigned long)p->address,
158 				 p->global_irq_base);
159 		}
160 		break;
161 
162 	case ACPI_MADT_TYPE_LOCAL_SAPIC:
163 		{
164 			struct acpi_madt_local_sapic *p =
165 			    (struct acpi_madt_local_sapic *)header;
166 			pr_debug("LSAPIC (acpi_id[0x%02x] lsapic_id[0x%02x] lsapic_eid[0x%02x] %s)\n",
167 				 p->processor_id, p->id, p->eid,
168 				 (p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
169 		}
170 		break;
171 
172 	case ACPI_MADT_TYPE_INTERRUPT_SOURCE:
173 		{
174 			struct acpi_madt_interrupt_source *p =
175 			    (struct acpi_madt_interrupt_source *)header;
176 			pr_info("PLAT_INT_SRC (%s %s type[0x%x] id[0x%04x] eid[0x%x] iosapic_vector[0x%x] global_irq[0x%x]\n",
177 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
178 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
179 				p->type, p->id, p->eid, p->io_sapic_vector,
180 				p->global_irq);
181 		}
182 		break;
183 
184 	case ACPI_MADT_TYPE_GENERIC_INTERRUPT:
185 		{
186 			struct acpi_madt_generic_interrupt *p =
187 				(struct acpi_madt_generic_interrupt *)header;
188 			pr_debug("GICC (acpi_id[0x%04x] address[%llx] MPIDR[0x%llx] %s)\n",
189 				 p->uid, p->base_address,
190 				 p->arm_mpidr,
191 				 (p->flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
192 
193 		}
194 		break;
195 
196 	case ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR:
197 		{
198 			struct acpi_madt_generic_distributor *p =
199 				(struct acpi_madt_generic_distributor *)header;
200 			pr_debug("GIC Distributor (gic_id[0x%04x] address[%llx] gsi_base[%d])\n",
201 				 p->gic_id, p->base_address,
202 				 p->global_irq_base);
203 		}
204 		break;
205 
206 	default:
207 		pr_warn("Found unsupported MADT entry (type = 0x%x)\n",
208 			header->type);
209 		break;
210 	}
211 }
212 
213 /**
214  * acpi_parse_entries_array - for each proc_num find a suitable subtable
215  *
216  * @id: table id (for debugging purposes)
217  * @table_size: single entry size
218  * @table_header: where does the table start?
219  * @proc: array of acpi_subtable_proc struct containing entry id
220  *        and associated handler with it
221  * @proc_num: how big proc is?
222  * @max_entries: how many entries can we process?
223  *
224  * For each proc_num find a subtable with proc->id and run proc->handler
225  * on it. Assumption is that there's only single handler for particular
226  * entry id.
227  *
228  * On success returns sum of all matching entries for all proc handlers.
229  * Otherwise, -ENODEV or -EINVAL is returned.
230  */
231 static int __init
232 acpi_parse_entries_array(char *id, unsigned long table_size,
233 		struct acpi_table_header *table_header,
234 		struct acpi_subtable_proc *proc, int proc_num,
235 		unsigned int max_entries)
236 {
237 	struct acpi_subtable_header *entry;
238 	unsigned long table_end;
239 	int count = 0;
240 	int i;
241 
242 	if (acpi_disabled)
243 		return -ENODEV;
244 
245 	if (!id)
246 		return -EINVAL;
247 
248 	if (!table_size)
249 		return -EINVAL;
250 
251 	if (!table_header) {
252 		pr_warn("%4.4s not present\n", id);
253 		return -ENODEV;
254 	}
255 
256 	table_end = (unsigned long)table_header + table_header->length;
257 
258 	/* Parse all entries looking for a match. */
259 
260 	entry = (struct acpi_subtable_header *)
261 	    ((unsigned long)table_header + table_size);
262 
263 	while (((unsigned long)entry) + sizeof(struct acpi_subtable_header) <
264 	       table_end) {
265 		if (max_entries && count >= max_entries)
266 			break;
267 
268 		for (i = 0; i < proc_num; i++) {
269 			if (entry->type != proc[i].id)
270 				continue;
271 			if (!proc[i].handler ||
272 			     proc[i].handler(entry, table_end))
273 				return -EINVAL;
274 
275 			proc->count++;
276 			break;
277 		}
278 		if (i != proc_num)
279 			count++;
280 
281 		/*
282 		 * If entry->length is 0, break from this loop to avoid
283 		 * infinite loop.
284 		 */
285 		if (entry->length == 0) {
286 			pr_err("[%4.4s:0x%02x] Invalid zero length\n", id, proc->id);
287 			return -EINVAL;
288 		}
289 
290 		entry = (struct acpi_subtable_header *)
291 		    ((unsigned long)entry + entry->length);
292 	}
293 
294 	if (max_entries && count > max_entries) {
295 		pr_warn("[%4.4s:0x%02x] ignored %i entries of %i found\n",
296 			id, proc->id, count - max_entries, count);
297 	}
298 
299 	return count;
300 }
301 
302 int __init
303 acpi_parse_entries(char *id,
304 			unsigned long table_size,
305 			acpi_tbl_entry_handler handler,
306 			struct acpi_table_header *table_header,
307 			int entry_id, unsigned int max_entries)
308 {
309 	struct acpi_subtable_proc proc = {
310 		.id		= entry_id,
311 		.handler	= handler,
312 	};
313 
314 	return acpi_parse_entries_array(id, table_size, table_header,
315 			&proc, 1, max_entries);
316 }
317 
318 int __init
319 acpi_table_parse_entries_array(char *id,
320 			 unsigned long table_size,
321 			 struct acpi_subtable_proc *proc, int proc_num,
322 			 unsigned int max_entries)
323 {
324 	struct acpi_table_header *table_header = NULL;
325 	acpi_size tbl_size;
326 	int count;
327 	u32 instance = 0;
328 
329 	if (acpi_disabled)
330 		return -ENODEV;
331 
332 	if (!id)
333 		return -EINVAL;
334 
335 	if (!strncmp(id, ACPI_SIG_MADT, 4))
336 		instance = acpi_apic_instance;
337 
338 	acpi_get_table_with_size(id, instance, &table_header, &tbl_size);
339 	if (!table_header) {
340 		pr_warn("%4.4s not present\n", id);
341 		return -ENODEV;
342 	}
343 
344 	count = acpi_parse_entries_array(id, table_size, table_header,
345 			proc, proc_num, max_entries);
346 
347 	early_acpi_os_unmap_memory((char *)table_header, tbl_size);
348 	return count;
349 }
350 
351 int __init
352 acpi_table_parse_entries(char *id,
353 			unsigned long table_size,
354 			int entry_id,
355 			acpi_tbl_entry_handler handler,
356 			unsigned int max_entries)
357 {
358 	struct acpi_subtable_proc proc = {
359 		.id		= entry_id,
360 		.handler	= handler,
361 	};
362 
363 	return acpi_table_parse_entries_array(id, table_size, &proc, 1,
364 						max_entries);
365 }
366 
367 int __init
368 acpi_table_parse_madt(enum acpi_madt_type id,
369 		      acpi_tbl_entry_handler handler, unsigned int max_entries)
370 {
371 	return acpi_table_parse_entries(ACPI_SIG_MADT,
372 					    sizeof(struct acpi_table_madt), id,
373 					    handler, max_entries);
374 }
375 
376 /**
377  * acpi_table_parse - find table with @id, run @handler on it
378  * @id: table id to find
379  * @handler: handler to run
380  *
381  * Scan the ACPI System Descriptor Table (STD) for a table matching @id,
382  * run @handler on it.
383  *
384  * Return 0 if table found, -errno if not.
385  */
386 int __init acpi_table_parse(char *id, acpi_tbl_table_handler handler)
387 {
388 	struct acpi_table_header *table = NULL;
389 	acpi_size tbl_size;
390 
391 	if (acpi_disabled)
392 		return -ENODEV;
393 
394 	if (!id || !handler)
395 		return -EINVAL;
396 
397 	if (strncmp(id, ACPI_SIG_MADT, 4) == 0)
398 		acpi_get_table_with_size(id, acpi_apic_instance, &table, &tbl_size);
399 	else
400 		acpi_get_table_with_size(id, 0, &table, &tbl_size);
401 
402 	if (table) {
403 		handler(table);
404 		early_acpi_os_unmap_memory(table, tbl_size);
405 		return 0;
406 	} else
407 		return -ENODEV;
408 }
409 
410 /*
411  * The BIOS is supposed to supply a single APIC/MADT,
412  * but some report two.  Provide a knob to use either.
413  * (don't you wish instance 0 and 1 were not the same?)
414  */
415 static void __init check_multiple_madt(void)
416 {
417 	struct acpi_table_header *table = NULL;
418 	acpi_size tbl_size;
419 
420 	acpi_get_table_with_size(ACPI_SIG_MADT, 2, &table, &tbl_size);
421 	if (table) {
422 		pr_warn("BIOS bug: multiple APIC/MADT found, using %d\n",
423 			acpi_apic_instance);
424 		pr_warn("If \"acpi_apic_instance=%d\" works better, "
425 			"notify linux-acpi@vger.kernel.org\n",
426 			acpi_apic_instance ? 0 : 2);
427 		early_acpi_os_unmap_memory(table, tbl_size);
428 
429 	} else
430 		acpi_apic_instance = 0;
431 
432 	return;
433 }
434 
435 /*
436  * acpi_table_init()
437  *
438  * find RSDP, find and checksum SDT/XSDT.
439  * checksum all tables, print SDT/XSDT
440  *
441  * result: sdt_entry[] is initialized
442  */
443 
444 int __init acpi_table_init(void)
445 {
446 	acpi_status status;
447 
448 	if (acpi_verify_table_checksum) {
449 		pr_info("Early table checksum verification enabled\n");
450 		acpi_gbl_verify_table_checksum = TRUE;
451 	} else {
452 		pr_info("Early table checksum verification disabled\n");
453 		acpi_gbl_verify_table_checksum = FALSE;
454 	}
455 
456 	status = acpi_initialize_tables(initial_tables, ACPI_MAX_TABLES, 0);
457 	if (ACPI_FAILURE(status))
458 		return -EINVAL;
459 
460 	check_multiple_madt();
461 	return 0;
462 }
463 
464 static int __init acpi_parse_apic_instance(char *str)
465 {
466 	if (!str)
467 		return -EINVAL;
468 
469 	if (kstrtoint(str, 0, &acpi_apic_instance))
470 		return -EINVAL;
471 
472 	pr_notice("Shall use APIC/MADT table %d\n", acpi_apic_instance);
473 
474 	return 0;
475 }
476 
477 early_param("acpi_apic_instance", acpi_parse_apic_instance);
478 
479 static int __init acpi_force_table_verification_setup(char *s)
480 {
481 	acpi_verify_table_checksum = true;
482 
483 	return 0;
484 }
485 
486 early_param("acpi_force_table_verification", acpi_force_table_verification_setup);
487