Z3 Technology HE4K-DCK-RPS User manual

RPS Software User Instructions
4K HEVC/H.265 & H.264 Encoding Systems
Rapid Production Starter Kit Software
Model Names:
HE4K-DCK-RPS
HE2K-DCK-RPS
FV2K-DCK-RPS
FV4K-DCK-RPS
DOC-USR-0110-02
Manual Version 2.0.0
December 5, 2018
Before attempting to connect or operate this product, please read these instructions carefully and save this manual for future use.
Copyright © 2018 Z3 Technology, LLC. All rights reserved.
This document contains proprietary information of Z3 Technology, LLC ("Z3"). This document may not be used, reproduced, disclosed, or
disseminated to anyone without the prior written approval of an authorized representative of Z3. Z3 reserves the right to change this product at
any time and without notice. All product names, trademarks, trade names, service marks, or service names mentioned in this document are the
property of their respective owners.

CONFIDENTIAL
DOC-USR-0110-02
2
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
REVISION HISTORY
Version
Date
Change Note
Author
1.0.0
10/24/2016
Original Document
TA
2.0.0
12/05/2018
Added nfs and web overview
RL

CONFIDENTIAL
DOC-USR-0110-02
3
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
TABLE OF CONTENTS
1.0 GENERAL DESCRIPTION .............................................................................................. 5
2.0 QUICK START GUIDE ................................................................................................. 5
2.1 If You Need to Update the Firmware on Your Hardware .................................................... 5
2.2 If You are Ready to Start Development ........................................................................ 5
3.0 UNTARRING AND BUILDING THE SAMPLE CODE................................................................... 5
3.1 Preparing the Linux Environment ............................................................................... 5
3.2 Making the Directories and Running the Make Script......................................................... 6
4.0 CODE OVERVIEW...................................................................................................... 8
4.1 The z3apps/hevc_app Directory................................................................................. 8
4.2 Z3 Web UI Overview............................................................................................... 8
4.3 Z3 Application Overview ......................................................................................... 9
5.0 PERFORMING OTHER OPERATIONS ................................................................................. 9
5.1 Changing the IP Address via Serial Connection................................................................ 9
5.2 Access the HTTP-based User Interface ........................................................................10
6.0 RUNNING THE CODE YOU BUILT ON THE BOARD ................................................................11
6.1 Method 1: Updating the Image File ............................................................................11
6.2 Method 2: Running Your code through TFTP/NFS............................................................13
APPENDIX A: Troubleshooting ..........................................................................................14
APPENDIX B: Set up Terminal Window ................................................................................15

CONFIDENTIAL
DOC-USR-0110-02
4
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
LIST OF FIGURES
Figure 1 Sample Content of Images Directory after Successful Build................................................. 7
Figure 2 System Setup Tab.................................................................................................11
Figure 3 Updater Screen ...................................................................................................12
Figure 4 Example File Selection Screen..................................................................................12

CONFIDENTIAL
DOC-USR-0110-02
5
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
1.0 GENERAL DESCRIPTION
This document is intended for users that have purchased a Rapid Production Starter kit (RPS) from Z3
Technology. For more information on your hardware and use, please consult your general product User
Instructions. The RPS software provided consists of Linux kernel and application packages to allow users to
develop their own advanced multimedia applications.
The software is based on the Linux OS. The kit comes with all of the low-level resources such as the Linux
kernel, u-boot, tool chain and starter file system pre-integrated and configured. The software bundle also
contains tools to allow the development of high-level applications using hardware-accelerated video
processing. Those customers that license the optional source code package can also receive source code for
Z3’s demonstration applications, providing an ideal starting point for custom applications.
Z3 Technology can provide services to customize the software applications to a customer’s specification. For
design services or additional support, please contact Z3 at www.Z3technology.com or
[e-mail].
2.0 QUICK START GUIDE
2.1 If You Need to Update the Firmware on Your Hardware
Details on updating the firmware on your Z3 hardware can be found in Section 6.0: “RUNNING THE CODE
YOU BUILT ON THE BOARD”, on page .
2.2 If You are Ready to Start Development
Details on how to untar and build the code can be found in Section 3.0: “ UNTARRING AND BUILDING
THE SAMPLE CODE,” on page . A brief overview of the code itself can be found in Section 4.0: “CODE
OVERVIEW,” on page .
Details on how to set up your system to access the code you have built can be found in Section 6.0:
“RUNNING THE CODE YOU BUILT ON THE BOARD”, on page .
3.0 UNTARRING AND BUILDING THE SAMPLE CODE
3.1 Preparing the Linux Environment
Prior to building the Z3 code, certain modules are required. In Ubuntu 16.04 or later, the following
command can be used to get the required modules:

