Hi35xx Vx00 Linux Development Environment

User Guide

Issue 01

Date 2018-05-15
Copyright © HiSilicon Technologies Co., Ltd. 2018. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior
written consent of HiSilicon Technologies Co., Ltd.

Trademarks and Permissions

, , and other HiSilicon icons are trademarks of HiSilicon Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.

Notice
The purchased products, services and features are stipulated by the contract made between HiSilicon
and the customer. All or part of the products, services and features described in this document may
not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all
statements, information, and recommendations in this document are provided "AS IS" without
warranties, guarantees or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in
the preparation of this document to ensure accuracy of the contents, but all statements, information,
and recommendations in this document do not constitute a warranty of any kind, express or implied.

HiSilicon Technologies Co., Ltd.

Address: New R&D Center, Wuhe Road,
Bantian, Longgang District,
Shenzhen 518129 P. R. China
Website: http://www.hisilicon.com
Email: [email protected]
 Hi35xx Vx00 Linux Development Environment
User Guide About This Document

About This Document

Purpose
This document describes the Linux development environment of the Hi3536C V100. This
document also explains how to set up the Linux and network development environments, burn
the Linux kernel, and root file system, and start Linux-based applications.
After reading this document, customers will clearly understand the Linux development
environment.

Related Versions
The following table lists the product versions related to this document.

Product Name Version

Hi3536C V100
Hi3521D V100
Hi3531D V100
Hi3520D V400
Hi3518E V200
Hi3518E V201
Hi3516C V200
Hi3521A V100
Hi3531A V100

Intended Audience
This document is intended for:
 Technical support personnel
 Software development engineers

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) i
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide About This Document

Change History
Changes between document issues are cumulative. Therefore, the latest document issue
contains all changes made in previous issues.

Issue 01 (2018-05-15)
This issue is the first official draft release.

Issue 00B04 (2018-03-02)

This issue is the fourth draft release, which incorporates the following changes:
The contents related to the Hi3518EV20X, Hi3516CV200, Hi3521A, and Hi3531A are added.
Table 1-1 is added.
In section 1.2, table 1-2 is modified.
Sections 1.3.2, 3.1, 3.2, and 4.2.2 are modified.

Issue 00B03(2017-12-20)
This issue is the third draft release.

Issue 00B02(2017-11-20)
This issue is the second draft release, which incorporates the following changes:
The prefix of "hisilicon$" is deleted throughout the document.
Chapter 1 Development Environment
In section 1.2, Table 1-1 is modified.
Section 1.3.2 is modified.
Chapter 3 Linux Kernel
Section 3.1 is updated.
Section 3.1.1 and section 3.1.2 are added.
Chapter 4 Root File System
Section 4.2.1, 4.2.2, and 4.3 are modified.
In section 4.3.2 and section 4.3.3, the "./" symbol is added at the beginning of the paths.

Issue 00B01 (2017-04-10)

This issue is the first draft release.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) ii
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide Contents

Contents

About This Document ......................................................................................................................i

1 Development Environment ......................................................................................................... 3
1.1 Embedded Development Environment............................................................................................................. 3
1.2 Overview of the Linux Development Environment ......................................................................................... 3
1.3 Setting Up the Linux Development Environment ............................................................................................ 3
1.3.1 Installing an OS on the Linux Server ...................................................................................................... 3
1.3.2 Installing the Cross Compiler ................................................................................................................. 3
1.3.3 Installing the SDK................................................................................................................................... 3

2 U-Boot .............................................................................................................................................. 3
3 Linux Kernel................................................................................................................................... 3
3.1 Kernel Source Codes ........................................................................................................................................ 3
3.1.1 Downloading the Kernel Source Code from the Linux Open Source Community ................................. 3
3.1.2 Installing the Patch .................................................................................................................................. 3
3.2 Configuring the Kernel..................................................................................................................................... 3
3.3 Compiling the Kernel and Generating the Kernel Image uImage .................................................................... 3

4 Root File System ............................................................................................................................ 3

