xref: /linux/drivers/acpi/tables.c (revision 5e8c0fb6a95728b852d56c0a9244425d474670c0)
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  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  *
24  */
25 
26 #define pr_fmt(fmt) "ACPI: " fmt
27 
28 #include <linux/init.h>
29 #include <linux/kernel.h>
30 #include <linux/smp.h>
31 #include <linux/string.h>
32 #include <linux/types.h>
33 #include <linux/irq.h>
34 #include <linux/errno.h>
35 #include <linux/acpi.h>
36 #include <linux/bootmem.h>
37 
38 #define ACPI_MAX_TABLES		128
39 
40 static char *mps_inti_flags_polarity[] = { "dfl", "high", "res", "low" };
41 static char *mps_inti_flags_trigger[] = { "dfl", "edge", "res", "level" };
42 
43 static struct acpi_table_desc initial_tables[ACPI_MAX_TABLES] __initdata;
44 
45 static int acpi_apic_instance __initdata;
46 
47 /*
48  * Disable table checksum verification for the early stage due to the size
49  * limitation of the current x86 early mapping implementation.
50  */
51 static bool acpi_verify_table_checksum __initdata = false;
52 
53 void acpi_table_print_madt_entry(struct acpi_subtable_header *header)
54 {
55 	if (!header)
56 		return;
57 
58 	switch (header->type) {
59 
60 	case ACPI_MADT_TYPE_LOCAL_APIC:
61 		{
62 			struct acpi_madt_local_apic *p =
63 			    (struct acpi_madt_local_apic *)header;
64 			pr_info("LAPIC (acpi_id[0x%02x] lapic_id[0x%02x] %s)\n",
65 				p->processor_id, p->id,
66 				(p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
67 		}
68 		break;
69 
70 	case ACPI_MADT_TYPE_LOCAL_X2APIC:
71 		{
72 			struct acpi_madt_local_x2apic *p =
73 			    (struct acpi_madt_local_x2apic *)header;
74 			pr_info("X2APIC (apic_id[0x%02x] uid[0x%02x] %s)\n",
75 				p->local_apic_id, p->uid,
76 				(p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
77 		}
78 		break;
79 
80 	case ACPI_MADT_TYPE_IO_APIC:
81 		{
82 			struct acpi_madt_io_apic *p =
83 			    (struct acpi_madt_io_apic *)header;
84 			pr_info("IOAPIC (id[0x%02x] address[0x%08x] gsi_base[%d])\n",
85 				p->id, p->address, p->global_irq_base);
86 		}
87 		break;
88 
89 	case ACPI_MADT_TYPE_INTERRUPT_OVERRIDE:
90 		{
91 			struct acpi_madt_interrupt_override *p =
92 			    (struct acpi_madt_interrupt_override *)header;
93 			pr_info("INT_SRC_OVR (bus %d bus_irq %d global_irq %d %s %s)\n",
94 				p->bus, p->source_irq, p->global_irq,
95 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
96 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2]);
97 			if (p->inti_flags  &
98 			    ~(ACPI_MADT_POLARITY_MASK | ACPI_MADT_TRIGGER_MASK))
99 				pr_info("INT_SRC_OVR unexpected reserved flags: 0x%x\n",
100 					p->inti_flags  &
101 					~(ACPI_MADT_POLARITY_MASK | ACPI_MADT_TRIGGER_MASK));
102 		}
103 		break;
104 
105 	case ACPI_MADT_TYPE_NMI_SOURCE:
106 		{
107 			struct acpi_madt_nmi_source *p =
108 			    (struct acpi_madt_nmi_source *)header;
109 			pr_info("NMI_SRC (%s %s global_irq %d)\n",
110 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
111 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
112 				p->global_irq);
113 		}
114 		break;
115 
116 	case ACPI_MADT_TYPE_LOCAL_APIC_NMI:
117 		{
118 			struct acpi_madt_local_apic_nmi *p =
119 			    (struct acpi_madt_local_apic_nmi *)header;
120 			pr_info("LAPIC_NMI (acpi_id[0x%02x] %s %s lint[0x%x])\n",
121 				p->processor_id,
122 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK	],
123 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
124 				p->lint);
125 		}
126 		break;
127 
128 	case ACPI_MADT_TYPE_LOCAL_X2APIC_NMI:
129 		{
130 			u16 polarity, trigger;
131 			struct acpi_madt_local_x2apic_nmi *p =
132 			    (struct acpi_madt_local_x2apic_nmi *)header;
133 
134 			polarity = p->inti_flags & ACPI_MADT_POLARITY_MASK;
135 			trigger = (p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2;
136 
137 			pr_info("X2APIC_NMI (uid[0x%02x] %s %s lint[0x%x])\n",
138 				p->uid,
139 				mps_inti_flags_polarity[polarity],
140 				mps_inti_flags_trigger[trigger],
141 				p->lint);
142 		}
143 		break;
144 
145 	case ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE:
146 		{
147 			struct acpi_madt_local_apic_override *p =
148 			    (struct acpi_madt_local_apic_override *)header;
149 			pr_info("LAPIC_ADDR_OVR (address[%p])\n",
150 				(void *)(unsigned long)p->address);
151 		}
152 		break;
153 
154 	case ACPI_MADT_TYPE_IO_SAPIC:
155 		{
156 			struct acpi_madt_io_sapic *p =
157 			    (struct acpi_madt_io_sapic *)header;
158 			pr_info("IOSAPIC (id[0x%x] address[%p] gsi_base[%d])\n",
159 				p->id, (void *)(unsigned long)p->address,
160 				p->global_irq_base);
161 		}
162 		break;
163 
164 	case ACPI_MADT_TYPE_LOCAL_SAPIC:
165 		{
166 			struct acpi_madt_local_sapic *p =
167 			    (struct acpi_madt_local_sapic *)header;
168 			pr_info("LSAPIC (acpi_id[0x%02x] lsapic_id[0x%02x] lsapic_eid[0x%02x] %s)\n",
169 				p->processor_id, p->id, p->eid,
170 				(p->lapic_flags & ACPI_MADT_ENABLED) ? "enabled" : "disabled");
171 		}
172 		break;
173 
174 	case ACPI_MADT_TYPE_INTERRUPT_SOURCE:
175 		{
176 			struct acpi_madt_interrupt_source *p =
177 			    (struct acpi_madt_interrupt_source *)header;
178 			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",
179 				mps_inti_flags_polarity[p->inti_flags & ACPI_MADT_POLARITY_MASK],
180 				mps_inti_flags_trigger[(p->inti_flags & ACPI_MADT_TRIGGER_MASK) >> 2],
181 				p->type, p->id, p->eid, p->io_sapic_vector,
182 				p->global_irq);
183 		}
184 		break;
185 
186 	default:
187 		pr_warn("Found unsupported MADT entry (type = 0x%x)\n",
188 			header->type);
189 		break;
190 	}
191 }
192 
193 int __init
194 acpi_parse_entries(char *id, unsigned long table_size,
195 		acpi_tbl_entry_handler handler,
196 		struct acpi_table_header *table_header,
197 		int entry_id, unsigned int max_entries)
198 {
199 	struct acpi_subtable_header *entry;
200 	int count = 0;
201 	unsigned long table_end;
202 
203 	if (acpi_disabled)
204 		return -ENODEV;
205 
206 	if (!id || !handler)
207 		return -EINVAL;
208 
209 	if (!table_size)
210 		return -EINVAL;
211 
212 	if (!table_header) {
213 		pr_warn("%4.4s not present\n", id);
214 		return -ENODEV;
215 	}
216 
217 	table_end = (unsigned long)table_header + table_header->length;
218 
219 	/* Parse all entries looking for a match. */
220 
221 	entry = (struct acpi_subtable_header *)
222 	    ((unsigned long)table_header + table_size);
223 
224 	while (((unsigned long)entry) + sizeof(struct acpi_subtable_header) <
225 	       table_end) {
226 		if (entry->type == entry_id
227 		    && (!max_entries || count < max_entries)) {
228 			if (handler(entry, table_end))
229 				return -EINVAL;
230 
231 			count++;
232 		}
233 
234 		/*
235 		 * If entry->length is 0, break from this loop to avoid
236 		 * infinite loop.
237 		 */
238 		if (entry->length == 0) {
239 			pr_err("[%4.4s:0x%02x] Invalid zero length\n", id, entry_id);
240 			return -EINVAL;
241 		}
242 
243 		entry = (struct acpi_subtable_header *)
244 		    ((unsigned long)entry + entry->length);
245 	}
246 
247 	if (max_entries && count > max_entries) {
248 		pr_warn("[%4.4s:0x%02x] ignored %i entries of %i found\n",
249 			id, entry_id, count - max_entries, count);
250 	}
251 
252 	return count;
253 }
254 
255 int __init
256 acpi_table_parse_entries(char *id,
257 			 unsigned long table_size,
258 			 int entry_id,
259 			 acpi_tbl_entry_handler handler,
260 			 unsigned int max_entries)
261 {
262 	struct acpi_table_header *table_header = NULL;
263 	acpi_size tbl_size;
264 	int count;
265 	u32 instance = 0;
266 
267 	if (acpi_disabled)
268 		return -ENODEV;
269 
270 	if (!id || !handler)
271 		return -EINVAL;
272 
273 	if (!strncmp(id, ACPI_SIG_MADT, 4))
274 		instance = acpi_apic_instance;
275 
276 	acpi_get_table_with_size(id, instance, &table_header, &tbl_size);
277 	if (!table_header) {
278 		pr_warn("%4.4s not present\n", id);
279 		return -ENODEV;
280 	}
281 
282 	count = acpi_parse_entries(id, table_size, handler, table_header,
283 			entry_id, max_entries);
284 
285 	early_acpi_os_unmap_memory((char *)table_header, tbl_size);
286 	return count;
287 }
288 
289 int __init
290 acpi_table_parse_madt(enum acpi_madt_type id,
291 		      acpi_tbl_entry_handler handler, unsigned int max_entries)
292 {
293 	return acpi_table_parse_entries(ACPI_SIG_MADT,
294 					    sizeof(struct acpi_table_madt), id,
295 					    handler, max_entries);
296 }
297 
298 /**
299  * acpi_table_parse - find table with @id, run @handler on it
300  * @id: table id to find
301  * @handler: handler to run
302  *
303  * Scan the ACPI System Descriptor Table (STD) for a table matching @id,
304  * run @handler on it.
305  *
306  * Return 0 if table found, -errno if not.
307  */
308 int __init acpi_table_parse(char *id, acpi_tbl_table_handler handler)
309 {
310 	struct acpi_table_header *table = NULL;
311 	acpi_size tbl_size;
312 
313 	if (acpi_disabled)
314 		return -ENODEV;
315 
316 	if (!id || !handler)
317 		return -EINVAL;
318 
319 	if (strncmp(id, ACPI_SIG_MADT, 4) == 0)
320 		acpi_get_table_with_size(id, acpi_apic_instance, &table, &tbl_size);
321 	else
322 		acpi_get_table_with_size(id, 0, &table, &tbl_size);
323 
324 	if (table) {
325 		handler(table);
326 		early_acpi_os_unmap_memory(table, tbl_size);
327 		return 0;
328 	} else
329 		return -ENODEV;
330 }
331 
332 /*
333  * The BIOS is supposed to supply a single APIC/MADT,
334  * but some report two.  Provide a knob to use either.
335  * (don't you wish instance 0 and 1 were not the same?)
336  */
337 static void __init check_multiple_madt(void)
338 {
339 	struct acpi_table_header *table = NULL;
340 	acpi_size tbl_size;
341 
342 	acpi_get_table_with_size(ACPI_SIG_MADT, 2, &table, &tbl_size);
343 	if (table) {
344 		pr_warn("BIOS bug: multiple APIC/MADT found, using %d\n",
345 			acpi_apic_instance);
346 		pr_warn("If \"acpi_apic_instance=%d\" works better, "
347 			"notify linux-acpi@vger.kernel.org\n",
348 			acpi_apic_instance ? 0 : 2);
349 		early_acpi_os_unmap_memory(table, tbl_size);
350 
351 	} else
352 		acpi_apic_instance = 0;
353 
354 	return;
355 }
356 
357 /*
358  * acpi_table_init()
359  *
360  * find RSDP, find and checksum SDT/XSDT.
361  * checksum all tables, print SDT/XSDT
362  *
363  * result: sdt_entry[] is initialized
364  */
365 
366 int __init acpi_table_init(void)
367 {
368 	acpi_status status;
369 
370 	if (acpi_verify_table_checksum) {
371 		pr_info("Early table checksum verification enabled\n");
372 		acpi_gbl_verify_table_checksum = TRUE;
373 	} else {
374 		pr_info("Early table checksum verification disabled\n");
375 		acpi_gbl_verify_table_checksum = FALSE;
376 	}
377 
378 	status = acpi_initialize_tables(initial_tables, ACPI_MAX_TABLES, 0);
379 	if (ACPI_FAILURE(status))
380 		return -EINVAL;
381 
382 	check_multiple_madt();
383 	return 0;
384 }
385 
386 static int __init acpi_parse_apic_instance(char *str)
387 {
388 	if (!str)
389 		return -EINVAL;
390 
391 	if (kstrtoint(str, 0, &acpi_apic_instance))
392 		return -EINVAL;
393 
394 	pr_notice("Shall use APIC/MADT table %d\n", acpi_apic_instance);
395 
396 	return 0;
397 }
398 
399 early_param("acpi_apic_instance", acpi_parse_apic_instance);
400 
401 static int __init acpi_force_table_verification_setup(char *s)
402 {
403 	acpi_verify_table_checksum = true;
404 
405 	return 0;
406 }
407 
408 early_param("acpi_force_table_verification", acpi_force_table_verification_setup);
409