From: Heinrich Schuchardt <xypron.glpk@gmx.de>
To: Simon Glass <sjg@chromium.org>
Cc: Tom Rini <trini@konsulko.com>,
Alexandru Gagniuc <mr.nuke.me@gmail.com>,
Andre Przywara <andre.przywara@arm.com>,
Chia-Wei Wang <chiawei_wang@aspeedtech.com>,
Jan Kiszka <jan.kiszka@siemens.com>,
Joe Hershberger <joe.hershberger@ni.com>,
Joel Stanley <joel@jms.id.au>, Marek Vasut <marex@denx.de>,
Philippe Reynes <philippe.reynes@softathome.com>,
Sean Anderson <sean.anderson@seco.com>,
U-Boot Mailing List <u-boot@lists.denx.de>
Subject: Re: [PATCH 22/45] image: Move comment for fit_conf_find_compat()
Date: Mon, 26 Sep 2022 08:54:18 +0200 [thread overview]
Message-ID: <acd7e4f0-2d72-7388-721a-78176fa765d3@gmx.de> (raw)
In-Reply-To: <20220925150248.2524421-23-sjg@chromium.org>
On 9/25/22 17:02, Simon Glass wrote:
> Move this comment to the header file, where the APIs should be defined.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> boot/image-fit.c | 43 -------------------------------------------
> include/image.h | 43 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 43 insertions(+), 43 deletions(-)
>
> diff --git a/boot/image-fit.c b/boot/image-fit.c
> index a7acd762272..94074515258 100644
> --- a/boot/image-fit.c
> +++ b/boot/image-fit.c
> @@ -1687,49 +1687,6 @@ int fit_check_format(const void *fit, ulong size)
> return 0;
> }
>
> -/**
> - * fit_conf_find_compat
> - * @fit: pointer to the FIT format image header
> - * @fdt: pointer to the device tree to compare against
> - *
> - * fit_conf_find_compat() attempts to find the configuration whose fdt is the
> - * most compatible with the passed in device tree.
> - *
> - * Example:
> - *
> - * / o image-tree
> - * |-o images
> - * | |-o fdt-1
> - * | |-o fdt-2
> - * |
> - * |-o configurations
> - * |-o config-1
> - * | |-fdt = fdt-1
> - * |
> - * |-o config-2
> - * |-fdt = fdt-2
> - *
> - * / o U-Boot fdt
> - * |-compatible = "foo,bar", "bim,bam"
> - *
> - * / o kernel fdt1
> - * |-compatible = "foo,bar",
> - *
> - * / o kernel fdt2
> - * |-compatible = "bim,bam", "baz,biz"
> - *
> - * Configuration 1 would be picked because the first string in U-Boot's
> - * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
> - * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
> - *
> - * As an optimization, the compatible property from the FDT's root node can be
> - * copied into the configuration node in the FIT image. This is required to
> - * match configurations with compressed FDTs.
> - *
> - * returns:
> - * offset to the configuration to use if one was found
> - * -1 otherwise
> - */
> int fit_conf_find_compat(const void *fit, const void *fdt > {
> int ndepth = 0;
> diff --git a/include/image.h b/include/image.h
> index b336cfa0842..ca1c6c5b3c2 100644
> --- a/include/image.h
> +++ b/include/image.h
> @@ -1136,6 +1136,49 @@ int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
> */
> int fit_check_format(const void *fit, ulong size);
>
> +/**
> + * fit_conf_find_compat
Please, adjust to style defined in
https://docs.kernel.org/doc-guide/kernel-doc.html#function-documentation:
fit_conf_find_compat() - Brief description
> + * @fit: pointer to the FIT format image header
> + * @fdt: pointer to the device tree to compare against
> + *
> + * fit_conf_find_compat() attempts to find the configuration whose fdt is the
> + * most compatible with the passed in device tree.
> + *
> + * Example:
> + *
> + * / o image-tree
> + * |-o images
> + * | |-o fdt-1
> + * | |-o fdt-2
> + * |
> + * |-o configurations
> + * |-o config-1
> + * | |-fdt = fdt-1
> + * |
> + * |-o config-2
> + * |-fdt = fdt-2
> + *
> + * / o U-Boot fdt
> + * |-compatible = "foo,bar", "bim,bam"
> + *
> + * / o kernel fdt1
> + * |-compatible = "foo,bar",
> + *
> + * / o kernel fdt2
> + * |-compatible = "bim,bam", "baz,biz"
Preformatted text should be indented and preceded by ::.
> + *
> + * Configuration 1 would be picked because the first string in U-Boot's
> + * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
> + * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
> + *
> + * As an optimization, the compatible property from the FDT's root node can be
> + * copied into the configuration node in the FIT image. This is required to
> + * match configurations with compressed FDTs.
> + *
> + * returns:
Return:
Best regards
Heinrich
> + * offset to the configuration to use if one was found
> + * -1 otherwise
> + */
> int fit_conf_find_compat(const void *fit, const void *fdt);
>
> /**
next prev parent reply other threads:[~2022-09-26 6:54 UTC|newest]
Thread overview: 72+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-25 15:02 [PATCH 00/45] vbe: Implement the full firmware flow Simon Glass
2022-09-25 15:02 ` [PATCH 01/45] Rename CONFIG_SYS_TEXT_BASE to CONFIG_TEXT_BASE Simon Glass
2022-09-25 15:02 ` [PATCH 02/45] disk: Drop debug messages in part_efi Simon Glass
2022-09-26 6:11 ` Heinrich Schuchardt
2022-09-25 15:02 ` [PATCH 03/45] bloblist: Drop debugging Simon Glass
2022-09-25 15:02 ` [PATCH 04/45] rsa: Avoid warning in padding_pss_verify() Simon Glass
2022-09-26 6:23 ` Heinrich Schuchardt
2022-09-25 15:02 ` [PATCH 05/45] spl: Use binman suffix allow symbols of any SPL etype Simon Glass
2022-09-25 15:02 ` [PATCH 06/45] spl: Split up the board_init_r() function Simon Glass
2022-09-25 15:02 ` [PATCH 07/45] spl: Refactor controls for console output Simon Glass
2022-09-29 15:16 ` Tom Rini
2022-09-25 15:02 ` [PATCH 08/45] spl: Add a separate silence option for SPL Simon Glass
2022-09-25 15:02 ` [PATCH 09/45] CI: Install pyelftools for builds Simon Glass
2022-09-26 6:29 ` Heinrich Schuchardt
2022-09-28 10:20 ` Simon Glass
2022-09-29 15:05 ` Tom Rini
2022-09-29 23:55 ` Simon Glass
2022-09-30 12:56 ` Tom Rini
2022-09-30 13:28 ` Simon Glass
2022-09-25 15:02 ` [PATCH 10/45] binman: Allow obtaining a symbol value Simon Glass
2022-09-25 15:02 ` [PATCH 11/45] binman: Split out looking up a symbol into a function Simon Glass
2022-09-25 15:02 ` [PATCH 12/45] binman: Handle writing ELF symbols in the Entry class Simon Glass
2022-09-25 15:02 ` [PATCH 13/45] binman: Support writing symbols into ELF files Simon Glass
2022-09-25 15:02 ` [PATCH 14/45] dm: blk: Add udevice functions Simon Glass
2022-09-26 0:17 ` AKASHI Takahiro
2022-09-28 10:20 ` Simon Glass
2022-09-29 0:51 ` AKASHI Takahiro
2022-09-29 2:35 ` Simon Glass
2022-09-30 1:54 ` AKASHI Takahiro
2022-09-25 15:02 ` [PATCH 15/45] dm: usb: Update the test to cover reading and writing Simon Glass
2022-09-25 15:02 ` [PATCH 16/45] dm: blk: mmc: Tidy up some Makefile rules for SPL Simon Glass
2022-09-25 15:02 ` [PATCH 17/45] dm: mmc: Allow sandbox emulator to build without writes Simon Glass
2022-09-25 15:02 ` [PATCH 18/45] sandbox: Drop message about writing sandbox state Simon Glass
2022-09-26 6:31 ` Heinrich Schuchardt
2022-09-25 15:02 ` [PATCH 19/45] sandbox: Generalise SPL booting Simon Glass
2022-09-25 15:02 ` [PATCH 20/45] sandbox: Add a way to specify the sandbox executable Simon Glass
2022-09-26 6:49 ` Heinrich Schuchardt
2022-11-07 23:35 ` Simon Glass
2022-09-25 15:02 ` [PATCH 21/45] bootstd: Add a way to set up a bootflow Simon Glass
2022-09-25 15:02 ` [PATCH 22/45] image: Move comment for fit_conf_find_compat() Simon Glass
2022-09-26 6:54 ` Heinrich Schuchardt [this message]
2022-09-25 15:02 ` [PATCH 23/45] test: Report skippped tests Simon Glass
2022-09-25 15:02 ` [PATCH 24/45] test: Update tests to use the skip feature Simon Glass
2022-09-25 15:02 ` [PATCH 25/45] test: Support tests which can only be run manually Simon Glass
2022-09-26 6:56 ` Heinrich Schuchardt
2022-09-28 10:20 ` Simon Glass
2022-09-25 15:02 ` [PATCH 26/45] image: Add the concept of a phase to FIT Simon Glass
2022-09-25 15:02 ` [PATCH 27/45] image: Allow loading a FIT config for a particular phase Simon Glass
2022-09-25 15:02 ` [PATCH 28/45] image: Correct strncpy() warning with image_set_name() Simon Glass
2022-09-25 15:02 ` [PATCH 29/45] vbe: Rename vbe_fixup to vbe_request Simon Glass
2022-09-25 15:02 ` [PATCH 30/45] vbe: Use a warning for a failed requests Simon Glass
2022-09-25 15:02 ` [PATCH 31/45] spl: Allow multiple loaders of the same type Simon Glass
2022-09-30 16:28 ` Tom Rini
2022-09-30 16:37 ` Simon Glass
2022-09-30 16:39 ` Tom Rini
2022-09-30 16:45 ` Simon Glass
2022-09-30 16:50 ` Tom Rini
2022-09-30 16:55 ` Simon Glass
2022-09-25 15:02 ` [PATCH 32/45] sandbox: Support obtaining the next phase from an image Simon Glass
2022-09-25 15:02 ` [PATCH 33/45] vbe: Support selecting operations by SPL phase Simon Glass
2022-09-25 15:02 ` [PATCH 34/45] vbe: Support reading the next SPL phase via VBE Simon Glass
2022-09-25 15:02 ` [PATCH 35/45] vbe: Move OS implementation into a separate file Simon Glass
2022-09-25 15:02 ` [PATCH 36/45] vbe: Drop the U-Boot prefix from the version Simon Glass
2022-09-25 15:02 ` [PATCH 37/45] vbe: Add Kconfig options for VPL Simon Glass
2022-09-25 15:02 ` [PATCH 38/45] vbe: Add info about the VBE device to the fwupd node Simon Glass
2022-09-25 15:02 ` [PATCH 39/45] sandbox: Add a binman image for VPL Simon Glass
2022-09-25 15:02 ` [PATCH 40/45] vbe: Correct pylint warnings in test_vbe Simon Glass
2022-09-25 15:02 ` [PATCH 41/45] vbe: Use a manual test Simon Glass
2022-09-25 15:02 ` [PATCH 42/45] vbe: Record which phases loaded using VBE Simon Glass
2022-09-25 15:02 ` [PATCH 43/45] vbe: Add docs and a test for the VBE command Simon Glass
2022-09-25 15:02 ` [PATCH 44/45] vbe: Add a subcommand to show the VBE state Simon Glass
2022-09-25 15:02 ` [PATCH 45/45] vbe: Add a test for the VBE flow into U-Boot proper 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=acd7e4f0-2d72-7388-721a-78176fa765d3@gmx.de \
--to=xypron.glpk@gmx.de \
--cc=andre.przywara@arm.com \
--cc=chiawei_wang@aspeedtech.com \
--cc=jan.kiszka@siemens.com \
--cc=joe.hershberger@ni.com \
--cc=joel@jms.id.au \
--cc=marex@denx.de \
--cc=mr.nuke.me@gmail.com \
--cc=philippe.reynes@softathome.com \
--cc=sean.anderson@seco.com \
--cc=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=u-boot@lists.denx.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).