Skip to content

Commit

Permalink
doc: Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Huaqi Fang <[email protected]>
  • Loading branch information
fanghuaqi committed Mar 19, 2021
1 parent 6721d2f commit e278505
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you want to run linux on Nuclei Demo SoC, you will need UX600 or UX900 RISC-V
- Status: Working
- Build dependencies: `build-essential git autotools-dev make cmake texinfo bison minicom flex liblz4-tool
libgmp-dev libmpfr-dev libmpc-dev gawk libz-dev libssl-dev device-tree-compiler libncursesw5-dev libncursesw5`
- Get prebuilt openocd from [Nuclei Development Tools](https://nucleisys.com/download.php)
- Get prebuilt openocd from [Nuclei Development Tools](https://nucleisys.com/download.php#tools)
- Setup openocd and add it into **PATH**
## Build Instructions
Expand All @@ -59,7 +59,7 @@ sudo apt-get install build-essential git autotools-dev cmake texinfo bison minic
### Install Nuclei Tools

Download prebuilt 64bit `openocd` tool from [Nuclei Development Tools](https://nucleisys.com/download.php),
Download prebuilt 64bit `openocd` tool from [Nuclei Development Tools](https://nucleisys.com/download.php#tools),
and extract it into your PC, and then setup **PATH** using this command:

~~~shell
Expand Down Expand Up @@ -162,7 +162,7 @@ Please modify the `Makefile` to your correct core configuration before build any
## Booting Linux on Nuclei xl-spike

**Note**: `xl_spike` tool should be installed and added into **PATH** in advance.
Contact with our sales via email [email protected] to get `xl-spike` tools.
Contact with our sales via email **[email protected]** to get `xl-spike` tools.

> This feature will be **deprecated** in future.
Expand Down Expand Up @@ -739,10 +739,6 @@ When your applications are placed into the sdcard correctly, then you can insert

For example, if you have an application called `coremark`, then you can directly run it using `/mnt/coremark`.

## Help

You can run `make help` for quick usage of this Nuclei Linux SDK.

## Port to your target

For our current development demo SoC, we used the following resources:
Expand All @@ -756,8 +752,9 @@ For our current development demo SoC, we used the following resources:
* PLIC @ 0x8000000
* QSPI @ 0x10034000, which connect to SDCard, SDCard will be used when boot from SDCard
* QSPI @ 0x10014000, which connect to XIP SPIFlash 4M, memory mapped started at 0x20000000.

SPIFlash is used to place freeloader, which contains opensbi, uboot, dtb, and optional kernel and rootfs
when flash-only boot is performed. Flash-only boot will required at least 8M flash.
when flash-only boot is performed. **Flash-only boot** will required at least 8M flash.

To basically port this SDK to match your target, you need at least to change the following files:

Expand Down Expand Up @@ -887,7 +884,7 @@ This repo is based on opensource repo https://github.com/sifive/freedom-u-sdk/tr
If you don't want to build the nuclei sdk, you can also download the boot images generated by [github action](https://github.com/Nuclei-Software/nuclei-linux-sdk/actions).
For example, for `dev_nuclei` branch, you can find the previous built artifacts in https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/runs/358740696.
For example, for `dev_nuclei_next` branch, you can find the previous built artifacts in https://github.com/Nuclei-Software/nuclei-linux-sdk/actions/runs/667358598.
Then you can extra the downloaded `bootimages_ux600.zip` and extract `freeloader/freeloader.elf` to your disk,
such as `D:/freeloader.elf`.
Expand Down

0 comments on commit e278505

Please sign in to comment.