NXP Semiconductors LS1021A-TSN User manual

Open Industrial User Guide
NXP Semiconductors Document identifier: OpenILUG
User's Guide Rev. 1.8, 05/2020

Contents
Chapter 1 Introduction........................................................................................... 7
1.1 Acronyms and abbreviations..................................................................................................... 7
1.2 Reference documentation......................................................................................................... 8
1.3 About OpenIL............................................................................................................................ 9
1.3.1 OpenIL Organization................................................................................................................... 9
1.3.2 Host system requirements........................................................................................................ 10
1.4 Feature set summary...............................................................................................................12
1.4.1 Compilation features................................................................................................................. 12
1.4.2 Supported industrial features.................................................................................................... 14
1.5 Supported NXP platforms and configurations......................................................................... 15
1.5.1 Default compilation settings for NXP platforms.........................................................................16
Chapter 2 Getting started.....................................................................................18
2.1 Getting OpenIL........................................................................................................................ 18
2.2 OpenIL quick start................................................................................................................... 18
2.2.1 Important notes......................................................................................................................... 18
2.2.2 Building the final images........................................................................................................... 18
2.3 Booting up the board............................................................................................................... 21
2.3.1 SD card bootup......................................................................................................................... 22
2.3.2 QSPI/FlexSPI bootup................................................................................................................ 22
2.3.3 Starting up the board.................................................................................................................22
2.4 Basic OpenIL operations......................................................................................................... 23
Chapter 3 NXP OpenIL platforms........................................................................ 25
3.1 Introduction..............................................................................................................................25
3.2 LS1021A-TSN......................................................................................................................... 25
3.2.1 Switch settings.......................................................................................................................... 25
3.2.2 Updating target images ............................................................................................................ 25
3.3 LS1021A-TWR........................................................................................................................ 26
3.3.1 Switch settings.......................................................................................................................... 26
3.3.2 Updating target images ............................................................................................................ 26
3.4 LS1021A-IoT........................................................................................................................... 27
3.4.1 Switch settings ......................................................................................................................... 27
3.4.2 Updating target images ............................................................................................................ 27
3.5 LS1043ARDB, LS1046ARDB and LS1046AFRWY................................................................ 28
3.5.1 Switch settings.......................................................................................................................... 28
3.5.2 Updating target images ............................................................................................................ 28
3.6 LS1012ARDB.......................................................................................................................... 29
3.6.1 Switch settings.......................................................................................................................... 30
3.6.2 Updating target images ............................................................................................................ 30
3.7 i.MX6QSabreSD......................................................................................................................31
3.7.1 Switch settings for the i.MX6Q SabreSD.................................................................................. 31
3.7.2 Updating target images............................................................................................................. 31
3.8 LS1028ARDB and LS1028ATSN............................................................................................ 32
3.8.1 Switch settings.......................................................................................................................... 32
3.8.2 Interface naming....................................................................................................................... 32
3.8.3 Updating target images............................................................................................................. 36
3.8.4 LCD controller and DisplayPort/eDP.........................................................................................37
3.9 LX2160ARDB.......................................................................................................................... 38
NXP Semiconductors
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 2 / 199

3.9.1 Switch settings.......................................................................................................................... 38
3.9.2 Updating target images ............................................................................................................ 38
Chapter 4 Industrial features................................................................................40
4.1 NETCONF/YANG....................................................................................................................40
4.2 TSN......................................................................................................................................... 40
4.3 Xenomai.................................................................................................................................. 40
4.3.1 Xenomai running mode............................................................................................................. 41
4.3.2 RTnet ....................................................................................................................................... 43
4.4 PREEMPT-RT......................................................................................................................... 47
4.4.1 System RT Latency Tests......................................................................................................... 47
4.4.2 RT Application Development.....................................................................................................47
4.5 IEEE 1588............................................................................................................................... 48
4.5.1 Introduction............................................................................................................................... 48
4.5.2 PTP device types...................................................................................................................... 48
4.5.3 Linux PTP stack........................................................................................................................ 49
4.5.4 Quick start guide for setting up IEEE standard 1588 demonstration........................................ 49
4.5.5 Known issues and limitations.................................................................................................... 53
4.5.6 Long term test results for Linux PTP.........................................................................................53
4.6 OP-TEE................................................................................................................................... 54
4.6.1 Introduction............................................................................................................................... 55
4.6.2 Deployment architecture........................................................................................................... 55
4.6.3 DDR memory map.....................................................................................................................56
4.6.4 Configuring OP-TEE on LS1021A-TSN platform...................................................................... 57
4.6.5 Running OP-TEE on LS1021A-TSN platform........................................................................... 57
4.7 SELinux................................................................................................................................... 59
4.7.1 Running SELinux demo............................................................................................................ 59
Chapter 5 IEEE 1588/802.1AS............................................................................ 68
5.1 Introduction..............................................................................................................................68
5.2 Device types............................................................................................................................68
5.3 Two types of time-aware systems in IEEE 802.1AS............................................................... 68
5.4 linuxptp stack...........................................................................................................................69
5.5 Quick Start for IEEE 1588....................................................................................................... 69
5.5.1 Ordinary clock verification......................................................................................................... 69
5.5.2 Boundary clock verification....................................................................................................... 70
5.5.3 Transparent clock verification................................................................................................... 70
5.6 Quick Start for IEEE 802.1AS..................................................................................................70
5.6.1 Time-aware end station verification.......................................................................................... 71
5.6.2 Time-aware bridge verification.................................................................................................. 71
5.7 Known issues and limitations.................................................................................................. 72
5.8 Long term test..........................................................................................................................72
Chapter 6 NETCONF/YANG................................................................................73
6.1 Overview..................................................................................................................................73
6.2 Netopeer2................................................................................................................................73
6.2.1 Overview................................................................................................................................... 73
6.2.2 Sysrepo..................................................................................................................................... 74
6.2.3 Netopeer2 server...................................................................................................................... 74
6.2.4 Netopeer2 client........................................................................................................................ 74
6.2.5 Workflow in application practice................................................................................................75
6.3 Installing Netopeer2-cli on Ubuntu18.04................................................................................. 75
NXP Semiconductors
Contents
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 3 / 199

