From patchwork Mon Mar 8 09:54:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Marek_Beh=C3=BAn?= X-Patchwork-Id: 1448950 X-Patchwork-Delegate: trini@ti.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=85.214.62.61; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=nic.cz header.i=@nic.cz header.a=rsa-sha256 header.s=default header.b=H8KK3YNR; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4DvDHR1QWRz9sWT for ; Mon, 8 Mar 2021 20:55:46 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 28FAA829D4; Mon, 8 Mar 2021 10:55:36 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=nic.cz Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=nic.cz header.i=@nic.cz header.b="H8KK3YNR"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id EA956829C9; Mon, 8 Mar 2021 10:55:20 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,SPF_HELO_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from mail.nic.cz (lists.nic.cz [IPv6:2001:1488:800:400::400]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 7B4CD828E8 for ; Mon, 8 Mar 2021 10:55:15 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=nic.cz Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=marek.behun@nic.cz Received: from dellmb.labs.office.nic.cz (unknown [IPv6:2001:1488:fffe:6:cac7:3539:7f1f:463]) by mail.nic.cz (Postfix) with ESMTPSA id 90073140A3E; Mon, 8 Mar 2021 10:55:13 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nic.cz; s=default; t=1615197314; bh=v+4VUTpgpJYTSMgNdRP+iI04IdT39dZ+2o5nywtZboM=; h=From:To:Date; b=H8KK3YNRdfizFwapfT20PFMQh4UEPoLCiaSCucYXOm57gPoh56GQoxXUdLhkWv/N5 UTBuTlJFt+xkQsh3De0aXsGBKCd9VJWaANV26jc9uceAxRMnqQZZBs6tEHG+8SeW61 Ds+0EoWglg4nuFt9pa3egmN8Uj3+cZ1BUtqdsbVE= From: =?utf-8?q?Marek_Beh=C3=BAn?= To: Heinrich Schuchardt Cc: u-boot@lists.denx.de, Marek Vasut , Simon Glass , Heiko Schocher , Patrick Delaunay , Patrice CHOTARD , Miquel Raynal , Tom Rini , Stefan Roese , Alexander Graf , Neil Armstrong , Ryder Lee , Adam Ford , Bin Meng , =?utf-8?q?Pa?= =?utf-8?q?li_Roh=C3=A1r?= , =?utf-8?q?Marek_Beh=C3=BAn?= Subject: [PATCH u-boot v1.2 14.1/39] efi_loader: add Sphinx doc for __efi_runtime and __efi_runtime_data Date: Mon, 8 Mar 2021 10:54:42 +0100 Message-Id: <20210308095444.22045-1-marek.behun@nic.cz> X-Mailer: git-send-email 2.26.2 In-Reply-To: <095c29bb-a716-2588-2ba1-31d1de97cbcc@gmx.de> References: MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.4 at phobos.denx.de X-Virus-Status: Clean Document the macros __efi_runtime and __efi_runtime_data in Sphinx style. Signed-off-by: Marek Behún --- include/efi_loader.h | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/include/efi_loader.h b/include/efi_loader.h index a8281b3c95..696f80e9f3 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -666,11 +666,34 @@ ssize_t efi_dp_check_length(const struct efi_device_path *dp, (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \ ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype)) -/* - * Use these to indicate that your code / data should go into the EFI runtime - * section and thus still be available when the OS is running +/** + * __efi_runtime_data - declares a non-const variable for EFI runtime section + * + * This macro indicates that a variable is non-const and should go into the + * EFI runtime section, and thus still be available when the OS is running. + * + * Only use on variables not declared const. + * + * Example: + * + * :: + * + * static __efi_runtime_data my_computed_table[256]; */ #define __efi_runtime_data __section(".data.efi_runtime") + +/** + * __efi_runtime - declares a function for EFI runtime section + * + * This macro indicates that a function should go into the EFI runtime section, + * and thus still be available when the OS is running. + * + * Example: + * + * :: + * + * static __efi_runtime compute_my_table(void); + */ #define __efi_runtime __section(".text.efi_runtime") /* Indicate supported runtime services */