Brecis uClinux distribution and associated bootloaders.
http://www.brecis.com
support@brecis.com

0. Table of Contents:
---------------------

1. Introduction and CD contents
2. Installation Instructions for uClinux
3. Installation Instructions for PMON
4. Installation Instructions for bbload
5. Installing all packages at once.
6. Getting Help.

1. INTRODUCTION:
----------------

	This CD contains the BRECIS distribution of uClinux and associated 
support packages such as the gnu tools prebuilt as cross-tools for the 
BRECIS MIPS target.  The CD contains 6 directories:

	uClinux		The BRECIS uClinux distribution. Including the
				tools needed to build itself.

	pmon  		A ROM Monitor/bootloader for use in 
				development/debuggging.

	bbload		A simple production bootloader

	binaries	precompiled versions of the uClinux, 
				bbload, manufinfo, and pmon packages

	open-tools  a copy of the gnu toolchain for BRECIS targets in 
				source form along with build scripts.  

	manufinfo  	a Unix tool for creating and installing a manufacturing 
				record in a BRECIS board.  Now superseded by the pmon 
				setup command.

The write up assumes the following:
	the cd is mounted in /mnt/cdrom 
	the user is using a bash shell
	the directory you wish to install into is referred to as $INSTALLDIR
	the user has write permissions for the directories listed below
		/tftpboot/$USER
		$INSTALLDIR

Important Notes:

	Further information about each of the packages contained on this CD 
	can be found in the README file contained in the root directory of 
	the package.  The file doc_index.html contains short descriptions of 
	all of the major documentation along with links.

	The BRECIS uClinux distribution is closely tied to the version of 
	tools used to build it.  To ensure that there are no problems with 
	tool conflicts, the build process will install the proper tools into 
	a directory within the build tree and reference these.  The tools 
	are installed on the first build and should NOT be installed by hand 
	previously.
	


2. uClinux INSTALLATION INSTRUCTIONS: 
-------------------------------------

1)	Copy the uClinux directory from this CD to the location you wish 
	build the image.  Simply replace the variable $INSTALLDIR below with 
	the actual directory name you wish to install to.
		cp -a /mnt/cdrom/uClinux $INSTALLDIR
	
2)	Obtain and install a version of tftp that is compatible with your 
	distribution. make sure the directory /tftpboot/${user} exists and that 
	you have write access to it.

3) 	Perform the first build to install the tools.
		cd $INSTALLDIR/uClinux/brecis/compilescripts
		make LINUXALL
	NOTE:  this script will require the root password a number of
    times to execute commands for building the file system image
    for the EVM board.  For convenience purposes you may wish to make 
	appropriate sudo settings, or run the build as root.

4)  The output of a successful compile will be the files:
	     /tftpboot/$USER/image.bin
    	 /tftpboot/$USER/image.flash

    image.bin is the uClinux kernel + file system.

    image.flash is a gunzip program + a gzip of image.bin produced above
    The gunzip program will extract the uClinux kernel + file system
    and will start the uClinux kernel executing when called.


3. pmon INSTALLATION INSTRUCTIONS:
----------------------------------

1)	Copy the pmon directory from this CD to the location you wish build 
	the image.  Simply replace the variable $INSTALLDIR below with the 
	actual directory name you wish to install to.
		cp -a /mnt/cdrom/pmon $INSTALLDIR

2)  Unlike the BRECIS uClinux distribution pmon does not include its own 
	tools, so you will need to tell the system where to find them.  If 
	you have already completed the bbload installation process you can
	skip this step.  To use the tools from the uClinux package edit the
	file:
 		/home/$USER/.bash_profile
	and add the following directory to your PATH
		$INSTALLDIR/uClinux/brecis/tools/mipsisa32-brecis-uclinux/bin
	this will take effect the next time you log into your account.

3)  To test your installation you can build the pmon package.  To do 
	this follow the instructions below.
		logout
		login
		cd $INSTALLDIR/pmon
		./bld
 
4. bbload INSTALLATION INSTRUCTIONS:
------------------------------------

1)	Copy the bbload directory from this CD to the location you wish 
	build the image.  Simply replace the variable $INSTALLDIR below with 
	the actual directory name you wish to install to.
		cp -a /mnt/cdrom/bbload $INSTALLDIR

2)  Unlike the BRECIS uClinux distribution bbload does not include its 
	own tools, so you will need to tell the system where to find them.  
	If you have already completed the pmon installation process you can
	skip this step.  To use the tools from the uClinux package edit the
	file:
 		/home/$USER/.bash_profile
	and add the following directory to your PATH
		$INSTALLDIR/uClinux/brecis/tools/mipsisa32-brecis-uclinux/bin
	this will take effect the next time you log into your account.

3)  To test your installation you can build the bbload package.  To do 
	this follow the instructions below.
		logout 
		login
		cd $INSTALLDIR/bbload
		make


5. INSTALLING ALL PACKAGES:
---------------------------

1)	Copy the contents of the CD to the directory you have chosen as the 
	Installation directory.
		cp -a /mnt/cdrom/* $INSTALLDIR

2)	Obtain and install a version of tftp that is compatible with your 
	distribution. make sure the directory /tftpboot/${user} exists and that 
	you have write access to it.

3) 	Perform the first build to install the tools.
		cd $INSTALLDIR/uClinux/brecis/compilescripts
		make LINUXALL
	NOTE:  this script will require the root password a number of
    times to execute commands for building the file system image
    for the EVM board.  For convenience purposes you may wish to make 
	appropriate sudo settings, or run the build as root.
	 
4)	Add the newly unzipped tools to your path to use with bbload and 
	pmon.  Edit the file:
 		/home/$USER/.bash_profile
	and add the following directory to your PATH
		$INSTALLDIR/uClinux/brecis/tools/mipsisa32-brecis-uclinux/bin
	this will take effect the next time you log into your account.

5) logout

6) login

7) 	Everything should now be fully installed and you should be able to 
	build each of the packages at will.


6. GETTING HELP:
----------------

For help please contact the BRECIS communications FAE assigned to 
support you.  For fastest support, please be sure to copy 
support@brecis.com with your email.  Make sure to include the BRECIS 
product you are working with, as well as a brief description of your 
software environment along with the description of your problem.
