ACPI / tables: Add acpi_subtable_proc to ACPI table parsers
[firefly-linux-kernel-4.4.55.git] / drivers / acpi / tables.c
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->handler || proc[i].handler(entry, table_end))
272                                 return -EINVAL;
273
274                         proc->count++;
275                         break;
276                 }
277                 if (i != proc_num)
278                         count++;
279
280                 /*
281                  * If entry->length is 0, break from this loop to avoid
282                  * infinite loop.
283                  */
284                 if (entry->length == 0) {
285                         pr_err("[%4.4s:0x%02x] Invalid zero length\n", id, proc->id);
286                         return -EINVAL;
287                 }
288
289                 entry = (struct acpi_subtable_header *)
290                     ((unsigned long)entry + entry->length);
291         }
292
293         if (max_entries && count > max_entries) {
294                 pr_warn("[%4.4s:0x%02x] ignored %i entries of %i found\n",
295                         id, proc->id, count - max_entries, count);
296         }
297
298         return count;
299 }
300
301 int __init
302 acpi_parse_entries(char *id,
303                         unsigned long table_size,
304                         acpi_tbl_entry_handler handler,
305                         struct acpi_table_header *table_header,
306                         int entry_id, unsigned int max_entries)
307 {
308         struct acpi_subtable_proc proc = {
309                 .id             = entry_id,
310                 .handler        = handler,
311         };
312
313         return acpi_parse_entries_array(id, table_size, table_header,
314                         &proc, 1, max_entries);
315 }
316
317 int __init
318 acpi_table_parse_entries_array(char *id,
319                          unsigned long table_size,
320                          struct acpi_subtable_proc *proc, int proc_num,
321                          unsigned int max_entries)
322 {
323         struct acpi_table_header *table_header = NULL;
324         acpi_size tbl_size;
325         int count;
326         u32 instance = 0;
327
328         if (acpi_disabled)
329                 return -ENODEV;
330
331         if (!id)
332                 return -EINVAL;
333
334         if (!strncmp(id, ACPI_SIG_MADT, 4))
335                 instance = acpi_apic_instance;
336
337         acpi_get_table_with_size(id, instance, &table_header, &tbl_size);
338         if (!table_header) {
339                 pr_warn("%4.4s not present\n", id);
340                 return -ENODEV;
341         }
342
343         count = acpi_parse_entries_array(id, table_size, table_header,
344                         proc, proc_num, max_entries);
345
346         early_acpi_os_unmap_memory((char *)table_header, tbl_size);
347         return count;
348 }
349
350 int __init
351 acpi_table_parse_entries(char *id,
352                         unsigned long table_size,
353                         int entry_id,
354                         acpi_tbl_entry_handler handler,
355                         unsigned int max_entries)
356 {
357         struct acpi_subtable_proc proc = {
358                 .id             = entry_id,
359                 .handler        = handler,
360         };
361
362         return acpi_table_parse_entries_array(id, table_size, &proc, 1,
363                                                 max_entries);
364 }
365
366 int __init
367 acpi_table_parse_madt(enum acpi_madt_type id,
368                       acpi_tbl_entry_handler handler, unsigned int max_entries)
369 {
370         return acpi_table_parse_entries(ACPI_SIG_MADT,
371                                             sizeof(struct acpi_table_madt), id,
372                                             handler, max_entries);
373 }
374
375 /**
376  * acpi_table_parse - find table with @id, run @handler on it
377  * @id: table id to find
378  * @handler: handler to run
379  *
380  * Scan the ACPI System Descriptor Table (STD) for a table matching @id,
381  * run @handler on it.
382  *
383  * Return 0 if table found, -errno if not.
384  */
385 int __init acpi_table_parse(char *id, acpi_tbl_table_handler handler)
386 {
387         struct acpi_table_header *table = NULL;
388         acpi_size tbl_size;
389
390         if (acpi_disabled)
391                 return -ENODEV;
392
393         if (!id || !handler)
394                 return -EINVAL;
395
396         if (strncmp(id, ACPI_SIG_MADT, 4) == 0)
397                 acpi_get_table_with_size(id, acpi_apic_instance, &table, &tbl_size);
398         else
399                 acpi_get_table_with_size(id, 0, &table, &tbl_size);
400
401         if (table) {
402                 handler(table);
403                 early_acpi_os_unmap_memory(table, tbl_size);
404                 return 0;
405         } else
406                 return -ENODEV;
407 }
408
409 /* 
410  * The BIOS is supposed to supply a single APIC/MADT,
411  * but some report two.  Provide a knob to use either.
412  * (don't you wish instance 0 and 1 were not the same?)
413  */
414 static void __init check_multiple_madt(void)
415 {
416         struct acpi_table_header *table = NULL;
417         acpi_size tbl_size;
418
419         acpi_get_table_with_size(ACPI_SIG_MADT, 2, &table, &tbl_size);
420         if (table) {
421                 pr_warn("BIOS bug: multiple APIC/MADT found, using %d\n",
422                         acpi_apic_instance);
423                 pr_warn("If \"acpi_apic_instance=%d\" works better, "
424                         "notify linux-acpi@vger.kernel.org\n",
425                         acpi_apic_instance ? 0 : 2);
426                 early_acpi_os_unmap_memory(table, tbl_size);
427
428         } else
429                 acpi_apic_instance = 0;
430
431         return;
432 }
433
434 /*
435  * acpi_table_init()
436  *
437  * find RSDP, find and checksum SDT/XSDT.
438  * checksum all tables, print SDT/XSDT
439  *
440  * result: sdt_entry[] is initialized
441  */
442
443 int __init acpi_table_init(void)
444 {
445         acpi_status status;
446
447         if (acpi_verify_table_checksum) {
448                 pr_info("Early table checksum verification enabled\n");
449                 acpi_gbl_verify_table_checksum = TRUE;
450         } else {
451                 pr_info("Early table checksum verification disabled\n");
452                 acpi_gbl_verify_table_checksum = FALSE;
453         }
454
455         status = acpi_initialize_tables(initial_tables, ACPI_MAX_TABLES, 0);
456         if (ACPI_FAILURE(status))
457                 return -EINVAL;
458
459         check_multiple_madt();
460         return 0;
461 }
462
463 static int __init acpi_parse_apic_instance(char *str)
464 {
465         if (!str)
466                 return -EINVAL;
467
468         if (kstrtoint(str, 0, &acpi_apic_instance))
469                 return -EINVAL;
470
471         pr_notice("Shall use APIC/MADT table %d\n", acpi_apic_instance);
472
473         return 0;
474 }
475
476 early_param("acpi_apic_instance", acpi_parse_apic_instance);
477
478 static int __init acpi_force_table_verification_setup(char *s)
479 {
480         acpi_verify_table_checksum = true;
481
482         return 0;
483 }
484
485 early_param("acpi_force_table_verification", acpi_force_table_verification_setup);