4.1 Introduction to the Root File System ............................................................................................................... 3
4.2 Creating a Root File System by Using the BusyBox........................................................................................ 3
4.2.1 Obtaining the Source Code of the BusyBox ........................................................................................... 3
4.2.2 Configuring the BusyBox ....................................................................................................................... 3
4.2.3 Compiling and Installing the BusyBox ................................................................................................... 3
4.2.4 Creating a Root File System ................................................................................................................... 3
4.3 Introduction to File Systems ............................................................................................................................ 3
4.3.1 CRAMFS ................................................................................................................................................ 3
4.3.2 JFFS2 ...................................................................................................................................................... 3
4.3.3 YAFFS2................................................................................................................................................... 3
4.3.4 ubifs ........................................................................................................................................................ 3
4.3.5 initrd ........................................................................................................................................................ 3
4.3.6 SquashFS ................................................................................................................................................ 3

5 Application Development ........................................................................................................... 3

5.1 Compiling Code ............................................................................................................................................... 3

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) iii
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide Contents

5.2 Running Applications ....................................................................................................................................... 3

A Acronyms and Abbreviations .................................................................................................... 3

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) iv
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide Figures

Figures

Figure 1-2 Development in embedded mode......................................................................................................... 3

Figure 1-3 Setting up the Linux development environment .................................................................................. 3

Figure 4-1 Structure of the root file system's top directory ................................................................................... 3

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) v
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide Tables

Tables

Table 1-1 Differences across all chip platforms..................................................................................................... 3

Table 1-2 Software running in the Linux development environment .................................................................... 3

Table 4-1 Some directories that can be ignored ..................................................................................................... 3

Table 4-2 BusyBox comparison between different chip platforms ........................................................................ 3

Table 4-3 JFFS2 parameters .................................................................................................................................. 3

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) vi
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 1 Development Environment

1 Development Environment

Table 1-1 Differences across all chip platforms

Chip Boot Media Kernel ARM BusyBox Uclibc Glibc CPU
Platform Version Compilation Version Version Version
Environment
(GCC
Version)
Hi3536C V100  SPI NOR linux-3.18. gcc4.9.4 1.20.2 0.9.33.2 2.20-201 Dual-c
Hi3521D V100  SPI NAND 20 4.11 ore A7
SMP
Hi3520D V400
Hi3531D V100  SPI NOR linux-3.18. gcc4.9.4 1.20.2 0.9.33.2 2.20-201 Dual-c
 SPI NAND 20 4.11 ore A9
SMP
 Parallel
NAND
Hi3518E V200  SPI NOR linux-4.9.3 gcc6.2.1 1.26.2 0.9.33.2 2.24 Single-
Hi3518E V201  SPI NAND 7 core
ARM9
Hi3516C V200
Hi3521A V100 SPI Nor linux-4.9.3 gcc6.2.1 1.26.2 0.9.33.2 2.24 Single-
SPI Nand 7 core
A7
Hi3531A V100  SPI NOR linux-4.9.3 gcc6.2.1 1.26.2 0.9.33.2 2.24 Dual-c
 SPI NAND 7 ore A9
SMP
 Parallel
NAND

1.1 Embedded Development Environment

The development and debugging tool cannot be run on the embedded board, because the
resources of the embedded board are limited. The embedded board is typically developed in

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 1
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 1 Development Environment

cross compilation mode, that is, in host+target machine (evaluation board) mode. The host
and target machine are typically connected through the serial port. However, they can also be
connected through the network port or Joint Test Action Group (JTAG) interface, as shown in
Figure 1-2.
The processors of the host and the target machine are different. A cross compilation
environment must be built on the host for the target machine. After a program is processed
through compilation, connection, and location, an executable file is created. When the
executable file is burnt to the target machine by some means, the program can then run on it.
After the target machine's bootloader is started, operational information about the target
machine is transmitted to the host and displayed through the serial port or the network port
and displayed. You can control the target machine by entering commands on the host's
console.

Figure 1-1 Development in embedded mode

1.2 Overview of the Linux Development Environment

The Linux development environment consists of a Linux server, a Windows console, and a
DMEB (target machine) on the same network, as shown in Figure 1-2.

Figure 1-2 Setting up the Linux development environment

After a cross compilation environment is set up on the Linux server, and the Windows console
is connected to the reference board (REFB) through the serial port or network interface, the
developer can develop programs on the Windows console or on the Linux server through

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 2
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 1 Development Environment

remote login. Table 1-2 describes the software running in the Linux development
environment.

Although a Windows console exists in the development environment, many operations can be completed
on the Linux server, such as replacing the HyperTerminal with Minicom. Therefore, you can adjust the
development environment to your personal preferences.