6.4 Configuration........................................................................................................................... 76
6.4.1 Enabling NETCONF feature in OpenIL..................................................................................... 76
6.4.2 Netopeer2-server...................................................................................................................... 77
6.4.3 Netopeer2-cli ............................................................................................................................77
6.4.4 Sysrepod................................................................................................................................... 80
6.4.5 Sysrepocfg................................................................................................................................ 81
6.4.6 Sysrepoctl................................................................................................................................. 81
6.4.7 Operation examples.................................................................................................................. 82
6.4.8 Application scenarios................................................................................................................ 84
6.5 Web UI demo...........................................................................................................................85
6.6 Troubleshooting.......................................................................................................................87
Chapter 7 OPC UA.............................................................................................. 89
7.1 OPC introduction..................................................................................................................... 89
7.2 The node model.......................................................................................................................89
7.3 Node Namespaces..................................................................................................................90
7.4 Node classes...........................................................................................................................91
7.5 Node graph and references.....................................................................................................91
7.6 Open62541..............................................................................................................................92
7.7 Example of a server application: OPC SJA1105.....................................................................93
7.8 FreeOpcUa Client GUI............................................................................................................ 93
Chapter 8 TSN .................................................................................................... 96
8.1 Using TSN features on LS1028ARDB.....................................................................................96
8.1.1 Tsntool User Manual................................................................................................................. 96
8.1.2 Kernel configuration................................................................................................................ 105
8.1.3 Basic TSN configuration examples on ENETC....................................................................... 106
8.1.4 Basic TSN configuration examples on the switch................................................................... 115
8.1.5 Netconf usage on LS1028ARDB.............................................................................................130
8.2 Using TSN features on LS1021A-TSN board........................................................................130
8.2.1 Topology................................................................................................................................. 130
8.2.2 SJA1105 Linux support........................................................................................................... 131
8.2.3 Synchronized 802.1Qbv demo................................................................................................134
8.2.4 NETCONF usage.................................................................................................................... 139
Chapter 9 4G-LTE Modem ................................................................................140
9.1 Introduction............................................................................................................................140
9.2 Hardware preparation............................................................................................................140
9.3 Software preparation............................................................................................................. 140
9.4 Testing 4G USB modem link to the internet.......................................................................... 140
Chapter 10 OTA implementation....................................................................... 142
10.1 Introduction..........................................................................................................................142
10.2 Platform support for OTA demo...........................................................................................142
10.3 Server requirements............................................................................................................143
10.4 OTA test case......................................................................................................................144
Chapter 11 EtherCAT........................................................................................ 145
11.1 Introduction..........................................................................................................................145
11.2 IGH EtherCAT architecture..................................................................................................145
NXP Semiconductors
Contents
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 4 / 199

