View source for How to Build FriendlyWrt

[[How to Build FriendlyWrt/zh|查看中文]]

==Introduction to FriendlyWrt==
FriendlyWrt is a customized OpenWrt system developed by FriendlyElec. It is open source and suitable for applications in IoT, NAS and smart home gateways and etc.<br />

==User Name & Password==
No password set default, please configure a root password to protect the web interface and enable SSH.

==Supported FriendlyElec Boards==
{| class="wikitable"
|-
  | '''OS'''
  | '''Version'''
  | '''Supported Board Types'''
  | '''Image File'''
  | '''Download Link'''
|-
  | FriendlyWRT for H3
  | 19.07.1
  | NanoPi-R1S, NanoPi-R1, NanoPi-NEO, NanoPi-NEO-Air,  <br />NanoPi-M1, ZeroPi, NanoPi-NEO-S,  <br />NanoPi-NEO-Core, NanoPi-M1-Plus, NanoPi-Duo2
  | nanopi-r1_sd_friendlywrt_4.14_armhf_YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopir1 H3 Download Link]
|-
  | FriendlyWRT for H5
  | 19.07-snapshot
  | NanoPi-NEO2,NanoPi-K1-Plus,NanoPi-NEO-Core2
  | nanopi-neo-core2_sd_friendlywrt_4.14_arm64_YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopineocore2 H5 Download Link]
|-
  | FriendlyWRT for S5P4418
  | 19.07-snapshot
  | NanoPi-Fire2A, NanoPC-T2, NanoPi-S2,  <br />NanoPi-M2A, Smart4418
  | s5p4418-sd-friendlywrt-4.4-YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopct2 S5P4418 Download Link]
|-
  | FriendlyWRT for S5P6818
  | 19.07-snapshot
  | NanoPi-Fire3, NanoPC-T3, Smart6818
  | s5p6818-sd-friendlywrt-4.4-YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopct3 S5P6818 Download Link]
|-
  | FriendlyWRT for RK3399 (1/2)
  | 19.07.5 with rockchip kernel-4.19
  | NanoPi-M4, NanoPC-T4, NanoPi-NEO4, Som-RK3399
  | rk3399-sd-friendlywrt-4.19-YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopct4 RK3399 Download Link]
|-
  | FriendlyWRT for RK3399 (2/2)
  | 19.07.5 with mainline kernel-5.4
  | NanoPi-R4S
  | rk3399-sd-friendlywrt-5.4-YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopi RK3399 Download Link]
|-
  | FriendlyWRT for RK3328
  | 19.07.1
  | NanoPi-R2S
  | rk3328-sd-friendlywrt-5.4-YYYYMMDD.img.zip
  | [http://download.friendlyarm.com/nanopir2s RK3328 Download Lin]
|}
How to test the image: extract the image file, use the "dd" command under Linux or the win32image utility under Windows to flash the image to an SD card.

==Get Source Code==
===Install repo===
Firstly you need to install the repo utility:
<syntaxhighlight lang="bash">
git clone https://github.com/friendlyarm/repo
sudo cp repo/repo /usr/bin/
</syntaxhighlight>

===Download Source Code===
There are two ways to obtain the source code. For mainland Chinese users the first is recommended:
====One: Use Repo Package from FriendlyElec's Cloud Storage====
The source files are located at the "sources/friendlywrt-CPU-YYYYMMDD.tar" directory in FriendlyElec's cloud storage. "CPU" stands for an SoC model and YYYYMMDD stands for date(the year, month and day) in which the package is packed.<br />
After you get a repo package run the following command to extract it. Let's take an image for Allwinner H3 based boards as an example:
<syntaxhighlight lang="bash">
tar xvf /path/to/netdisk/sources/friendlywrt-h3-20190101.tar
cd friendlywrt-h3
repo sync -l --no-clone-bundle
</syntaxhighlight>
Now you have had the full source code for generating an image. The last number digits in the file name stand for the packing date. If you want to obtain the latest official release, remove "-l" and do "repo sync" again:
<syntaxhighlight lang="bash">
cd friendlywrt-h3
repo sync --no-clone-bundle
</syntaxhighlight>

====Two: Get Source Code from Github====
=====H3 Based Boards=====
<syntaxhighlight lang="bash">
mkdir friendlywrt-h3
cd friendlywrt-h3
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master-v19.07.1 -m h3.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
=====H5 Based Boards=====
<syntaxhighlight lang="bash">
mkdir friendlywrt-h5
cd friendlywrt-h5
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master \
        -m h5.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
=====S5P4418 Based Boards=====
<syntaxhighlight lang="bash">
mkdir friendlywrt-s5p4418
cd friendlywrt-s5p4418
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master \
        -m s5p4418.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
=====S5P6818 Based Boards=====
<syntaxhighlight lang="bash">
mkdir friendlywrt-s5p6818
cd friendlywrt-s5p6818
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master \
        -m s5p6818.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