Table 1-2 Software running in the Linux development environment

Software Description
Windows console Operating Windows 98, Windows me, Windows 2000, Windows
system (OS) XP, or Windows 7
Application Putty, HyperTerminal, Trivial File Transfer Protocol
software (TFTP) server, and DS-5.
Linux server OS Ubuntu, Redhat, and Debian are supported, and there
are no special requirements. The kernel 2.6.18 or later
is supported. Additionally, full installation is
recommended.
Application Network file system (NFS), telnetd, Samba, and VIM,
software and ARM cross compilation environment. (For details
about the GCC versions, see Table 1-1.)
Other application software varies according to the
actual development requirements. The required
software is pre-installed by default. You need only
configure the software before using it.
Target board Boot Fastboot
program
OS HiSilicon Linux (HiLinux for short). The HiLinux
kernel is developed based on the standard Linux
kernel, and the root file system is developed based on
the BusyBox. (For details about the kernel and
BusyBox versions, see Table 1-1.)
Application Supports common Linux commands, such as telnetd
software and gdb server.
Program Uclibc and Glibc
development (For details about the versions of the development
library libraries, see Table 1-1.)

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 3
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 1 Development Environment

1.3 Setting Up the Linux Development Environment

1.3.1 Installing an OS on the Linux Server
It is recommended that you install the latest stable release of an OS on the Linux server (such
as the RedHat Fedora Core series, SUCE10, or Ubuntu10) to ensure easily available technical
support. The following lists some recommended OS versions:
 Later versions of RedHat, such as the RedHat Fedora Core series, Redhat Enterprise
Linux, and Red Hat 3.4.4-2.
 Earlier versions of RedHat, such as RedHat 9.0.
The stable releases of Debian are also commonly used. The advantage of Debian is that
several types of installation packages are available and can be easily updated online.

1.3.2 Installing the Cross Compiler

A cross compiler obtained from other sources (such as Internet) may not be compatible with
the existing kernel, and may result in unexpected issues during development.

A toolchain release package is seperately provided and contains two compilation toolchains:
arm-hisiv5x0-linux (based on Uclibc) and arm-hisiv6x0-linux (based on Glibc). For details
about the toolchain versions, see Table 1-1. In this document, arm-hisiXXX-linux is used to
represent the two toolchains.
To install the cross compiler, perform the following steps:
Step 1 Go to the toolchain directory and run the following command to decompress the toolchain:
cd toolchain
tar -xvf arm-hisiXXX-linux.tgz

Step 2 Install the toolchain.

Modify the permission to run the installation tool, and run the sudo ./
arm-hisivXXX-linux/arm-hisivXXX-linux.install command to install the toolchain.
----End

1.3.3 Installing the SDK

The SDK is a software development package based on the REFB. It contains all the tools and
source code used in Linux-related development. Therefore, the SDK acts as the basic software
platform for chip development.
To install the Hi35xx V100 SDK on a Linux server, perform the following steps:
Step 1 Copy the Hi35xx_V100R001XX.tgz package (XX indicates the version number) to the Linux
server.
Step 2 Decompress the preceding package by running tar –zxf Hi35xx_V100R001XX.tgz.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 4
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 1 Development Environment

If no message is displayed during decompression, wait until the command is executed.

Step 3 Open the Hi35xx_V100R001XX folder, and run ./ sdk.unpack.
If you do not have the root permission, the system asks you to enter the password of the root
user or sudo user. If the system displays a message indicating that you have no execution
permission, run chmod 777 ./sdk.unpack.
----End

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 5
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 2 U-Boot

2 U-Boot

For details, see Hi35xx Vx00 U-Boot Porting Development Guide.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 6
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 3 Linux Kernel

3 Linux Kernel

3.1 Kernel Source Codes

By default, only the patch file is released in the release package, and the kernel source code
package needs to be downloaded from the open source community. For details of the
instructions, see osdrv/opensource/kernel/readme_cn.txt. For details of the kernel and
toolchain versions used by a specific platform, see Table 1-1.

3.1.1 Downloading the Kernel Source Code from the Linux Open
Source Community
Step 1 Go to the website www.kernel.org.
Step 2 Click HTTP or https://www.kernel.org/pub/.
Step 3 Click linux/.
Step 4 Click kernel/.
Step 5 Click v3.x/ or v4.x/
Step 6 Download linux-3.18.20.tar.gz (or linux-4.9.37.tar.gz).
----End