11.3 EtherCAT protocol...............................................................................................................146
11.4 EtherCAT system integration and example ........................................................................147
11.4.1 Building kernel images for EtherCAT.................................................................................... 147
11.4.2 Command-line tool................................................................................................................ 148
11.4.3 System integration................................................................................................................ 150
11.4.4 Running a sample application............................................................................................... 151
Chapter 12 nxp-servo........................................................................................ 155
12.1 CoE network........................................................................................................................155
12.2 Libnservo Architecture.........................................................................................................155
12.3 Xml Configuration................................................................................................................156
12.3.1 Master Element..................................................................................................................... 157
12.3.2 Axle Element......................................................................................................................... 160
12.4 Test......................................................................................................................................160
12.4.1 Hardware Preparation .......................................................................................................... 160
12.4.2 Software Preparation............................................................................................................ 161
12.4.3 CoE Network Detection.........................................................................................................161
12.4.4 Start Test...............................................................................................................................161
Chapter 13 FlexCAN..........................................................................................164
13.1 Introduction..........................................................................................................................164
13.1.1 CAN bus................................................................................................................................164
13.1.2 CANopen...............................................................................................................................165
13.2 FlexCAN integration in OpenIL............................................................................................167
13.2.1 LS1021AIOT CAN resource allocation..................................................................................167
13.2.2 Introducing the function of CAN example code.....................................................................169
13.3 Running a CAN application................................................................................................. 170
13.3.1 Hardware preparation for LS1021-IoT.................................................................................. 170
13.3.2 Hardware preparation for LS1028ARDB...............................................................................171
13.3.3 Compiling the CANopen-app binary for the master node..................................................... 172
13.3.4 Running the CANopen application........................................................................................ 173
13.3.5 Running the Socketcan commands...................................................................................... 176
13.3.6 Testing CAN bus................................................................................................................... 176
Chapter 14 NFC click board...............................................................................178
14.1 Introduction..........................................................................................................................178
14.2 PN7120 features..................................................................................................................178
14.3 Hardware preparation..........................................................................................................178
14.4 Software preparation........................................................................................................... 178
14.5 Testing the NFC click board................................................................................................ 179
Chapter 15 BEE Click Board..............................................................................181
15.1 Introduction..........................................................................................................................181
15.2 Features.............................................................................................................................. 181
15.3 Hardware preparation..........................................................................................................181
15.4 Software preparation........................................................................................................... 182
15.5 Testing the BEE click board................................................................................................ 183
Chapter 16 BLE click board............................................................................... 185
16.1 Introduction..........................................................................................................................185
NXP Semiconductors
Contents
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 5 / 199

16.2 Features.............................................................................................................................. 185
16.3 Hardware preparation..........................................................................................................185
16.4 Software preparation........................................................................................................... 186
16.5 Testing the BLE P click board............................................................................................. 187
Chapter 17 QT................................................................................................... 190
17.1 Introduction..........................................................................................................................190
17.2 Software settings and configuration.................................................................................... 190
17.3 Hardware setup................................................................................................................... 190
17.4 Running the QT5 demo....................................................................................................... 191
17.4.1 Environment setting.............................................................................................................. 191
17.4.2 Running the demos............................................................................................................... 191
Chapter 18 EdgeScale client............................................................................. 194
18.1 What is EdgeScale.............................................................................................................. 194
18.2 Edgescale features..............................................................................................................194
18.3 Building EdgeScale client....................................................................................................194
18.4 Procedure to start EdgeScale..............................................................................................194
Chapter 19 Revision history...............................................................................196
NXP Semiconductors
Contents
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 6 / 199

Chapter 1
Introduction
This document provides a complete description of Open Industrial Linux (OpenIL) features, getting started on OpenIL using NXP
OpenIL platforms, and the various software settings involved. It describes in detail the industrial features, which include
NETCONF/YANG, TSN, Xenomai, Preempt-RT, IEEE 1588, OP-TEE, and SELinux. It also includes detailed steps for running
the demos such as Selinux demo, 1-board TSN Demo, 3-board TSN demo, 4G-LTE demo, and OTA implementation. It also
provides a complete description of the OpenIL compilation steps.
1.1 Acronyms and abbreviations
The following table lists the acronyms used in this document.
Table 1. Acronyms and abbreviations
Term Description
BC Boundary clock
BMC Best master clock
CA Client application
CAN Controller Area Network
DEI Drop eligibility indication
EtherCAT Ethernet for Control Automation Technology
FMan Frame manager
ICMP Internet control message protocol
IETF Internet engineering task force
IPC Inter process communication
KM Key management
LBT Latency and bandwidth tester
MAC Medium access control
NMT Network management
OC Ordinary clock
OpenIL Open industry Linux
OP-TEE Open portable trusted execution environment
OS Operating system
OTA Over-the air
OTPMK One-time programmable master key
PCP Priority code point
PDO Process data object
PHC PTP hardware clock
Table continues on the next page...
NXP Semiconductors
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 7 / 199

