VIP4205/VIP5305 Files

Notice
------
This is the source code distribution for open source with redistribution
obligations that has been used in the KreaTV Software Development Kit. The
KreaTV SDK is used by operators and system integrators to create a customized
boot image which is commonly downloaded to the set-top box over the operator
network. The operator or system integrator adds their own GUI and possibly
extra software in that process.

This distribution covers the VIP53X5 series of set-top boxes.

VIP family STB's are only available in secure versions. Secure versions only
boots signed and encrypted software images. The resulting kernel/boot images
signed with the keys supplied with this distribution (located in dist/config/keys)
will boot on a VIP STB configured with the corresponding keys.


Installing the cross compiler toolchain
---------------------------------------
The toolchain must be installed to a predefined location. Extract the toolchain
archive in /usr/local/kreatv.


Installing required external build tools
----------------------------------------
Install the patch management tool Quilt, GNU make, GCC, Python (2.6 or 2.7), and
CMake (2.8.0 or higher version) available as optional packages in major Linux distributions.
Also make sure the required utilities hostname, rpm2cpio, file, indent, unzip, bison, gperf,
and jsoncpp are installed.

Example:

 * yum install quilt make gcc gcc-c++ python cmake rpm hostname file indent unzip bison gperf jsoncpp

or

 * apt-get install quilt make gcc g++ python cmake rpm2cpio hostname file indent unzip bison gperf jsoncpp


Build environment
-----------------
It is a requirement that you run a 64-bit OS.

The build scripts in the OSSK require that bash is installed as the default
shell. This is not the case on some Linux installations, like on some Ubuntu
distributions which use dash as its default shell.

Please update your /bin/sh link to point to /bin/bash:
 $ cd /bin
 $ sudo rm sh
 $ sudo ln -s bash sh

It is also a requirement that python2 is available in the path. If your
distribution does not set up such a link automatically when installing python
then please create it, for example:

 $ cd /usr/bin
 $ sudo ln -s python2.6 python2


Building the cross compiler toolchain
-------------------------------------
Extract the toolchain src archive. Run make from the src root directory. This
is only needed if the pre built toolchain is not installed or if modifications
to binutils, gcc or the C standard library are needed.


Building
--------
A complete build of all source code can be done by running make in the top
directory.

Enter subdirectory bootimage/tools to build a boot image. All dependencies must
be built. Running "make" will take care of that. If dependencies have already
been built, it is enough to run "make local_all". This will create:

 * bootimage/tools/<toolchain>/<device>/boot
   - Boot image
 * bootimage/tools/<toolchain>/<device>/kernel-nfs
   - Linux kernel image with NFS support
 * bootimage/tools/<toolchain>/<device>/rootdisk.tar.gz
   - Tarball of the root filesystem
 * bootimage/tools/<toolchain>/<device>/debug-boot
   - Boot image with NFS support


Altering a boot image
---------------------
Modify build_boot_image.sh to have more files added to the boot image.


Boot methods
------------
What's required:
 * TFTP server
 * DHCP server

What's optional:
 * NFS server

For configuring the server daemons consult your system documentation. An
example of relevant dhcpd options follows below.

Configuring the dhcpd DHCP server for booting TFTP boot image:

host clientname {
  next-server 0.0.0.0;                           # TFTP server IP
  filename "/tftpboot/boot";                     # Boot image location
}

Configuring the dhcpd DHCP server for booting TFTP kernel and NFS rootdisk:

host clientname {
  next-server 0.0.0.0;                           # TFTP server IP
  filename "/tftpboot/kernel-nfs";               # Kernel location
  option swap-server 0.0.0.0;                    # NFS server IP
  option root-path "/nfs/rootdisk";              # Rootdisk location
}

The rootdisk must be extracted with permissions preserved.
sudo tar -C /nfs -xzpf /path/to/rootdisk.tar.gz


Device tree binary
------------------
This kit contains a device tree binary representing the hardware setup. For
normal building of the kit it isn’t required to have the file in text form.
Anybody that wants to see the file in clear text can use widely available
tools to do the conversion from binary format to text format.