3.1.2 Installing the Patch

This section uses kernel linux-3.18.y as an example to describe how to install patches to the Linux
kernel, which applies to linux-4.9.y as well.

Step 1 Save the downloaded linux-3.18.20.tar.gz file to the osdrv/opensource/kernel directory of

the hi35xx SDK release package.
Step 2 On the Linux server, go to the osdrv root directory of hi35xx SDK release package and run
the following commands:
cd opensource/kernel
tar -zxf linux-3.18.20.tar.gz
mv linux-3.18.20 linux-3.18.y
cd linux-3.18.y

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 7
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 3 Linux Kernel

patch -p1 < ../hi35xx_for_linux_v3.18.y.patch

cd ../

----End

 If the downloaded kernel file is linux-3.18.20.tar.xz, run the xz -d linux-3.18.20.tar.xz

command to decompress linux-3.18.20.tar.xz into linux-3.18.20.tar, and then run the tar
-xvf linux-3.18.20.tar command to decompress linux-3.18.20.tar.
 The source code package of kernel linux-4.9.y downloaded from the open source
community is linux-4.9.37.tar.gz (or linux-4.9.37.tar.xz). The format conversion of the
source code is similar to that of linux-3.18.20.tar.xz.

3.2 Configuring the Kernel

This section uses kernel linux-3.18.y as an example to describe how to configure the Linux kernel,
which applies to linux-4.9.y as well.

If you are not familiar with the kernel and Hi35xx Vx00 platform, do not change the default
configuration. However, you can add modules as required.

To configure the kernel, run the following commands:

Step 1 Copy the .config file manually:
cd kernel/linux-3.18.y
cp arch/arm/configs/hi35xx_xx_full_defconfig .config

The configuration files can be classified into the following types based on the boot medium of the flash
memory: hi35xx_full_defconfig and hi35xx_nand_defconfig. The former is used for configuring the SPI
NOR flash and SPI NAND flash, and the latter is used for configuring the parallel NAND flash. (Not all
platforms support the parallel NAND flash. For details, see Table 1-1.)

Step 2 Configure the kernel by running the make menuconfig command

make ARCH=arm CROSS_COMPILE= arm-hisiXXX-linux- menuconfig

Step 3 Select modules as required.

Step 4 Save the settings and exit.
----End

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 8
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 3 Linux Kernel

The two parameters ARCH = arm and CROSS_COMPILE = arm-hisiXXX-linux- must be added
after the make command during kernel compilation. The CROSS_COMPILE parameter indicates the
toolchain. In this document, the CROSS_COMPILE = arm-hisiXXX-linux- parameter indicates the
following two situations:
 Hi35xx_V100R001C01SPCxxx corresponds to Uclibc. If the Uclibc toolchain is used, the
CROSS_COMPILE parameter is set to arm-hisiv5x0-linux-.
 Hi35xx_V100R001C02SPCxxx corresponds to Glibc. If the Glibc toolchain is used, the
CROSS_COMPILE parameter is set to arm-hisiv6x0-linux-.

3.3 Compiling the Kernel and Generating the Kernel

Image uImage
After settings are saved, run make ARCH=arm
CROSS_COMPILE=arm-hisiXXX-linux-uImage to compile the kernel and generate the
kernel image. This may take several minutes.

If errors occur during kernel compilation, execute commands in the following sequence:
 make ARCH=arm CROSS_COMPILE=arm-hisiXXX-linux- clean
 make ARCH=arm CROSS_COMPILE=arm-hisiXXX-linux- menuconfig,
 make ARCH=arm CROSS_COMPILE=arm-hisiv100nptl-linux- uImage.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 9
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

4 Root File System

4.1 Introduction to the Root File System

The top layer of the Linux directory structure is the root directory called "/". After loading the
Linux kernel, the system mounts a device to the root directory. The file system of the device is
called the root file system. All the mount points of system commands, system configuration,
and other file systems are all located in the root file system.
The root file system is typically stored in the common memory, flash memory, or
network-based file system. All the applications, libraries, and other services required by the
embedded system are stored in the root file system. Figure 4-1 shows the structure of the top
directory of the root file system.