Table 1. Acronyms and abbreviations (continued)
Term Description
PIT Packet inter-arrival times
PTP Precision time protocol
QSPI Queued serial peripheral interface
RCW Reset configuration word
REE Rich execution environment
RPC Remote procedure call
RTT Round-trip times
SABRE Smart Application Blueprint for Rapid Engineering
SDO Service data object
SRK Single root key
TA Trusted application
TAS Time-aware scheduler
TCP Transmission control protocol
TEE Trusted execution environment
TFTP Trivial file transfer protocol
TSN Time sensitive networking
TZASC Trust zone address space controller
UDP User datagram protocol
VLAN Virtual local area network
1.2 Reference documentation
1. Refer to the following documents for detailed instructions on booting up the NXP hardware boards supported by Open IL:
•LS1012ARDB Getting Started Guide
.
•LS1021AIoT Getting Started Guide .
•LS1021ATSN Getting Started Guide
•LS1021ATWR Getting Started Guide
•LS1043ARDB Getting Started Guide.
•LS1046ARDB Getting Started Guide.
•LS1046AFRWY Getting Started Guide
•i.MX6 SabreSD Board Quick Start Guide
•LS1028ARDB Quick Start Guide
•LX2160ARDB Quick Start Guide
2. For booting up LS1021A-TSN board, refer to the Section Booting up the board of this document.
3. For the complete description of the industrial IoT baremetal framework, refer to the latest available version of Industrial
IoT Baremetal Framework Developer Guide.
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 8 / 199

1.3 About OpenIL
The OpenIL project (“Open Industry Linux”) is designed for embedded industrial usage. It is an integrated Linux distribution for
industry.
OpenIL is built on buildroot project and provides packages for the industrial market.
•Focus on industry: OpenIL provides key components for industry usage, for example, Time sensitive network (TSN), Netconf,
IEEE 1588, and Xenomai or Preempt-RT.
•Ease of use: OpenIL is a tool that simplifies and automates the process of building a complete Linux system for an embedded
system, using cross-compilation. It follows the buildroot project rules. For more buildroot information, refer to the page: https://
buildroot.org/
•Extensibility: OpenIL provides capabilities of industry usage and standardized Linux system packages. And user can also
easily replicate the same setup on customized packages and devices.
•Lightweight: OpenIL only includes necessary Linux packages and industry packages in order to make the system more
lightweight to adapt to industry usage. Users can customize the package via a configuration file.
•Open Source: OpenIL is an open project. Anyone can participate in the OpenIL development through the Open Source
community.
1.3.1 OpenIL Organization
OpenIL follows the Buildroot directory structure depicted in the following figure. The second and third levels of the directory are
generated during compilation.
Figure 1. OpenIL structure
Table 2. Source directories
Directory name Description
arch Files defining the architecture variants (processor type, ABI, floating point, etc.)
toolchain Packages for generating or using tool-chains
system Contains the rootfs skeleton and options for system-wide features
linux The linux kernel package.
Table continues on the next page...
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 9 / 199

Table 2. Source directories (continued)
Directory name Description
package All the user space packages (1800+)
fs Logic to generate file system images in various formats
boot Boot-loader packages
configs Default configuration files for various platforms
board Board-specific files (kernel configurations, patches, image flashing scripts, etc.)
support Miscellaneous utilities (kconfig code, libtool patches, download helpers, and more)
docs Documentation
Table 3. Build directories
Directory name Description
dl Path where all the source tarballs are downloaded
output Global output directory
output/build Path where all source tarballs are extracted and the build of each package takes place.
output/host Contains both the tools built for the host and the sysroot of the toolchain
output/staging A symbolic link to the sysroot, that is, to host/<tuple>/sysroot/ for convenience
output/target The target Linux root filesystem, used to generate the final root filesystem images
output/images Contains all the final images: kernel, bootloader, root file system, and so on
1.3.2 Host system requirements
OpenIL is designed to build in Linux systems. The following host environments have been verified to build the OpenIL.
• Ubuntu 16.10
• Ubuntu 16.04
• Ubuntu 14.04
• Ubuntu 18.04
While OpenIL itself builds most host packages it needs for the compilation, certain standard Linux utilities are expected to be
already installed on the host system. The following tables provide an overview of the mandatory and optional packages.
Package names listed in the following tables might vary between distributions.
NOTE
Table 4. Host system mandatory packages
Mandatory packages Remarks
which
sed
make Version 3.81 or later
binutils
Table continues on the next page...
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 10 / 199

Table 4. Host system mandatory packages (continued)
Mandatory packages Remarks
build-essential Only for Debian based systems
gcc Version 2.95 or later
g++ Version 2.95 or later
bash
patch
gzip
bzip2
perl Version 5.8.7 or later
tar
cpio
python Version 2.6 or later
unzip
rsync
file Must be in /usr/bin/file
bc
wget
autoconf, dh-autoreconf
openssl, libssl-dev
libmagickwand-dev (Debian,
Ubuntu)
imageMagick-devel (CentOS)
autogen autoconf libtool
pkg-config
python3-pyelftools
python-pyelftools
python3-pycryptodome
python-pycryptodome
binfmt-support used when building ubuntu-rootfs
qemu-system-common used when building ubuntu-rootfs
qemu-user-static used when building ubuntu-rootfs
debootstrap used when building ubuntu-rootfs
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 11 / 199

