Merge tag 'for-v2020.07' of https://gitlab.denx.de/u-boot/custodians/u-boot-i2c
[oweals/u-boot.git] / doc / board / sifive / fu540.rst
1 .. SPDX-License-Identifier: GPL-2.0+
2
3 HiFive Unleashed
4 ================
5
6 FU540-C000 RISC-V SoC
7 ---------------------
8 The FU540-C000 is the world’s first 4+1 64-bit RISC-V SoC from SiFive.
9
10 The HiFive Unleashed development platform is based on FU540-C000 and capable
11 of running Linux.
12
13 Mainline support
14 ----------------
15 The support for following drivers are already enabled:
16
17 1. SiFive UART Driver.
18 2. SiFive PRCI Driver for clock.
19 3. Cadence MACB ethernet driver for networking support.
20 4. SiFive SPI Driver.
21 5. MMC SPI Driver for MMC/SD support.
22
23 TODO:
24
25 1. U-Boot expects the serial console device entry to be present under /chosen
26    DT node. Without a serial console U-Boot will panic. Example:
27
28 .. code-block:: none
29
30    chosen {
31         stdout-path = "/soc/serial@10010000:115200";
32    };
33
34 Building
35 --------
36
37 1. Add the RISC-V toolchain to your PATH.
38 2. Setup ARCH & cross compilation enviornment variable:
39
40 .. code-block:: none
41
42    export ARCH=riscv
43    export CROSS_COMPILE=<riscv64 toolchain prefix>
44
45 3. make sifive_fu540_defconfig
46 4. make
47
48 Flashing
49 --------
50
51 The current U-Boot port is supported in S-mode only and loaded from DRAM.
52
53 A prior stage M-mode firmware/bootloader (e.g OpenSBI) is required to
54 boot the u-boot.bin in S-mode and provide M-mode runtime services.
55
56 Currently, the u-boot.bin is used as a payload of the OpenSBI FW_PAYLOAD
57 firmware. We need to compile OpenSBI with below command:
58
59 .. code-block:: none
60
61 make PLATFORM=sifive/fu540 FW_PAYLOAD_PATH=<path to u-boot-dtb.bin>
62
63 More detailed description of steps required to build FW_PAYLOAD firmware
64 is beyond the scope of this document. Please refer OpenSBI documenation.
65 (Note: OpenSBI git repo is at https://github.com/riscv/opensbi.git)
66
67 Once the prior stage firmware/bootloader binary is generated, it should be
68 copied to the first partition of the sdcard.
69
70 .. code-block:: none
71
72     sudo dd if=<prior_stage_firmware_binary> of=/dev/disk2s1 bs=1024
73
74 Booting
75 -------
76 Once you plugin the sdcard and power up, you should see the U-Boot prompt.
77
78 Sample boot log from HiFive Unleashed board
79 -------------------------------------------
80
81 .. code-block:: none
82
83    U-Boot 2019.07-00024-g350ff02f5b (Jul 22 2019 - 11:45:02 +0530)
84
85    CPU:   rv64imafdc
86    Model: SiFive HiFive Unleashed A00
87    DRAM:  8 GiB
88    MMC:   spi@10050000:mmc@0: 0
89    In:    serial@10010000
90    Out:   serial@10010000
91    Err:   serial@10010000
92    Net:   eth0: ethernet@10090000
93    Hit any key to stop autoboot:  0
94    => version
95    U-Boot 2019.07-00024-g350ff02f5b (Jul 22 2019 - 11:45:02 +0530)
96
97    riscv64-linux-gcc.br_real (Buildroot 2018.11-rc2-00003-ga0787e9) 8.2.0
98    GNU ld (GNU Binutils) 2.31.1
99    => mmc info
100    Device: spi@10050000:mmc@0
101    Manufacturer ID: 3
102    OEM: 5344
103    Name: SU08G
104    Bus Speed: 20000000
105    Mode: SD Legacy
106    Rd Block Len: 512
107    SD version 2.0
108    High Capacity: Yes
109    Capacity: 7.4 GiB
110    Bus Width: 1-bit
111    Erase Group Size: 512 Bytes
112    => mmc part
113
114    Partition Map for MMC device 0  --   Partition Type: EFI
115
116    Part    Start LBA       End LBA         Name
117            Attributes
118            Type GUID
119            Partition GUID
120      1     0x00000800      0x000107ff      "bootloader"
121            attrs:  0x0000000000000000
122            type:   2e54b353-1271-4842-806f-e436d6af6985
123            guid:   393bbd36-7111-491c-9869-ce24008f6403
124      2     0x00040800      0x00ecdfde      ""
125            attrs:  0x0000000000000000
126            type:   0fc63daf-8483-4772-8e79-3d69d8477de4
127            guid:   7fc9a949-5480-48c7-b623-04923080757f
128
129 Now you can configure your networking, tftp server and use tftp boot method to
130 load uImage.
131
132 .. code-block:: none
133
134    => setenv ipaddr 10.206.7.133
135    => setenv netmask 255.255.252.0
136    => setenv serverip 10.206.4.143
137    => setenv gateway 10.206.4.1
138
139 If you want to use a flat kernel image such as Image file
140
141 .. code-block:: none
142
143    => tftpboot ${kernel_addr_r} /sifive/fu540/Image
144    ethernet@10090000: PHY present at 0
145    ethernet@10090000: Starting autonegotiation...
146    ethernet@10090000: Autonegotiation complete
147    ethernet@10090000: link up, 1000Mbps full-duplex (lpa: 0x3c00)
148    Using ethernet@10090000 device
149    TFTP from server 10.206.4.143; our IP address is 10.206.7.133
150    Filename '/sifive/fu540/Image'.
151    Load address: 0x84000000
152    Loading: #################################################################
153             #################################################################
154             #################################################################
155             #################################################################
156             #################################################################
157             #################################################################
158             #################################################################
159             #################################################################
160             #################################################################
161             #################################################################
162             #################################################################
163             #################################################################
164             #################################################################
165             #################################################################
166             #################################################################
167             #################################################################
168             #################################################################
169             #################################################################
170             #################################################################
171             #################################################################
172             #################################################################
173             #################################################################
174             #################################################################
175             #################################################################
176             #################################################################
177             #################################################################
178             ##########################################
179             1.2 MiB/s
180    done
181    Bytes transferred = 8867100 (874d1c hex)
182
183 Or if you want to use a compressed kernel image file such as Image.gz
184
185 .. code-block:: none
186
187    => tftpboot ${kernel_addr_r} /sifive/fu540/Image.gz
188    ethernet@10090000: PHY present at 0
189    ethernet@10090000: Starting autonegotiation...
190    ethernet@10090000: Autonegotiation complete
191    ethernet@10090000: link up, 1000Mbps full-duplex (lpa: 0x3c00)
192    Using ethernet@10090000 device
193    TFTP from server 10.206.4.143; our IP address is 10.206.7.133
194    Filename '/sifive/fu540/Image.gz'.
195    Load address: 0x84000000
196    Loading: #################################################################
197             #################################################################
198             #################################################################
199             #################################################################
200             #################################################################
201             #################################################################
202             #################################################################
203             #################################################################
204             #################################################################
205             #################################################################
206             #################################################################
207             #################################################################
208             #################################################################
209             #################################################################
210             #################################################################
211             #################################################################
212             #################################################################
213             #################################################################
214             #################################################################
215             #################################################################
216             #################################################################
217             #################################################################
218             #################################################################
219             #################################################################
220             #################################################################
221             #################################################################
222             ##########################################
223             1.2 MiB/s
224    done
225    Bytes transferred = 4809458 (4962f2 hex)
226    =>setenv kernel_comp_addr_r 0x90000000
227    =>setenv kernel_comp_size 0x500000
228
229 By this time, correct kernel image is loaded and required enviornment variables
230 are set. You can proceed to load the ramdisk and device tree from the tftp server
231 as well.
232
233 .. code-block:: none
234
235    => tftpboot ${ramdisk_addr_r} /sifive/fu540/uRamdisk
236    ethernet@10090000: PHY present at 0
237    ethernet@10090000: Starting autonegotiation...
238    ethernet@10090000: Autonegotiation complete
239    ethernet@10090000: link up, 1000Mbps full-duplex (lpa: 0x3c00)
240    Using ethernet@10090000 device
241    TFTP from server 10.206.4.143; our IP address is 10.206.7.133
242    Filename '/sifive/fu540/uRamdisk'.
243    Load address: 0x88300000
244    Loading: #################################################################
245             #################################################################
246             #################################################################
247             #################################################################
248             #################################################################
249             #################################################################
250             #################################################################
251             ##############
252             418.9 KiB/s
253    done
254    Bytes transferred = 2398272 (249840 hex)
255    => tftpboot ${fdt_addr_r} /sifive/fu540/hifive-unleashed-a00.dtb
256    ethernet@10090000: PHY present at 0
257    ethernet@10090000: Starting autonegotiation...
258    ethernet@10090000: Autonegotiation complete
259    ethernet@10090000: link up, 1000Mbps full-duplex (lpa: 0x7c00)
260    Using ethernet@10090000 device
261    TFTP from server 10.206.4.143; our IP address is 10.206.7.133
262    Filename '/sifive/fu540/hifive-unleashed-a00.dtb'.
263    Load address: 0x88000000
264    Loading: ##
265             1000 Bytes/s
266    done
267    Bytes transferred = 5614 (15ee hex)
268    => setenv bootargs "root=/dev/ram rw console=ttySIF0 ip=dhcp earlycon=sbi"
269    => booti ${kernel_addr_r} ${ramdisk_addr_r} ${fdt_addr_r}
270    ## Loading init Ramdisk from Legacy Image at 88300000 ...
271       Image Name:   Linux RootFS
272       Image Type:   RISC-V Linux RAMDisk Image (uncompressed)
273       Data Size:    2398208 Bytes = 2.3 MiB
274       Load Address: 00000000
275       Entry Point:  00000000
276       Verifying Checksum ... OK
277    ## Flattened Device Tree blob at 88000000
278       Booting using the fdt blob at 0x88000000
279       Using Device Tree in place at 0000000088000000, end 00000000880045ed
280
281    Starting kernel ...
282
283    [    0.000000] OF: fdt: Ignoring memory range 0x80000000 - 0x80200000
284    [    0.000000] Linux version 5.3.0-rc1-00003-g460ac558152f (anup@anup-lab-machine) (gcc version 8.2.0 (Buildroot 2018.11-rc2-00003-ga0787e9)) #6 SMP Mon Jul 22 10:01:01 IST 2019
285    [    0.000000] earlycon: sbi0 at I/O port 0x0 (options '')
286    [    0.000000] printk: bootconsole [sbi0] enabled
287    [    0.000000] Initial ramdisk at: 0x(____ptrval____) (2398208 bytes)
288    [    0.000000] Zone ranges:
289    [    0.000000]   DMA32    [mem 0x0000000080200000-0x00000000ffffffff]
290    [    0.000000]   Normal   [mem 0x0000000100000000-0x000000027fffffff]
291    [    0.000000] Movable zone start for each node
292    [    0.000000] Early memory node ranges
293    [    0.000000]   node   0: [mem 0x0000000080200000-0x000000027fffffff]
294    [    0.000000] Initmem setup node 0 [mem 0x0000000080200000-0x000000027fffffff]
295    [    0.000000] software IO TLB: mapped [mem 0xfbfff000-0xfffff000] (64MB)
296    [    0.000000] CPU with hartid=0 is not available
297    [    0.000000] CPU with hartid=0 is not available
298    [    0.000000] elf_hwcap is 0x112d
299    [    0.000000] percpu: Embedded 18 pages/cpu s34584 r8192 d30952 u73728
300    [    0.000000] Built 1 zonelists, mobility grouping on.  Total pages: 2067975
301    [    0.000000] Kernel command line: root=/dev/ram rw console=ttySIF0 ip=dhcp earlycon=sbi
302    [    0.000000] Dentry cache hash table entries: 1048576 (order: 11, 8388608 bytes, linear)
303    [    0.000000] Inode-cache hash table entries: 524288 (order: 10, 4194304 bytes, linear)
304    [    0.000000] Sorting __ex_table...
305    [    0.000000] mem auto-init: stack:off, heap alloc:off, heap free:off
306    [    0.000000] Memory: 8182308K/8386560K available (5916K kernel code, 368K rwdata, 1840K rodata, 213K init, 304K bss, 204252K reserved, 0K cma-reserved)
307    [    0.000000] SLUB: HWalign=64, Order=0-3, MinObjects=0, CPUs=4, Nodes=1
308    [    0.000000] rcu: Hierarchical RCU implementation.
309    [    0.000000] rcu:     RCU restricting CPUs from NR_CPUS=8 to nr_cpu_ids=4.
310    [    0.000000] rcu: RCU calculated value of scheduler-enlistment delay is 25 jiffies.
311    [    0.000000] rcu: Adjusting geometry for rcu_fanout_leaf=16, nr_cpu_ids=4
312    [    0.000000] NR_IRQS: 0, nr_irqs: 0, preallocated irqs: 0
313    [    0.000000] plic: mapped 53 interrupts with 4 handlers for 9 contexts.
314    [    0.000000] riscv_timer_init_dt: Registering clocksource cpuid [0] hartid [1]
315    [    0.000000] clocksource: riscv_clocksource: mask: 0xffffffffffffffff max_cycles: 0x1d854df40, max_idle_ns: 3526361616960 ns
316    [    0.000006] sched_clock: 64 bits at 1000kHz, resolution 1000ns, wraps every 2199023255500ns
317    [    0.008559] Console: colour dummy device 80x25
318    [    0.012989] Calibrating delay loop (skipped), value calculated using timer frequency.. 2.00 BogoMIPS (lpj=4000)
319    [    0.023104] pid_max: default: 32768 minimum: 301
320    [    0.028273] Mount-cache hash table entries: 16384 (order: 5, 131072 bytes, linear)
321    [    0.035765] Mountpoint-cache hash table entries: 16384 (order: 5, 131072 bytes, linear)
322    [    0.045307] rcu: Hierarchical SRCU implementation.
323    [    0.049875] smp: Bringing up secondary CPUs ...
324    [    0.055729] smp: Brought up 1 node, 4 CPUs
325    [    0.060599] devtmpfs: initialized
326    [    0.064819] random: get_random_u32 called from bucket_table_alloc.isra.10+0x4e/0x160 with crng_init=0
327    [    0.073720] clocksource: jiffies: mask: 0xffffffff max_cycles: 0xffffffff, max_idle_ns: 7645041785100000 ns
328    [    0.083176] futex hash table entries: 1024 (order: 4, 65536 bytes, linear)
329    [    0.090721] NET: Registered protocol family 16
330    [    0.106319] vgaarb: loaded
331    [    0.108670] SCSI subsystem initialized
332    [    0.112515] usbcore: registered new interface driver usbfs
333    [    0.117758] usbcore: registered new interface driver hub
334    [    0.123167] usbcore: registered new device driver usb
335    [    0.128905] clocksource: Switched to clocksource riscv_clocksource
336    [    0.141239] NET: Registered protocol family 2
337    [    0.145506] tcp_listen_portaddr_hash hash table entries: 4096 (order: 4, 65536 bytes, linear)
338    [    0.153754] TCP established hash table entries: 65536 (order: 7, 524288 bytes, linear)
339    [    0.163466] TCP bind hash table entries: 65536 (order: 8, 1048576 bytes, linear)
340    [    0.173468] TCP: Hash tables configured (established 65536 bind 65536)
341    [    0.179739] UDP hash table entries: 4096 (order: 5, 131072 bytes, linear)
342    [    0.186627] UDP-Lite hash table entries: 4096 (order: 5, 131072 bytes, linear)
343    [    0.194117] NET: Registered protocol family 1
344    [    0.198417] RPC: Registered named UNIX socket transport module.
345    [    0.203887] RPC: Registered udp transport module.
346    [    0.208664] RPC: Registered tcp transport module.
347    [    0.213429] RPC: Registered tcp NFSv4.1 backchannel transport module.
348    [    0.219944] PCI: CLS 0 bytes, default 64
349    [    0.224170] Unpacking initramfs...
350    [    0.262347] Freeing initrd memory: 2336K
351    [    0.266531] workingset: timestamp_bits=62 max_order=21 bucket_order=0
352    [    0.280406] NFS: Registering the id_resolver key type
353    [    0.284798] Key type id_resolver registered
354    [    0.289048] Key type id_legacy registered
355    [    0.293114] nfs4filelayout_init: NFSv4 File Layout Driver Registering...
356    [    0.300262] NET: Registered protocol family 38
357    [    0.304432] Block layer SCSI generic (bsg) driver version 0.4 loaded (major 254)
358    [    0.311862] io scheduler mq-deadline registered
359    [    0.316461] io scheduler kyber registered
360    [    0.356421] Serial: 8250/16550 driver, 4 ports, IRQ sharing disabled
361    [    0.363004] 10010000.serial: ttySIF0 at MMIO 0x10010000 (irq = 4, base_baud = 0) is a SiFive UART v0
362    [    0.371468] printk: console [ttySIF0] enabled
363    [    0.371468] printk: console [ttySIF0] enabled
364    [    0.380223] printk: bootconsole [sbi0] disabled
365    [    0.380223] printk: bootconsole [sbi0] disabled
366    [    0.389589] 10011000.serial: ttySIF1 at MMIO 0x10011000 (irq = 1, base_baud = 0) is a SiFive UART v0
367    [    0.398680] [drm] radeon kernel modesetting enabled.
368    [    0.412395] loop: module loaded
369    [    0.415214] sifive_spi 10040000.spi: mapped; irq=3, cs=1
370    [    0.420628] sifive_spi 10050000.spi: mapped; irq=5, cs=1
371    [    0.425897] libphy: Fixed MDIO Bus: probed
372    [    0.429964] macb 10090000.ethernet: Registered clk switch 'sifive-gemgxl-mgmt'
373    [    0.436743] macb: GEM doesn't support hardware ptp.
374    [    0.441621] libphy: MACB_mii_bus: probed
375    [    0.601316] Microsemi VSC8541 SyncE 10090000.ethernet-ffffffff:00: attached PHY driver [Microsemi VSC8541 SyncE] (mii_bus:phy_addr=10090000.ethernet-ffffffff:00, irq=POLL)
376    [    0.615857] macb 10090000.ethernet eth0: Cadence GEM rev 0x10070109 at 0x10090000 irq 6 (70:b3:d5:92:f2:f3)
377    [    0.625634] e1000e: Intel(R) PRO/1000 Network Driver - 3.2.6-k
378    [    0.631381] e1000e: Copyright(c) 1999 - 2015 Intel Corporation.
379    [    0.637382] ehci_hcd: USB 2.0 'Enhanced' Host Controller (EHCI) Driver
380    [    0.643799] ehci-pci: EHCI PCI platform driver
381    [    0.648261] ehci-platform: EHCI generic platform driver
382    [    0.653497] ohci_hcd: USB 1.1 'Open' Host Controller (OHCI) Driver
383    [    0.659599] ohci-pci: OHCI PCI platform driver
384    [    0.664055] ohci-platform: OHCI generic platform driver
385    [    0.669448] usbcore: registered new interface driver uas
386    [    0.674575] usbcore: registered new interface driver usb-storage
387    [    0.680642] mousedev: PS/2 mouse device common for all mice
388    [    0.709493] mmc_spi spi1.0: SD/MMC host mmc0, no DMA, no WP, no poweroff, cd polling
389    [    0.716615] usbcore: registered new interface driver usbhid
390    [    0.722023] usbhid: USB HID core driver
391    [    0.726738] NET: Registered protocol family 10
392    [    0.731359] Segment Routing with IPv6
393    [    0.734332] sit: IPv6, IPv4 and MPLS over IPv4 tunneling driver
394    [    0.740687] NET: Registered protocol family 17
395    [    0.744660] Key type dns_resolver registered
396    [    0.806775] mmc0: host does not support reading read-only switch, assuming write-enable
397    [    0.814020] mmc0: new SDHC card on SPI
398    [    0.820137] mmcblk0: mmc0:0000 SU08G 7.40 GiB
399    [    0.850220]  mmcblk0: p1 p2
400    [    3.821524] macb 10090000.ethernet eth0: link up (1000/Full)
401    [    3.828938] IPv6: ADDRCONF(NETDEV_CHANGE): eth0: link becomes ready
402    [    3.848919] Sending DHCP requests .., OK
403    [    6.252076] IP-Config: Got DHCP answer from 10.206.4.1, my address is 10.206.7.133
404    [    6.259624] IP-Config: Complete:
405    [    6.262831]      device=eth0, hwaddr=70:b3:d5:92:f2:f3, ipaddr=10.206.7.133, mask=255.255.252.0, gw=10.206.4.1
406    [    6.272809]      host=dhcp-10-206-7-133, domain=sdcorp.global.sandisk.com, nis-domain=(none)
407    [    6.281228]      bootserver=10.206.126.11, rootserver=10.206.126.11, rootpath=
408    [    6.281232]      nameserver0=10.86.1.1, nameserver1=10.86.2.1
409    [    6.294179]      ntpserver0=10.86.1.1, ntpserver1=10.86.2.1
410    [    6.301026] Freeing unused kernel memory: 212K
411    [    6.304683] This architecture does not have kernel memory protection.
412    [    6.311121] Run /init as init process
413               _  _
414              | ||_|
415              | | _ ____  _   _  _  _
416              | || |  _ \| | | |\ \/ /
417              | || | | | | |_| |/    \
418              |_||_|_| |_|\____|\_/\_/
419
420                   Busybox Rootfs
421
422    Please press Enter to activate this console.
423    / #