CONFIDENTIAL
DOC-USR-0110-02
6
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
sudo apt-get install build-essential bison flex mtd-utils liblzo2-dev uuid-dev
zlib1g-dev libpcre3-dev autoconf autoconf-archive automake libtool libtool-
doc libc6-dev lynx xutils-dev libncurses5-dev yodl cmake libmnl-dev libmnl0
pkg-config pkgconf
In Fedora, the command would be:
sudo yum install bison flex mtd-utils mtd-utils-ubi lzo-devel libuuid-devel
pcre-devel automake autoconf libtool
If you are running a 64-bit OS, it may be necessary to install some 32-bit libraries for the cross-compiling
toolchain. You can determine whether your OS is 64-bit by using the “uname –p” command. A 64-bit OS
will return “x86_64,” while a 32-bit OS will return “i386”, “i586”, or “i686”.
For 64-bit Ubuntu, you can get the necessary libraries by typing:
# sudo apt-get install gcc-multilib
# sudo dpkg –-add-architecture i386
# sudo apt-get update
# sudo apt-get install libc6-dev:i386 libncurses5-dev:i386 libstdc++6:i386
zlib1g:i386
For 64-bit Fedora, you can type:
# sudo yum install glibc.i686
For Ubuntu change shell from dash to bash:
# sudo dpkg-reconfigure dash
Then select “No” when it asks if “dash” should be the system shell (this will cause /bin/sh to be linked
to “bash” instead)
For Ubuntu sudo secure_path needs to be disabled run:
# sudo visudo
Comment out the secure_path directive with “#”in the first column
#Defaults secure_path=”/usr/local/sin:/user/local/bin:/user/sbin:/user/bin:/sbin:/bin”
3.2 Making the Directories and Running the Make Script
The software provided will allow you to re-create the software pre-installed on the RPS hardware
starting from the included code.
On a PC running Linux, create a directory where the released materials are going to be located:

CONFIDENTIAL
DOC-USR-0110-02
7
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
# mkdir /home/z3/z3-he4k
Copy the released tar archive to that directory (note: the name may slightly vary).
# cp SW-CH1-00657-01_HE4K-DCK-10-20160721.tar.bz2 /home/z3/z3-he4k
Untar the archive (name of tar file may slightly vary):
# tar -xvjf SW-CH1-00657-01_HE4K-DCK-10-20160721.tar.bz2
*Note: Untarring takes 5 to 10 minutes.
Go into the directory just created and run the build script (directory name may slightly vary):
# cd SW-CH1-00657-01_HE4K-DCK-10-20160721
# ./makeall
*Note: Building can take around 15-20 minutes. You will also need to type in the sudo password a few
times.
The outcome of the build process should be newly created image files in the images directory. You can
confirm this by doing the following:
# cd images
# ls -alt
The result should be something like the following. Note that actual filenames, dates, and times will
differ.
Figure 1 Sample Content of Images Directory after Successful Build

CONFIDENTIAL
DOC-USR-0110-02
8
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
4.0 CODE OVERVIEW
Once you have untarred the code, you will see the following top-level directories:
build-tools Config files and scripts for building the codebase
hevc_sdk The encoder SDK code
factory Factory testing scripts (the user can disregard these)
sysapps Various supporting applications
z3apps Z3 demo application code and scripts
The Z3 application code that comes with the RPS is run from the serial_menu.lua script in
z3apps/hevc_app/scripts/. This code calls the /opt/mcsenc binary, which initializes and runs the encoder.
This binary is built from the z3apps/hevc_app/encode_app directory. The code for the binary resides in
z3apps/hi35xx_app/encode_app. The z3apps/hevc_app directory is described in more detail in the next
section.
4.1 The z3apps/hevc_app Directory
There are three main subdirectories: encode_app, hevc_audio, and scripts
4.1.1 encode_app
This directory contains the code for the encoder application
The file mcsenc.cpp is responsible for setting the output mode of the encoder. Output to
file, rtp, and MPEG2-TS are handled here.
4.1.2 hevc_audio
This directory contains the code for the audio encode API.
4.1.3 scripts
This directory contains the control scripts for the serial user interface and HTTP-based web
user interface.
4.2 Z3 Web UI Overview
The web ui directory is located under z3apps/webgui/gui this contains relevant files to the client
side implementation. The server implementation is done using a lua based web server called