Table 5. Host system optional packages
Optional packages Remarks
ncurses5 To use the menuconfig interface
qt4 To use the xconfig interface
glib2, gtk2 and glade2 To use the gconfig interface
bazaar Source fetching tools.
If you enable packages using any of these methods, you need to install the corresponding tool
on the host system
cvs
git
mercurial
scp
javac compiler Java-related packages, if the Java Classpath needs to be built for the target system
jar tool
asciidoc Documentation generation tools
w3m
python with the argparse
module
dblatex
graphviz To use graph-depends and <pkg>-graph-depends
python-matplotlib To use graph-build
1.4 Feature set summary
This section provides a summary of OpenIL's compilation and industrial features.
1.4.1 Compilation features
The following are the compilation features:
•Create Ramdisk root filesystem by using the make menuconfig command.
Filesystem images --->
[*] cpio the root filesystem (for use as an initial RAM filesystem)
[*] Create U-Boot image of the root filesystem
This configuration will generate Ramdisk root filesystem based on CPIO, some files created: rootfs.cpio.uboot, rootfs.cpio.gz,
rootfs.cpio.
•Specify partition size of the storage for the filesystem by using the make menuconfig command.
Filesystem images --->
(512M) exact size
This configuration specifies the size of the storage device partition for the building rootfs and currently used by NXP platforms
and SD card device. To set the size of the partition with 512M, 2G or other values, the target system can get the specific size
of partition space for the using filesystem.
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 12 / 199

Another way to modify the space size of second partition: using tool "fdisk" to resize the partition, below are the example steps.
~$ sudo fdisk -l /dev/sdc
Disk /dev/sdc: 7.4 GiB, 7948206080 bytes, 15523840 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: dos
Disk identifier: 0x00000000
Device Boot Start End Sectors Size Id Type
/dev/sdc1 * 131072 655359 524288 256M c W95 FAT32 (LBA)
/dev/sdc2 655360 1703935 1048576 512M 83 Linux
# Notice: we need this start sectors "655360" of second partition when create new partition.#
~$ sudo fdisk /dev/sdc
Welcome to fdisk (util-linux 2.31.1).
Changes will remain in memory only, until you decide to write them.
Be careful before using the write command.
Command (m for help): d
Partition number (1,2, default 2):
Partition 2 has been deleted.
Command (m for help): n
Partition type
p primary (1 primary, 0 extended, 3 free)
e extended (container for logical partitions)
Select (default p):
Using default response p.
Partition number (2-4, default 2):
First sector (2048-15523839, default 2048): 655360
Last sector, +sectors or +size{K,M,G,T,P} (655360-15523839, default 15523839):
Created a new partition 2 of type 'Linux' and of size 7.1 GiB.
Partition #2 contains a ext4 signature.
Do you want to remove the signature? [Y]es/[N]o: n
Command (m for help): w
The partition table has been altered.
Calling ioctl() to re-read partition table.
Syncing disks.
~$ sudo fsck.ext4 /dev/sdc2
e2fsck 1.44.1 (24-Mar-2018)
/dev/sdc2: clean, 3493/32768 files, 26617/131072 blocks
~$ sudo resize2fs /dev/sdc2
resize2fs 1.44.1 (24-Mar-2018)
Resizing the filesystem on /dev/sdc2 to 1858560 (4k) blocks.
The filesystem on /dev/sdc2 is now 1858560 (4k) blocks long.
~$ sudo fdisk -l /dev/sdc
Disk /dev/sdc: 7.4 GiB, 7948206080 bytes, 15523840 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: dos
Disk identifier: 0x00000000
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 13 / 199

Device Boot Start End Sectors Size Id Type
/dev/sdc1 * 131072 655359 524288 256M c W95 FAT32 (LBA)
/dev/sdc2 655360 15523839 14868480 7.1G 83 Linux
•Support custom filesystem (that is, Ubuntu)
Users can download OpenIL and build the target system with an Ubuntu filesystem. The specific filesystem can be set
conveniently by using the make menuconfig command (Notice: "sudo" permission is required when building ubuntu root file
system).
System configuration --->
Root FS skeleton (custom target skeleton) --->
Custom skeleton via network --->
Currently, there are six NXP platforms that can support Ubuntu filesystem:
—configs/nxp_ls1043ardb-64b_ubuntu_defconfig
—configs/nxp_ls1043ardb-64b_ubuntu_full_defconfig
—configs/nxp_ls1046ardb-64b_ubuntu_defconfig
—configs/nxp_ls1046ardb-64b_ubuntu_full_defconfig
—configs/nxp_ls1046afrwy-64b_ubuntu_defconfig
—configs/nxp_ls1046afrwy-64b_ubuntu_full_defconfig
—configs/fii_ls1028atsn-64b_ubuntu_defconfig
—configs/fii_ls1028atsn-64b_ubuntu_full_defconfig
—configs/nxp_ls1028ardb-64b_ubuntu_defconfig
—configs/nxp_ls1028ardb-64b_ubuntu_full_defconfig
—configs/nxp_ls1021aiot_ubuntu_defconfig
—configs/nxp_ls1021aiot_ubuntu_full_defconfig
—configs/imx6q-sabresd_ubuntu_defconfig
—configs/imx6q-sabresd_ubuntu_full_defconfig
—configs/nxp_lx2160ardb-64b_ubuntu_defconfig
—configs/nxp_lx2160ardb-64b_ubuntu_full_defconfig
1.4.2 Supported industrial features
The following are the industrial features supported by OpenIL:
• Netconf/Yang
• Netopeer
• TSN
• IEEE 1588
• IEEE 1588 2-step E2E transparent clock support
• Xenomai Cobalt mode
• Preempt-RT
• SELinux (Ubuntu)
• OP-TEE
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 14 / 199

