From patchwork Thu Aug 17 13:07:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandre Ghiti X-Patchwork-Id: 13356450 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id E76F8C27C7A for ; Thu, 17 Aug 2023 13:08:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=13pTUGozNQ6lFQuWIeeujFuZEUT32VyJ5YZRyP1Id5Q=; b=GWJqVcczCOBhjb XUIsOvJ3C/1nWQfjJEYdcoaOCNXsE3eqcbKIqgeJ228Pu0Q7m+q3EbPl69PoQlFZRbNgD7BwIvvXj +ib9MYRbaqFw+L3tQZiCF1Vh6Gbbc+hQe1cNdRcr/byTrBJyb5D1i2Mn/omATmimtmlKCzGF1GmnH ij4QaaZSEXnHiB5qPIe9A49keYg6t0BgkoYdIeu+p3arCFUcTux9sJByQ57ReE6e7JJqj7dJ/d44/ fWMo7VSIIT8EM9nXpMdLwWLJdmQ63CqN24iENuC31I5jooGM7HVkQmWIMwtWs0Nto5Z5A8B/zTk8Q 5YOACbHGFEtcU4Bnlp7Q==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qWcj2-006QfD-0M; Thu, 17 Aug 2023 13:07:44 +0000 Received: from mail-ej1-x635.google.com ([2a00:1450:4864:20::635]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qWciy-006Qe9-0a for linux-riscv@lists.infradead.org; Thu, 17 Aug 2023 13:07:42 +0000 Received: by mail-ej1-x635.google.com with SMTP id a640c23a62f3a-99c4923195dso1039588366b.2 for ; Thu, 17 Aug 2023 06:07:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20221208.gappssmtp.com; s=20221208; t=1692277657; x=1692882457; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=TI4WEo8JBa7BZd/mm79h4G4Y9fT6R4+52BHu8koh6+Q=; b=vB1JjgNnYRYIGaf7JSJrPw3vQhtSiLbPIiRuS8F+dMBz7l9Ezb280tjcdqTRNjUNS1 vGwIXoPDvhsHyBc4tYUR4/X92hqFciBNxmRv5roV6Bw8PljdTqJ9WHDo7oj/AsVbxJjV /c8786uf4yTLw7cKhEXg9/PpGqdnh2rGBEucW8AosdbhckX6CQiZwkiKpf7tz0utrC+K 7qDivPtPENr/tHMoDw9xdsdddwyaulCHlIJXAdRh3fdg0JW9/9FJmQJewpKrB0L0GhQU cMd1Q20z2zLldhY1SVLGQCF7VaTpvRD/VU2ae+nu2aeeiJg0Mpkbw4Of82cler629Mbm JY5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692277657; x=1692882457; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=TI4WEo8JBa7BZd/mm79h4G4Y9fT6R4+52BHu8koh6+Q=; b=aH684JuTuQF5JBV8FlWCRxmk786Y5xk4I4buwTzK4SL2IKzkiCG3wKafVLYQTyUtzG eV0qv0/Kso8mFF7h2GDHu7CZSB9aTRmtdiym10I7lCSmQ9/zTn1ttTOt1sIa/LCMW1dz 9ZK2UUIYMLI0zUxlXQyUMoApgiIc6e5YrZAXy91tN7QD/q+PTkQAPGqaNKiIbnRC0qZm ++5WFjkm2Gdn71xZq7vc4+HuMA79Y3dvOhkwK8XM6EsUMJgDVI2qHXhqJ+ReI1tkZ8l1 KONQlvu8y/a9xMwSCV1kUgj1Wi1S9oDK/1tj1i9IU/wLkaZjyah+K3In2xC+74Wq8NTI PU4w== X-Gm-Message-State: AOJu0Yz+rY8WdyJUZLxDcVRdirksBzBHCsjb5p4LEPNRyXahvs26M5bY u5gqx/Vo2GCu9yK0SMKEZI+xzA== X-Google-Smtp-Source: AGHT+IEuOGz6Ic3C9ppPiDWIIRGMKEkWVcsX7LpLAMv38XoWrqVy0+63u/IO19hIcaWenrDygouLTw== X-Received: by 2002:a17:906:3058:b0:99c:a23b:b4f4 with SMTP id d24-20020a170906305800b0099ca23bb4f4mr4019871ejd.2.1692277656978; Thu, 17 Aug 2023 06:07:36 -0700 (PDT) Received: from alex-rivos.ba.rivosinc.com ([77.205.22.0]) by smtp.gmail.com with ESMTPSA id k8-20020a1709061c0800b0099d9b50d786sm6863021ejg.199.2023.08.17.06.07.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Aug 2023 06:07:36 -0700 (PDT) From: Alexandre Ghiti To: Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , =?utf-8?b?QmrDtnJuIFTDtnBlbA==?= , Andrew Jones , Conor Dooley , Sunil V L , Song Shuai , Randy Dunlap , linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org Cc: Alexandre Ghiti , Atish Patra Subject: [PATCH v7 1/3] Documentation: arm: Add bootargs to the table of added DT parameters Date: Thu, 17 Aug 2023 15:07:32 +0200 Message-Id: <20230817130734.10387-1-alexghiti@rivosinc.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230817_060740_239615_E68BFFCA X-CRM114-Status: GOOD ( 10.74 ) X-BeenThere: linux-riscv@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org The bootargs node is also added by the EFI stub in the function update_fdt(), so add it to the table. Signed-off-by: Alexandre Ghiti Reviewed-by: Atish Patra Reviewed-by: Song Shuai --- - Changes in v5: * Rebase on top of docs-next Documentation/arch/arm/uefi.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/arch/arm/uefi.rst b/Documentation/arch/arm/uefi.rst index baebe688a006..2b7ad9bd7cd2 100644 --- a/Documentation/arch/arm/uefi.rst +++ b/Documentation/arch/arm/uefi.rst @@ -50,7 +50,7 @@ The stub populates the FDT /chosen node with (and the kernel scans for) the following parameters: ========================== ====== =========================================== -Name Size Description +Name Type Description ========================== ====== =========================================== linux,uefi-system-table 64-bit Physical address of the UEFI System Table. @@ -67,4 +67,6 @@ linux,uefi-mmap-desc-ver 32-bit Version of the mmap descriptor format. kaslr-seed 64-bit Entropy used to randomize the kernel image base address location. + +bootargs String Kernel command line ========================== ====== =========================================== From patchwork Thu Aug 17 13:07:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Alexandre Ghiti X-Patchwork-Id: 13356451 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id DADDCC27C7A for ; Thu, 17 Aug 2023 13:08:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=OBtfZpvTSCtZmt6DsROe+xR3g0zK6wO2CJzWWb7ovis=; b=FWKgY5f5/9DRYQ VMfNg14aDpQThsag+ve0kbkcD7OuDilkmX3YEclouFhgXSN+KNS5C3MHZYCXA/ZYXb1vICbJbbfAF u/z9G5elbrtS71u8EqMKqvhp+UepQXVWLOXcSHUWUqnYtkMUM7I997jfJtZzwW/1MJhed/KpdnUt+ a5WVE0bLjqSoXUnooF8h7JW+R79ViFxO92gbKul6xSotqNK/48bYzXYIXYtsSfL2snrXo++6GXXhQ Jdi8AzyDx2jyrig6tabIe6TZzgcHoVKooXPI7XpI5cKZkuZt8YiBQAra8e2QfljrkIwlP904rxLNH W1epL53DghgjcbkK2mpQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qWck0-006QjQ-0r; Thu, 17 Aug 2023 13:08:44 +0000 Received: from mail-ej1-x62f.google.com ([2a00:1450:4864:20::62f]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qWcjx-006Qij-1d for linux-riscv@lists.infradead.org; Thu, 17 Aug 2023 13:08:43 +0000 Received: by mail-ej1-x62f.google.com with SMTP id a640c23a62f3a-977e0fbd742so995518566b.2 for ; Thu, 17 Aug 2023 06:08:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20221208.gappssmtp.com; s=20221208; t=1692277719; x=1692882519; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=APTli72ITRVfE+/LgIiZ7exRy/QBz3O8JNU41MzsRrI=; b=Rn6eK35XhS9DOR8BOVda+LOPKkOzhRarlTIun+WOow460nfNy91fny8SHHupXhrTiK RY5n1VB7fa00zBmgjhsdP7L2Xhs7EQcCpWj2CLtT2BIvW8dzj0NhnELFKB2zB1f6bBPt +I0By5E1V/5qPCHHSvZYUZcyBbqG7K80wvKipbbZrFFYiPt9l4TsrhYpoZQAmbm2iWrb BVTC2a78c2HsWr0ZJ85PvNyOUlKan/XMzHeSH0OMpkHjomhvLZxz6zmzaFkVrVHdpN3L jPp2Kwh5kh/qVxk6UtwosGF8Cvq7F96tq6q51YiMqEoGDLaMMoRmKE+KJjpWQbPY3TV6 BrEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692277719; x=1692882519; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=APTli72ITRVfE+/LgIiZ7exRy/QBz3O8JNU41MzsRrI=; b=gBet41HrhYtmZ175F27PSR14KyZyem9S7t7+5THCSn8VNmowFyecpVK7Zei5/Lml6m LSHLRyiJRj/C73UVJXosXbQTDa3IwwyMlnbUb7vHD8qWO97Qw8VsjGQ80O2Vg1kavtAR cGvCspQOqKA7jNMpCsajTLIkIOkELpf//zGA1eeiWC07zhoMPOBTGOIfJer2VEpn2dMu 7X3N+F0l7O27Id36wNtgOpWtaRsVjyf1+VTSJ52CFuipwg7c2VLEdDgHqj0mMwCIChbB PbxyNpbJNrJb6Khmc/rbXzxsrrqERF4HE+VGVkGA7WEr323TbuYMqnFia9Q5z30kQcgG pYTQ== X-Gm-Message-State: AOJu0YzCvwRUaJDNG8InvAmkgjnECPD7lgDp/3+hntM6tRW4G/pCeiqT 6hIezfJFyeZeC2S2SCt28bFHrg== X-Google-Smtp-Source: AGHT+IE6czGL1xSi5fj7Hje8f3BSGNUAb7PJ+eEjRiIBOtWGwAx59UfTVRIyzXn5AKFPT9o+FWpM0Q== X-Received: by 2002:a17:906:105c:b0:99d:f778:b8e5 with SMTP id j28-20020a170906105c00b0099df778b8e5mr3387621ejj.28.1692277719517; Thu, 17 Aug 2023 06:08:39 -0700 (PDT) Received: from alex-rivos.ba.rivosinc.com ([77.205.22.0]) by smtp.gmail.com with ESMTPSA id b12-20020a170906660c00b009828e26e519sm10123033ejp.122.2023.08.17.06.08.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Aug 2023 06:08:39 -0700 (PDT) From: Alexandre Ghiti To: Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , =?utf-8?b?QmrDtnJuIFTDtnBlbA==?= , Andrew Jones , Conor Dooley , Sunil V L , Song Shuai , Randy Dunlap , linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org Cc: Alexandre Ghiti , Palmer Dabbelt , Atish Patra Subject: [PATCH v7 2/3] Documentation: riscv: Add early boot document Date: Thu, 17 Aug 2023 15:07:33 +0200 Message-Id: <20230817130734.10387-2-alexghiti@rivosinc.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230817130734.10387-1-alexghiti@rivosinc.com> References: <20230817130734.10387-1-alexghiti@rivosinc.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230817_060841_552366_172BC1E7 X-CRM114-Status: GOOD ( 33.00 ) X-BeenThere: linux-riscv@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org This document describes the constraints and requirements of the early boot process in a RISC-V kernel. Signed-off-by: Alexandre Ghiti Reviewed-by: Björn Töpel Reviewed-by: Conor Dooley Reviewed-by: Sunil V L Reviewed-by: Andrew Jones Reviewed-by: Palmer Dabbelt Reviewed-by: Atish Patra Reviewed-by: Song Shuai Reviewed-by: Randy Dunlap Acked-by: Palmer Dabbelt --- Changes in v7: * Fix path to arm documentation Changes in v6: * s/cpu/CPU as suggested by Randy * s/but/and as suggested by Randy * s/entrance/entry as suggested by Randy Changes in v5: * Rebase on top of docs-next Documentation/riscv/boot-image-header.rst | 3 - Documentation/riscv/boot.rst | 169 ++++++++++++++++++++++ Documentation/riscv/index.rst | 1 + 3 files changed, 170 insertions(+), 3 deletions(-) create mode 100644 Documentation/riscv/boot.rst diff --git a/Documentation/riscv/boot-image-header.rst b/Documentation/riscv/boot-image-header.rst index d7752533865f..a4a45310c4c4 100644 --- a/Documentation/riscv/boot-image-header.rst +++ b/Documentation/riscv/boot-image-header.rst @@ -7,9 +7,6 @@ Boot image header in RISC-V Linux This document only describes the boot image header details for RISC-V Linux. -TODO: - Write a complete booting guide. - The following 64-byte header is present in decompressed Linux kernel image:: u32 code0; /* Executable code */ diff --git a/Documentation/riscv/boot.rst b/Documentation/riscv/boot.rst new file mode 100644 index 000000000000..6077b587a842 --- /dev/null +++ b/Documentation/riscv/boot.rst @@ -0,0 +1,169 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=============================================== +RISC-V Kernel Boot Requirements and Constraints +=============================================== + +:Author: Alexandre Ghiti +:Date: 23 May 2023 + +This document describes what the RISC-V kernel expects from bootloaders and +firmware, and also the constraints that any developer must have in mind when +touching the early boot process. For the purposes of this document, the +``early boot process`` refers to any code that runs before the final virtual +mapping is set up. + +Pre-kernel Requirements and Constraints +======================================= + +The RISC-V kernel expects the following of bootloaders and platform firmware: + +Register state +-------------- + +The RISC-V kernel expects: + + * ``$a0`` to contain the hartid of the current core. + * ``$a1`` to contain the address of the devicetree in memory. + +CSR state +--------- + +The RISC-V kernel expects: + + * ``$satp = 0``: the MMU, if present, must be disabled. + +Reserved memory for resident firmware +------------------------------------- + +The RISC-V kernel must not map any resident memory, or memory protected with +PMPs, in the direct mapping, so the firmware must correctly mark those regions +as per the devicetree specification and/or the UEFI specification. + +Kernel location +--------------- + +The RISC-V kernel expects to be placed at a PMD boundary (2MB aligned for rv64 +and 4MB aligned for rv32). Note that the EFI stub will physically relocate the +kernel if that's not the case. + +Hardware description +-------------------- + +The firmware can pass either a devicetree or ACPI tables to the RISC-V kernel. + +The devicetree is either passed directly to the kernel from the previous stage +using the ``$a1`` register, or when booting with UEFI, it can be passed using the +EFI configuration table. + +The ACPI tables are passed to the kernel using the EFI configuration table. In +this case, a tiny devicetree is still created by the EFI stub. Please refer to +"EFI stub and devicetree" section below for details about this devicetree. + +Kernel entry +------------ + +On SMP systems, there are 2 methods to enter the kernel: + +- ``RISCV_BOOT_SPINWAIT``: the firmware releases all harts in the kernel, one hart + wins a lottery and executes the early boot code while the other harts are + parked waiting for the initialization to finish. This method is mostly used to + support older firmwares without SBI HSM extension and M-mode RISC-V kernel. +- ``Ordered booting``: the firmware releases only one hart that will execute the + initialization phase and then will start all other harts using the SBI HSM + extension. The ordered booting method is the preferred booting method for + booting the RISC-V kernel because it can support CPU hotplug and kexec. + +UEFI +---- + +UEFI memory map +~~~~~~~~~~~~~~~ + +When booting with UEFI, the RISC-V kernel will use only the EFI memory map to +populate the system memory. + +The UEFI firmware must parse the subnodes of the ``/reserved-memory`` devicetree +node and abide by the devicetree specification to convert the attributes of +those subnodes (``no-map`` and ``reusable``) into their correct EFI equivalent +(refer to section "3.5.4 /reserved-memory and UEFI" of the devicetree +specification v0.4-rc1). + +RISCV_EFI_BOOT_PROTOCOL +~~~~~~~~~~~~~~~~~~~~~~~ + +When booting with UEFI, the EFI stub requires the boot hartid in order to pass +it to the RISC-V kernel in ``$a1``. The EFI stub retrieves the boot hartid using +one of the following methods: + +- ``RISCV_EFI_BOOT_PROTOCOL`` (**preferred**). +- ``boot-hartid`` devicetree subnode (**deprecated**). + +Any new firmware must implement ``RISCV_EFI_BOOT_PROTOCOL`` as the devicetree +based approach is deprecated now. + +Early Boot Requirements and Constraints +======================================= + +The RISC-V kernel's early boot process operates under the following constraints: + +EFI stub and devicetree +----------------------- + +When booting with UEFI, the devicetree is supplemented (or created) by the EFI +stub with the same parameters as arm64 which are described at the paragraph +"UEFI kernel support on ARM" in Documentation/arch/arm/uefi.rst. + +Virtual mapping installation +---------------------------- + +The installation of the virtual mapping is done in 2 steps in the RISC-V kernel: + +1. ``setup_vm()`` installs a temporary kernel mapping in ``early_pg_dir`` which + allows discovery of the system memory. Only the kernel text/data are mapped + at this point. When establishing this mapping, no allocation can be done + (since the system memory is not known yet), so ``early_pg_dir`` page table is + statically allocated (using only one table for each level). + +2. ``setup_vm_final()`` creates the final kernel mapping in ``swapper_pg_dir`` + and takes advantage of the discovered system memory to create the linear + mapping. When establishing this mapping, the kernel can allocate memory but + cannot access it directly (since the direct mapping is not present yet), so + it uses temporary mappings in the fixmap region to be able to access the + newly allocated page table levels. + +For ``virt_to_phys()`` and ``phys_to_virt()`` to be able to correctly convert +direct mapping addresses to physical addresses, they need to know the start of +the DRAM. This happens after step 1, right before step 2 installs the direct +mapping (see ``setup_bootmem()`` function in arch/riscv/mm/init.c). Any usage of +those macros before the final virtual mapping is installed must be carefully +examined. + +Devicetree mapping via fixmap +----------------------------- + +As the ``reserved_mem`` array is initialized with virtual addresses established +by ``setup_vm()``, and used with the mapping established by +``setup_vm_final()``, the RISC-V kernel uses the fixmap region to map the +devicetree. This ensures that the devicetree remains accessible by both virtual +mappings. + +Pre-MMU execution +----------------- + +A few pieces of code need to run before even the first virtual mapping is +established. These are the installation of the first virtual mapping itself, +patching of early alternatives and the early parsing of the kernel command line. +That code must be very carefully compiled as: + +- ``-fno-pie``: This is needed for relocatable kernels which use ``-fPIE``, + since otherwise, any access to a global symbol would go through the GOT which + is only relocated virtually. +- ``-mcmodel=medany``: Any access to a global symbol must be PC-relative to + avoid any relocations to happen before the MMU is setup. +- *all* instrumentation must also be disabled (that includes KASAN, ftrace and + others). + +As using a symbol from a different compilation unit requires this unit to be +compiled with those flags, we advise, as much as possible, not to use external +symbols. diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst index 81cf6e616476..4dab0cb4b900 100644 --- a/Documentation/riscv/index.rst +++ b/Documentation/riscv/index.rst @@ -6,6 +6,7 @@ RISC-V architecture :maxdepth: 1 acpi + boot boot-image-header vm-layout hwprobe From patchwork Thu Aug 17 13:07:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandre Ghiti X-Patchwork-Id: 13356452 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id D152EC27C7A for ; Thu, 17 Aug 2023 13:09:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=g+6TWnHrjBLJvdHCHtUNWc/fl+pFPvIlNwMt52I5a8g=; b=ZD+Liq1xez44MX AKRp9fLyc0rzMxwHCdxtFJfmDK6dcTCIMWKIa8W+6iXXk27ofBUqQzgvuEBxIVwzLjOA/+hxqTN1y GQzoPnT8T605d42t9RGVjQxvFazydviUDomTHm+le5WQOIFPDnKyR3Km3kwnO51MDMNmAOrKKB04f SWI1q6dwNVHcCeUF7TAXD+jgRWZlWu8WvHgjg6QKm6aK6w4juFa8O/6yMpbRgcXJNUW06RGABAc1N 4tQ7wRi9LuTg71AMXOi+LfrFfKbP2Q9dxnNaCyGv/1aAF4nwwoiG8t57w6nKuOCY3mbGbHiov0Onm 4EG/bjWDRQDHSzvua5jA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qWcl3-006Qoe-1d; Thu, 17 Aug 2023 13:09:49 +0000 Received: from mail-ed1-x535.google.com ([2a00:1450:4864:20::535]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qWcl1-006Qno-0f for linux-riscv@lists.infradead.org; Thu, 17 Aug 2023 13:09:48 +0000 Received: by mail-ed1-x535.google.com with SMTP id 4fb4d7f45d1cf-523bf06f7f8so8445706a12.1 for ; Thu, 17 Aug 2023 06:09:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rivosinc-com.20221208.gappssmtp.com; s=20221208; t=1692277782; x=1692882582; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=dia79abijhqNuyOI1X7cuUqq5ei10OSh1lyxFY8ZqEI=; b=3nb6Lx91hP38MJ3GLl8uaDcXhmdsFacX63aBoL59zCMgJncHjeenKLbguGHpu3TTET 3CAawoe5G94N+Zlg0PjwH+2WnqRPe3YDrJPMrPzQHaT0FI6oiSgOYnaIM2iiSt7hMkx1 JXe0yDUxjjCa67x2MTZagetgaYShcRqgjxGBDh6Al02vtsCsgSm4dXmSnDNPl9g4DdYU GDN9edqu/82jOUuqLQuz2DVd3EWcnUVWvVVvY8SygZZ/Hjs1bXVaRZDAEu0IKkSVW6DK hx7/Sl76DMH9q2ilOlpGLf4ueapRgEXDufjufHMeOcHsnUf/s+wgpSVFP2vUZAuwQBHt dwBQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692277782; x=1692882582; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=dia79abijhqNuyOI1X7cuUqq5ei10OSh1lyxFY8ZqEI=; b=YkWkFYkepG4Hpl29JwPcSMPlvrtihPYpwb6e7FyC3D76kVqZ8ZpayFC2u5ePIh5KUA pq0KnJlK1nHieObnthZVtrmI9MwHz0MvAtLDLWL2u8CqmujwB9VSCXsOKVtBUJui3O8v rS7U4N7ZFJdaimRNtUJ4bpmL0y2hNCUYxUQuGmHuQp6wZB2yRu6Y/r4/+Gr8nCkRaF+R pgrfB/3fhNeckAh6KLr44AodfW0+IcAbuZnOfjA7nY7Jz57poRCr2yb/EvGVbOXE6nbD o5zYeXOEgo6dfpFMRZxnftwstE0kL0PzEDBiKZOepmyUe/ELrFzc/MLYnC34r7+TFJBK 8ywg== X-Gm-Message-State: AOJu0YzGGfJqGGRpKhDcVN+OtmO9E5/yK+9GTBjJfLCxm0yyr+7qRDr+ WvobylTYr3VrgCPzTFzdMFQg0Q== X-Google-Smtp-Source: AGHT+IHPEG0Uf4bUW9nG0gFKJH77vR45Ar5vo3OmomUBR3HmWHPm8EAlptOc0vd76nvl6VVmMrqFKg== X-Received: by 2002:aa7:db58:0:b0:522:3a37:a463 with SMTP id n24-20020aa7db58000000b005223a37a463mr4006086edt.20.1692277781929; Thu, 17 Aug 2023 06:09:41 -0700 (PDT) Received: from alex-rivos.ba.rivosinc.com ([77.205.22.0]) by smtp.gmail.com with ESMTPSA id h2-20020aa7de02000000b005232e637c24sm9912829edv.84.2023.08.17.06.09.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Aug 2023 06:09:41 -0700 (PDT) From: Alexandre Ghiti To: Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , =?utf-8?b?QmrDtnJuIFTDtnBlbA==?= , Andrew Jones , Conor Dooley , Sunil V L , Song Shuai , Randy Dunlap , linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, linux-kernel@vger.kernel.org Cc: Alexandre Ghiti , Atish Patra , Palmer Dabbelt Subject: [PATCH v7 3/3] Documentation: riscv: Update boot image header since EFI stub is supported Date: Thu, 17 Aug 2023 15:07:34 +0200 Message-Id: <20230817130734.10387-3-alexghiti@rivosinc.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230817130734.10387-1-alexghiti@rivosinc.com> References: <20230817130734.10387-1-alexghiti@rivosinc.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230817_060947_246957_F592DF4A X-CRM114-Status: GOOD ( 14.65 ) X-BeenThere: linux-riscv@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org The EFI stub is supported on RISC-V so update the documentation that explains how the boot image header was reused to support it. Signed-off-by: Alexandre Ghiti Reviewed-by: Atish Patra Reviewed-by: Palmer Dabbelt Acked-by: Palmer Dabbelt --- - Changes in v5: * Rebase on top of docs-next Documentation/riscv/boot-image-header.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/riscv/boot-image-header.rst b/Documentation/riscv/boot-image-header.rst index a4a45310c4c4..df2ffc173e80 100644 --- a/Documentation/riscv/boot-image-header.rst +++ b/Documentation/riscv/boot-image-header.rst @@ -28,11 +28,11 @@ header in future. Notes ===== -- This header can also be reused to support EFI stub for RISC-V in future. EFI - specification needs PE/COFF image header in the beginning of the kernel image - in order to load it as an EFI application. In order to support EFI stub, - code0 should be replaced with "MZ" magic string and res3(at offset 0x3c) should - point to the rest of the PE/COFF header. +- This header is also reused to support EFI stub for RISC-V. EFI specification + needs PE/COFF image header in the beginning of the kernel image in order to + load it as an EFI application. In order to support EFI stub, code0 is replaced + with "MZ" magic string and res3(at offset 0x3c) points to the rest of the + PE/COFF header. - version field indicate header version number