[PATCH v3 8/9] fdt: update the document and Kconfig description

[Simon Glass]

Hi Raymond,

On Fri, Dec 22, 2023 at 9:32 PM Raymond Mao <raymond.mao at linaro.org> wrote:
>
> Update the document and Kconfig to describe the behavior of board
> specific custom functions when CONFIG_OF_BOARD is defined.
>
> Signed-off-by: Raymond Mao <raymond.mao at linaro.org>
> ---
>  doc/develop/devicetree/control.rst | 6 +++---
>  dts/Kconfig                        | 7 +++++--
>  2 files changed, 8 insertions(+), 5 deletions(-)
>
> diff --git a/doc/develop/devicetree/control.rst b/doc/develop/devicetree/control.rst
> index cbb65c9b17..e061f4e812 100644
> --- a/doc/develop/devicetree/control.rst
> +++ b/doc/develop/devicetree/control.rst
> @@ -104,9 +104,9 @@ in u-boot.bin so you can still just flash u-boot.bin onto your board. If you are
>  using CONFIG_SPL_FRAMEWORK, then u-boot.img will be built to include the device
>  tree binary.
>
> -If CONFIG_OF_BOARD is defined, a board-specific routine will provide the
> -devicetree at runtime, for example if an earlier bootloader stage creates
> -it and passes it to U-Boot.
> +If CONFIG_OF_BOARD is defined, board-specific routines will provide the
> +bloblist and devicetree at runtime, for example if an earlier bootloader stage
> +creates it and passes it to U-Boot.
>
>  If CONFIG_SANDBOX is defined, then it will be read from a file on
>  startup. Use the -d flag to U-Boot to specify the file to read, -D for the
> diff --git a/dts/Kconfig b/dts/Kconfig
> index 00c0aeff89..12d61dc748 100644
> --- a/dts/Kconfig
> +++ b/dts/Kconfig
> @@ -110,8 +110,11 @@ config OF_BOARD
>         default y if SANDBOX || OF_HAS_PRIOR_STAGE
>         help
>           If this option is enabled, the device tree is provided at runtime by
> -         a custom function called board_fdt_blob_setup(). The board must
> -         implement this function if it wishes to provide special behaviour.
> +         a custom function called board_fdt_blob_setup().
> +         If this option is enabled, bloblist is provided at runtime by a
> +         custom function called board_bloblist_from_boot_arg().
> +         The board must implement these functions if it wishes to provide
> +         special behaviour.

Again, this spec is not board-specific, so it should work on any ARM
board, without board-specific code, just by enabling the feature.

>
>           With this option, the device tree build by U-Boot may be overridden or
>           ignored. See OF_HAS_PRIOR_STAGE.
> --
> 2.25.1
>

Regards,
SImon