OpenRG SDK Installation Guide Version 4.8 Jungo Software Technologies Ltd.
OpenRG SDK Installation Guide: Version 4.8 Jungo Software Technologies Ltd. Copyright © 1998-2007 Jungo Software Technologies Ltd. All Rights Reserved. Jungo Confidential and Proprietary. Product names mentioned in this document are trademarks of their respective manufacturers and are used here only for identification purposes. Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement. The software may be used, copied or distributed only in accordance with that agreement. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means, electronically or mechanically, including photocopying and recording for any purpose without the written permission of Jungo Ltd. This document is available for download at: http://www.jungo.com/openrg/install.html
© 1998-2007 Jungo Software Technologies Ltd.
2
© 1998-2007 Jungo Software Technologies Ltd.
3
Table of Contents 1. Overview ................................................................................................................................ 1 1.1. What Does the SDK Provide? .................................................................................... 1 1.2. Software and Hardware Requirements ....................................................................... 2 1.3. Windows Users ........................................................................................................... 3 2. Installation Process ................................................................................................................ 4 3. Compiling an Image .............................................................................................................. 6 4. Burning an Image .................................................................................................................. 7 5. Uninstall Process ................................................................................................................... 8 6. Troubleshooting ..................................................................................................................... 9 6.1. I Have a Missing Package .......................................................................................... 9 6.2. I Have a Compilation Problem ................................................................................... 9 6.3. My Evaluation License has Expired ........................................................................... 9 6.4. How do I Perform Multiple Installations of OpenRG on a Single Download?......... 10
© 1998-2007 Jungo Software Technologies Ltd.
iv
1 Overview This document takes you through the OpenRG Software Development Kit (SDK) installation process, and assists you in solving potential installation difficulties.
1.1. What Does the SDK Provide? • A fully featured, 30-day evaluation SDK for Gateway developers. • Available for all hardware platforms: • All Intel-based IXP425 platforms • ADI AD6834 • Broadcom ASUS BCM6348 • Conexant CX8620X • Freescale MPC8272ADS • Storlink Centroid • Broadcom GTWX5803 • A gateway emulation (UML), which enables you to compile and run a virtual gateway on your PC without a hardware platform. • Includes an installation script (install.sh), which installs the following components: • Toolchain according to your chosen platform. © 1998-2007 Jungo Software Technologies Ltd.
1
Overview
• License files (.lic). • Key features source code and the Linux kernel. • Tools to help you work in the OpenRG environment such as compiler, linker, assembler, debugger and others.
1.2. Software and Hardware Requirements Developing with OpenRG requires the following setup: • A Residential Gateway or development platform • A host PC running one of the following versions of the Linux operating system: • Debian 3.1 or higher • Mandrake 8.1 or higher • Redhat 7.3 or higher • Ubuntu Note: When compiling OpenRG on Ubuntu, change the soft-link /bin/sh to point to /bin/bash. OpenRG's UML distribution cannot be compiled on Ubuntu. • A text editor that supports tags, such as VI or Emacs. • The following minimum hardware requirements for the host PC: • 1.6GHz CPU • 256MB RAM • 1.5GB free disk space • 2 network cards • Internet access, unless the installation is performed using a CD
© 1998-2007 Jungo Software Technologies Ltd.
2
Overview
1.3. Windows Users For Windows users, the SDK can also be used on a virtual Linux, running on top of Windows. These emulators run the Linux as a Windows application. The following are links to download virtual Linux over Windows: • coLinux - a free and open source emulation: http://www.colinux.org • VMWare - both a commercial version and a 30-day evaluation are available: http:// www.vmware.com
© 1998-2007 Jungo Software Technologies Ltd.
3
2 Installation Process Note: In order to install the SDK, you must have certain standard Linux packages installed. If a package is missing during the installation process, you will be prompted to install it to complete the process. The Linux packages you will need are the standard gcc, make and libc packages for your Linux distribution. If you can compile "hello world", you are ready to install the OpenRG SDK. To install the development environment on your host PC perform the following: 1. Download the SDK from http://www.jungo.com/openrg/download.html. 2. Extract the SDK archive, usually rg_sdk_install.tgz: $ tar xvzf rg_sdk_install.tgz
3. Change the directory to rg_sdk_install and run the install script. $ cd rg_sdk_install $ ./install.sh
4. The install script is interactive. Follow its instructions: 1. If prompted, select the target architecture to install. Enter 'y' to confirm the installation. The script will fetch and extract source packages and toolchains from the Internet. These actions may take some time, depending on your Internet connection speed. 2. If interested, change the default directory of the development tree when prompted to enter the installation directory. For example, ~/rg-4_0_11. The install script copies the toolchain to the /usr/local/openrg directory, and the OpenRG development tree and license file to the /rg directory. © 1998-2007 Jungo Software Technologies Ltd.
4
Installation Process
Have the root password ready, you will need to provide it to the script when installing the toolchain. 5. After a successful installation, instructions for compiling the image appear on the screen (refer to chapterchap_compile). Note: After installing the SDK, most OpenRG configurations will require: Bison - GNU Project parser generator. Flex - Contains a utility for generating programs that perform pattern-matching on text.
© 1998-2007 Jungo Software Technologies Ltd.
5
3 Compiling an Image 1. Change the directory to where you installed the OpenRG development tree, for example: $ cd ~/rg.4_8_11/rg
2. Execute the following command to automatically configure the development tree: make config DIST= LIC=
The "platform-specific distribution" part correlates with your board's model. The license is provided with your distribution. 3. To build the image files, execute: make
4. The compilation process will produce openrg.img, which is a binary that can be downloaded and burnt using OpenRG's 'flash load' CLI command. You can find the image in the build subdirectory of the OpenRG development tree (i.e. rg.4_8_11/rg/build). The factory settings can be found in the build/pkg/main subdirectory (i.e. rg.4_8_11/rg/build/ pkg/main/rg_factory).
© 1998-2007 Jungo Software Technologies Ltd.
6
4 Burning an Image Burn the image to the board according to the installation guide of your chosen platform. You can download installation guides for each of the platforms from: http://www.jungo.com/ openrg/install.html .
© 1998-2007 Jungo Software Technologies Ltd.
7
5 Uninstall Process In order to uninstall the SDK, follow these steps: 1. Remove sources: $ rm -rf rg-
Specify the version of OpenRG you wish to remove. 2. Become a super-user: $ su
Provide an administrator password. 3. Remove toolchains, which are copied by the install script to /usr/local/openrg: # rm -rf /usr/local/openrg
© 1998-2007 Jungo Software Technologies Ltd.
8
6 Troubleshooting 6.1. I Have a Missing Package The following is an example of an error message that can appear during your installation process: CRITICAL: Could not find package rg-build_4.0.30_src.ejpkg jpkg failed to download/extract required package.
In this case, the rg-build_4.0.30_src.ejpkg package could not be found. If you encounter a similar message, please: 1. Make sure you are connected to the Internet. 2. If this error still appears, contact Jungo's support team at
[email protected], and we will provide you with the missing package.
6.2. I Have a Compilation Problem If you encounter compilation problems: 1. Make sure you are able to compile "hello world". 2. If "hello world" compiles and the SDK does not, please contact Jungo's support team at
[email protected].
6.3. My Evaluation License has Expired If your evaluation license has expired, you have the following options: © 1998-2007 Jungo Software Technologies Ltd.
9
Troubleshooting
1. You may extend your evaluation for an additional 30-day period, by contacting Jungo's support team at
[email protected]. 2. If you wish to purchase a commercial license, please contact your local representative, which you can locate at http://www.jungo.com/contact.html , or write directly to
[email protected].
6.4. How do I Perform Multiple Installations of OpenRG on a Single Download? 1. Install OpenRG once on one computer. The OpenRG packages will be cached in ~/ .jpkg_cache/*.ejpkg. 2. Copy all the *.ejpkg files to a file server in your own network, or to a local computer to which you would like to install. 3. Set JPKG_SEARCH_PATH to the path of the OpenRG packages: • If the server is a Web server: $ export JPKG_SEARCH_PATH=
• If the server is a file server: $ export JPKG_SEARCH_PATH=
4. Run install.sh to install OpenRG.
© 1998-2007 Jungo Software Technologies Ltd.
10
