firmware: coreboot: Linux-owned SMI handler and its loader
PATCH v3 1/1 firmware: coreboot: Linux-owned SMI handler and its loader
coreboot exposes System Management Mode (SMM) related data in the coreboot table. Extend exisiting interface with structure corresponding to SMM data, and add COREBOOT_PAYLOAD_MM config.
Load Linux-owned SMI handler:
- Place Linux-owned SMI handler in arbitrary location in the lower 4GB of memory.
- Inform coreboot about the location of Linux-owned SMI handler via an SMI, coreboot copy the handler to SMRAM and redirects upcoming SMIs to it.
Linux-owned SMI is compiled in a similar fashion to the realmode trampolines for x86. Currently supported are two SMIs: ACPI enable and disable.
---
Hi,
This patchset adds support for Management Mode (MM) payload when Linux is used as coreboot's payload. The main idea is to delegate higher-level SMM functions to the payload, limiting the coreboot's System Management Mode (SMM) related responsibilities to the minimum of basic SMM setup [1]. This is done by loading a blob with SMI handler to the shared buffer, from which it is copied to SMRAM [2].
The MM payload is still in a Proof of Concept stage, and we are still working on getting the patches needed for coreboot upstreamed, but I would appreciate any feedback that you may have.
Thanks,
Michal
[1]: https://github.com/9elements/LinuxBootSMM/wiki/Proposed-design#current-design-approach---mm-payload
[2]: https://github.com/9elements/LinuxBootSMM/wiki/Proof-of-Concept-(PoC)
Changes in v3:
- merged patches into one
- rephrased commit messages to use imperative mode
- replaced -1 and PAYLOAD_MM_RET_FAILURE with -errno
- removed delay in favour of making driver !SMP dependent
- removed get_mm_info() in favour of conditional check in
mm_loader_probe
- added driver specific struct accessed via dev_get_drvdata()
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- merged mm_info into mm_loader
- removed mm_loader_exit in favour of allocating memory with devm_*()
- added forgotten "\n\t" in trigger_smi()
- added gitignore in mm_handler/
- added COREBOOT_PAYLOAD_MM dependency on x86
- error handling for mm_info struct
- error handling for shared_buffer
- removed whitespace changes in coreboot_table.h
- removed INFO level prints
- Link to v1: https://lore.kernel.org/r/[email protected]
--- drivers/firmware/google/Kconfig | 12 + drivers/firmware/google/Makefile | 11 + drivers/firmware/google/coreboot_table.h | 11 + drivers/firmware/google/mm_blob.S | 20 + drivers/firmware/google/mm_handler/.gitignore | 4 + drivers/firmware/google/mm_handler/Makefile | 51 +++ drivers/firmware/google/mm_handler/handler.lds.S | 46 ++ drivers/firmware/google/mm_handler/mm_handler.S | 510 +++++++++++++++++++++++ drivers/firmware/google/mm_handler/mm_handler.h | 21 + drivers/firmware/google/mm_handler/mm_header.S | 19 + drivers/firmware/google/mm_loader.c | 202 +++++++++ drivers/firmware/google/mm_payload.h | 48 +++ 12 files changed, 955 insertions(+)
drivers/firmware/google/Kconfig +12 -0
@@ -81,4 +81,16 @@ config GOOGLE_VPD This option enables the kernel to expose the content of Google VPD under /sys/firmware/vpd. +config COREBOOT_PAYLOAD_MM + tristate "SMI handling in Linux (LinuxBootSMM)" + depends on X86 && GOOGLE_COREBOOT_TABLE && !SMP + help + Enables support for SMI handling by Linux-owned code. + coreboot reserves region for payload-owned SMI handler, the Linux + driver prepares its SMI handler outside of SMRAM, and lets coreboot + know where the handler is placed by issuing an SMI. On this SMI, the + handler is being placed in SMRAM and all supported SMIs from that point + on are handled by Linux-owned SMI handler. + If in doubt, say N. + endif # GOOGLE_FIRMWARE
drivers/firmware/google/Makefile +11 -0
@@ -12,3 +12,14 @@ obj-$(CONFIG_GOOGLE_CBMEM) += cbmem.o vpd-sysfs-y := vpd.o vpd_decode.o obj-$(CONFIG_GOOGLE_VPD) += vpd-sysfs.o + +# LinuxBootSMM related. +subdir-$(CONFIG_COREBOOT_PAYLOAD_MM) += mm_handler + +$(obj)/mm_handler/handler.bin: FORCE + $(Q)$(MAKE) $(build)=$(obj)/mm_handler $@ + +$(obj)/mm_blob.o: $(obj)/mm_handler/handler.bin + +payload-mm-$(CONFIG_COREBOOT_PAYLOAD_MM) := mm_loader.o mm_blob.o +obj-$(CONFIG_COREBOOT_PAYLOAD_MM) += payload-mm.o
drivers/firmware/google/coreboot_table.h +11 -0
@@ -52,6 +52,16 @@ struct lb_cbmem_entry {u32 id; }; +/* Corresponds to LB_TAG_PLD_MM_INTERFACE_INFO */ +#define LB_TAG_PLD_MM_INTERFACE_INFO 0x3b +struct lb_pld_mm_interface_info { +u32 tag; +u32 size; +u8 revision; +u8 requires_long_mode_call; +u8 register_mm_entry_command; +}; +/* Describes framebuffer setup by coreboot */ struct lb_framebuffer {u32 tag;
@@ -80,6 +90,7 @@ struct coreboot_device {struct lb_cbmem_ref cbmem_ref;struct lb_cbmem_entry cbmem_entry;struct lb_framebuffer framebuffer; +struct lb_pld_mm_interface_info mm_info;DECLARE_FLEX_ARRAY (u8, raw); }; };
drivers/firmware/google/mm_blob.S new file +20 -0
@@ -0,0 +1,20 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Derived from rmpiggy.S. + * + * Wrapper script for the MM payload binary as a transport object + * before copying to SMRAM memory. + */ +#include <linux/linkage.h> +#include <asm/page_types.h> + + .section ".data","aw" + + .balign PAGE_SIZE + +SYM_DATA_START(mm_blob) + .incbin "drivers/firmware/google/mm_handler/handler.bin" +SYM_DATA_END_LABEL(mm_blob, SYM_L_GLOBAL, mm_blob_end) + +SYM_DATA_START(mm_relocs) + .incbin "drivers/firmware/google/mm_handler/handler.relocs" +SYM_DATA_END(mm_relocs)
drivers/firmware/google/mm_handler/.gitignore new file +4 -0
@@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0-only +pasyms.h +handler.lds +handler.relocs
drivers/firmware/google/mm_handler/Makefile new file +51 -0
51 lines not on this page · raw message
drivers/firmware/google/mm_handler/handler.lds.S new file +46 -0
46 lines not on this page · raw message
drivers/firmware/google/mm_handler/mm_handler.S new file +510 -0
510 lines not on this page · raw message
drivers/firmware/google/mm_handler/mm_handler.h new file +21 -0
@@ -0,0 +1,21 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Derived from arch/x86/include/realmode.h +*/ + +#ifndef _MM_HANDLER_H +#define _MM_HANDLER_H + +#define REALMODE_END_SIGNATURE 0x65a22c82 + +/* +* These macros correspond to the arguments +* passed by coreboot's SMI handler. Depending +* on which one is passed in rdi or esp + x, handler +* will jump to the appropriate section. +*/ +#define MM_ACPI_ENABLE 1 +#define MM_ACPI_DISABLE 0 +#define MM_STORE 2 + +#endif /* _MM_HANDLER_H */
drivers/firmware/google/mm_handler/mm_header.S new file +19 -0
@@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * MM blob header; this should match mm_payload.h + */ + +#include <linux/linkage.h> +#include <asm/page_types.h> +#include <asm/segment.h> + + .section ".header", "a" + + .balign 16 +SYM_DATA_START(mm_header) + .long pa_text_start + .long pa_mm_entry_32 + .long pa_mm_entry_64 + .long pa_mm_signature + .long pa_mm_blob_size +SYM_DATA_END(mm_header)
drivers/firmware/google/mm_loader.c new file +202 -0
202 lines not on this page · raw message
drivers/firmware/google/mm_payload.h new file +48 -0
48 lines not on this page · raw message
---
base-commit: 981d7f91aeda17424b29f033249f4fa7cd2a7556
change-id: 20250613-coreboot-payload-mm-6642bb42284a
Best regards,
Signature · 1 line
Michal Gorlas <[email protected]>