xref: /openbmc/u-boot/doc/README.splashprepare (revision f253f2933b7373556329c0174dd5b101039a4056)
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.
9f82eb2faSNikita Kiryanov
10f82eb2faSNikita KiryanovCONFIG_SPLASH_SOURCE
11f82eb2faSNikita Kiryanov
12f82eb2faSNikita KiryanovUse the splash_source.c library. This library provides facilities to declare
13f82eb2faSNikita Kiryanovboard specific splash image locations, routines for loading splash image from
14f82eb2faSNikita Kiryanovsupported locations, and a way of controlling the selected splash location
15f82eb2faSNikita Kiryanovusing the "splashsource" environment variable.
16f82eb2faSNikita Kiryanov
17f82eb2faSNikita Kiryanovsplashsource works as follows:
18f82eb2faSNikita Kiryanov- If splashsource is set to a supported location name as defined by board code,
19f82eb2faSNikita Kiryanov  use that splash location.
20f82eb2faSNikita Kiryanov- If splashsource is undefined, use the first splash location as default.
21f82eb2faSNikita Kiryanov- If splashsource is set to an unsupported value, do not load a splash screen.
22870dd309SNikita Kiryanov
23*db1b79b8Stomas.melin@vaisala.comA splash source location can describe either storage with raw data, a storage
24*db1b79b8Stomas.melin@vaisala.comformatted with a file system or a FIT image. In case of a filesystem, the splash
25*db1b79b8Stomas.melin@vaisala.comscreen data is loaded as a file. The name of the splash screen file can be
26*db1b79b8Stomas.melin@vaisala.comcontrolled with the environment variable "splashfile".
27*db1b79b8Stomas.melin@vaisala.com
28*db1b79b8Stomas.melin@vaisala.comTo enable loading the splash image from a FIT image, CONFIG_FIT must be
29*db1b79b8Stomas.melin@vaisala.comenabled. Struct splash_location field 'name' should match the splash image
30*db1b79b8Stomas.melin@vaisala.comname within the FIT and the FIT should start at the 'offset' field address in
31*db1b79b8Stomas.melin@vaisala.comthe specified storage.
32