Merge https://gitlab.denx.de/u-boot/custodians/u-boot-spi into next
[platform/kernel/u-boot.git] / doc / README.nokia_rx51
1 Board: Nokia RX-51 aka N900
2
3 This board definition results in a u-boot.bin which can be chainloaded
4 from NOLO in qemu or on a real N900. It does very little hardware config
5 because NOLO has already configured the board. Only needed is enabling
6 internal eMMC memory via twl4030 regulator which is not enabled by NOLO.
7
8 NOLO is expecting a kernel image and will treat any image it finds in
9 onenand as such. This u-boot is intended to be flashed to the N900 like
10 a kernel. In order to transparently boot the original kernel, it will be
11 appended to u-boot.bin at 0x40000. NOLO will load the entire image into
12 (random) memory and execute u-boot, which saves hw revision, boot reason
13 and boot mode ATAGs set by NOLO. Then the bootscripts will attempt to load
14 uImage or boot.scr from a fat, ext2/ext3 or ext4 filesystem in external
15 SD card or internal eMMC memory. If this fails or keyboard is closed then
16 the appended kernel image will be booted using some generated and some
17 stored ATAGs (see boot order).
18
19 For generating combined image of u-boot and kernel there is a simple script
20 called u-boot-gen-combined. It is available in following repository:
21
22   https://github.com/pali/u-boot-maemo
23
24 There is support for hardware watchdog. Hardware watchdog is started by
25 NOLO so u-boot must kick watchdog to prevent reboot device (but not very
26 often, max every 2 seconds). There is also support for framebuffer display
27 output with ANSI escape codes and the N900 HW keyboard input. USB tty works
28 but is disabled because it prevents the current Maemo kernel from booting.
29
30 When U-Boot is starting it enable IBE bit in Auxiliary Control Register,
31 which is needed for Thumb-2 ISA support. It is workaround for errata 430973.
32
33 Default boot order:
34
35  * 0. if keyboard is closed boot automatically attached kernel image
36  * 1. try boot from external SD card
37  * 2. try boot from internal eMMC memory
38  * 3. try boot from attached kernel image
39
40 Boot from SD or eMMC in this order:
41
42  * 1.
43    * 1.1 find boot.scr on first fat partition
44    * 1.2 find uImage on first fat partition
45    * 1.3 same order for 2. - 4. fat partition
46  * 2. same as 1. but for ext2/3 partition
47  * 3. same as 1. but for ext4 partition
48
49
50 Available additional commands/variables:
51
52  * run sercon - Use serial port for control
53  * run usbcon - Use usbtty for control
54  * run vgacon - Use framebuffer and HW keyboard for control (default)
55
56  * run sdboot - Boot from external SD card (see boot order)
57  * run emmcboot - Boot from internal eMMC memory (see boot order)
58  * run attachboot - Boot attached kernel image (attached to U-Boot binary)
59
60  * run scriptload - Load boot script ${mmcscriptfile}
61  * run scriptboot - Run loaded boot script
62  * run kernload - Load kernel image ${mmckernfile}
63  * run initrdload - Load initrd image ${mmcinitrdfile}
64  * run kernboot - Boot loaded kernel image
65  * run kerninitrdboot - Boot loaded kernel image with loaded initrd image
66
67  * run trymmcscriptboot - Try to load and boot script ${mmcscriptfile}
68  * run trymmckernboot - Try to load and boot kernel image ${mmckernfile}
69  * run trymmckerninitrdboot - Try to load and boot kernel image ${mmckernfile}
70                               with initrd image ${mmcinitrdfile}
71
72 Additional variables for loading files from mmc:
73
74  * mmc ${mmcnum} (0 - external, 1 - internal)
75  * partition number ${mmcpart} (1 - 4)
76  * parition type ${mmctype} (fat, ext2, ext4)
77
78 Additional variables for booting kernel:
79
80  * setup_omap_atag - Add OMAP table into atags structure (needs maemo kernel)
81  * setup_console_atag - Enable serial console in OMAP table
82  * setup_boot_reason_atag - Change boot reason in OMAP table
83  * setup_boot_mode_atag - Change boot mode in OMAP table
84
85  Variable setup_omap_atag is automatically set when booting attached kernel.
86  When variable setup_omap_atag is set, variable setup_console_atag is unset
87  and u-boot standard output is set to serial then setup_console_atag is
88  automatically set to 1. So output from Maemo kernel would go to serial port.
89
90 USB TTY:
91
92  Maemo kernel 2.6.28 will crash if u-boot enable usb tty. So USB TTY is disabled.
93  For enabling USB TTY just add this line to file include/configs/nokia_rx51.h
94
95  #define CONFIG_USB_TTY
96
97
98 UBIFS support:
99
100  UBIFS support is disabled, because U-Boot image is too big and cannot be
101  flashed with attached zImage to RX-51 kernel nand area. For enabling UBIFS
102  support add following lines into file configs/nokia_rx51_defconfig
103
104  CONFIG_CMD_UBI=y
105  CONFIG_CMD_UBIFS=y
106  CONFIG_MTD_UBI_FASTMAP=y
107  CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT=1