xref: /openbmc/u-boot/board/ti/am335x/README (revision cb3761ea)
1Summary
2=======
3
4This document covers various features of the 'am335x_evm' build, and some of
5the related build targets (am335x_evm_uartN, etc).
6
7Hardware
8========
9
10The binary produced by this board supports, based on parsing of the EEPROM
11documented in TI's reference designs:
12- AM335x GP EVM
13- AM335x EVM SK
14- Beaglebone White
15- Beaglebone Black
16'
17NAND
18====
19
20The AM335x GP EVM ships with a 256MiB NAND available in most profiles.  In
21this example to program the NAND we assume that an SD card has been
22inserted with the files to write in the first SD slot and that mtdparts
23have been configured correctly for the board.  As a time saving measure we
24load MLO into memory in one location, copy it into the three locatations
25that the ROM checks for additional valid copies, then load U-Boot into
26memory.  We then write that whole section of memory to NAND.
27
28U-Boot # mmc rescan
29U-Boot # env default -f -a
30U-Boot # nand erase.chip
31U-Boot # saveenv
32U-Boot # load mmc 0 81000000 MLO
33U-Boot # cp.b 81000000 81020000 20000
34U-Boot # cp.b 81000000 81040000 20000
35U-Boot # cp.b 81000000 81060000 20000
36U-Boot # load mmc 0 81080000 u-boot.img
37U-Boot # nand write 81000000 0 260000
38U-Boot # load mmc 0 ${loadaddr} uImage
39U-Boot # nand write ${loadaddr} kernel 500000
40
41NOR
42===
43
44The Beaglebone White can be equiped with a "memory cape" that in turn can
45have a NOR module plugged into it.  In this case it is then possible to
46program and boot from NOR.  Note that due to how U-Boot is architectured we
47must build a specific version of U-Boot that knows we have NOR flash.  This
48build is named 'am335x_evm_nor'.  Further, we have a 'am335x_evm_norboot'
49build that will assume that the environment is on NOR rather than NAND.  In
50the following example we assume that and SD card has been populated with
51MLO and u-boot.img from a 'am335x_evm_nor' build and also contains the
52'u-boot.bin' from a 'am335x_evm_norboot' build.  When booting from NOR, a
53binary must be written to the start of NOR, with no header or similar
54prepended.  In the following example we use a size of 512KiB (0x80000)
55as that is how much space we set aside before the environment, as per
56the config file.
57
58U-Boot # mmc rescan
59U-Boot # load mmc 0 ${loadaddr} u-boot.bin
60U-Boot # protect off 08000000 +80000
61U-Boot # erase 08000000 +80000
62U-Boot # cp.b ${loadaddr} 08000000 ${filesize}
63
64Falcon Mode
65===========
66
67The default build includes "Falcon Mode" (see doc/README.falcon) via NAND,
68eMMC (or raw SD cards) and FAT SD cards.  Our default behavior currently is
69to read a 'c' on the console while in SPL at any point prior to loading the
70OS payload (so as soon as possible) to opt to booting full U-Boot.  Also
71note that while one can program Falcon Mode "in place" great care needs to
72be taken by the user to not 'brick' their setup.  As these are all eval
73boards with multiple boot methods, recovery should not be an issue in this
74worst-case however.
75
76Falcon Mode: eMMC
77=================
78
79The recommended layout in this case is:
80
81MMC BLOCKS      |--------------------------------| LOCATION IN BYTES
820x0000 - 0x007F : MBR or GPT table               : 0x000000 - 0x020000
830x0080 - 0x00FF : ARGS or FDT file               : 0x010000 - 0x020000
840x0100 - 0x01FF : SPL.backup1 (first copy used)  : 0x020000 - 0x040000
850x0200 - 0x02FF : SPL.backup2 (second copy used) : 0x040000 - 0x060000
860x0300 - 0x06FF : U-Boot                         : 0x060000 - 0x0e0000
870x0700 - 0x08FF : U-Boot Env + Redundant         : 0x0e0000 - 0x120000
880x0900 - 0x28FF : Kernel                         : 0x120000 - 0x520000
89
90Note that when we run 'spl export' it will prepare to boot the kernel.
91This includes relocation of the uImage from where we loaded it to the entry
92point defined in the header.  As these locations overlap by default, it
93would leave us with an image that if written to MMC will not boot, so
94instead of using the loadaddr variable we use 0x81000000 in the following
95example.  In this example we are loading from the network, for simplicity,
96and assume a valid partition table already exists and 'mmc dev' has already
97been run to select the correct device.  Also note that if you previously
98had a FAT partition (such as on a Beaglebone Black) it is not enough to
99write garbage into the area, you must delete it from the partition table
100first.
101
102# Ensure we are able to talk with this mmc device
103U-Boot # mmc rescan
104U-Boot # tftp 81000000 am335x/MLO
105# Write to two of the backup locations ROM uses
106U-Boot # mmc write 81000000 100 100
107U-Boot # mmc write 81000000 200 100
108# Write U-Boot to the location set in the config
109U-Boot # tftp 81000000 am335x/u-boot.img
110U-Boot # mmc write 81000000 300 400
111# Load kernel and device tree into memory, perform export
112U-Boot # tftp 81000000 am335x/uImage
113U-Boot # run findfdt
114U-Boot # tftp ${fdtaddr} am335x/${fdtfile}
115U-Boot # run mmcargs
116U-Boot # spl export fdt 81000000 - ${fdtaddr}
117# Write the updated device tree to MMC
118U-Boot # mmc write ${fdtaddr} 80 80
119# Write the uImage to MMC
120U-Boot # mmc write 81000000 900 2000
121
122Falcon Mode: FAT SD cards
123=========================
124
125In this case the additional file is written to the filesystem.  In this
126example we assume that the uImage and device tree to be used are already on
127the FAT filesystem (only the uImage MUST be for this to function
128afterwards) along with a Falcon Mode aware MLO and the FAT partition has
129already been created and marked bootable:
130
131U-Boot # mmc rescan
132# Load kernel and device tree into memory, perform export
133U-Boot # load mmc 0:1 ${loadaddr} uImage
134U-Boot # run findfdt
135U-Boot # load mmc 0:1 ${fdtaddr} ${fdtfile}
136U-Boot # run mmcargs
137U-Boot # spl export fdt ${loadaddr} - ${fdtaddr}
138
139This will print a number of lines and then end with something like:
140   Using Device Tree in place at 80f80000, end 80f85928
141   Using Device Tree in place at 80f80000, end 80f88928
142So then you:
143
144U-Boot # fatwrite mmc 0:1 0x80f80000 args 8928
145
146Falcon Mode: NAND
147=================
148
149In this case the additional data is written to another partition of the
150NAND.  In this example we assume that the uImage and device tree to be are
151already located on the NAND somewhere (such as fileystem or mtd partition)
152along with a Falcon Mode aware MLO written to the correct locations for
153booting and mtdparts have been configured correctly for the board:
154
155U-Boot # nand read ${loadaddr} kernel
156U-Boot # load nand rootfs ${fdtaddr} /boot/am335x-evm.dtb
157U-Boot # run nandargs
158U-Boot # spl export fdt ${loadaddr} - ${fdtaddr}
159U-Boot # nand erase.part u-boot-spl-os
160U-Boot # nand write ${fdtaddr} u-boot-spl-os
161