Merge branch 'master' of git://git.denx.de/u-boot-uniphier
[oweals/u-boot.git] / doc / README.uniphier
1 U-Boot for UniPhier SoC family
2 ==============================
3
4
5 Tested toolchains
6 -----------------
7
8  (a) Ubuntu packages  (CROSS_COMPILE=arm-linux-gnueabi-)
9
10   If you are building U-Boot on Ubuntu, its standard package is recommended.
11   You can install it as follows:
12
13     $ sudo apt-get install gcc-arm-linux-gnueabi-
14
15  (b) Linaro compilers  (CROSS_COMPILE=arm-linux-gnueabihf-)
16
17   You can download pre-built toolchains from:
18
19     http://www.linaro.org/downloads/
20
21  (c) kernel.org compilers  (CROSS_COMPILE=arm-unknown-linux-gnueabi-)
22
23   You can download pre-built toolchains from:
24
25     ftp://www.kernel.org/pub/tools/crosstool/files/bin/
26
27
28 Compile the source
29 ------------------
30
31 PH1-sLD3:
32     $ make ph1_sld3_defconfig
33     $ make CROSS_COMPILE=arm-linux-gnueabi-
34
35 PH1-LD4:
36     $ make ph1_ld4_defconfig
37     $ make CROSS_COMPILE=arm-linux-gnueabi-
38
39 PH1-Pro4:
40     $ make ph1_pro4_defconfig
41     $ make CROSS_COMPILE=arm-linux-gnueabi-
42
43 PH1-sLD8:
44     $ make ph1_sld8_defconfig
45     $ make CROSS_COMPILE=arm-linux-gnueabi-
46
47 PH1-Pro5:
48     $ make ph1_pro5_defconfig
49     $ make CROSS_COMPILE=arm-linux-gnueabi-
50
51 ProXstream2:
52     $ make pxs2_defconfig
53     $ make CROSS_COMPILE=arm-linux-gnueabi-
54
55 PH1-LD6b:
56     $ make ph1_ld6b_defconfig
57     $ make CROSS_COMPILE=arm-linux-gnueabi-
58
59 You may wish to change the "CROSS_COMPILE=arm-linux-gnueabi-"
60 to use your favorite compiler.
61
62
63 Burn U-Boot images to NAND
64 --------------------------
65
66 Write two files to the NAND device as follows:
67  - spl/u-boot-spl-dtb.bin at the offset address 0x00000000
68  - u-boot-dtb.img         at the offset address 0x00010000
69
70 If a TFTP server is available, the images can be easily updated.
71 Just copy the u-boot-spl-dtb.bin and u-boot-dtb.img to the TFTP public
72 directory, and then run the following command at the U-Boot command line:
73
74   => run nandupdate
75
76
77 UniPhier specific commands
78 --------------------------
79
80  - pinmon (enabled by CONFIG_CMD_PINMON)
81      shows the boot mode pins that has been latched at the power-on reset
82
83  - ddrphy (enabled by CONFIG_CMD_DDRPHY_DUMP)
84      shows the DDR PHY parameters set by the PHY training
85
86
87 Supported devices
88 -----------------
89
90  - UART (on-chip)
91  - NAND
92  - USB 2.0 (EHCI)
93  - USB 3.0 (xHCI)
94  - LAN (on-board SMSC9118)
95  - I2C
96  - EEPROM (connected to the on-board I2C bus)
97  - Support card (SRAM, NOR flash, some peripherals)
98
99
100 Micro Support Card
101 ------------------
102
103 The recommended bit switch settings are as follows:
104
105  SW2    OFF(1)/ON(0)   Description
106  ------------------------------------------
107  bit 1   <----         BKSZ[0]
108  bit 2   ---->         BKSZ[1]
109  bit 3   <----         SoC Bus Width 16/32
110  bit 4   <----         SERIAL_SEL[0]
111  bit 5   ---->         SERIAL_SEL[1]
112  bit 6   ---->         BOOTSWAP_EN
113  bit 7   <----         CS1/CS5
114  bit 8   <----         SOC_SERIAL_DISABLE
115
116  SW8    OFF(1)/ON(0)   Description
117  ------------------------------------------
118  bit 1    ---->        CS1_SPLIT
119  bit 2    <----        CASE9_ON
120  bit 3    <----        CASE10_ON
121  bit 4  Don't Care     Reserve
122  bit 5  Don't Care     Reserve
123  bit 6  Don't Care     Reserve
124  bit 7    ---->        BURST_EN
125  bit 8    ---->        FLASHBUS32_16
126
127 The BKSZ[1:0] specifies the address range of memory slot and peripherals
128 as follows:
129
130  BKSZ    Description              RAM slot            Peripherals
131  --------------------------------------------------------------------
132  0b00   15MB RAM / 1MB Peri    00000000-0effffff    0f000000-0fffffff
133  0b01   31MB RAM / 1MB Peri    00000000-1effffff    1f000000-1fffffff
134  0b10   64MB RAM / 1MB Peri    00000000-3effffff    3f000000-3fffffff
135  0b11  127MB RAM / 1MB Peri    00000000-7effffff    7f000000-7fffffff
136
137 Set BSKZ[1:0] to 0b01 for U-Boot.
138 This mode is the most handy because EA[24] is always supported by the save pin
139 mode of the system bus.  On the other hand, EA[25] is not supported for some
140 newer SoCs.  Even if it is, EA[25] is not connected on most of the boards.
141
142 --
143 Masahiro Yamada <yamada.masahiro@socionext.com>
144 Aug. 2015