Blame view
doc/README.SPL
3.87 KB
6a11cf48a spl: add initial ... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
Generic SPL framework ===================== Overview -------- To unify all existing implementations for a secondary program loader (SPL) and to allow simply adding of new implementations this generic SPL framework has been created. With this framework almost all source files for a board can be reused. No code duplication or symlinking is necessary anymore. How it works ------------ There is a new directory TOPDIR/spl which contains only a Makefile. The object files are built separately for SPL and placed in this directory. The final binaries which are generated are u-boot-spl, u-boot-spl.bin and u-boot-spl.map. During the SPL build a variable named CONFIG_SPL_BUILD is exported in the make environment and also appended to CPPFLAGS with -DCONFIG_SPL_BUILD. Source files can therefore be compiled for SPL with different settings. ARM-based boards have previously used the option CONFIG_PRELOADER for it. For example: ifeq ($(CONFIG_SPL_BUILD),y) COBJS-y += board_spl.o else COBJS-y += board.o endif COBJS-$(CONFIG_SPL_BUILD) += foo.o #ifdef CONFIG_SPL_BUILD |
04e5ae793 Minor coding styl... |
37 |
foo(); |
6a11cf48a spl: add initial ... |
38 39 40 41 42 43 |
#endif The building of SPL images can be with: #define CONFIG_SPL |
fd3d28e7a doc: fix typos |
44 45 |
Because SPL images normally have a different text base, one has to be configured by defining CONFIG_SPL_TEXT_BASE. The linker script has to be |
6a11cf48a spl: add initial ... |
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
defined with CONFIG_SPL_LDSCRIPT. To support generic U-Boot libraries and drivers in the SPL binary one can optionally define CONFIG_SPL_XXX_SUPPORT. Currently following options are supported: CONFIG_SPL_LIBCOMMON_SUPPORT (common/libcommon.o) CONFIG_SPL_LIBDISK_SUPPORT (disk/libdisk.o) CONFIG_SPL_I2C_SUPPORT (drivers/i2c/libi2c.o) CONFIG_SPL_GPIO_SUPPORT (drivers/gpio/libgpio.o) CONFIG_SPL_MMC_SUPPORT (drivers/mmc/libmmc.o) CONFIG_SPL_SERIAL_SUPPORT (drivers/serial/libserial.o) CONFIG_SPL_SPI_FLASH_SUPPORT (drivers/mtd/spi/libspi_flash.o) CONFIG_SPL_SPI_SUPPORT (drivers/spi/libspi.o) CONFIG_SPL_FAT_SUPPORT (fs/fat/libfat.o) CONFIG_SPL_LIBGENERIC_SUPPORT (lib/libgeneric.o) |
682b3a81e spl: Add POWER li... |
62 |
CONFIG_SPL_POWER_SUPPORT (drivers/power/libpower.o) |
12c2f1ee3 spl: add NAND Lib... |
63 |
CONFIG_SPL_NAND_SUPPORT (drivers/mtd/nand/libnand.o) |
6609916ef powerpc:mpc85xx: ... |
64 |
CONFIG_SPL_DRIVERS_MISC_SUPPORT (drivers/misc) |
3a0d60c50 SPL: Add DMA library |
65 |
CONFIG_SPL_DMA_SUPPORT (drivers/dma/libdma.o) |
18e8ff18f spl: add option f... |
66 |
CONFIG_SPL_POST_MEM_SUPPORT (post/drivers/memory.o) |
435199f38 arm, davinci: add... |
67 |
CONFIG_SPL_NAND_LOAD (drivers/mtd/nand/nand_spl_load.o) |
32b112739 sf: Add spi_boot(... |
68 |
CONFIG_SPL_SPI_LOAD (drivers/mtd/spi/spi_spl_load.o) |
c57b953da SPL: Add support ... |
69 |
CONFIG_SPL_RAM_DEVICE (common/spl/spl.c) |
a09f96498 arm, spl: add wat... |
70 |
CONFIG_SPL_WATCHDOG_SUPPORT (drivers/watchdog/libwatchdog.o) |
d22650afa mkconfig: add sup... |
71 72 73 74 75 76 77 78 |
Normally CPU is assumed to be the same between the SPL and normal u-boot build. However it is possible to specify a different CPU for the SPL build for cases where the SPL is expected to run on a different CPU model from the main u-boot. This is done by specifying an SPL CPU in boards.cfg as follows: normal_cpu:spl_cpu |
a544eaddc cosmetic: README.... |
79 |
This case CPU will be set to "normal_cpu" during the main u-boot |
d22650afa mkconfig: add sup... |
80 |
build and "spl_cpu" during the SPL build. |
f8e754d51 README.SPL: Add a... |
81 82 83 84 85 86 87 |
Debugging --------- When building SPL with DEBUG set you may also need to set CONFIG_PANIC_HANG as in most cases do_reset is not defined within SPL. |
c3567d808 README.SPL: Move ... |
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
Estimating stack usage ---------------------- With gcc 4.6 (and later) and the use of GNU cflow it is possible to estimate stack usage at various points in run sequence of SPL. The -fstack-usage option to gcc will produce '.su' files (such as arch/arm/cpu/armv7/syslib.su) that will give stack usage information and cflow can construct program flow. Must have gcc 4.6 or later, which supports -fstack-usage 1) Build normally 2) Perform the following shell command to generate a list of C files used in SPL: $ find spl -name '*.su' | sed -e 's:^spl/::' -e 's:[.]su$:.c:' > used-spl.list 3) Execute cflow: $ cflow --main=board_init_r `cat used-spl.list` 2>&1 | $PAGER cflow will spit out a number of warnings as it does not parse the config files and picks functions based on #ifdef. Parsing the '.i' files instead introduces another set of headaches. These warnings are not usually important to understanding the flow, however. |