Skip to content

Commit 4445eb6

Browse files
committed
Merge tag 'stable-shared-branch-for-driver-tree' of git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi into driver-core-next
Ard writes: Stable shared branch between EFI and driver tree Stable shared branch to ease the integration of Hans's series to support device firmware loaded from EFI boot service memory regions. [PATCH v12 00/10] efi/firmware/platform-x86: Add EFI embedded fw support https://lore.kernel.org/linux-efi/[email protected]/ * tag 'stable-shared-branch-for-driver-tree' of git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi: efi: Add embedded peripheral firmware support efi: Export boot-services code and data as debugfs-blobs
2 parents 99917e3 + f0df68d commit 4445eb6

File tree

8 files changed

+264
-0
lines changed

8 files changed

+264
-0
lines changed

arch/x86/platform/efi/efi.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ int __init efi_memblock_x86_reserve_range(void)
243243
efi.memmap.desc_version);
244244

245245
memblock_reserve(pmap, efi.memmap.nr_map * efi.memmap.desc_size);
246+
set_bit(EFI_PRESERVE_BS_REGIONS, &efi.flags);
246247

247248
return 0;
248249
}
@@ -943,6 +944,7 @@ static void __init __efi_enter_virtual_mode(void)
943944
goto err;
944945
}
945946

947+
efi_check_for_embedded_firmwares();
946948
efi_free_boot_services();
947949

