From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 97923C3ABBC for ; Fri, 9 May 2025 07:47:43 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 167B56B00D9; Fri, 9 May 2025 03:47:29 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 02ABE6B00D8; Fri, 9 May 2025 03:47:28 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id DC0456B00D9; Fri, 9 May 2025 03:47:28 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id B90926B00D6 for ; Fri, 9 May 2025 03:47:28 -0400 (EDT) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 0F040121302 for ; Fri, 9 May 2025 07:47:30 +0000 (UTC) X-FDA: 83422589460.29.6491FC7 Received: from mail-pl1-f202.google.com (mail-pl1-f202.google.com [209.85.214.202]) by imf08.hostedemail.com (Postfix) with ESMTP id 40EBE160005 for ; Fri, 9 May 2025 07:47:28 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=Uj7v1WFI; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf08.hostedemail.com: domain of 3D7MdaAoKCDQSXQdWokQdbWeeWbU.SecbYdkn-ccalQSa.ehW@flex--changyuanl.bounces.google.com designates 209.85.214.202 as permitted sender) smtp.mailfrom=3D7MdaAoKCDQSXQdWokQdbWeeWbU.SecbYdkn-ccalQSa.ehW@flex--changyuanl.bounces.google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1746776848; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=cA0yISDxPF9g5T2ZPfjTueF/jIC5Kq4+wTcKq9ODUXQ=; b=xSSNVXbSfHXDbjUjBXv4TJ+mxdxG5RQiel3owHDjaH5CEwZ1GkzXx3O0d4MpS6/fIbdiIB xvmAHOtToE9hY/dyuoGj8lQaLiU/Xprz7ceO4koyC7ZoQxTwvbyJTXMUek6LMeICW4A448 yMTqu+ZwB+ARdaoSRxmD2DtK2u8i/d8= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=Uj7v1WFI; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf08.hostedemail.com: domain of 3D7MdaAoKCDQSXQdWokQdbWeeWbU.SecbYdkn-ccalQSa.ehW@flex--changyuanl.bounces.google.com designates 209.85.214.202 as permitted sender) smtp.mailfrom=3D7MdaAoKCDQSXQdWokQdbWeeWbU.SecbYdkn-ccalQSa.ehW@flex--changyuanl.bounces.google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1746776848; a=rsa-sha256; cv=none; b=H2MPdpVdXpq79nKSyWn0mkJqkkUqNyBfy4tkLGs8x3UJvsrM583NAIbO/8JJDlmmdPX1UH NkkmV4mZhO5GUefMJWhK0soPDeGLvGG4Q6GMvvZ/MxJaYC7a3IY1dG0BZLVZRkyHkNoyr3 ZEU0SCmAWl10ucbtzZU05PIMfTdbMAM= Received: by mail-pl1-f202.google.com with SMTP id d9443c01a7336-22fd4e7ea48so3484855ad.3 for ; Fri, 09 May 2025 00:47:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1746776847; x=1747381647; darn=kvack.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=cA0yISDxPF9g5T2ZPfjTueF/jIC5Kq4+wTcKq9ODUXQ=; b=Uj7v1WFIZ1iNbxvc6vsPbL7HLrdulnmF8t0bSw/knSDVcxhVXgdz9DDt9Y/0N3gQwm Nv36HTkRzuQl9RnsUMgCWJZhFfMpDiYf1zmtBqWZ6CL4aB4vEdIu4Ip8KAogIv2bQA3w ldBoFiEGtx7fspmZ/s53hoIDNjBU5di5BSKxy2lwoUQX8PwgZknt4MjxK+TOClM3egML krtza6wyrHDgwpw9el0NVCRwymOauflRIJl2QK0Xw5ObmJU3QmWMu+REaRq5i32vkpKl oor9l99zaJO68vO+OSzAoZDvQ7f7n/KQWTdhsP+TZZaK27S0+HXbna6hC2W+OKwakwro yznQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1746776847; x=1747381647; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=cA0yISDxPF9g5T2ZPfjTueF/jIC5Kq4+wTcKq9ODUXQ=; b=NgivUCih86IPGILd6viUhKDbumASRPbC6gdaGLHiXFGs7Uz4AJ4vvbYp8McERCtKhj Xc5jBukqpRmoeZ9nIk8pdzRHgq95uvDMEz+rh5CuN4y0fzU7kVg9gS+0SJpdkwSQbVSw BJSYsiO531P5ZR1O3q/Nu2fNpOKG98xZa28tukdtHIre2jMb8wpHvkWfShL/2agIRdDW puO8y/82ECrxui7ELkrDNtvgvfKsgs2C/ndh/zH4pfaNwkQoXM60q/pFaCwEAGsmFg6w zrZXegB+eSTWcLwRD162pTqWw2HnVZzBiKoR/dmwAAfO8U1oWSzAYm1E0xtLvtXvj3e6 FDZQ== X-Forwarded-Encrypted: i=1; AJvYcCUi+uYEecp7pfi3lbaz1+2I/e4tU89rTwm3aF7E0q6AWy0gu2QAfYAiami5iIC8o715HmAL+EJPMw==@kvack.org X-Gm-Message-State: AOJu0Ywf5ix2ZSXbj/DjZn1awbeYQ5cv8v6Y9zbHAteKfi5RvZDckqtP CzRBSitmdZBF1L19+3+blw4KuOnm9xQZ13Kk2eZDlLjdkAAWwszYQI63ogV9ySddcgQyK9QR8Fz siZ5dfrtyXeRK9zzEZQ== X-Google-Smtp-Source: AGHT+IFlDUYjFmNLjZAtgvspY6ix2dHys/RJQDHcQLdAfrz+DupB+ruuhonXRKp9ueOFjqDPInrpTwbWkYVKg2ph X-Received: from plle3.prod.google.com ([2002:a17:903:1663:b0:223:3b74:1b21]) (user=changyuanl job=prod-delivery.src-stubby-dispatcher) by 2002:a17:902:f68f:b0:223:66a1:4503 with SMTP id d9443c01a7336-22fc8b73d0emr28784975ad.30.1746776847032; Fri, 09 May 2025 00:47:27 -0700 (PDT) Date: Fri, 9 May 2025 00:46:35 -0700 In-Reply-To: <20250509074635.3187114-1-changyuanl@google.com> Mime-Version: 1.0 References: <20250509074635.3187114-1-changyuanl@google.com> X-Mailer: git-send-email 2.49.0.1015.ga840276032-goog Message-ID: <20250509074635.3187114-18-changyuanl@google.com> Subject: [PATCH v8 17/17] Documentation: KHO: Add memblock bindings From: Changyuan Lyu To: akpm@linux-foundation.org, linux-kernel@vger.kernel.org Cc: anthony.yznaga@oracle.com, arnd@arndb.de, ashish.kalra@amd.com, benh@kernel.crashing.org, bp@alien8.de, catalin.marinas@arm.com, corbet@lwn.net, dave.hansen@linux.intel.com, devicetree@vger.kernel.org, dwmw2@infradead.org, ebiederm@xmission.com, graf@amazon.com, hpa@zytor.com, jgowans@amazon.com, kexec@lists.infradead.org, krzk@kernel.org, linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-mm@kvack.org, luto@kernel.org, mark.rutland@arm.com, mingo@redhat.com, pasha.tatashin@soleen.com, pbonzini@redhat.com, peterz@infradead.org, ptyadav@amazon.de, robh@kernel.org, rostedt@goodmis.org, rppt@kernel.org, saravanak@google.com, skinsburskii@linux.microsoft.com, tglx@linutronix.de, thomas.lendacky@amd.com, will@kernel.org, x86@kernel.org, Changyuan Lyu Content-Type: text/plain; charset="UTF-8" X-Stat-Signature: r9xwcd83z3e9kqife4tssc5w5tmd4wqx X-Rspamd-Queue-Id: 40EBE160005 X-Rspam-User: X-Rspamd-Server: rspam05 X-HE-Tag: 1746776848-337202 X-HE-Meta: U2FsdGVkX19Eq6d6Oae01/o+YxG7pwpWes6e5BVRWSWPsnbs+DrhXUDlGdKm9x7cOvkTOCvwESB8z+hd5dfkWRnhOin95joGpgRUm+Emdrp7hSXmJqJlo7zsg8BBWKGo4MGzbVmmXWyRZuXDgTi9qHF+GcYrV08/6jOa/ygBbO+2lY5gO4uQ9PeK13j07eJ5bVLsSiE0Pun26G8Kgh4UB86EHs4wbSRt5CUYy8WaDpfbgMn40WLT9aKbgOESkLFJGB76yuRulCBUhRW5rDG1bZLoZZGru1j1fSSYm5ptichuGV7LAFnPZayJ6PtdZVTWucDCE+uGW2RGu7b+HVknJJBiJnrk0bWyX3W7QU9l/14+Lhu/E88obfL7bpKshqg4Fia25y+6YiyKDGR0zlzHSHUg0qfpL40OwIUNtdW6DRNbuiOxO7aAbxN7NmOr2dqy4jFfjXeN8eTecJOqTgUYJw0j2KtERfUOYVaFXUSgmyj4R844V4jLyyPqwAJsPv6dMapAM8JzNtaii0ZoY5mD4e7Fe+F6a/+Yrz1AT97oR8c0qwuD6JSac0FfAih7h2pmeGxwgstXvmqyJ5XlmrlMrI26/61/E+zv2qnEBCVuapGWv43ZNRa09D9Musi3V7xegybOLnd64ir3qBTrKzv4R16RaVi/SpmlLLbBQtwEv8FwvR+8ZNch6qY/TWugYGBm3rLEAHdeMTfK/kD6PdA7ofhssLFQ50skHdRojaf4+Ny8AiZKDFa+e3chqOrZ3/f5S9XtE4c6HPa7dZW6y4HGQxVwWUIUzQ0ISX4URfJ+Kd1EZEjb6sLT1jfDYGnXulotdWRWUVbt/rtGVEztYLbG0evwasxtj2oJy67farU3bEM76hPqUIVziHKfvowktye6Swm8rfd3FWn8MKVDQ968kpRkrQvIeWYjdxEwxyy0mXpz5yHpL5wpV+f/pnB/jdLzpv67JdwzyM9f14Vghm9 QX2p9po7 6ca2kOol2LgWR02Y9KEaHbPf4yD5P4Ag0+nNpcMqLFhwU97plUsAmoIUBWfmSi6POtd4DpDanveM0reAaoVHxySOicn+NEOP2ZfP0bakVzjODCxA/6Eju8f4FxfLkuPPWrK7+sWOUjb2WVxX9U5GGL80CNgTj+4fqjVdHK4Ec02lRcKCdsvMzC34EE5u2/6uklQxLL4vtu3wjzyvnFIxpi2SdG2lNN/5owXCqQVjJqCcQSBGJSi3QfkVwubV9Nne3XUEGg9I7viKvdAfcx5xowactNfh0ca2/vZScLVyKeuw9FTX79HAh2IESzzjmdjTs+vt0SygbHrvE7l3E6Xfb1Jm1bmBb4DV32aA5yKCYi9iDc16RZnUyEwSN7nctSG7ylPpP1uVLZuMITBYfbSkYiydfBjGhQ1tTyDTqXdEXkLIPGEk6UrJ04XtTVOV19jFX+sqxS+OVUiMd+CgpX2nSQgpIcpwA8W96D2FdtgZcb2DilqMzdQ23fq0dFYxPa4aq2pTk9mQjU4wpJ2EkdLO9GdzBLDKqf2Yb6t2x3JnJR9NQxmUlEjPzb4xujR/YqIESXjCB0HkhtmgjqGowwjObVY0qI63J+kCrnMLFm/JtRNFYuh5XQKUbG9ASZqvpHKq4/dFRWqLW/4qsahyvjmjBjO1YIoQQ390Bo0lLDEVbsyM13nea8Fiua8Vy4g== X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: From: "Mike Rapoport (Microsoft)" We introduced KHO into Linux: A framework that allows Linux to pass metadata and memory across kexec from Linux to Linux. KHO reuses fdt as file format and shares a lot of the same properties of firmware-to- Linux boot formats: It needs a stable, documented ABI that allows for forward and backward compatibility as well as versioning. As first user of KHO, we introduced memblock which can now preserve memory ranges reserved with reserve_mem command line options contents across kexec, so you can use the post-kexec kernel to read traces from the pre-kexec kernel. This patch adds memblock schemas similar to "device" device tree ones to a new kho bindings directory. This allows us to force contributors to document the data that moves across KHO kexecs and catch breaking change during review. Co-developed-by: Alexander Graf Signed-off-by: Alexander Graf Signed-off-by: Mike Rapoport (Microsoft) Signed-off-by: Changyuan Lyu --- .../kho/bindings/memblock/memblock.yaml | 39 ++++++++++++++++++ .../kho/bindings/memblock/reserve-mem.yaml | 40 +++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 80 insertions(+) create mode 100644 Documentation/core-api/kho/bindings/memblock/memblock.yaml create mode 100644 Documentation/core-api/kho/bindings/memblock/reserve-mem.yaml diff --git a/Documentation/core-api/kho/bindings/memblock/memblock.yaml b/Documentation/core-api/kho/bindings/memblock/memblock.yaml new file mode 100644 index 0000000000000..d388c28eb91d1 --- /dev/null +++ b/Documentation/core-api/kho/bindings/memblock/memblock.yaml @@ -0,0 +1,39 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +title: Memblock reserved memory + +maintainers: + - Mike Rapoport + +description: | + Memblock can serialize its current memory reservations created with + reserve_mem command line option across kexec through KHO. + The post-KHO kernel can then consume these reservations and they are + guaranteed to have the same physical address. + +properties: + compatible: + enum: + - reserve-mem-v1 + +patternProperties: + "$[0-9a-f_]+^": + $ref: reserve-mem.yaml# + description: reserved memory regions + +required: + - compatible + +additionalProperties: false + +examples: + - | + memblock { + compatible = "memblock-v1"; + n1 { + compatible = "reserve-mem-v1"; + start = <0xc06b 0x4000000>; + size = <0x04 0x00>; + }; + }; diff --git a/Documentation/core-api/kho/bindings/memblock/reserve-mem.yaml b/Documentation/core-api/kho/bindings/memblock/reserve-mem.yaml new file mode 100644 index 0000000000000..10282d3d1bcdc --- /dev/null +++ b/Documentation/core-api/kho/bindings/memblock/reserve-mem.yaml @@ -0,0 +1,40 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +title: Memblock reserved memory regions + +maintainers: + - Mike Rapoport + +description: | + Memblock can serialize its current memory reservations created with + reserve_mem command line option across kexec through KHO. + This object describes each such region. + +properties: + compatible: + enum: + - reserve-mem-v1 + + start: + description: | + physical address (u64) of the reserved memory region. + + size: + description: | + size (u64) of the reserved memory region. + +required: + - compatible + - start + - size + +additionalProperties: false + +examples: + - | + n1 { + compatible = "reserve-mem-v1"; + start = <0xc06b 0x4000000>; + size = <0x04 0x00>; + }; diff --git a/MAINTAINERS b/MAINTAINERS index 72345ca65edda..d7bd49dae2e0c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -15447,6 +15447,7 @@ M: Mike Rapoport L: linux-mm@kvack.org S: Maintained F: Documentation/core-api/boot-time-mm.rst +F: Documentation/core-api/kho/bindings/memblock/* F: include/linux/memblock.h F: mm/memblock.c F: mm/mm_init.c -- 2.49.0.1015.ga840276032-goog