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 phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4DBF2C433F5 for ; Tue, 4 Jan 2022 10:53:04 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id BA4FF83041; Tue, 4 Jan 2022 11:52:12 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org 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; unprotected) header.d=chromium.org header.i=@chromium.org header.b="YDXGJpA8"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id F3E8E8192E; Tue, 4 Jan 2022 11:51:57 +0100 (CET) Received: from mail-wr1-x42a.google.com (mail-wr1-x42a.google.com [IPv6:2a00:1450:4864:20::42a]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 9D22D82FC8 for ; Tue, 4 Jan 2022 11:51:53 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=sjg@chromium.org Received: by mail-wr1-x42a.google.com with SMTP id w20so66312051wra.9 for ; Tue, 04 Jan 2022 02:51:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=N+2RBOTYLe8s3oystSjmUC9tKea0iq/3BEkE1Lrzn9U=; b=YDXGJpA8mF0l/tK6AQfQQmTk0cBCZ5bu5YZKe9VS67VI0wNUDcqUh0On8cR5UjDtyZ K2dpWSEComKzjeltt/7V1wF8Vy9bo6n8uCOFMQ5N24vJuMdETlGiKdzgdbojI6gSufnR qzsnJ04izm7aacQqWSWJcfBfBaRmWFNLdc9uo= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=N+2RBOTYLe8s3oystSjmUC9tKea0iq/3BEkE1Lrzn9U=; b=zoZnYLLyBzgTKS0l+Qb77b3L20tq2jwu4WchdFqQlEQKMn0eLEjjZj1u53aHSE/F0D NmdNy12gMjWJ5pC07TAYowFlvy9jqh/SzgZ8cjIEbtyKQsbqTfDqX93aQJ2vgl6AhzuC avSn5febdZk3PQMjlUOdh60cy745x8TW5FPWPmTmNHi+Kl6tv0O6msXhrfaGIfInBR0B PjBZnEy04hwy4AaOZbEmv15WDs6lKTVy+oaaV4WZOD8eeGYihG4hsobmCWCReH5hBFd3 1y6d7yZtBgN7Uc+D0zEmWy0ApR0eSN+LrcRzdVRcug41NnC761nK0m0mJPSwrxMglT5Q pjkA== X-Gm-Message-State: AOAM5307bEu/wdwucekPTYlYyLQSt2pGNiWQOBJ2Ul3WOh1MBn02/WSs kRTn6jkFMyOtIt0uhSZqlphyVzNoLWPcebKN X-Google-Smtp-Source: ABdhPJwxaKuGhgeLMVB0uQwwTk9nzxSaO1zUKO18vKgAXZ11r+DpVgFDNf/c43yKz7NMGo97PSSpDQ== X-Received: by 2002:a5d:6702:: with SMTP id o2mr41715402wru.292.1641293513013; Tue, 04 Jan 2022 02:51:53 -0800 (PST) Received: from sjg1.roam.corp.google.com (bba134459.alshamil.net.ae. [217.165.114.93]) by smtp.gmail.com with ESMTPSA id m10sm38310552wms.25.2022.01.04.02.51.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 04 Jan 2022 02:51:52 -0800 (PST) From: Simon Glass To: U-Boot Mailing List Cc: Heinrich Schuchardt , Christian Melki , Tom Rini , Ilias Apalodimas , Bin Meng , Simon Glass , Alexander Graf Subject: [PATCH v9 9/9] efi: Tidy up some comments in efi header Date: Tue, 4 Jan 2022 03:51:18 -0700 Message-Id: <20220104105118.373365-5-sjg@chromium.org> X-Mailer: git-send-email 2.34.1.448.ga2b2bfdf31-goog In-Reply-To: <20220104105118.373365-1-sjg@chromium.org> References: <20220104105118.373365-1-sjg@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 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.103.2 at phobos.denx.de X-Virus-Status: Clean Document the return value in efi_init(). Fix up @sizep in efi_info_get(). Use Return: instead of @return Signed-off-by: Simon Glass --- (no changes since v8) Changes in v8: - Add new patch to tidy up header comments include/efi.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/include/efi.h b/include/efi.h index 9b7ba0d54d3..6159f34ad2b 100644 --- a/include/efi.h +++ b/include/efi.h @@ -510,14 +510,14 @@ void efi_set_priv(struct efi_priv *priv); /** * efi_get_sys_table() - Get access to the main EFI system table * - * @return pointer to EFI system table + * Returns: pointer to EFI system table */ struct efi_system_table *efi_get_sys_table(void); /** * efi_get_boot() - Get access to the EFI boot services table * - * @return pointer to EFI boot services table + * Returns: pointer to EFI boot services table */ struct efi_boot_services *efi_get_boot(void); @@ -526,7 +526,7 @@ struct efi_boot_services *efi_get_boot(void); * * This is used when U-Boot is built as an EFI application. * - * @return the base of RAM as known to U-Boot + * Returns: the base of RAM as known to U-Boot */ unsigned long efi_get_ram_base(void); @@ -537,6 +537,7 @@ unsigned long efi_get_ram_base(void); * @banner: Banner to display when starting * @image: The image handle passed to efi_main() * @sys_table: The EFI system table pointer passed to efi_main() + * Return: 0 on succcess, EFI error code on failure */ int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image, struct efi_system_table *sys_table); @@ -547,7 +548,7 @@ int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image, * @priv: Pointer to private EFI structure * @size: Number of bytes to allocate * @retp: Return EFI status result - * @return pointer to memory allocated, or NULL on error + * Returns: pointer to memory allocated, or NULL on error */ void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp); @@ -584,8 +585,8 @@ void efi_putc(struct efi_priv *priv, const char ch); * * @type: Entry type to search for * @datap: Returns pointer to entry data - * @sizep: Returns pointer to entry size - * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry + * @sizep: Returns entry size + * Return: 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry * of the requested type, -EPROTONOSUPPORT if the table has the wrong version */ int efi_info_get(enum efi_entry_t type, void **datap, int *sizep); @@ -597,7 +598,7 @@ int efi_info_get(enum efi_entry_t type, void **datap, int *sizep); * exit_boot_services() * * @priv: Pointer to private EFI structure - * @return 0 if OK, non-zero on error + * Returns: 0 if OK, non-zero on error */ int efi_store_memory_map(struct efi_priv *priv); @@ -620,7 +621,7 @@ int efi_call_exit_boot_services(void); * @keyp: Returns memory-map key * @desc_sizep: Returns size of each @desc_base record * @versionp: Returns version number of memory map - * @return 0 on success, -ve on error + * Returns: 0 on success, -ve on error */ int efi_get_mmap(struct efi_mem_desc **descp, int *sizep, uint *keyp, int *desc_sizep, uint *versionp); -- 2.34.1.448.ga2b2bfdf31-goog