CONFIDENTIAL
DOC-USR-0110-02
9
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
Turbo.lua. The server implementation can be found in z3apps/hevc_app/scripts/web_backend.lua.
The web_backend.lua script uses several other lua scripts to support all web requests.
4.2.1
The web ui files can be edited in place on the unit. Make sure to run:
# mount -o remount rw /
To allow modification of files. When edited in place the web backend will restart when a file is
changed.
4.3 Z3 Application Overview
4.3.1 Application Names and Locations
(1) The application binary can be found at /opt/mcsenc.
(2) Z3 lua scripts can be found at /opt/z3scripts.
(3) Config files including the current database file, z3.ini, ssh keys, and default database
files can be found in /opt/config.
(4) Log files are located in /tmp.
4.3.2 Application Source Code
Application source code is available under a separate license agreement. For customers that
have licensed it, the application source code can be found mainly in:
$PRJROOT/z3apps/hevc_app/encode_app
The top-level file for the menu-driven application is mcsenc.cpp.
5.0 PERFORMING OTHER OPERATIONS
5.1 Changing the IP Address via Serial Connection
The IP address is currently set in u-boot. This can be changed via serial.
(1) With the serial console connected reboot the board and interrupt the boot in u-boot by pressing
any key. If successful the following will be seen:
U-Boot 2010.06-dirty (Apr 05 2016 - 16:08:07)

CONFIDENTIAL
DOC-USR-0110-02
10
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
NAND: Check nand flash controller v610. found
Special NAND id table Version 1.36
Nand ID: 0xC8 0xDA 0x90 0x95 0x44 0x7F 0x7F 0x7F
Block:128KB Page:2KB Chip:256MB*1 OOB:64B ECC:4bit/512
256 MiB
Check spi flash controller v350... Found
Spi(cs1) ID: 0xC2 0x20 0x19 0xC2 0x20 0x19
Spi(cs1): Block:64KB Chip:32MB Name:"MX25L 256/257 35 E/F"
In: serial
Out: serial
Err: serial
Hit any key to stop autoboot: 0
z3-XXXXXXX #
(2) At the prompt enter:
z3-XXXXXXX# setenv ipaddr {ip-address}
z3-XXXXXXX# saveenv; reset
The new IP address will now be set and the system’s user interface can be reached there.
5.2 Access the HTTP-based User Interface
There are two methods to get to the HTTP Web UI.
5.2.1 Manually
(1) You can access the HTTP-based user interface by manually typing your unit’s IP address into a
web browser on any computer connected to the same network as the unit. (For best results,
Firefox or Chrome are recommended.)
5.2.2 Using ZFinder
ZFinder is a PC utility that allows you to find any Z3 Technology product on your network. If you have
not yet downloaded this to your computer, you can find this program on your customer account on
Z3’s support server or at Z3Cam-4K.Z3technology.com.
(1) Verify your Windows PC is set to DHCP. If it is set to a static IP address, ZFinder may be
unable to discover your Z3 hardware.
(2) Run the ZFinder PC Utility on your PC. The ZFinder window appears. ZFinder completes a
scan of the network and lists the location of all Z3 systems connected to the network. Your Z3
hardware will appear.
(3) Select the product you would like to configure.

CONFIDENTIAL
DOC-USR-0110-02
11
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
(4) Click the “Open Device” button. An internet browser window is opened in your default web
browser (for best results, Firefox or Chrome are recommended) and the user interface
appears.
*Note:Selecting Edit Device allows for manual changes to network settings.
*Note:If the device appears in red, there is a network error, and network settings will need to
be modified in order to access the user interface.
6.0 RUNNING THE CODE YOU BUILT ON THE BOARD
6.1 Method 1: Updating the Image File
(1) Access the HTTP-based user interface (See Section 5.2.2).
(2) Select “Update device firmware” from the System Setup tab.
Figure 2 System Setup Tab
(3) This brings you to the update image screen. In this screen, click on “Browse…”
Click here
Figure SEQ Figure \* ARABIC 2 Updating the Device Firmware from the User
Interface

CONFIDENTIAL
DOC-USR-0110-02
12
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
(4) This brings you to the File Selection Screen. From here, select the name of the .img file to update
with and click “Open”.
Figure 4 Example File Selection Screen
(5) Click on “Upload and Update”.
(6) You will see screens stating that the image is being uploaded and that the flash is being updated.
After about one minute, the main menu will appear again.
(7) Your Z3 hardware is now updated.
Figure 3 Updater Screen