=====RK3399 Based Boards=====
* FriendlyWrt with Rockchip kernel-4.19
For NanoPi-M4, NanoPC-T4, NanoPi-NEO4, Som-RK3399:
<syntaxhighlight lang="bash">
mkdir friendlywrt-rk3399
cd friendlywrt-rk3399
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master-v19.07.5 \
        -m rk3399-kernel4.19.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
* FriendlyWrt with Mainline kernel-5.4
For NanoPi-R4S:
<syntaxhighlight lang="bash">
mkdir friendlywrt-rk3399
cd friendlywrt-rk3399
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master-v19.07.5 \
        -m rk3399.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>
=====RK3328 Based Boards=====
<syntaxhighlight lang="bash">
mkdir friendlywrt-rk3328
cd friendlywrt-rk3328
repo init -u https://github.com/friendlyarm/friendlywrt_manifests -b master-v19.07.1 \
        -m rk3328.xml --repo-url=https://github.com/friendlyarm/repo  --no-clone-bundle
repo sync -c  --no-clone-bundle
</syntaxhighlight>

====Get Latest Release With "Sync"====
<syntaxhighlight lang="bash">
repo sync -c --no-clone-bundle
</syntaxhighlight>
If synchronization is interrupted you can run the following script to do sync again:
<syntaxhighlight lang="bash">
#! /bin/bash
repo sync -c --no-clone-bundle
while [ $? -ne 0 ]; 
do  
    repo sync -c --no-clone-bundle
done
</syntaxhighlight>

====Swtich To Different Platform====
If you have been working on the source code for Allwinner H3's boards and want to swtich to the source code for Allwinner H5's boards you can do it this way:
<syntaxhighlight lang="bash">
cp -af friendlywrt-h3 friendlywrt-h5
cd friendlywrt-h5
repo init -m h5.xml
repo sync --force-sync
</syntaxhighlight>

==Compile Source Code==
===Setup Development Environment===
You need a host PC running a 64-bit Ubuntu 18.04 system and run the following command on the PC:
<syntaxhighlight lang="bash">
wget -O - https://raw.githubusercontent.com/friendlyarm/build-env-on-ubuntu-bionic/master/install.sh | bash
</syntaxhighlight>

===Get Help Info===
Run the build.sh script without any options it will print the help information:
<syntaxhighlight lang="bash">
./build.sh 
</syntaxhighlight>
Let's take Allwinner H3 as an example, the help information will be presented as follows:
<syntaxhighlight lang="bash">
USAGE: ./build.sh <parameter>

# Select Board Type:
  ./build.sh nanopi_r1.mk
  ./build.sh nanopi_duo.mk
  ./build.sh nanopi_neo_core.mk
  ./build.sh nanopi_neo.mk
  ./build.sh nanopi_neo_s.mk
  ./build.sh nanopi_m1_plus.mk
  ./build.sh nanopi_m1.mk
  ./build.sh nanopi_neo_air.mk

# Select Module:
  ./build.sh all                -compile all
  ./build.sh uboot              -compile uboot
  ./build.sh kernel             -compile kernel
  ./build.sh friendlywrt        -compile friendlywrt
  ./build.sh sd-img             -generate an image for an sd card
  ./build.sh emmc-img           -generate an image for emmc (the generated image should be flased to an SD card and then flashed to emm with this SD card)
# Clean:
  ./build.sh cleanall
</syntaxhighlight>

===Auto Compile===
For a first time compilation you need to select an SoC platform. Let's take the NanoPi R1(Allwinner H3) as an example:
<syntaxhighlight lang="bash">
./build.sh nanopi_r1.mk
</syntaxhighlight>
After the script is done successfully all components including a u-boot, a kernel and a friendlywrt will be compiled, and an image file will be generated.

===Compile Individual Component===
====kernel====
<syntaxhighlight lang="bash">
./build.sh kernel
</syntaxhighlight>
====u-boot====
<syntaxhighlight lang="bash">
./build.sh uboot
</syntaxhighlight>
====FriendlyWrt====
<syntaxhighlight lang="bash">
./build.sh friendlywrt
</syntaxhighlight>
===Generate Image for SD Card===
<syntaxhighlight lang="bash">
sudo ./build.sh sd-img
</syntaxhighlight>
If an img file is generated successfully you will see the following messages. You can use the "dd" command to flash the img file to an SD card. Note: you will need to replace "/dev/sdX" with the actual device name which your system recognizes the device as:<br />
<syntaxhighlight lang="bash">
Run the following for sdcard install:
    sudo dd if=out/FriendlyWrt_20190828_NanoPi-R1_armhf_sd.img bs=1M of=/dev/sdX
</syntaxhighlight>
===Generate emmc (eflasher) Image===
<syntaxhighlight lang="bash">
sudo ./build.sh emmc-img
</syntaxhighlight>
If an img file is generated successfully you will see the following messages. You can use the "dd" command to flash the img file to an SD card. Note: you will need to replace "/dev/sdX" with the actual device name which your system recognizes the device as:<br />
<syntaxhighlight lang="bash">
Run the following for sdcard install:
    sudo dd if=out/FriendlyWrt_20190828_NanoPi-R1_armhf_eflasher.img bs=1M of=/dev/sdX
