xref: /openbmc/u-boot/doc/README.splashprepare (revision f82eb2fa5df86b7180ea355a3cb98482f7c27269)
159b15922SRobert Winkler---------------------------------------------------------------------
259b15922SRobert WinklerSplash Screen
359b15922SRobert Winkler---------------------------------------------------------------------
459b15922SRobert WinklerThe splash_screen_prepare() function is a weak function defined in
559b15922SRobert Winklercommon/splash.c. It is called as part of the splash screen display
659b15922SRobert Winklersequence. It gives the board an opportunity to prepare the splash
759b15922SRobert Winklerimage data before it is processed and sent to the frame buffer by
859b15922SRobert WinklerU-Boot.  Define your own version to use this feature.
9*f82eb2faSNikita Kiryanov
10*f82eb2faSNikita KiryanovCONFIG_SPLASH_SOURCE
11*f82eb2faSNikita Kiryanov
12*f82eb2faSNikita KiryanovUse the splash_source.c library. This library provides facilities to declare
13*f82eb2faSNikita Kiryanovboard specific splash image locations, routines for loading splash image from
14*f82eb2faSNikita Kiryanovsupported locations, and a way of controlling the selected splash location
15*f82eb2faSNikita Kiryanovusing the "splashsource" environment variable.
16*f82eb2faSNikita Kiryanov
17*f82eb2faSNikita Kiryanovsplashsource works as follows:
18*f82eb2faSNikita Kiryanov- If splashsource is set to a supported location name as defined by board code,
19*f82eb2faSNikita Kiryanov  use that splash location.
20*f82eb2faSNikita Kiryanov- If splashsource is undefined, use the first splash location as default.
21*f82eb2faSNikita Kiryanov- If splashsource is set to an unsupported value, do not load a splash screen.
22