README.falcon 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. U-Boot Falcon Mode
  2. ====================
  3. Introduction
  4. ------------
  5. This document provides an overview of how to add support for Falcon Mode
  6. to a board.
  7. Falcon Mode is introduced to speed up the booting process, allowing
  8. to boot a Linux kernel (or whatever image) without a full blown U-Boot.
  9. Falcon Mode relies on the SPL framework. In fact, to make booting faster,
  10. U-Boot is split into two parts: the SPL (Secondary Program Loader) and U-Boot
  11. image. In most implementations, SPL is used to start U-Boot when booting from
  12. a mass storage, such as NAND or SD-Card. SPL has now support for other media,
  13. and can generally be seen as a way to start an image performing the minimum
  14. required initialization. SPL mainly initializes the RAM controller, and then
  15. copies U-Boot image into the memory.
  16. The Falcon Mode extends this way allowing to start the Linux kernel directly
  17. from SPL. A new command is added to U-Boot to prepare the parameters that SPL
  18. must pass to the kernel, using ATAGS or Device Tree.
  19. In normal mode, these parameters are generated each time before
  20. loading the kernel, passing to Linux the address in memory where
  21. the parameters can be read.
  22. With Falcon Mode, this snapshot can be saved into persistent storage and SPL is
  23. informed to load it before running the kernel.
  24. To boot the kernel, these steps under a Falcon-aware U-Boot are required:
  25. 1. Boot the board into U-Boot.
  26. After loading the desired legacy-format kernel image into memory (and DT as
  27. well, if used), use the "spl export" command to generate the kernel parameters
  28. area or the DT. U-Boot runs as when it boots the kernel, but stops before
  29. passing the control to the kernel.
  30. 2. Save the prepared snapshot into persistent media.
  31. The address where to save it must be configured into board configuration
  32. file (CONFIG_CMD_SPL_NAND_OFS for NAND).
  33. 3. Boot the board into Falcon Mode. SPL will load the kernel and copy
  34. the parameters which are saved in the persistent area to the required address.
  35. If a valid uImage is not found at the defined location, U-Boot will be
  36. booted instead.
  37. It is required to implement a custom mechanism to select if SPL loads U-Boot
  38. or another image.
  39. The value of a GPIO is a simple way to operate the selection, as well as
  40. reading a character from the SPL console if CONFIG_SPL_CONSOLE is set.
  41. Falcon Mode is generally activated by setting CONFIG_SPL_OS_BOOT. This tells
  42. SPL that U-Boot is not the only available image that SPL is able to start.
  43. Configuration
  44. ----------------------------
  45. CONFIG_CMD_SPL Enable the "spl export" command.
  46. The command "spl export" is then available in U-Boot
  47. mode
  48. CONFIG_SYS_SPL_ARGS_ADDR Address in RAM where the parameters must be
  49. copied by SPL.
  50. In most cases, it is <start_of_ram> + 0x100
  51. CONFIG_SYS_NAND_SPL_KERNEL_OFFS Offset in NAND where the kernel is stored
  52. CONFIG_CMD_SPL_NAND_OFS Offset in NAND where the parameters area was saved.
  53. CONFIG_CMD_SPL_WRITE_SIZE Size of the parameters area to be copied
  54. CONFIG_SPL_OS_BOOT Activate Falcon Mode.
  55. Function that a board must implement
  56. ------------------------------------
  57. void spl_board_prepare_for_linux(void) : optional
  58. Called from SPL before starting the kernel
  59. spl_start_uboot() : required
  60. Returns "0" if SPL should start the kernel, "1" if U-Boot
  61. must be started.
  62. Environment variables
  63. ---------------------
  64. A board may chose to look at the environment for decisions about falcon
  65. mode. In this case the following variables may be supported:
  66. boot_os : Set to yes/Yes/true/True/1 to enable booting to OS,
  67. any other value to fall back to U-Boot (including
  68. unset)
  69. falcon_args_file : Filename to load as the 'args' portion of falcon mode
  70. rather than the hard-coded value.
  71. falcon_image_file : Filename to load as the OS image portion of falcon
  72. mode rather than the hard-coded value.
  73. Using spl command
  74. -----------------
  75. spl - SPL configuration
  76. Usage:
  77. spl export <img=atags|fdt> [kernel_addr] [initrd_addr] [fdt_addr ]
  78. img : "atags" or "fdt"
  79. kernel_addr : kernel is loaded as part of the boot process, but it is not started.
  80. This is the address where a kernel image is stored.
  81. initrd_addr : Address of initial ramdisk
  82. can be set to "-" if fdt_addr without initrd_addr is used
  83. fdt_addr : in case of fdt, the address of the device tree.
  84. The spl export command does not write to a storage media. The user is
  85. responsible to transfer the gathered information (assembled ATAGS list
  86. or prepared FDT) from temporary storage in RAM into persistant storage
  87. after each run of 'spl export'. Unfortunately the position of temporary
  88. storage can not be predicted nor provided at commandline, it depends
  89. highly on your system setup and your provided data (ATAGS or FDT).
  90. However at the end of an succesful 'spl export' run it will print the
  91. RAM address of temporary storage. The RAM address of FDT will also be
  92. set in the environment variable 'fdtargsaddr', the new length of the
  93. prepared FDT will be set in the environment variable 'fdtargslen'.
  94. These environment variables can be used in scripts for writing updated
  95. FDT to persistent storage.
  96. Now the user have to save the generated BLOB from that printed address
  97. to the pre-defined address in persistent storage
  98. (CONFIG_CMD_SPL_NAND_OFS in case of NAND).
  99. The following example shows how to prepare the data for Falcon Mode on
  100. twister board with ATAGS BLOB.
  101. The "spl export" command is prepared to work with ATAGS and FDT. However,
  102. using FDT is at the moment untested. The ppc port (see a3m071 example
  103. later) prepares the fdt blob with the fdt command instead.
  104. Usage on the twister board:
  105. --------------------------------
  106. Using mtd names with the following (default) configuration
  107. for mtdparts:
  108. device nand0 <omap2-nand.0>, # parts = 9
  109. #: name size offset mask_flags
  110. 0: MLO 0x00080000 0x00000000 0
  111. 1: u-boot 0x00100000 0x00080000 0
  112. 2: env1 0x00040000 0x00180000 0
  113. 3: env2 0x00040000 0x001c0000 0
  114. 4: kernel 0x00600000 0x00200000 0
  115. 5: bootparms 0x00040000 0x00800000 0
  116. 6: splashimg 0x00200000 0x00840000 0
  117. 7: mini 0x02800000 0x00a40000 0
  118. 8: rootfs 0x1cdc0000 0x03240000 0
  119. twister => nand read 82000000 kernel
  120. NAND read: device 0 offset 0x200000, size 0x600000
  121. 6291456 bytes read: OK
  122. Now the kernel is in RAM at address 0x82000000
  123. twister => spl export atags 0x82000000
  124. ## Booting kernel from Legacy Image at 82000000 ...
  125. Image Name: Linux-3.5.0-rc4-14089-gda0b7f4
  126. Image Type: ARM Linux Kernel Image (uncompressed)
  127. Data Size: 3654808 Bytes = 3.5 MiB
  128. Load Address: 80008000
  129. Entry Point: 80008000
  130. Verifying Checksum ... OK
  131. Loading Kernel Image ... OK
  132. OK
  133. cmdline subcommand not supported
  134. bdt subcommand not supported
  135. Argument image is now in RAM at: 0x80000100
  136. The result can be checked at address 0x80000100:
  137. twister => md 0x80000100
  138. 80000100: 00000005 54410001 00000000 00000000 ......AT........
  139. 80000110: 00000000 00000067 54410009 746f6f72 ....g.....ATroot
  140. 80000120: 65642f3d 666e2f76 77722073 73666e20 =/dev/nfs rw nfs
  141. The parameters generated with this step can be saved into NAND at the offset
  142. 0x800000 (value for twister for CONFIG_CMD_SPL_NAND_OFS)
  143. nand erase.part bootparms
  144. nand write 0x80000100 bootparms 0x4000
  145. Now the parameters are stored into the NAND flash at the address
  146. CONFIG_CMD_SPL_NAND_OFS (=0x800000).
  147. Next time, the board can be started into Falcon Mode moving the
  148. setting the gpio (on twister gpio 55 is used) to kernel mode.
  149. The kernel is loaded directly by the SPL without passing through U-Boot.
  150. Example with FDT: a3m071 board
  151. -------------------------------
  152. To boot the Linux kernel from the SPL, the DT blob (fdt) needs to get
  153. prepard/patched first. U-Boot usually inserts some dynamic values into
  154. the DT binary (blob), e.g. autodetected memory size, MAC addresses,
  155. clocks speeds etc. To generate this patched DT blob, you can use
  156. the following command:
  157. 1. Load fdt blob to SDRAM:
  158. => tftp 1800000 a3m071/a3m071.dtb
  159. 2. Set bootargs as desired for Linux booting (e.g. flash_mtd):
  160. => run mtdargs addip2 addtty
  161. 3. Use "fdt" commands to patch the DT blob:
  162. => fdt addr 1800000
  163. => fdt boardsetup
  164. => fdt chosen
  165. 4. Display patched DT blob (optional):
  166. => fdt print
  167. 5. Save fdt to NOR flash:
  168. => erase fc060000 fc07ffff
  169. => cp.b 1800000 fc060000 10000
  170. ...
  171. Falcon Mode was presented at the RMLL 2012. Slides are available at:
  172. http://schedule2012.rmll.info/IMG/pdf/LSM2012_UbootFalconMode_Babic.pdf