</syntaxhighlight>
Use this SD card to boot the eflasher system and run eflasher commands to install an OS to emmc. After installation is done, take off the SD card of the board and boot your system friendlywrt will load from eMMC.

==Make Your Own Friendlywrt==
===Structure of Source Code Directories===
<syntaxhighlight lang="bash">
├── friendlywrt
│   ├── friendlywrt -> friendlywrt's source code
│   └── configs -> save the "friendlywrt defconfig" file
│   └── toolchain -> cross-compiler, used for compiling a u-boot and kernel
│   ├── build.sh -> script for auto-compile
│   ├── device/friendlyelec -> configuration file for friendlyelec boards
│   ├── kernel -> kernel
│   └── u-boot -> u-boot
│   └── scripts -> script files for generating an img
</syntaxhighlight>

===Configure friendlywrt Components===
* Configure by Using Make Menuconfig(H3)
<syntaxhighlight lang="bash">
cd friendlywrt-h3/friendlywrt
make menuconfig
</syntaxhighlight>
* Save Your Configurations
<syntaxhighlight lang="bash">
make menuconfig
./scripts/diffconfig.sh > ../configs/my_config
</syntaxhighlight>
* Set Your Configurations As Default
Let's take the NanoPi-R1 as an example and edit the following file:
<syntaxhighlight lang="bash">
device/friendlyelec/h3/nanopi_r1.mk
</syntaxhighlight>
Set TARGET_FRIENDLYWRT_CONFIG to your configurations.
* Recompile Friendlywrt and Generate Image for SD Card
<syntaxhighlight lang="bash">
./build.sh friendlywrt
./build.sh sd-img
</syntaxhighlight>

===Put Your Add-on Features to Friendlywrt===
Let's take H3 as an example. Put your files and directories to the following directory and they will be compiled to an img file.
<syntaxhighlight lang="bash">
device/friendlyelec/h3/common-files
</syntaxhighlight>
Or you can put your files and directories in a new directory. Let's take the NanoPi-R1 as an example and edit the following file:
<syntaxhighlight lang="bash">
device/friendlyelec/h3/nanopi_r1.mk
</syntaxhighlight>
Open the file and add a new line(replace "XXX" with your directory):
<syntaxhighlight lang="bash">
FRIENDLYWRT_FILES+=(device/friendlyelec/h3/XXX)
</syntaxhighlight>

===Change Friendlywrt's Default Configurations(Network, Firewall Etc)===
Open and edit the following files:
<syntaxhighlight lang="bash">
device/friendlyelec/h3/default-settings/files
friendlywrt/package/base-files/files
</syntaxhighlight>

===Change U-boot and Kernel's Configurations(H3)===
Open and edit the following file:
<syntaxhighlight lang="bash">
device/friendlyelec/h3/nanopi_r1.mk
</syntaxhighlight>
Change uboot's settings to your own by making the following changes:
<syntaxhighlight lang="bash">
TARGET_UBOOT_CONFIG=nanopi_h3_defconfig
</syntaxhighlight>
Change kernel's settings to your own by making the following changes:
<syntaxhighlight lang="bash">
TARGET_KERNEL_CONFIG=sunxi_defconfig
</syntaxhighlight>

===Change Other COnfigurations===
Open and edit the following xml file and you can replace the source code of kernel, uboot and friendlywrt yo your own code:
<syntaxhighlight lang="bash">
.repo/manifests/h3.xml
</syntaxhighlight>
For more details about what each item in the xml file means, refer to:[https://gerrit.googlesource.com/git-repo/+/refs/heads/master/docs/manifest-format.md repo Manifest Format]<br />
After you make your changes you need to do "repo" to sync and make the changes effective. For example after you change the kernel's source code you need to run the following command to sync:
<syntaxhighlight lang="bash">
repo sync --force-sync kernel
</syntaxhighlight>
After synchronization you just need to recompile the kernel's source code:
<syntaxhighlight lang="bash">
./build.sh kernel
</syntaxhighlight>

== Tips ==
===Visit FriendlyWrt management page===
Enter http://friendlywrt/ or the IP address on the computer browser to enter the FriendlyWrt management page. By default, the IP address of the LAN port is 192.168.2.1, and the WAN will dynamically obtain an IP address from your main router.
<!--
==Enable swap===
<syntaxhighlight lang="bash">
/etc/enable-swap.sh
reboot
</syntaxhighlight>
-->

===mount smbfs resource===
<syntaxhighlight lang="bash">
mount -t cifs //192.168.1.10/shared /movie -o username=xxx,password=yyy,file_mode=0644
</syntaxhighlight>

==Common Issues and Tips==
* When you compile a source code under Ubuntu you cannot do it as root and you need to do it as a non-root user
* Compilation in VNC may not succeed




==Resources==
[https://source.android.com/setup/develop/repo repo guidance]<br />

==Report bug==
Please mail-to：techsupport@friendlyarm.com<br />

==Update Log==
===2020-02-20===
* Optimized openssl performance<br />
* Added support for PWM fan, support fan speed control (platform: rk33xx)<br />
===2019-09-06===
* Released English version