• DM-Crypt
• Baremetal
• FlexCan
• EtherCAT
• NFC-Clickboard
• BEE-Clickboard
• BLE-Clickboard
These are explained in detail in Industrial features.
For the complete description of the Industrial IoT baremetal framework, refer to the document,
Industrial_IoT_Baremetal_Framework_Developer_Guide .
NOTE
1.5 Supported NXP platforms and configurations
The following table lists the NXP platforms and configurations supported by OpenIL.
Table 6. Supported NXP platforms
Platform Architecture Configuration file in OpenIL Boot
ls1021atsn (default) ARM v7 configs/nxp_ls1021atsn_defconfig SD
ls1021atsn (OP-TEE-SB) ARM v7 configs/nxp_ls1021atsn_optee-sb_defconfig SD
ls1021aiot (default) ARM v7 configs/nxp_ls1021aiot_defconfig SD
ls1021aiot (OP-TEE) ARM v7 configs/nxp_ls1021aiot_optee_defconfig SD
ls1021aiot (Baremetal) ARM v7 configs/nxp_ls1021aiot_baremetal_defconfig SD
ls1021aiot (Ubuntu) ARM v7 configs/nxp_ls1021aiot_ubuntu_defconfig SD
ls1021atwr (default, QSPI) ARM v7 configs/nxp_ls1021atwr_defconfig SD
ls1021atwr (IFC) ARM v7 configs/nxp_ls1021atwr_sdboot_ifc_defconfig SD
ls1043ardb (64bit, default) ARM v8 configs/nxp_ls1043ardb-64b_defconfig SD
ls1043ardb (Baremetal) ARM v8 configs/nxp_ls1043ardb_baremetal-64b_defconfig SD
ls1043ardb (Ubuntu) ARM v8 configs/nxp_ls1043ardb-64b_ubuntu_defconfig SD
ls1046ardb (64bit, default) ARM v8 configs/nxp_ls1046ardb-64b_defconfig SD
ls1046ardb (EMMC) ARM v8 configs/nxp_ls1046ardb-64b-emmcboot_defconfig EMMC
ls1046ardb (QSPI) ARM v8 configs/nxp_ls1046ardb-64b_qspi_defconfig QSPI
ls1046ardb (QSPI-SB) ARM v8 configs/nxp_ls1046ardb-64b_qspi-sb_defconfig QSPI
ls1046ardb (Baremetal) ARM v8 configs/nxp_ls1046ardb_baremetal-64b_defconfig SD
ls1046ardb (Ubuntu) ARM v8 configs/nxp_ls1046ardb-64b_ubuntu_defconfig SD
ls1046afrwy (64bit, default) ARM v8 configs/nxp_ls1046afrwy-64b_defconfig SD
ls1046afrwy (QSPI) ARM v8 configs/nxp_ls1046afrwy-64b_qspi_defconfig QSPI
Table continues on the next page...
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 15 / 199

