u-boot.lists.denx.de archive mirror
 help / color / mirror / Atom feed
From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org>,
	Christian Melki <christian.melki@t2data.com>,
	Bin Meng <bmeng.cn@gmail.com>,
	Heinrich Schuchardt <xypron.glpk@gmx.de>,
	Tom Rini <trini@konsulko.com>, Simon Glass <sjg@chromium.org>,
	Alexander Graf <agraf@csgraf.de>
Subject: [PATCH v5 11/28] efi: Add comments to struct efi_priv
Date: Sat,  4 Dec 2021 08:56:40 -0700	[thread overview]
Message-ID: <20211204155657.2913911-8-sjg@chromium.org> (raw)
In-Reply-To: <20211204155657.2913911-1-sjg@chromium.org>

This structure is uncommented. Fix it.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v3)

Changes in v3:
- Drop comments that confuse sphinx
- Move device_path path change to its own patch

 include/efi.h | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/include/efi.h b/include/efi.h
index 77e599c256e..6622a733e6e 100644
--- a/include/efi.h
+++ b/include/efi.h
@@ -400,14 +400,37 @@ static inline struct efi_mem_desc *efi_get_next_mem_desc(
 	return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
 }
 
+/**
+ * struct efi_priv - Information about the environment provided by EFI
+ *
+ * @parent_image: image passed into the EFI app or stub
+ * @sys_table: Pointer to system table
+ * @boot: Pointer to boot-services table
+ * @run: Pointer to runtime-services table
+ *
+ * @use_pool_for_malloc: true if all allocation should go through the EFI 'pool'
+ *	methods allocate_pool() and free_pool(); false to use 'pages' methods
+ *	allocate_pages() and free_pages()
+ * @ram_base: Base address of RAM (size CONFIG_EFI_RAM_SIZE)
+ * @image_data_type: Type of the loaded image (e.g. EFI_LOADER_CODE)
+ *
+ * @info: Header of the info list, holding info collected by the stub and passed
+ *	to U-Boot
+ * @info_size: Size of the info list, in bytes from @info
+ * @next_hdr: Pointer to where to put the next header when adding to the list
+ */
 struct efi_priv {
 	efi_handle_t parent_image;
 	struct efi_system_table *sys_table;
 	struct efi_boot_services *boot;
 	struct efi_runtime_services *run;
+
+	/* app: */
 	bool use_pool_for_malloc;
 	unsigned long ram_base;
 	unsigned int image_data_type;
+
+	/* stub: */
 	struct efi_info_hdr *info;
 	unsigned int info_size;
 	void *next_hdr;
-- 
2.34.1.400.ga245620fadb-goog


  parent reply	other threads:[~2021-12-04 15:59 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-04 15:56 [PATCH v5 00/28] efi: Improvements to U-Boot running on top of UEFI Simon Glass
2021-12-04 15:56 ` [PATCH v5 01/28] efi: Rename UCLASS_EFI and IF_TYPE_EFI Simon Glass
2021-12-09 18:38   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 02/28] efi: Add EFI uclass for media Simon Glass
2021-12-09 18:54   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 03/28] efi: Add a media/block driver for EFI block devices Simon Glass
2021-12-09 19:04   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 04/28] efi: Locate all block devices in the app Simon Glass
2021-12-04 18:43   ` Heinrich Schuchardt
2021-12-09 19:23     ` Heinrich Schuchardt
2021-12-17 16:37       ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 05/28] efi: serial: Support arrow keys Simon Glass
2021-12-09 19:39   ` Heinrich Schuchardt
2021-12-17 16:37     ` Simon Glass
2021-12-17 17:09       ` Heinrich Schuchardt
2021-12-17 17:42         ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 06/28] bloblist: Support allocating the bloblist Simon Glass
2021-12-04 15:56 ` [PATCH v5 07/28] x86: Allow booting a kernel from the EFI app Simon Glass
2021-12-04 15:56 ` [PATCH v5 08/28] x86: Don't process the kernel command line unless enabled Simon Glass
2021-12-04 15:56 ` [PATCH v5 09/28] x86: efi: Add room for the binman definition in the dtb Simon Glass
2021-12-04 15:56 ` [PATCH v5 10/28] efi: Drop device_path from struct efi_priv Simon Glass
2021-12-04 15:56 ` Simon Glass [this message]
2021-12-04 15:56 ` [PATCH v5 12/28] efi: Fix ll_boot_init() operation with the app Simon Glass
2021-12-04 15:56 ` [PATCH v5 13/28] efi: Add a few comments to the stub Simon Glass
2021-12-04 19:10   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 14/28] efi: Share struct efi_priv between the app and stub code Simon Glass
2021-12-04 15:56 ` [PATCH v5 15/28] efi: Move exit_boot_services into a function Simon Glass
2021-12-04 19:13   ` Heinrich Schuchardt
2021-12-17 16:37     ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 16/28] efi: Check for failure when initing the app Simon Glass
2021-12-09 20:17   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 17/28] efi: Mention that efi_info_get() is only used in the stub Simon Glass
2021-12-09 20:20   ` Heinrich Schuchardt
2021-12-04 15:56 ` [PATCH v5 18/28] efi: Show when allocated pages are used Simon Glass
2021-12-09 19:55   ` Heinrich Schuchardt
2021-12-17 16:37     ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 19/28] efi: Allow easy selection of serial-only operation Simon Glass
2021-12-04 15:56 ` [PATCH v5 20/28] x86: efi: Update efi_get_next_mem_desc() to avoid needing a map Simon Glass
2021-12-04 15:56 ` [PATCH v5 21/28] efi: Support the efi command in the app Simon Glass
2021-12-09 20:27   ` Heinrich Schuchardt
2021-12-17 16:37     ` Simon Glass
2021-12-20  2:38       ` AKASHI Takahiro
2021-12-29 13:36         ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 22/28] x86: efi: Show the system-table revision Simon Glass
2021-12-09 20:29   ` Heinrich Schuchardt
2021-12-17 16:37     ` Simon Glass
2021-12-04 15:56 ` [PATCH v5 23/28] x86: efi: Don't set up global_data again with EFI Simon Glass
2021-12-04 15:56 ` [PATCH v5 24/28] x86: efi: Tweak the code used for the 64-bit EFI app Simon Glass
2021-12-04 15:56 ` [PATCH v5 25/28] x86: efi: Round out the link script for 64-bit EFI Simon Glass
2021-12-04 15:56 ` [PATCH v5 26/28] x86: efi: Don't use the 64-bit link script for the EFI app Simon Glass
2021-12-05 14:03   ` Christian Melki
2021-12-04 15:56 ` [PATCH v5 27/28] x86: efi: Set the correct link flags for the 64-bit " Simon Glass
2021-12-05 14:03   ` Christian Melki
2021-12-04 15:56 ` [PATCH v5 28/28] efi: Build the 64-bit app properly Simon Glass

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211204155657.2913911-8-sjg@chromium.org \
    --to=sjg@chromium.org \
    --cc=agraf@csgraf.de \
    --cc=bmeng.cn@gmail.com \
    --cc=christian.melki@t2data.com \
    --cc=ilias.apalodimas@linaro.org \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    --cc=xypron.glpk@gmx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).