| Robert Winkler | 8571c6c | 2013-06-17 11:31:30 -0700 | [diff] [blame] | 1 | --------------------------------------------------------------------- |
| 2 | Splash Screen |
| 3 | --------------------------------------------------------------------- |
| 4 | The splash_screen_prepare() function is a weak function defined in |
| 5 | common/splash.c. It is called as part of the splash screen display |
| 6 | sequence. It gives the board an opportunity to prepare the splash |
| 7 | image data before it is processed and sent to the frame buffer by |
| tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 8 | U-Boot. Define your own version to use this feature. |
| Nikita Kiryanov | 7f9ceea | 2015-01-14 10:42:54 +0200 | [diff] [blame] | 9 | |
| 10 | CONFIG_SPLASH_SOURCE |
| 11 | |
| 12 | Use the splash_source.c library. This library provides facilities to declare |
| 13 | board specific splash image locations, routines for loading splash image from |
| 14 | supported locations, and a way of controlling the selected splash location |
| 15 | using the "splashsource" environment variable. |
| 16 | |
| 17 | splashsource works as follows: |
| 18 | - If splashsource is set to a supported location name as defined by board code, |
| 19 | use that splash location. |
| 20 | - If splashsource is undefined, use the first splash location as default. |
| 21 | - If splashsource is set to an unsupported value, do not load a splash screen. |
| Nikita Kiryanov | 7428271 | 2015-10-29 11:54:41 +0200 | [diff] [blame] | 22 | |
| tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 23 | A splash source location can describe either storage with raw data, a storage |
| 24 | formatted with a file system or a FIT image. In case of a filesystem, the splash |
| 25 | screen data is loaded as a file. The name of the splash screen file can be |
| 26 | controlled with the environment variable "splashfile". |
| 27 | |
| 28 | To enable loading the splash image from a FIT image, CONFIG_FIT must be |
| Leo Ruan | e9b74d9 | 2019-02-08 10:51:35 +0100 | [diff] [blame] | 29 | enabled. The FIT image has to start at the 'offset' field address in the |
| 30 | selected splash location. The name of splash image within the FIT shall be |
| 31 | specified by the environment variable "splashfile". |
| 32 | |
| 33 | In case the environment variable "splashfile" is not defined the default name |
| 34 | 'splash.bmp' will be used. |