Convert the existing doc/README.splashprepare file to reStructuredText format and integrate it into the documentation tree.
Signed-off-by: David Lechner <[email protected]> --- common/splash.c | 2 +- doc/README.splashprepare | 34 ---------------------------------- doc/develop/index.rst | 1 + doc/develop/splash.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 43 insertions(+), 35 deletions(-) diff --git a/common/splash.c b/common/splash.c index c5591293634..8cc9e28ccdf 100644 --- a/common/splash.c +++ b/common/splash.c @@ -156,7 +156,7 @@ void splash_display_banner(void) /* * Common function to show a splash image if env("splashimage") is set. - * For additional details please refer to doc/README.splashprepare. + * For additional details please refer to doc/develop/splash.rst. */ int splash_display(void) { diff --git a/doc/README.splashprepare b/doc/README.splashprepare deleted file mode 100644 index 3cb5b5aeb48..00000000000 --- a/doc/README.splashprepare +++ /dev/null @@ -1,34 +0,0 @@ ---------------------------------------------------------------------- -Splash Screen ---------------------------------------------------------------------- -The splash_screen_prepare() function is a weak function defined in -common/splash.c. It is called as part of the splash screen display -sequence. It gives the board an opportunity to prepare the splash -image data before it is processed and sent to the frame buffer by -U-Boot. Define your own version to use this feature. - -CONFIG_SPLASH_SOURCE - -Use the splash_source.c library. This library provides facilities to declare -board specific splash image locations, routines for loading splash image from -supported locations, and a way of controlling the selected splash location -using the "splashsource" environment variable. - -splashsource works as follows: -- If splashsource is set to a supported location name as defined by board code, - use that splash location. -- If splashsource is undefined, use the first splash location as default. -- If splashsource is set to an unsupported value, do not load a splash screen. - -A splash source location can describe either storage with raw data, a storage -formatted with a file system or a FIT image. In case of a filesystem, the splash -screen data is loaded as a file. The name of the splash screen file can be -controlled with the environment variable "splashfile". - -To enable loading the splash image from a FIT image, CONFIG_FIT must be -enabled. The FIT image has to start at the 'offset' field address in the -selected splash location. The name of splash image within the FIT shall be -specified by the environment variable "splashfile". - -In case the environment variable "splashfile" is not defined the default name -'splash.bmp' will be used. diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 0b757e8601e..2d8bf6a4f71 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -53,6 +53,7 @@ Implementation printf smbios spl + splash falcon uefi/index vbe diff --git a/doc/develop/splash.rst b/doc/develop/splash.rst new file mode 100644 index 00000000000..8b8d9d3a8c4 --- /dev/null +++ b/doc/develop/splash.rst @@ -0,0 +1,41 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Splash screen +============= + +Preparing the splash image +-------------------------- + +The splash_screen_prepare() function is a weak function defined in +``common/splash.c``. It is called as part of the splash screen display sequence. +It gives the board an opportunity to prepare the splash image data before it is +processed and sent to the frame buffer by U-Boot. Define your own version to use +this feature. + +Selecting the splash image source +--------------------------------- + +CONFIG_SPLASH_SOURCE enables the splash_source.c library. This library provides +facilities to declare board specific splash image locations, routines for +loading a splash image from supported locations, and a way of controlling the +selected splash location using the *splashsource* environment variable. + +*splashsource* works as follows: + +* If *splashsource* is set to a supported location name as defined by board + code, use that splash location. +* If *splashsource* is undefined, use the first splash location as default. +* If *splashsource* is set to an unsupported value, do not load a splash screen. + +A splash source location can describe either storage with raw data, a storage +formatted with a file system or a FIT image. In case of a filesystem, the splash +screen data is loaded as a file. The name of the splash screen file can be +controlled with the environment variable *splashfile*. + +To enable loading the splash image from a FIT image, CONFIG_FIT must be enabled. +The FIT image has to start at the 'offset' field address in the selected splash +location. The name of the splash image within the FIT shall be specified by the +environment variable *splashfile*. + +In case the environment variable *splashfile* is not defined the default name +``splash.bmp`` will be used. -- 2.43.0