Figure 4-1 Structure of the root file system's top directory

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 10
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

A common Linux root file system consists of all the directories in the root file system's top
directory structure. In an embedded system, the root file system needs to be simplified. Table
4-1 describes some directories that can be ignored.

Table 4-1 Some directories that can be ignored

Directory Description

/home, /mnt, /opt, and /root Directories that can be expanded by multiple users.
/var and /tmp The /var directory stores system logs or temporary service
program files.
The /tmp directory stores temporary user files.
/boot The /boot directory stores kernel images. During startup, the
PC loads the kernel from the /boot directory. For an
embedded system, the kernel images are stored in the flash
memory or on the network server instead of the root file
system to conserve space. Therefore, this directory can be
ignored.

Empty directories do not increase the size of a file system. If there is no specific reason, you are advised
to retain these directories.

4.2 Creating a Root File System by Using the BusyBox

Before creating a root file system by using the BusyBox, you need to obtain the BusyBox
source code, and then configure, compile, and install the BusyBox.

4.2.1 Obtaining the Source Code of the BusyBox

After the SDK is installed successfully, the complete source code of the BusyBox is saved in
osdrv/opensource/busybox/ folder. You can also download the BusyBox source code of the
same version from http://www.busybox.net.

4.2.2 Configuring the BusyBox

Table 4-2 BusyBox comparison between different chip platforms

Chip Platform Configuration File CFLAGS Configuration

Hi3531D V100  config_v500_a9_softf (-march=armv7-a -mcpu=cortex-a9
p_neon -mfloat-abi=softfp -mfpu=neon
 config_v600_a9_softf -mno-unaligned-access
p_neon -fno-aggressive-loop-optimizations)
Additional CFLAGS

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 11
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

Chip Platform Configuration File CFLAGS Configuration

 Hi3521D V100  config_v500_a7_softf (-mcpu=cortex-a7 -mfloat-abi=softfp
 Hi3520D V400 p_neon -mfpu=neon-vfpv4
 config_v600_a7_softf -fno-aggressive-loop-optimizations)
 Hi3536C V100
p_neon Additional CFLAGS

 Hi3518E V200  config_v510_arm9 (-march=armv5te -mcpu=arm926ej-s

 Hi3518E V201  config_v610_arm9 -fno-aggressive-loop-optimizations)
Additional CFLAGS
 Hi3516C V200
Hi3521A V100  config_v510_a7_softf (-mcpu=cortex-a7 -mfloat-abi=softfp
p_neon -mfpu=neon-vfpv4
 config_v610_a7_softf -fno-aggressive-loop-optimizations)
p_neon Additional CFLAGS

Hi3531A V100  config_v510_a9_softf (-mcpu=cortex-a9 -mfloat-abi=softfp

p_neon -mfpu=neon
 config_v610_a9_softf -fno-aggressive-loop-optimizations)
p_neon Additional CFLAGS

 The following takes busybox-1.20.2 as an example to describe how to configure the BusyBox,
which applies to busybox-1.20.2 as well.
 For details about the CFLAGS configuration, see Table 4-2.

To configure the BusyBox, you need to go to the directory of the BusyBox, decompress the
source code file, and then run the following command:
1. cp osdrv/opensource/busybox/busybox-1.20.2/config_XXX_xx_softfp_neon
osdrv/opensource/busybox/busybox-1.20.2/.config //Specify a configuration file.
XXX indicates the toolchain, and xx indicates the CPU. For details, see Table 4-2.
2. make menuconfig
The configuration GUI of the BusyBox is the same as that of the kernel. By using the simple
and intuitive configuration options, you can configure the BusyBox as required. Pay attention
to the following two options that are displayed after you choose BusyBox Settings > Build
Options:
[*]Build BusyBox as a static binary (no shared libs)
[*] Build with Large File Support (for accessing files > 2 GB)
(arm-hisiv500-linux-) Cross Compiler prefix
() Path to sysroot
(-mcpu=cortex-a9 -mfloat-abi=softfp -mfpu=neon) Additional CFLAGS
() Additional LDLIBS

Note the following points:

 The first option is used to determine whether to compile the BusyBox as an executable
file with a static link. If the option is selected, the compiled BusyBox has a static link. In
this case, the BusyBox does not depend on the dynamic library and has a large size. If

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 12
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