CONFIDENTIAL
DOC-USR-0110-02
13
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
6.2 Method 2: Running Your code through TFTP/NFS
(1) Set up a TFTP server on your Linux PC and configure it to read from your “images” directory. This
will vary depending on the Linux setup you have. As an example, here is a set of steps that would be
run from Ubuntu 10.x or later (in gray to denote they can vary from system to system):
(a) Get TFTP if it is not already installed:
# sudo apt-get install xinetd tftpd tftp
(b) Create the file /etc/xinetd.d/tftp . Set “server_args” to the home directory containing
“z3-cam” (/home in this example). An example of a tftp file would be:
service tftp
{
disable= no
:
:
server = /usr/sbin/in.tftpd
server_args = -s /home
}
(c) Start TFTP
# sudo /etc/init.d/xinetd start
(2) Enable NFS on the Linux PC. The target Z3 encoder will mount the root file system using NFS. This,
like TFTP, will also vary depending on the Linux setup you have. As an example, here is a set of steps
that would be run from Ubuntu 10.x or later (these are in gray to denote they can vary from system
to system):
(a) Get NFS if it is not already installed:
# sudo apt-get install nfs-kernel-server
(b) Add an entry for the file system directory in /etc/exports. For example, the line would be
something like (here, 192.168.0.120 is the IP address of the PC, and 255.255.255.0 is the netmask):
/home/z3/z3-cam/filesys/fs
192.168.0.120/255.255.0.0(no_root_squash,insecure,nohide,rw,async)
(c) In the file /etc/default/nfs-kernel-server, remove the –manage-gids option:
#RPCMOUNTDOPTS=”—manage-gids”
RRCMOUNTDOPTS=””
After the NFS change, restart your computer to make it take effect.
(d) Create symbolic links in your top-level directory to allow access to your filesys and images
directory (note: actual directory name may be different depending on your specific release):
# cd /home/z3/z3-cam

CONFIDENTIAL
DOC-USR-0110-02
14
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
# ln –s ../SW-CH1-00657-01_HE4K-DCK-10-20160721/images images
# ln –s /home/z3/SW-CH1-00657-01_HE4K-DCK-10-20160721/filesys filesys
(e) Start the NFS server
# sudo service nfs-kernel-server restart
(3) Configure u-boot on your board to match your system configuration settings.
(a) Reboot the board with minicom or TeraTerm on your PC (see Appendix B).
(b) As soon as the board boots, press the spacebar immediately to make it stop in the u-boot
prompt.
(c) You should see the “z3-30-0069 #” prompt. Type the following commands:
z3-30-0069 #setenv nfs_root ‘/home/z3/z3-cam/filesys/fs’
z3-30-0069 #setenv tftp_root ‘z3/z3-cam/images’
z3-30-0069 #setenv bootcmd run boot-nfs
z3-30-0069 #saveenv
nfs_root is set to the fs subdirectory within the filesys link set up in step (2c).
tftp_root, when combined with the value of “server_args” in the /etc/xinetd.d/tftp file set
up in step (1b), points to the images link set up in step (2c). Note user may also have to run
setenv serverip x.x.x.x, setenv nfsserver x.x.x.x, setenv ipaddr x.x.x.x, and setenv netmask
x.x.x.x to communicate with your tftp/nfs server.
(d) After typing “saveenv”, you should see a “Writing to Nand... done” message.
(4) Now that you’ve finished configuring, either type “reset” at the prompt or reboot the board.
(5) You should then see TFTP being used to load code from the development PC.
(6) To go back to booting from Flash rather than TFTP/NFS, you would type the following at the u-boot
prompt:
Z3-DM385# setenv bootcmd run boot_yaffs2
Z3-DM385# saveenv
APPENDIX A: Troubleshooting
▪Problem: Web browser user interface does not come up.
- Is the Ethernet cable plugged in to the encoder solidly (do you see the link light)?
- Do the encoder IP address and the PC IP address have the same first two values (or, if netmask is
set to 255.255.255.0, the same first three values)?

CONFIDENTIAL
DOC-USR-0110-02
15
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N 8th ST, STE 250 ♦Lincoln, NE 68508-1369 USA ♦+1.402.323.0702
- Do the encoder and the PC have the same netmask? (Default value is 255.255.0.0)
-You can check the netmask of the PC by typing ifconfig in Linux.
- Are all firewalls on the network turned off?
-Try connecting the PC directly to the board without any routers, etc.
- Can the PC and target board see each other on the network?
-Try pinging the encoder IP address from the PC.
-Try pinging the PC from the encoder.
APPENDIX B: Set up Terminal Window
1) If running from a Windows PC, run TeraTerm. Select “Setup – Serial Port” and set the following:
Port: The serial port the port is connected to
Baud Rate: 115200
Data: 8-bit
Parity: None
Stop: 1-bit
Flow Control: None
2) If running from a Linux PC, type:
# sudo minicom -a
And then configure by doing the following:
-Select “Serial Port Setup”
-Ensure the right Serial Device is specified (typically “/dev/ttyUSB0”)
-Set option E (“Bps/Par/Bits”) to 115200 8N1
-Press <return>
-Select “Exit”
When contacting Z3 Support for additional support, please send a log file of the serial output to Z3 Technology.
Z3 Technology’s Express Limited Warranty will be void if the label on the hardware bearing the Serial Number is removed,
tampered with or defaced. You can view Z3 Technology’s full hardware warranty at http://z3technology.com/Support/OEM-HW-
Warranty.html.