From patchwork Wed Aug 20 11:23:30 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 74 Return-Path: X-Original-To: u-boot-concept@u-boot.org Delivered-To: u-boot-concept@u-boot.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755689069; bh=MCbqvL122+nDlptHAvWsUNWPCsoR8SrKBMU5qGS/g+c=; h=From:To:Date:In-Reply-To:References:CC:Subject:List-Id: List-Archive:List-Help:List-Owner:List-Post:List-Subscribe: List-Unsubscribe:From; b=CpjrJncF0oPpF5cZWfXHZKTdJDyx8yRjLA+rN7nvaWG51YdpVK9TeIZr+VZ0NH0fU j04l5ODa4MCGYPHjEE5EW0vOOkP+F7Wl49nalb9yd2GBPHFuc8LZ94KB+As7Zx/Y9f IuDNpb25zBKlZXct5bnJYbQ7J4lGqtkITuT/7L/pwJUAMg0U6Y9Rc2aqzf7rklbRQQ oYmxdQ2oWZaKgRj5PX+9znvT2Bqpo8PP9ER2+RxUMRqr/qPvtqY5o6EC/O0fEL/KSH euatUGeob02l9lgDAvPFNvyFpj2kHY0j0UIoRrhrJnd4eltM7wNbjyC6xzeZmbAhVz gISpz1t2r+LXA== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id C79D46767F for ; Wed, 20 Aug 2025 05:24:29 -0600 (MDT) X-Virus-Scanned: Debian amavis at Received: from mail.u-boot.org ([127.0.0.1]) by localhost (mail.u-boot.org [127.0.0.1]) (amavis, port 10024) with ESMTP id HRI2wkoK5D3t for ; Wed, 20 Aug 2025 05:24:29 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755689068; bh=MCbqvL122+nDlptHAvWsUNWPCsoR8SrKBMU5qGS/g+c=; h=From:To:Date:In-Reply-To:References:CC:Subject:List-Id: List-Archive:List-Help:List-Owner:List-Post:List-Subscribe: List-Unsubscribe:From; b=U/5ruWUIF+xqVXSEmJM80rkV0Odk0FWqMaEK3UFE3WM6HJgvW8gR/6Cb4D+TbNGq/ Ng/dmZHW+rtEFiLEwn+Hm+x5tj/m3OuuKVvPYTTNlAJsHW/iIjA89n4RE9QwPmZRDS lz7HYFGE87UHLELnSBdobvl93gQEOpemnB3a5Cp+X7OfKdvbS1vuq/9kMlB9R5b2aa T17DJMtHtwKCSoeK938P5JAa5qm3vP+xm0hYDPh2KgKwanwq7JPAyqeR0WQRizZTpi MpO6IUiz+CAcsl0h9KP/P3ONEv/rgfrN8NmRfct+1bbKKPGSgOflAnJkHhKtxc64R9 DEyuDBYXC6mvw== Received: from mail.u-boot.org (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id CFAA867689 for ; Wed, 20 Aug 2025 05:24:28 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755689064; bh=sXdpVQ4INkdO0YsspInzavDxKrFcoynISIPL8ecClwM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=cy4HTxTMfkjBorLE7+aE95Zccoqca9D/CPHRbW/2AmGunQJ9ieW8QmBGO/9RPh6Pr BrQH4TSSvyiu1KR0rtBkjBI/UQTOWg0MavFTrjl9onfzfkcJcqRowqcAQNwt5Zq+3a bRu0kE+VBN8VWklMO6amzm+KFUOBdMxXYBfNVSTxQbnlK0zJY65+3cRqfLMpX5mlBQ fIVLH4RIr7Uu3ibzHK2z0yFXeIuXYXeREXB1Knk6U+ionhLkkvZq0p/YD3o7P9wZ7S Z/mDETBpwHFx5Nj979iSAt6HwzrrrWW85Uc8GXhgU7gtmv+4mRc9bfeniBEgH0BKif vU1uq/nkwns9w== Received: from localhost (localhost [127.0.0.1]) by mail.u-boot.org (Postfix) with ESMTP id A8A06674AF; Wed, 20 Aug 2025 05:24:24 -0600 (MDT) X-Virus-Scanned: Debian amavis at Received: from mail.u-boot.org ([127.0.0.1]) by localhost (mail.u-boot.org [127.0.0.1]) (amavis, port 10026) with ESMTP id qdRR1FXe9Ec6; Wed, 20 Aug 2025 05:24:24 -0600 (MDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=u-boot.org; s=default; t=1755689060; bh=Mq/bTxOpt0LqdJ0PvskpXV4HRU/m1e0c9b9ha/9hLnY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=pyqy4jHjIrt4UcNru7EEfeDaypckg400HvwtVhR94HpvzloJHB9zSbv0arL77g3Xo /D5Pw89hAY3O8Pckal63pzWSyLX/GOdAxrug+D25RT3tjV3VaM82lEorL6B7D/n5L+ ChNjUUxvF7m4xeteLOP9mmOz7t2IQ6g83Pz0EnFkavdf7mPFqStVjWpRVNFntrHnJ6 aWbx9u2DGZA2us+Hz2vj14znoVfsb3BqNg2dWnnRBeKR+jiOkssvtqhDAtN6gTGzUk IHCwDH/q6AbT7bPY4Oyjv6VbTiA+htNPbf3EN0hzGN0prJ9Q2SvjhepaX42PPkKyFL QETLoGlmVii2A== Received: from u-boot.org (unknown [73.34.74.121]) by mail.u-boot.org (Postfix) with ESMTPSA id DFED367680; Wed, 20 Aug 2025 05:24:19 -0600 (MDT) From: Simon Glass To: U-Boot Concept Date: Wed, 20 Aug 2025 05:23:30 -0600 Message-ID: <20250820112340.147082-19-sjg@u-boot.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250820112340.147082-1-sjg@u-boot.org> References: <20250820112340.147082-1-sjg@u-boot.org> MIME-Version: 1.0 Message-ID-Hash: HHTQN6BI2DB5PSN2Q2EADXO2LLGZAAHG X-Message-ID-Hash: HHTQN6BI2DB5PSN2Q2EADXO2LLGZAAHG X-MailFrom: sjg@u-boot.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Heinrich Schuchardt , Simon Glass X-Mailman-Version: 3.3.10 Precedence: list Subject: [Concept] [PATCH v2 18/18] efi: doc: Add documentation for efidebug command in the app List-Id: Discussion and patches related to U-Boot Concept Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Simon Glass Mention the efidebug command specifically the EFI-app documentaion, to highlight its usefulness. Signed-off-by: Simon Glass --- Changes in v2: - Mention the 'dh' subcommand - Mention that 'order' allows the boot order to be changed - Mention the eficonfig command and the underlying UEFI firmware doc/develop/uefi/u-boot_on_efi.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst index d20d5b00ec6..845d04d7826 100644 --- a/doc/develop/uefi/u-boot_on_efi.rst +++ b/doc/develop/uefi/u-boot_on_efi.rst @@ -143,6 +143,30 @@ enough) should be straightforward. Use the 'reset' command to get back to EFI. +EFI Debugging Commands +~~~~~~~~~~~~~~~~~~~~~~ +When running as an EFI application, U-Boot provides access to the 'efidebug' +command, which offers a subset of functionality useful for debugging and +inspecting the UEFI environment. This command allows you to: + +* Display memory maps with 'efidebug memmap' +* Show EFI system tables with 'efidebug show tables' +* Show EFI handles with 'efidebug dh' +* Manage boot options with 'efidebug boot' subcommands: + + - dump - Display current boot options + - add - Add new boot options + - rm - Remove boot options + - order - Display and modify the boot order + +This command uses the EFI system table and runtime services to provide this +functionality, so it can help with understanding and debugging UEFI +environments. See the :doc:`/usage/cmd/efidebug` for more information. + +See also the :doc:`/usage/cmd/eficonfig` for controlling the boot order. The +underlying UEFI firmware typically provides an easier way to manage boot +options. + EFI Payload ~~~~~~~~~~~ The payload approach is a different kettle of fish. It works by building