the option is deselected, the compiled BusyBox has a dynamic link. In this case, the
BusyBox has a small size but requires the support of the dynamic library.
 The second option is used to select a cross compiler recommended in the SDK. After
configuration, you need to save the settings and close the BusyBox.
For details about the options of the BusyBox, see the BusyBox Configuration Help.

4.2.3 Compiling and Installing the BusyBox

To compile and install the BusyBox, run the following commands:
make
make install

If the BusyBox is compiled and installed successfully, the following directories and files are
generated in the _install directory of the BusyBox:
drwxrwxr-x 2 xxx XXX 4096 October 18 10:58 bin
lrwxrwxrwx 1 xxx XXX 11 October 18 10:58 linuxrc -> bin/busybox
drwxrwxr-x 2 xxx XXX 4096 October 18 10:58 sbin
drwxrwxr-x 4 xxx XXX 4096 October 18 10:58 usr

xxx indicates the user and XXX indicates the group.

4.2.4 Creating a Root File System

After the SDK is installed successfully, the created root file system is saved in the osdrv/pub
directory.
If necessary, you can create a root file system based on the BusyBox.
The following takes busybox-1.20.2 as an example to describe how to create a root file system
based on the BusyBox, which applies to busybox-1.26.2 as well.
To create a root file system, perform the following steps:
Step 1 Go to osdrv/pub/rootfs_XXXX (XXXX indicates the development library, such as Uclibc or
Glibc).
Directories of the root file system are as follows:
mkdir rootbox
cd rootbox
cp –R packet/os /busybox-1.20.2/_intsall/* .
mkdir etc dev lib tmp var mnt home proc

Step 2 Provide required files in the etc, lib, and dev directories.
1. For the files in the etc directory, see the files in /etc of the system. The main files include
inittab, fstab, and init.d/rcS. You are recommended to copy these files from the
examples directory of the BusyBox, and then modify them as required.
2. You can copy device files from the system by running the cp –R file command or
generate required device files by running the mknod command in the dev directory.
3. The lib directory is used to store the library files required by applications. You need to
copy related library files based on applications.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 13
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

----End

After the preceding steps are completed, a root file system is generated.

If you have no special requirements, the configured root file system in the SDK can be used directly. If
you want to add applications developed by yourself, you only need to copy the applications and related
library files to the corresponding directories of the root file system.

4.3 Introduction to File Systems

In the embedded system, the common file systems include the compressed RAM file system
(CRAMFS), journaling flash file system version2 (JFFS2), NFS, initrd, YAFFS2, UBIFS, and
SquashFS. These file systems have the following features:
 CRAMFS and JFFS2 have good spatial features; therefore, they are applicable to
embedded applications.
 CRAMFS and SquashFS are read-only file systems.
 SquashFS provides the highest compression rate.
 JFFS2 is a readable/writable file system.
 NFS is suitable for the commissioning phase at the initial stage of development.
 UBIFS and YAFFS2 are applicable to the NAND flash.
 initrd uses the read-only CRAMFS.

4.3.1 CRAMFS
CRAMFS is a new file system that was developed based on Linux kernel V2.4 and later.
CRAMFS is easy to use, easy to load, and has a high running speed.
The advantages and disadvantages of CRAMFS are as follows:
 Advantages: CRAMFS stores file data in compression mode. When CRAMFS runs, the
data is decompressed. This mode can save the storage space in flash memory.
 Disadvantages: CRAMFS cannot directly run on flash memory, because it stores
compressed files. When CRAMFS runs, the data needs to be decompressed and then
copied to the memory, which reduces read efficiency. Also, CRAMFS is read-only.
For Linux running on the board to support CRAMFS, you must add the cramfs option when
compiling the kernel. The process is as follows: After running make menuconfig, choose
File > systems, select miscellaneous filesystems, and then select Compressed ROM file
system support (the option is selected in the SDK kernel by default).
The mkfs.cramfs tool is used to create the CRAMFS image. To be specific, the CRAMFS
image is generated after you process a created file system by using mkfs.cramfs. This
procedure is similar to the procedure for creating an ISO file image using a CD-ROM. The
related command is as follows:
./mkfs.cramfs ./rootfs./cramfs-root.img

Where, rootfs is a created root file system, and cramfs-root.img is the generated CRAMFS
image.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 14
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

4.3.2 JFFS2
JFFS2 is on the successor of the JFFS file system created by David Woodhouse of RedHat.
JFFS2 is the actual file system used in original flash chips of embedded mini-devices. As a
readable/writable file system with structured logs, JFFS2 has the following advantages and
disadvantages:
 Advantages: The stored files are compressed. The most important feature is that the
system is readable and writable.
 Disadvantages: When being mounted, the entire JFFS2 needs to be scanned. Therefore,
when the JFFS2 partition is expanded, the mounting time also increases. Flash memory
space may be wasted if JFFS2 format is used. The main causes of this are excessive use
of log files and reclamation of useless storage units of the system. The size of wasted
space is equal to the size of several data segments. Another disadvantage is that the
running speed of JFFS2 decreases rapidly when the memory is full or nearly full due to
trash collection.
To load JFFS2, perform the following steps:
Step 1 Scan the entire chip, check log nodes, and load all the log nodes to the buffer.
Step 2 Collate all the log nodes to collect effective nodes and generate a file directory.
Step 3 Search the file system for invalid nodes and then delete them.
Step 4 Collate the information in the memory and release the invalid nodes that are loaded to the
buffer.
----End

The preceding features show that system reliability is improved at the expense of system
speed. Additionally, flash chips with large capacity, the loading process is slower.
To enable kernel support for JFFS2, you must select the JFFS2 option when compiling the
kernel (the released kernel of HiSilicon supports JFFS2 by default). The process is as follows:
After running the make menuconfig command, choose File > systems, select miscellaneous
filesystems, and then select Journaling Flash File System v2 (JFFS2) support (the option is
selected in the SDK kernel by default).
To create a JFFS2 file system, run the following command:
./mkfs.jffs2 –d ./rootfs -l –e 0x20000 -o rootfs.jffs2

You can download the mkfs.jffs2 tool from the Internet or obtain it from the SDK. rootfs is a
created root file system. Table 4-3 describes the JFFS2 parameters.

Table 4-3 JFFS2 parameters

Parameter Description
d Specifies the root file system.
l Indicates the little-endian mode.
e Specifies the buffer size of the flash memory.
o Exports images.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 15
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

4.3.3 YAFFS2
YAFFS2 is an embedded file system designed for the NAND flash (including the SPI NAND
flash and parallel NAND flash). As a file system with structured logs, YAFFS2 provides the
loss balance and power failure protection, which ensures the consistency and integrity of the
file system in case of power failure.

 According to the difference between the boot media of flash memories, if the Hi35xx
supports only SPI NAND flash, the tool to make the YAFFS2 file system is
mkyaffs2image100. If the Hi35xx supports the SPI NAND flash and parallel NAND flash,
the tools to make the YAFFS2 file system are the mkyaffs2image100 and
mkyaffs2image610.
 The parallel NAND flash is supported only by Hi3531D V100 and Hi3531A V100.

The advantages and disadvantages of YAFFS2 are as follows:

 Advantages
− Designed for NAND flash and provides optimized software structure and fast running
speed.
− Stores the file organization information by using the spare area of the hardware. Only
the organization information is scanned in the case of system startup. In this way, the
system starts fast.
− Adopts the multi-policy trash recycle algorithm. Therefore, YAFFS2 improves the
efficiency and fairness of trash recycle for the loss balance.
 Disadvantages
The stored files are not compressed. Even when the contents are the same, a YAFFS2
image is greater than a JFFS2 image.
In the SDK, YAFFS2 is provided as a module. To generate the YAFFS2 module, you need to
add the path of the related kernel code to the Makefile in the YAFFS2 code package, and then
perform compilation.
Both the YAFFS2 image and CRAMFS image can be generated by using tools. To generate a
YAFFS2 image, run the following command:
For the SPI NAND Flash:
./mkyaffs2image100 ./rootfs image_rootfs.yaffs2 pagesize ecctype

For the parallel NAND flash:

./mkyaffs2image610 ./rootfs image_rootfs.yaffs2 pagesize ecctype

Where, rootfs is a created root file system, image_rootfs.yaffs2 is a generated YAFFS2

image, pagesize is the page size of the NAND flash welded on the board, and ecctype is the
error checking and correcting (ECC) type of the NAND flash.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 16
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

4.3.4 ubifs
For details about the introduction and usage of the UBIFS file system, see the UBI File
System User Guide.

4.3.5 initrd
The initrd is equivalent to the store media and supports the formats such as ext2 and cramfs.
Therefore, the kernel must support both initrd and CRAMFS. The following configurations
must be complete to enable the initrd to work normally. Generally, the following
configurations are complete in the SDK by default. If you change the configurations by
mistake, do as follows:
 Choose Device Drivers > Block devices, and select RAM block device support and
Initial RAM disk (initrd) support.
 Choose File > systems, and select Miscellaneous filesystems and Compressed ROM
file system support.
To create an initrd image, perform the following steps:
Step 1 Create a CRAMFS image. For details, see section 4.3.1 "CRAMFS."
Step 2 Create an initrd image based on the created CRAMFS image by running the mkimage -A
arm -T ramdisk -C none -a 0 -e 0 -n cramfs-initrd -d ./cramfs-image cramfs-initrd
command.
----End

4.3.6 SquashFS
SquashFS is a read-only file system based on the Linux kernel and features high compression
rate.
SquashFS has the following features:
 Compresses data, inode, and directories.
 Retains 32-bit UID/GIDS and file creation time.
 Supports a maximum of 4 GB file system.
 Detects and deletes duplicate files.
To use SquashFS, perform the following steps:
Step 1 Create a kernel image supporting SquashFS. Go to the kernel directory, and run the following
commands:
cp arch/arm/configs/hi35xx_xx_defconfig .config
make ARCH=arm CROSS_COMPILE=arm-hisiXXX-linux- menuconfig (Save and then
exit)
make ARCH=arm CROSS_COMPILE=arm-hisiXXX-linux- uImage
Enable the option supporting the xz compression algorithm:
File systems --->
[*] Miscellaneous filesystems --->
<*> SquashFS 4.0 - Squashed file system support
[*] Include support for XZ compressed file systems

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 17
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 4 Root File System

Step 2 Create the image of the SquashFS file system by using mksquashfs stored in
SDK/package/osdrv/tools/pc_tools. To use mksquashfs, run the following command:
./mksquashfs rootfs ./ rootfs.squashfs.img -b 64K –comp xz

where rootfs is the created root file system; rootfs.squashfs.img is the generated image of the
SquashFS file system; -b 64K indicates that the block size of the SquashFS file system is 64
KB (which determines the actual block size of the SPI flash); –comp xz indicates that the
algorithm for compressing the file system is XZ. You need to modify the parameters as
required.
----End

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 18
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide 5 Application Development

5 Application Development

5.1 Compiling Code

You can choose a code compilation tool as desired. In general, the Source Insight is used in
Windows, and Vim+ctags+cscope is used in Linux.

5.2 Running Applications

Before running compiled applications, you need to add them to the target machine and
perform the following operations:
 Add the applications and required library files (if any) to the directories of the root file
system of the target machine. Generally, applications are placed in the /bin directory,
library files are placed in the /lib directory, and configuration files are placed in the /etc
directory.
 Creates a root file system containing new applications.

Before running applications, you need to write and read the file system. You are recommended to use the
YAFFS2 or JFFS2 file system.

To create CRAMFS, YAFFS2 or JFFS2, you need to create corresponding file system (see
section 4.3 "Introduction to File Systems"), burn the root file system to the specified address
in the flash memory, and set the related boot parameters. In this case, new applications can
run properly after Linux starts.

To enable new applications to run automatically when the system starts, edit the /etc/init.d/rcS file, and
then add the paths of the applications to be started.

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 19
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide A Acronyms and Abbreviations

A Acronyms and Abbreviations

A
ARM advanced RISC machine

C
CRAMFS compressed RAM file system

D
DMS digital media solution

E
ELF executable and linkable format

G
GCC GNU compiler collection
GNU GNU's not Unix

I
IP Internet Protocol

J
JFFS2 journaling flash file system version2
JTAG joint test action group

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 20
Copyright © HiSilicon Technologies Co., Ltd.
 Hi35xx Vx00 Linux Development Environment
User Guide A Acronyms and Abbreviations

P
PC personal computer

S
SDRAM synchronous dynamic random access memory
SDK software development kit

U
UBIFS unsorted block image file system

YAFFS2 yet another flash file system v2

HiSilicon Proprietary and Confidential

Issue 01 (2018-05-15) 21
Copyright © HiSilicon Technologies Co., Ltd.