Merge branch 'master' of http://git.denx.de/u-boot-sunxi
[platform/kernel/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 reference board:
32     $ make uniphier_sld3_defconfig
33     $ make CROSS_COMPILE=arm-linux-gnueabi-
34
35 PH1-LD4 reference board:
36     $ make uniphier_ld4_sld8_defconfig
37     $ make CROSS_COMPILE=arm-linux-gnueabi-
38
39 PH1-sLD8 reference board:
40     $ make uniphier_ld4_sld8_defconfig
41     $ make CROSS_COMPILE=arm-linux-gnueabi- DEVICE_TREE=uniphier-ph1-sld8-ref
42
43 PH1-Pro4 reference board:
44     $ make uniphier_pro4_defconfig
45     $ make CROSS_COMPILE=arm-linux-gnueabi-
46
47 PH1-Pro5 4KBOX Board:
48     $ make uniphier_pro5_defconfig
49     $ make CROSS_COMPILE=arm-linux-gnueabi-
50
51 ProXstream2 Gentil board:
52     $ make uniphier_pxs2_ld6b_defconfig
53     $ make CROSS_COMPILE=arm-linux-gnueabi- DEVICE_TREE=uniphier-proxstream2-gentil
54
55 ProXstream2 Vodka board:
56     $ make uniphier_pxs2_ld6b_defconfig
57     $ make CROSS_COMPILE=arm-linux-gnueabi-
58
59 PH1-LD6b reference board:
60     $ make uniphier_pxs2_ld6b_defconfig
61     $ make CROSS_COMPILE=arm-linux-gnueabi- DEVICE_TREE=uniphier-ph1-ld6b-ref
62
63 You may wish to change the "CROSS_COMPILE=arm-linux-gnueabi-"
64 to use your favorite compiler.
65
66
67 Burn U-Boot images to NAND
68 --------------------------
69
70 Write two files to the NAND device as follows:
71  - spl/u-boot-spl-dtb.bin at the offset address 0x00000000
72  - u-boot-dtb.img         at the offset address 0x00010000
73
74 If a TFTP server is available, the images can be easily updated.
75 Just copy the u-boot-spl-dtb.bin and u-boot-dtb.img to the TFTP public
76 directory, and then run the following command at the U-Boot command line:
77
78   => run nandupdate
79
80
81 UniPhier specific commands
82 --------------------------
83
84  - pinmon (enabled by CONFIG_CMD_PINMON)
85      shows the boot mode pins that has been latched at the power-on reset
86
87  - ddrphy (enabled by CONFIG_CMD_DDRPHY_DUMP)
88      shows the DDR PHY parameters set by the PHY training
89
90
91 Supported devices
92 -----------------
93
94  - UART (on-chip)
95  - NAND
96  - USB 2.0 (EHCI)
97  - USB 3.0 (xHCI)
98  - LAN (on-board SMSC9118)
99  - I2C
100  - EEPROM (connected to the on-board I2C bus)
101  - Support card (SRAM, NOR flash, some peripherals)
102
103
104 Micro Support Card
105 ------------------
106
107 The recommended bit switch settings are as follows:
108
109  SW2    OFF(1)/ON(0)   Description
110  ------------------------------------------
111  bit 1   <----         BKSZ[0]
112  bit 2   ---->         BKSZ[1]
113  bit 3   <----         SoC Bus Width 16/32
114  bit 4   <----         SERIAL_SEL[0]
115  bit 5   ---->         SERIAL_SEL[1]
116  bit 6   ---->         BOOTSWAP_EN
117  bit 7   <----         CS1/CS5
118  bit 8   <----         SOC_SERIAL_DISABLE
119
120  SW8    OFF(1)/ON(0)   Description
121  ------------------------------------------
122  bit 1    ---->        CS1_SPLIT
123  bit 2    <----        CASE9_ON
124  bit 3    <----        CASE10_ON
125  bit 4  Don't Care     Reserve
126  bit 5  Don't Care     Reserve
127  bit 6  Don't Care     Reserve
128  bit 7    ---->        BURST_EN
129  bit 8    ---->        FLASHBUS32_16
130
131 The BKSZ[1:0] specifies the address range of memory slot and peripherals
132 as follows:
133
134  BKSZ    Description              RAM slot            Peripherals
135  --------------------------------------------------------------------
136  0b00   15MB RAM / 1MB Peri    00000000-00efffff    00f00000-00ffffff
137  0b01   31MB RAM / 1MB Peri    00000000-01efffff    01f00000-01ffffff
138  0b10   64MB RAM / 1MB Peri    00000000-03efffff    03f00000-03ffffff
139  0b11  127MB RAM / 1MB Peri    00000000-07efffff    07f00000-07ffffff
140
141 Set BSKZ[1:0] to 0b01 for U-Boot.
142 This mode is the most handy because EA[24] is always supported by the save pin
143 mode of the system bus.  On the other hand, EA[25] is not supported for some
144 newer SoCs.  Even if it is, EA[25] is not connected on most of the boards.
145
146 --
147 Masahiro Yamada <yamada.masahiro@socionext.com>
148 Aug. 2015