948950
/*

arch/x86/platform/efi/quirks.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,10 @@ void __init efi_free_boot_services(void)
410410
int num_entries = 0;
411411
void *new, *new_md;
412412

413+
/* Keep all regions for /sys/kernel/debug/efi */
414+
if (efi_enabled(EFI_DBG))
415+
return;
416+
413417
for_each_efi_memory_desc(md) {
414418
unsigned long long start = md->phys_addr;
415419
unsigned long long size = md->num_pages << EFI_PAGE_SHIFT;

drivers/firmware/efi/Kconfig

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,11 @@ config EFI_DISABLE_PCI_DMA
239239

240240
endmenu
241241

242+
config EFI_EMBEDDED_FIRMWARE
243+
bool
244+
depends on EFI
245+
select CRYPTO_LIB_SHA256
246+
242247
config UEFI_CPER
243248
bool
244249

drivers/firmware/efi/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ obj-$(CONFIG_EFI_TEST) += test/
2626
obj-$(CONFIG_EFI_DEV_PATH_PARSER) += dev-path-parser.o
2727
obj-$(CONFIG_APPLE_PROPERTIES) += apple-properties.o
2828
obj-$(CONFIG_EFI_RCI2_TABLE) += rci2-table.o
29+
obj-$(CONFIG_EFI_EMBEDDED_FIRMWARE) += embedded-firmware.o
2930

3031
fake_map-y += fake_mem.o
3132
fake_map-$(CONFIG_X86) += x86_fake_mem.o

drivers/firmware/efi/efi.c

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
#include <linux/kobject.h>
1818
#include <linux/module.h>
1919
#include <linux/init.h>
20+
#include <linux/debugfs.h>
2021
#include <linux/device.h>
2122
#include <linux/efi.h>
2223
#include <linux/of.h>
@@ -325,6 +326,59 @@ static __init int efivar_ssdt_load(void)
325326
static inline int efivar_ssdt_load(void) { return 0; }
326327
#endif
327328

329+
#ifdef CONFIG_DEBUG_FS
330+
331+
#define EFI_DEBUGFS_MAX_BLOBS 32
332+
333+
static struct debugfs_blob_wrapper debugfs_blob[EFI_DEBUGFS_MAX_BLOBS];
334+
335+
static void __init efi_debugfs_init(void)
336+
{
337+
struct dentry *efi_debugfs;
338+
efi_memory_desc_t *md;
339+
char name[32];
340+
int type_count[EFI_BOOT_SERVICES_DATA + 1] = {};
341+
int i = 0;
342+
343+
efi_debugfs = debugfs_create_dir("efi", NULL);
344+
if (IS_ERR_OR_NULL(efi_debugfs))
345+
return;
346+
347+
for_each_efi_memory_desc(md) {
348+
switch (md->type) {
349+
case EFI_BOOT_SERVICES_CODE:
350+
snprintf(name, sizeof(name), "boot_services_code%d",
351+
type_count[md->type]++);
352+
break;
353+
case EFI_BOOT_SERVICES_DATA:
354+
snprintf(name, sizeof(name), "boot_services_data%d",
355+
type_count[md->type]++);
356+
break;
357+
default:
358+
continue;
359+
}
360+
361+
if (i >= EFI_DEBUGFS_MAX_BLOBS) {
362+
pr_warn("More then %d EFI boot service segments, only showing first %d in debugfs\n",
363+
EFI_DEBUGFS_MAX_BLOBS, EFI_DEBUGFS_MAX_BLOBS);
364+
break;
365+
}
366+
367+
debugfs_blob[i].size = md->num_pages << EFI_PAGE_SHIFT;
368+
debugfs_blob[i].data = memremap(md->phys_addr,
369+
debugfs_blob[i].size,
370+
MEMREMAP_WB);
371+
if (!debugfs_blob[i].data)
372+
continue;
373+
374+
debugfs_create_blob(name, 0400, efi_debugfs, &debugfs_blob[i]);
375+
i++;
376+
}
377+
}
378+
#else
379+
static inline void efi_debugfs_init(void) {}
380+
#endif
381+
328382
/*
329383
* We register the efi subsystem with the firmware subsystem and the
330384
* efivars subsystem with the efi subsystem, if the system was booted with
@@ -381,6 +435,9 @@ static int __init efisubsys_init(void)
381435
goto err_remove_group;
382436
}
383437

438+
if (efi_enabled(EFI_DBG) && efi_enabled(EFI_PRESERVE_BS_REGIONS))
439+
efi_debugfs_init();
440+
384441
return 0;
385442

386443
err_remove_group:
Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/*
3+
* Support for extracting embedded firmware for peripherals from EFI code,
4+
*
5+
* Copyright (c) 2018 Hans de Goede <[email protected]>
6+
*/
7+
8+
#include <linux/dmi.h>
9+
#include <linux/efi.h>
10+
#include <linux/efi_embedded_fw.h>
11+
#include <linux/io.h>
12+
#include <linux/slab.h>
13+
#include <linux/types.h>
14+
#include <linux/vmalloc.h>
15+
#include <crypto/sha.h>
16+
17+
/* Exported for use by lib/test_firmware.c only */
18+
LIST_HEAD(efi_embedded_fw_list);
19+
EXPORT_SYMBOL_GPL(efi_embedded_fw_list);
20+
21+
static bool checked_for_fw;
22+
23+
static const struct dmi_system_id * const embedded_fw_table[] = {
24+
NULL
25+
};
26+
27+
/*
28+
* Note the efi_check_for_embedded_firmwares() code currently makes the
29+
* following 2 assumptions. This may needs to be revisited if embedded firmware
30+
* is found where this is not true:
31+
* 1) The firmware is only found in EFI_BOOT_SERVICES_CODE memory segments
32+
* 2) The firmware always starts at an offset which is a multiple of 8 bytes
33+
*/
34+
static int __init efi_check_md_for_embedded_firmware(
35+
efi_memory_desc_t *md, const struct efi_embedded_fw_desc *desc)
36+
{
37+
struct sha256_state sctx;
38+
struct efi_embedded_fw *fw;
39+
u8 sha256[32];
40+
u64 i, size;
41+
u8 *map;
42+
43+
size = md->num_pages << EFI_PAGE_SHIFT;
44+
map = memremap(md->phys_addr, size, MEMREMAP_WB);
45+
if (!map) {
46+
pr_err("Error mapping EFI mem at %#llx\n", md->phys_addr);
47+
return -ENOMEM;
48+
}
49+
50+
for (i = 0; (i + desc->length) <= size; i += 8) {
51+
if (memcmp(map + i, desc->prefix, EFI_EMBEDDED_FW_PREFIX_LEN))
52+
continue;
53+
54+
sha256_init(&sctx);
55+
sha256_update(&sctx, map + i, desc->length);
56+
sha256_final(&sctx, sha256);
57+
if (memcmp(sha256, desc->sha256, 32) == 0)
58+
break;
59+
}
60+
if ((i + desc->length) > size) {
61+
memunmap(map);
62+
return -ENOENT;
63+
}
64+
65+
pr_info("Found EFI embedded fw '%s'\n", desc->name);
66+
67+
fw = kmalloc(sizeof(*fw), GFP_KERNEL);
68+
if (!fw) {
69+
memunmap(map);
70+
return -ENOMEM;
71+
}
72+
73+
fw->data = kmemdup(map + i, desc->length, GFP_KERNEL);
74+
memunmap(map);
75+
if (!fw->data) {
76+
kfree(fw);
77+
return -ENOMEM;
78+
}
79+
80+
fw->name = desc->name;
81+
fw->length = desc->length;
82+
list_add(&fw->list, &efi_embedded_fw_list);
83+
84+
return 0;
85+
}
86+
87+
void __init efi_check_for_embedded_firmwares(void)
88+
{
89+
const struct efi_embedded_fw_desc *fw_desc;
90+
const struct dmi_system_id *dmi_id;
91+
efi_memory_desc_t *md;
92+
int i, r;
93+
94+
for (i = 0; embedded_fw_table[i]; i++) {
95+
dmi_id = dmi_first_match(embedded_fw_table[i]);
96+
if (!dmi_id)
97+
continue;
98+
99+
fw_desc = dmi_id->driver_data;
100+
101+
/*
102+
* In some drivers the struct driver_data contains may contain
103+
* other driver specific data after the fw_desc struct; and
104+
* the fw_desc struct itself may be empty, skip these.
105+
*/
106+
if (!fw_desc->name)
107+
continue;
108+
109+
for_each_efi_memory_desc(md) {
110+
if (md->type != EFI_BOOT_SERVICES_CODE)
111+
continue;
112+
113+
r = efi_check_md_for_embedded_firmware(md, fw_desc);
114+
if (r == 0)
115+
break;
116+
}
117+
}
118+
119+
checked_for_fw = true;
120+
}
121+
122+
int efi_get_embedded_fw(const char *name, const u8 **data, size_t *size)
123+
{
124+
struct efi_embedded_fw *iter, *fw = NULL;
125+
126+
if (!checked_for_fw) {
127+
pr_warn("Warning %s called while we did not check for embedded fw\n",
128+
__func__);
129+
return -ENOENT;
130+
}
131+
132+
list_for_each_entry(iter, &efi_embedded_fw_list, list) {
133+
if (strcmp(name, iter->name) == 0) {
134+
fw = iter;
135+
break;
136+
}
137+
}
138+
139+
if (!fw)
140+
return -ENOENT;
141+
142+
*data = fw->data;
143+
*size = fw->length;
144+
145+
return 0;
146+
}
147+
EXPORT_SYMBOL_GPL(efi_get_embedded_fw);

include/linux/efi.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1124,6 +1124,7 @@ extern int __init efi_setup_pcdp_console(char *);
11241124
#define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */
11251125
#define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
11261126
#define EFI_MEM_NO_SOFT_RESERVE 11 /* Is the kernel configured to ignore soft reservations? */
1127+
#define EFI_PRESERVE_BS_REGIONS 12 /* Are EFI boot-services memory segments available? */
11271128

11281129
#ifdef CONFIG_EFI
11291130
/*
@@ -1553,6 +1554,12 @@ static inline void
15531554
efi_enable_reset_attack_mitigation(void) { }
15541555
#endif
15551556

1557+
#ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1558+
void efi_check_for_embedded_firmwares(void);
1559+
#else
1560+
static inline void efi_check_for_embedded_firmwares(void) { }
1561+
#endif
1562+
15561563
efi_status_t efi_random_get_seed(void);
15571564

15581565
void efi_retrieve_tpm2_eventlog(void);

include/linux/efi_embedded_fw.h

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/* SPDX-License-Identifier: GPL-2.0 */
2+
#ifndef _LINUX_EFI_EMBEDDED_FW_H
3+
#define _LINUX_EFI_EMBEDDED_FW_H
4+
5+
#include <linux/list.h>
6+
#include <linux/mod_devicetable.h>
7+
8+
#define EFI_EMBEDDED_FW_PREFIX_LEN 8
9+
10+
/*
11+
* This struct and efi_embedded_fw_list are private to the efi-embedded fw
12+
* implementation they are in this header for use by lib/test_firmware.c only!
13+
*/
14+
struct efi_embedded_fw {
15+
struct list_head list;
16+
const char *name;
17+
const u8 *data;
18+
size_t length;
19+
};
20+
21+
extern struct list_head efi_embedded_fw_list;
22+
23+
/**
24+
* struct efi_embedded_fw_desc - This struct is used by the EFI embedded-fw
25+
* code to search for embedded firmwares.
26+
*
27+
* @name: Name to register the firmware with if found
28+
* @prefix: First 8 bytes of the firmware
29+
* @length: Length of the firmware in bytes including prefix
30+
* @sha256: SHA256 of the firmware
31+
*/
32+
struct efi_embedded_fw_desc {
33+
const char *name;
34+
u8 prefix[EFI_EMBEDDED_FW_PREFIX_LEN];
35+
u32 length;
36+
u8 sha256[32];
37+
};
38+
39+
int efi_get_embedded_fw(const char *name, const u8 **dat, size_t *sz);
40+
41+
#endif

0 commit comments

Comments
 (0)