SURFboard SB6190 Files

##########################################################

OSS components of SB6190 Cable Modem 
FW Version 9.1.93D

##########################################################

README.txt - This file explains the OSS package contents and how to build.

== CONTENTS==
   
     Overview
     Package Info
     Open Source Toolchain
     Installation
     Build Instructions
     End


== Overview ==

The SB6190 (Surfboard 6190) is a Docsis 3.0 compliant cable modem. 
This package contains all the files used in the 9.1.93D code on SB6190 that are open 
source and meant for re-distribution to the community.


== Package Info ==

A brief description of the files included in the SB6190_9.1.93D.tar.bz2 package.

OSS Package contents
--------------------

Here is a list of the OSS packages that 9.1.93D code on the SB6190 uses. 
For details of each package, refer to the README in respective directories.

NOTE: "modified" string in the package name implies that the packages are modified by Intel/ARRIS.


7zip-4.57-modified	        : File archiver tool with a high compression ratio.

arris_mod		        : ARRIS utilities kernel module
 
atmel_char		        : Atmel device driver kernel module

bridge_utils-1.0.4-modified     : This package is for Linux ethernet bridge code.

busybox-1.19.2-modified	        : Contains free unix utilities.

cable_ni-sdk4.5	                : DOCSIS data path kernel module  

core-sdk4.5		        : DOCSIS Filters/QoS Classifiers Control module

dbridge_dlm-sdk4.5	        : DOCSIS Bridge kernel module

dpp_dlm-sdk4.5		        : DOCSIS Packet Processor Kernel Module

engine_pro_C-07.05.26-modified  : State Machine Engine program in the form of portable standard C

flex-2.5.4a		        : Tool to generate fast lexical analyzers

fw_env-1.2.0-modified	        : Command line user interface to firmware (=U-Boot) environment

hal_isr-sdk4.5		        : DOCSIS HAL Infrastructure Kernel Module

hal_soc_interface_driver-sdk4.5 : DOCSIS SoC Interface driver Kernel Module

hal_mng_q-sdk4.5                : DOCSIS HAL Management Queue Kernel Module

Intel-Puma-Toolchain_03         : This contains the tool chain installation script and patches.

iostat-2.2-modified	        : This contains Linux I/O performance monitoring utility.

kconfig-1.4-modified	        : Utility to save, copy, delete and restore kernel configuration

linux-2.6.39.3-modified	        : The linux kernel.

squashfs-4.2-modified	        : This is a read only file system for Linux.

ti_sysklogd-1.4.1-modified      : Kernel and system logging daemons

tibat_char		        : TI device driver kernel module

uClibc-0.9.33.2-modified        : This contains the C library functions for embedded Linux systems.

udev-0.87-modified	        : A user space implementation of dev file system.

ups_manager		        : ARRIS telemetry kernel module


In addition, the SB6190_9.1.93D.tar.bz2 package contains this below file:

README.txt                      : This README file.


== Open Source Toolchain ==

armeb-linux-uclibceabi-gcc -v
gcc version 4.7.3 (Buildroot 2013.08.1)


== Installation ==

The following install and build instructions have been verified on an Ubuntu 12.04.5 LTS 64-bit host.
Make sure you have an Internet connection to create the host environment setup.


HOST ENVIRONMENT SETUP
----------------------

1) Download and install Ubuntu 12.04.5 LTS 64-bit
2) Download the necessary packages using these three shell commands:


sudo apt-get --yes update

sudo apt-get --yes install gcc-4.6 g++-4.6 libc6-i386 lib32ncursesw5-dev \
lib32stdc++6 lib32gcc1 xutils-dev \
apt-file libncurses-dev automake autoconf rpm patch lib32ncurses5 lib32ncurses5-dev \
libncurses5-dev doxygen g++ bison flex gettext texinfo minicom lrzsz gawk fakeroot \
git-core gnupg gperf libsdl-dev libesd0-dev libwxgtk2.6-dev \
build-essential zip zlib1g-dev valgrind gcc-multilib \
g++-multilib ia32-libs x11proto-core-dev libx11-dev lib32z1-dev \
lib32bz2-dev libc6-dev-i386 intltool unifdef \
lib32readline6-dev openssl libssl-dev libstdc++6-4.6-dev curl

sudo apt-file update


3) Restart to complete the updates

4) Download the "SB6190_9.1.93D.tar.bz2" package
5) cd to the directory where "SB6190_9.1.93D.tar.bz2" was downloaded
6) Untar the contents using the command:  tar -xvf SB6190_9.1.93D.tar.bz2
   This will create a directory named 'SB6190_9.1.93D'
7) cd SB6190_9.1.93D
   This directory contains the toolchain 'Intel-Puma-Toolchain_03.tgz' file, 
   the top-level source code directory 'sourcecode', and this README file.


== Build Instructions ==

INSTRUCTIONS TO BUILD TOOL CHAIN
--------------------------------

1) Make a directory for the toolchain build:
   mkdir -p $HOME/toolchains

2) Copy the toolchain file 'Intel-Puma-Toolchain_03.tgz' to that directory:
   cp Intel-Puma-Toolchain_03.tgz $HOME/toolchains/

3) Change direcory to this new location:
   cd $HOME/toolchains

4) Extract the toolchain:
   tar -xvf Intel-Puma-Toolchain_03.tgz

5) Prepare the toochain build install directory environment variable:
   export INTEL_PUMA_TOOLCHAIN_INSTALL_DIR=$HOME/toolchains/Intel-Puma-Toolchain_03

6) Change directory into the extracted toolchain source:
   cd Intel-Puma-Toolchain_03

7) Start the toolchain build with this command:
   ./build-toolchain-13.08.1.sh

   Most toolchains take quite a while to build. When done, the toolchain executables are in the folder:
   $INTEL_PUMA_TOOLCHAIN_INSTALL_DIR/usr/bin

8) Add the toolchain executables folder to the PATH environment variable so the build process can access it.
   export PATH=$HOME/toolchains/Intel-Puma-Toolchain_03/usr/bin:$PATH

   To make this path permanent, add it to your system's $HOME/.bashrc file.


INSTRUCTIONS TO BUILD SB6190 SOURCE CODE
----------------------------------------

1) Change directory back to 'SB6190_9.1.93D'

2) cd sourcecode

3) cd TS_nextgen

4) In the 'TS_nextgen' directory, issue this command for initial configuration:
   make buildconfig PRODUCT=VSDK DOCSIS_SOC=PUMA6

5) To build the entire SB6190 product, issue this last command:
   make vsdk


= END =