Table 6. Supported NXP platforms (continued)
Platform Architecture Configuration file in OpenIL Boot
ls1046afrwy (Ubuntu) ARM v8 configs/nxp_ls1046afrwy-64b_ubuntu_defconfig SD
ls1012ardb (64bit) ARM v8 configs/nxp_ls1012ardb-64b_defconfig QSPI
i.MX6Q SabreSD (default) ARM v7 configs/imx6q-sabresd_defconfig SD
i.MX6Q SabreSD (Baremetal) ARM v7 configs/imx6q-sabresd_baremetal_defconfig SD
i.MX6Q SabreSD (Ubuntu) ARM v7 configs/imx6q-sabresd_ubuntu_defconfig SD
ls1028ardb (64bit, default) ARM v8 configs/nxp_ls1028ardb-64b_defconfig SD
ls1028ardb (EMMC) ARM v8 configs/nxp_ls1028ardb-64b-emmc_defconfig EMMC
ls1028ardb (XSPI) ARM v8 configs/nxp_ls1028ardb-64b-xspi_defconfig XSPI
ls1028ardb (Baremetal) ARM v8 configs/nxp_ls1028ardb_baremetal-64b_defconfig SD
ls1028ardb (Ubuntu) ARM v8 configs/nxp_ls1028ardb-64b_ubuntu_defconfig SD
ls1028atsn (64bit, default) ARM v8 configs/fii_ls1028atsn-64b_defconfig SD
ls1028atsn (Ubuntu) ARM v8 configs/fii_ls1028atsn-64b_ubuntu_defconfig SD
lx2160ardb (64bit, default) ARM v8 configs/nxp_lx2160ardb-64b_defconfig SD
lx2160ardb (XSPI) ARM v8 configs/nxp_lx2160ardb-64b-xspi_defconfig XSPI
lx2160ardb (Baremetal) ARM v8 configs/nxp_lx2160ardb_baremetal-64b_defconfig SD
lx2160ardb (Ubuntu) ARM v8 configs/nxp_lx2160ardb-64b_ubuntu_defconfig SD
1.5.1 Default compilation settings for NXP platforms
The following table provides the default compilation settings for each OpenIL NXP platform.
Table 7. Default compilation settings
Platform Toolchain libc Init system Filesystem
ls1021atsn gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1021atsn (OP-TEE) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1021aiot gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1021aiot (OP-TEE) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1021aiot (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm
ls1021atwr gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1043ardb (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1043ardb (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
ls1046ardb (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1046ardb (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
ls1046afrwy (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1046afrwy (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
Table continues on the next page...
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 16 / 199

Table 7. Default compilation settings (continued)
Platform Toolchain libc Init system Filesystem
ls1012ardb (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
i.MX6Q SabreSD gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
i.MX6Q SabreSD gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm
ls1028ardb (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1028ardb (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
ls1028atsn (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
ls1028atsn (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
lx2160ardb (64-bit) gcc 7.5.0 glibc 2.25 BusyBox OpenIL default
lx2160ardb (Ubuntu) gcc 7.5.0 glibc 2.25 Systemd ubuntu-base-18.04.4-arm64
NXP Semiconductors
Introduction
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 17 / 199

Chapter 2
Getting started
After reading this section, you should be able to get the OpenIL source code, build and program the NXP platform images, and
run the OpenIL system on the supported NXP platforms.
2.1 Getting OpenIL
OpenIL releases are available every a few months. The Release Number follows the format 'YYYYMM', for example, 201708.
Release tarballs are available at: https://github.com/openil/openil.
To follow development, make a clone of the Git repository. Use the below command:
$ git clone https://github.com/openil/openil.git
$ cd openil
# checkout to the 2020.05 v1.8 release
$ git checkout OpenIL-v1.8-202005 -b OpenIL-v1.8-202005
2.2 OpenIL quick start
The steps below help the user to build the NXP platform images with OpenIL quickly. Ensure to follow the important notes provided
in the following section.
2.2.1 Important notes
• Build everything as a normal user. There is no need to be a root user to configure and use OpenIL. By running all commands
as a regular user, you protect your system against packages behaving badly during compilation and installation.
• "sudo" permission is required when building ubuntu root file system.
• The PERL_MM_OPT issue: You might encounter an error message for the PERL_MM_OPT parameter when using the make
command in some host Linux environment as shown below:
You have PERL_MM_OPT defined because Perl local::lib is installed on your system.
Please unset this variable before starting Buildroot, otherwise the compilation of Perl
related packages will fail.
make[1]: *** [core-dependencies] Error 1
make: *** [_all] Error 2
To resolve this issue, just unset the PERL_MM_OPT parameter.
$ unset PERL_MM_OPT
2.2.2 Building the final images
For the NXP platforms supported by OpenIL, the default configuration files can be found in the configs directory. The following
table describes the default configuation files for the NXP-supported OpenIL platforms.
Table 8. Default configuration
Platform Configuration file in OpenIL
ls1021atsn configs/nxp_ls1021atsn_defconfig
ls1021atsn (OP-TEE-SB) configs/nxp_ls1021atsn_optee-sb_defconfig
Table continues on the next page...
NXP Semiconductors
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 18 / 199

Table 8. Default configuration (continued)
Platform Configuration file in OpenIL
ls1021aiot configs/nxp_ls1021aiot_defconfig
ls1021aiot (OP-TEE) configs/nxp_ls1021aiot_optee_defconfig
ls1021aiot (Baremetal) configs/nxp_ls1021aiot_baremetal_defconfig
ls1021aiot (Ubuntu) configs/nxp_ls1021aiot_ubuntu_defconfig
ls1021atwr (QSPI) configs/nxp_ls1021atwr_defconfig
ls1021atwr (IFC) configs/nxp_ls1021atwr_sdboot_ifc_defconfig
ls1028atsn (64-bit) configs/fii_ls1028atsn-64b_defconfig
ls1028atsn (Ubuntu) configs/fii_ls1028atsn-64b_ubuntu_defconfig
ls1028ardb (EMMC) configs/nxp_ls1028ardb-64b-emmc_defconfig
ls1028ardb (XSPI) configs/nxp_ls1028ardb-64b-xspi_defconfig
ls1028ardb (Baremetal) configs/nxp_ls1028ardb_baremetal-64b_defconfig
ls1028ardb (64-bit) configs/nxp_ls1028ardb-64b_defconfig
ls1028ardb (Ubuntu) configs/nxp_ls1028ardb-64b_ubuntu_defconfig
ls1028ardb (64bit) configs/nxp_ls1028ardb-64b-xspi_defconfig
ls1043ardb (64-bit) configs/nxp_ls1043ardb-64b_defconfig
ls1043ardb (Baremetal) configs/nxp_ls1043ardb_baremetal-64b_defconfig
ls1043ardb (Ubuntu) configs/nxp_ls1043ardb-64b_ubuntu_defconfig
ls1046ardb (64-bit) configs/nxp_ls1046ardb-64b_defconfig
ls1046ardb (EMMC) configs/nxp_ls1046ardb-64b-emmcboot_defconfig
ls1046ardb (QSPI) configs/nxp_ls1046ardb-64b_qspi_defconfig
ls1046ardb (QSPI-SB) configs/nxp_ls1046ardb-64b_qspi-sb_defconfig
ls1046ardb (QSPI4EMMC) configs/nxp_ls1046ardb-64b-emmc_qspiboot_defconfig
ls1046ardb (Baremetal) configs/nxp_ls1046ardb_baremetal-64b_defconfig
ls1046ardb (Ubuntu) configs/nxp_ls1046ardb-64b_ubuntu_defconfig
ls1046afrwy (64-bit) configs/nxp_ls1046afrwy-64b_defconfig
ls1046afrwy (QSPI) configs/nxp_ls1046afrwy-64b_qspi_defconfig
ls1046afrwy (Ubuntu) configs/nxp_ls1046afrwy-64b_ubuntu_defconfig
ls1012ardb (64-bit) configs/nxp_ls1012ardb-64b_defconfig
lx2160ardb (64-bit) configs/nxp_lx2160ardb-64b_defconfig
lx2160ardb (XSPI) configs/nxp_lx2160ardb-64b-xspi_defconfig
lx2160ardb (Baremetal) configs/nxp_lx2160ardb_baremetal-64b_defconfig
lx2160ardb (Ubuntu) configs/nxp_lx2160ardb-64b_ubuntu_defconfig
Table continues on the next page...
NXP Semiconductors
Getting started
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 19 / 199

Table 8. Default configuration (continued)
Platform Configuration file in OpenIL
i.MX6Q SabreSD configs/imx6q-sabresd_defconfig
i.MX6Q SabreSD (Baremtal) configs/imx6q-sabresd_baremetal_defconfig
i.MX6Q SabreSD (Ubuntu) configs/imx6q-sabresd_ubuntu_defconfig
The “configs/nxp_xxxx_defconfig” files listed in the preceding table include all the necessary U-Boot, kernel
configurations, and application packages for the filesystem. Based on the files without any changes, you can build a complete
Linux environment for the target platforms.
To build the final images for an NXP platform (for example, LS1046ARDB), run the following commands:
$ cd openil
$ make nxp_ls1046ardb-64b_defconfig
$ make
# or make with a log
$ make 2>&1 | tee build.log
The make clean command should be implemented before any other new compilation.
NOTE
The make command generally performs the following steps:
• Downloads source files (as required and at the first instance);
• Configures, builds, and installs the cross-compilation toolchain;
• Configures, builds, and installs selected target packages;
• Builds a kernel image, if selected;
• Builds a bootloader image, if selected;
• Creates the BL2, BL31, BL33 binary from ATF;
• Creates a root filesystem in selected formats.
• Generates the Image file for booting;
After the correct compilation, you can find all the images for the platform at output/images.
images/
├── bl2_sd.pbl --- BL2 + RCW
├── fip.bin --- BL31 + BL33 (uboot)
├── rcw_1800_sdboot.bin --- RCW binary
├── boot.vfat
├── fmucode.bin
├── fsl-ls1046a-rdb-sdk.dtb --- dtb file for ls1046ardb
├── rootfs.ext2
├── rootfs.ext4
├── rootfs.tar
├── sdcard.img --- entire image can be programmed into the SD
├── uboot-env.bin
├── u-boot-dtb.bin --- uboot image for ls1046ardb
└── Image --- kernel image for ls1046ardb
Notice: Image file name used for each configurations as following described:
• xspi.cpio.img: *xspi_defconfig
NXP Semiconductors
Getting started
Open Industrial User Guide, Rev. 1.8, 05/2020
User's Guide 20 / 199