GNU Linux-libre 4.19.264-gnu1
[releases.git] / arch / x86 / platform / efi / quirks.c
1 #define pr_fmt(fmt) "efi: " fmt
2
3 #include <linux/init.h>
4 #include <linux/kernel.h>
5 #include <linux/string.h>
6 #include <linux/time.h>
7 #include <linux/types.h>
8 #include <linux/efi.h>
9 #include <linux/slab.h>
10 #include <linux/memblock.h>
11 #include <linux/bootmem.h>
12 #include <linux/acpi.h>
13 #include <linux/dmi.h>
14
15 #include <asm/e820/api.h>
16 #include <asm/efi.h>
17 #include <asm/uv/uv.h>
18 #include <asm/cpu_device_id.h>
19
20 #define EFI_MIN_RESERVE 5120
21
22 #define EFI_DUMMY_GUID \
23         EFI_GUID(0x4424ac57, 0xbe4b, 0x47dd, 0x9e, 0x97, 0xed, 0x50, 0xf0, 0x9f, 0x92, 0xa9)
24
25 #define QUARK_CSH_SIGNATURE             0x5f435348      /* _CSH */
26 #define QUARK_SECURITY_HEADER_SIZE      0x400
27
28 /*
29  * Header prepended to the standard EFI capsule on Quark systems the are based
30  * on Intel firmware BSP.
31  * @csh_signature:      Unique identifier to sanity check signed module
32  *                      presence ("_CSH").
33  * @version:            Current version of CSH used. Should be one for Quark A0.
34  * @modulesize:         Size of the entire module including the module header
35  *                      and payload.
36  * @security_version_number_index: Index of SVN to use for validation of signed
37  *                      module.
38  * @security_version_number: Used to prevent against roll back of modules.
39  * @rsvd_module_id:     Currently unused for Clanton (Quark).
40  * @rsvd_module_vendor: Vendor Identifier. For Intel products value is
41  *                      0x00008086.
42  * @rsvd_date:          BCD representation of build date as yyyymmdd, where
43  *                      yyyy=4 digit year, mm=1-12, dd=1-31.
44  * @headersize:         Total length of the header including including any
45  *                      padding optionally added by the signing tool.
46  * @hash_algo:          What Hash is used in the module signing.
47  * @cryp_algo:          What Crypto is used in the module signing.
48  * @keysize:            Total length of the key data including including any
49  *                      padding optionally added by the signing tool.
50  * @signaturesize:      Total length of the signature including including any
51  *                      padding optionally added by the signing tool.
52  * @rsvd_next_header:   32-bit pointer to the next Secure Boot Module in the
53  *                      chain, if there is a next header.
54  * @rsvd:               Reserved, padding structure to required size.
55  *
56  * See also QuartSecurityHeader_t in
57  * Quark_EDKII_v1.2.1.1/QuarkPlatformPkg/Include/QuarkBootRom.h
58  * from https://downloadcenter.intel.com/download/23197/Intel-Quark-SoC-X1000-Board-Support-Package-BSP
59  */
60 struct quark_security_header {
61         u32 csh_signature;
62         u32 version;
63         u32 modulesize;
64         u32 security_version_number_index;
65         u32 security_version_number;
66         u32 rsvd_module_id;
67         u32 rsvd_module_vendor;
68         u32 rsvd_date;
69         u32 headersize;
70         u32 hash_algo;
71         u32 cryp_algo;
72         u32 keysize;
73         u32 signaturesize;
74         u32 rsvd_next_header;
75         u32 rsvd[2];
76 };
77
78 static const efi_char16_t efi_dummy_name[] = L"DUMMY";
79
80 static bool efi_no_storage_paranoia;
81
82 /*
83  * Some firmware implementations refuse to boot if there's insufficient
84  * space in the variable store. The implementation of garbage collection
85  * in some FW versions causes stale (deleted) variables to take up space
86  * longer than intended and space is only freed once the store becomes
87  * almost completely full.
88  *
89  * Enabling this option disables the space checks in
90  * efi_query_variable_store() and forces garbage collection.
91  *
92  * Only enable this option if deleting EFI variables does not free up
93  * space in your variable store, e.g. if despite deleting variables
94  * you're unable to create new ones.
95  */
96 static int __init setup_storage_paranoia(char *arg)
97 {
98         efi_no_storage_paranoia = true;
99         return 0;
100 }
101 early_param("efi_no_storage_paranoia", setup_storage_paranoia);
102
103 /*
104  * Deleting the dummy variable which kicks off garbage collection
105 */
106 void efi_delete_dummy_variable(void)
107 {
108         efi.set_variable_nonblocking((efi_char16_t *)efi_dummy_name,
109                                      &EFI_DUMMY_GUID,
110                                      EFI_VARIABLE_NON_VOLATILE |
111                                      EFI_VARIABLE_BOOTSERVICE_ACCESS |
112                                      EFI_VARIABLE_RUNTIME_ACCESS, 0, NULL);
113 }
114
115 /*
116  * In the nonblocking case we do not attempt to perform garbage
117  * collection if we do not have enough free space. Rather, we do the
118  * bare minimum check and give up immediately if the available space
119  * is below EFI_MIN_RESERVE.
120  *
121  * This function is intended to be small and simple because it is
122  * invoked from crash handler paths.
123  */
124 static efi_status_t
125 query_variable_store_nonblocking(u32 attributes, unsigned long size)
126 {
127         efi_status_t status;
128         u64 storage_size, remaining_size, max_size;
129
130         status = efi.query_variable_info_nonblocking(attributes, &storage_size,
131                                                      &remaining_size,
132                                                      &max_size);
133         if (status != EFI_SUCCESS)
134                 return status;
135
136         if (remaining_size - size < EFI_MIN_RESERVE)
137                 return EFI_OUT_OF_RESOURCES;
138
139         return EFI_SUCCESS;
140 }
141
142 /*
143  * Some firmware implementations refuse to boot if there's insufficient space
144  * in the variable store. Ensure that we never use more than a safe limit.
145  *
146  * Return EFI_SUCCESS if it is safe to write 'size' bytes to the variable
147  * store.
148  */
149 efi_status_t efi_query_variable_store(u32 attributes, unsigned long size,
150                                       bool nonblocking)
151 {
152         efi_status_t status;
153         u64 storage_size, remaining_size, max_size;
154
155         if (!(attributes & EFI_VARIABLE_NON_VOLATILE))
156                 return 0;
157
158         if (nonblocking)
159                 return query_variable_store_nonblocking(attributes, size);
160
161         status = efi.query_variable_info(attributes, &storage_size,
162                                          &remaining_size, &max_size);
163         if (status != EFI_SUCCESS)
164                 return status;
165
166         /*
167          * We account for that by refusing the write if permitting it would
168          * reduce the available space to under 5KB. This figure was provided by
169          * Samsung, so should be safe.
170          */
171         if ((remaining_size - size < EFI_MIN_RESERVE) &&
172                 !efi_no_storage_paranoia) {
173
174                 /*
175                  * Triggering garbage collection may require that the firmware
176                  * generate a real EFI_OUT_OF_RESOURCES error. We can force
177                  * that by attempting to use more space than is available.
178                  */
179                 unsigned long dummy_size = remaining_size + 1024;
180                 void *dummy = kzalloc(dummy_size, GFP_KERNEL);
181
182                 if (!dummy)
183                         return EFI_OUT_OF_RESOURCES;
184
185                 status = efi.set_variable((efi_char16_t *)efi_dummy_name,
186                                           &EFI_DUMMY_GUID,
187                                           EFI_VARIABLE_NON_VOLATILE |
188                                           EFI_VARIABLE_BOOTSERVICE_ACCESS |
189                                           EFI_VARIABLE_RUNTIME_ACCESS,
190                                           dummy_size, dummy);
191
192                 if (status == EFI_SUCCESS) {
193                         /*
194                          * This should have failed, so if it didn't make sure
195                          * that we delete it...
196                          */
197                         efi_delete_dummy_variable();
198                 }
199
200                 kfree(dummy);
201
202                 /*
203                  * The runtime code may now have triggered a garbage collection
204                  * run, so check the variable info again
205                  */
206                 status = efi.query_variable_info(attributes, &storage_size,
207                                                  &remaining_size, &max_size);
208
209                 if (status != EFI_SUCCESS)
210                         return status;
211
212                 /*
213                  * There still isn't enough room, so return an error
214                  */
215                 if (remaining_size - size < EFI_MIN_RESERVE)
216                         return EFI_OUT_OF_RESOURCES;
217         }
218
219         return EFI_SUCCESS;
220 }
221 EXPORT_SYMBOL_GPL(efi_query_variable_store);
222
223 /*
224  * The UEFI specification makes it clear that the operating system is
225  * free to do whatever it wants with boot services code after
226  * ExitBootServices() has been called. Ignoring this recommendation a
227  * significant bunch of EFI implementations continue calling into boot
228  * services code (SetVirtualAddressMap). In order to work around such
229  * buggy implementations we reserve boot services region during EFI
230  * init and make sure it stays executable. Then, after
231  * SetVirtualAddressMap(), it is discarded.
232  *
233  * However, some boot services regions contain data that is required
234  * by drivers, so we need to track which memory ranges can never be
235  * freed. This is done by tagging those regions with the
236  * EFI_MEMORY_RUNTIME attribute.
237  *
238  * Any driver that wants to mark a region as reserved must use
239  * efi_mem_reserve() which will insert a new EFI memory descriptor
240  * into efi.memmap (splitting existing regions if necessary) and tag
241  * it with EFI_MEMORY_RUNTIME.
242  */
243 void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size)
244 {
245         phys_addr_t new_phys, new_size;
246         struct efi_mem_range mr;
247         efi_memory_desc_t md;
248         int num_entries;
249         void *new;
250
251         if (efi_mem_desc_lookup(addr, &md) ||
252             md.type != EFI_BOOT_SERVICES_DATA) {
253                 pr_err("Failed to lookup EFI memory descriptor for %pa\n", &addr);
254                 return;
255         }
256
257         if (addr + size > md.phys_addr + (md.num_pages << EFI_PAGE_SHIFT)) {
258                 pr_err("Region spans EFI memory descriptors, %pa\n", &addr);
259                 return;
260         }
261
262         size += addr % EFI_PAGE_SIZE;
263         size = round_up(size, EFI_PAGE_SIZE);
264         addr = round_down(addr, EFI_PAGE_SIZE);
265
266         mr.range.start = addr;
267         mr.range.end = addr + size - 1;
268         mr.attribute = md.attribute | EFI_MEMORY_RUNTIME;
269
270         num_entries = efi_memmap_split_count(&md, &mr.range);
271         num_entries += efi.memmap.nr_map;
272
273         new_size = efi.memmap.desc_size * num_entries;
274
275         new_phys = efi_memmap_alloc(num_entries);
276         if (!new_phys) {
277                 pr_err("Could not allocate boot services memmap\n");
278                 return;
279         }
280
281         new = early_memremap_prot(new_phys, new_size,
282                                   pgprot_val(pgprot_encrypted(FIXMAP_PAGE_NORMAL)));
283         if (!new) {
284                 pr_err("Failed to map new boot services memmap\n");
285                 return;
286         }
287
288         efi_memmap_insert(&efi.memmap, new, &mr);
289         early_memunmap(new, new_size);
290
291         efi_memmap_install(new_phys, num_entries);
292         e820__range_update(addr, size, E820_TYPE_RAM, E820_TYPE_RESERVED);
293         e820__update_table(e820_table);
294 }
295
296 /*
297  * Helper function for efi_reserve_boot_services() to figure out if we
298  * can free regions in efi_free_boot_services().
299  *
300  * Use this function to ensure we do not free regions owned by somebody
301  * else. We must only reserve (and then free) regions:
302  *
303  * - Not within any part of the kernel
304  * - Not the BIOS reserved area (E820_TYPE_RESERVED, E820_TYPE_NVS, etc)
305  */
306 static bool can_free_region(u64 start, u64 size)
307 {
308         if (start + size > __pa_symbol(_text) && start <= __pa_symbol(_end))
309                 return false;
310
311         if (!e820__mapped_all(start, start+size, E820_TYPE_RAM))
312                 return false;
313
314         return true;
315 }
316
317 void __init efi_reserve_boot_services(void)
318 {
319         efi_memory_desc_t *md;
320
321         for_each_efi_memory_desc(md) {
322                 u64 start = md->phys_addr;
323                 u64 size = md->num_pages << EFI_PAGE_SHIFT;
324                 bool already_reserved;
325
326                 if (md->type != EFI_BOOT_SERVICES_CODE &&
327                     md->type != EFI_BOOT_SERVICES_DATA)
328                         continue;
329
330                 already_reserved = memblock_is_region_reserved(start, size);
331
332                 /*
333                  * Because the following memblock_reserve() is paired
334                  * with free_bootmem_late() for this region in
335                  * efi_free_boot_services(), we must be extremely
336                  * careful not to reserve, and subsequently free,
337                  * critical regions of memory (like the kernel image) or
338                  * those regions that somebody else has already
339                  * reserved.
340                  *
341                  * A good example of a critical region that must not be
342                  * freed is page zero (first 4Kb of memory), which may
343                  * contain boot services code/data but is marked
344                  * E820_TYPE_RESERVED by trim_bios_range().
345                  */
346                 if (!already_reserved) {
347                         memblock_reserve(start, size);
348
349                         /*
350                          * If we are the first to reserve the region, no
351                          * one else cares about it. We own it and can
352                          * free it later.
353                          */
354                         if (can_free_region(start, size))
355                                 continue;
356                 }
357
358                 /*
359                  * We don't own the region. We must not free it.
360                  *
361                  * Setting this bit for a boot services region really
362                  * doesn't make sense as far as the firmware is
363                  * concerned, but it does provide us with a way to tag
364                  * those regions that must not be paired with
365                  * free_bootmem_late().
366                  */
367                 md->attribute |= EFI_MEMORY_RUNTIME;
368         }
369 }
370
371 void __init efi_free_boot_services(void)
372 {
373         phys_addr_t new_phys, new_size;
374         efi_memory_desc_t *md;
375         int num_entries = 0;
376         void *new, *new_md;
377
378         for_each_efi_memory_desc(md) {
379                 unsigned long long start = md->phys_addr;
380                 unsigned long long size = md->num_pages << EFI_PAGE_SHIFT;
381                 size_t rm_size;
382
383                 if (md->type != EFI_BOOT_SERVICES_CODE &&
384                     md->type != EFI_BOOT_SERVICES_DATA) {
385                         num_entries++;
386                         continue;
387                 }
388
389                 /* Do not free, someone else owns it: */
390                 if (md->attribute & EFI_MEMORY_RUNTIME) {
391                         num_entries++;
392                         continue;
393                 }
394
395                 /*
396                  * Nasty quirk: if all sub-1MB memory is used for boot
397                  * services, we can get here without having allocated the
398                  * real mode trampoline.  It's too late to hand boot services
399                  * memory back to the memblock allocator, so instead
400                  * try to manually allocate the trampoline if needed.
401                  *
402                  * I've seen this on a Dell XPS 13 9350 with firmware
403                  * 1.4.4 with SGX enabled booting Linux via Fedora 24's
404                  * grub2-efi on a hard disk.  (And no, I don't know why
405                  * this happened, but Linux should still try to boot rather
406                  * panicing early.)
407                  */
408                 rm_size = real_mode_size_needed();
409                 if (rm_size && (start + rm_size) < (1<<20) && size >= rm_size) {
410                         set_real_mode_mem(start, rm_size);
411                         start += rm_size;
412                         size -= rm_size;
413                 }
414
415                 free_bootmem_late(start, size);
416         }
417
418         if (!num_entries)
419                 return;
420
421         new_size = efi.memmap.desc_size * num_entries;
422         new_phys = efi_memmap_alloc(num_entries);
423         if (!new_phys) {
424                 pr_err("Failed to allocate new EFI memmap\n");
425                 return;
426         }
427
428         new = memremap(new_phys, new_size, MEMREMAP_WB);
429         if (!new) {
430                 pr_err("Failed to map new EFI memmap\n");
431                 return;
432         }
433
434         /*
435          * Build a new EFI memmap that excludes any boot services
436          * regions that are not tagged EFI_MEMORY_RUNTIME, since those
437          * regions have now been freed.
438          */
439         new_md = new;
440         for_each_efi_memory_desc(md) {
441                 if (!(md->attribute & EFI_MEMORY_RUNTIME) &&
442                     (md->type == EFI_BOOT_SERVICES_CODE ||
443                      md->type == EFI_BOOT_SERVICES_DATA))
444                         continue;
445
446                 memcpy(new_md, md, efi.memmap.desc_size);
447                 new_md += efi.memmap.desc_size;
448         }
449
450         memunmap(new);
451
452         if (efi_memmap_install(new_phys, num_entries)) {
453                 pr_err("Could not install new EFI memmap\n");
454                 return;
455         }
456 }
457
458 /*
459  * A number of config table entries get remapped to virtual addresses
460  * after entering EFI virtual mode. However, the kexec kernel requires
461  * their physical addresses therefore we pass them via setup_data and
462  * correct those entries to their respective physical addresses here.
463  *
464  * Currently only handles smbios which is necessary for some firmware
465  * implementation.
466  */
467 int __init efi_reuse_config(u64 tables, int nr_tables)
468 {
469         int i, sz, ret = 0;
470         void *p, *tablep;
471         struct efi_setup_data *data;
472
473         if (!efi_setup)
474                 return 0;
475
476         if (!efi_enabled(EFI_64BIT))
477                 return 0;
478
479         data = early_memremap(efi_setup, sizeof(*data));
480         if (!data) {
481                 ret = -ENOMEM;
482                 goto out;
483         }
484
485         if (!data->smbios)
486                 goto out_memremap;
487
488         sz = sizeof(efi_config_table_64_t);
489
490         p = tablep = early_memremap(tables, nr_tables * sz);
491         if (!p) {
492                 pr_err("Could not map Configuration table!\n");
493                 ret = -ENOMEM;
494                 goto out_memremap;
495         }
496
497         for (i = 0; i < efi.systab->nr_tables; i++) {
498                 efi_guid_t guid;
499
500                 guid = ((efi_config_table_64_t *)p)->guid;
501
502                 if (!efi_guidcmp(guid, SMBIOS_TABLE_GUID))
503                         ((efi_config_table_64_t *)p)->table = data->smbios;
504                 p += sz;
505         }
506         early_memunmap(tablep, nr_tables * sz);
507
508 out_memremap:
509         early_memunmap(data, sizeof(*data));
510 out:
511         return ret;
512 }
513
514 static const struct dmi_system_id sgi_uv1_dmi[] = {
515         { NULL, "SGI UV1",
516                 {       DMI_MATCH(DMI_PRODUCT_NAME,     "Stoutland Platform"),
517                         DMI_MATCH(DMI_PRODUCT_VERSION,  "1.0"),
518                         DMI_MATCH(DMI_BIOS_VENDOR,      "SGI.COM"),
519                 }
520         },
521         { } /* NULL entry stops DMI scanning */
522 };
523
524 void __init efi_apply_memmap_quirks(void)
525 {
526         /*
527          * Once setup is done earlier, unmap the EFI memory map on mismatched
528          * firmware/kernel architectures since there is no support for runtime
529          * services.
530          */
531         if (!efi_runtime_supported()) {
532                 pr_info("Setup done, disabling due to 32/64-bit mismatch\n");
533                 efi_memmap_unmap();
534         }
535
536         /* UV2+ BIOS has a fix for this issue.  UV1 still needs the quirk. */
537         if (dmi_check_system(sgi_uv1_dmi))
538                 set_bit(EFI_OLD_MEMMAP, &efi.flags);
539 }
540
541 /*
542  * For most modern platforms the preferred method of powering off is via
543  * ACPI. However, there are some that are known to require the use of
544  * EFI runtime services and for which ACPI does not work at all.
545  *
546  * Using EFI is a last resort, to be used only if no other option
547  * exists.
548  */
549 bool efi_reboot_required(void)
550 {
551         if (!acpi_gbl_reduced_hardware)
552                 return false;
553
554         efi_reboot_quirk_mode = EFI_RESET_WARM;
555         return true;
556 }
557
558 bool efi_poweroff_required(void)
559 {
560         return acpi_gbl_reduced_hardware || acpi_no_s5;
561 }
562
563 #ifdef CONFIG_EFI_CAPSULE_QUIRK_QUARK_CSH
564
565 static int qrk_capsule_setup_info(struct capsule_info *cap_info, void **pkbuff,
566                                   size_t hdr_bytes)
567 {
568         struct quark_security_header *csh = *pkbuff;
569
570         /* Only process data block that is larger than the security header */
571         if (hdr_bytes < sizeof(struct quark_security_header))
572                 return 0;
573
574         if (csh->csh_signature != QUARK_CSH_SIGNATURE ||
575             csh->headersize != QUARK_SECURITY_HEADER_SIZE)
576                 return 1;
577
578         /* Only process data block if EFI header is included */
579         if (hdr_bytes < QUARK_SECURITY_HEADER_SIZE +
580                         sizeof(efi_capsule_header_t))
581                 return 0;
582
583         pr_debug("Quark security header detected\n");
584
585         if (csh->rsvd_next_header != 0) {
586                 pr_err("multiple Quark security headers not supported\n");
587                 return -EINVAL;
588         }
589
590         *pkbuff += csh->headersize;
591         cap_info->total_size = csh->headersize;
592
593         /*
594          * Update the first page pointer to skip over the CSH header.
595          */
596         cap_info->phys[0] += csh->headersize;
597
598         /*
599          * cap_info->capsule should point at a virtual mapping of the entire
600          * capsule, starting at the capsule header. Our image has the Quark
601          * security header prepended, so we cannot rely on the default vmap()
602          * mapping created by the generic capsule code.
603          * Given that the Quark firmware does not appear to care about the
604          * virtual mapping, let's just point cap_info->capsule at our copy
605          * of the capsule header.
606          */
607         cap_info->capsule = &cap_info->header;
608
609         return 1;
610 }
611
612 #define ICPU(family, model, quirk_handler) \
613         { X86_VENDOR_INTEL, family, model, X86_FEATURE_ANY, \
614           (unsigned long)&quirk_handler }
615
616 static const struct x86_cpu_id efi_capsule_quirk_ids[] = {
617         ICPU(5, 9, qrk_capsule_setup_info),     /* Intel Quark X1000 */
618         { }
619 };
620
621 int efi_capsule_setup_info(struct capsule_info *cap_info, void *kbuff,
622                            size_t hdr_bytes)
623 {
624         int (*quirk_handler)(struct capsule_info *, void **, size_t);
625         const struct x86_cpu_id *id;
626         int ret;
627
628         if (hdr_bytes < sizeof(efi_capsule_header_t))
629                 return 0;
630
631         cap_info->total_size = 0;
632
633         id = x86_match_cpu(efi_capsule_quirk_ids);
634         if (id) {
635                 /*
636                  * The quirk handler is supposed to return
637                  *  - a value > 0 if the setup should continue, after advancing
638                  *    kbuff as needed
639                  *  - 0 if not enough hdr_bytes are available yet
640                  *  - a negative error code otherwise
641                  */
642                 quirk_handler = (typeof(quirk_handler))id->driver_data;
643                 ret = quirk_handler(cap_info, &kbuff, hdr_bytes);
644                 if (ret <= 0)
645                         return ret;
646         }
647
648         memcpy(&cap_info->header, kbuff, sizeof(cap_info->header));
649
650         cap_info->total_size += cap_info->header.imagesize;
651
652         return __efi_capsule_setup_info(cap_info);
653 }
654
655 #endif