README.TXT
~~~~~~~~~~

This file contains general information about the building the Route 
Table Management executable and binary on NT/Win95 and LINUX System.

The following files are necessary for building and running given 
test for the RTM. some of the files are informative.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

readme.txt                  - This file

Files needed for compilation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

linux.mak                   - Makefile for Linux 
rtm_mak.dep                 - Dependency file for Linux make utility.
rtm.mak                     - Makefile to build RTM executable and 
                              library on NT/Win95 system.
rtm_dll.mak                 - Makefile to build rtm_dll.dll and 
                              rtm_dll.lib on NT/Win95 System.
rtm.dsw                     - Microsoft Developer Studio Workspace 
                              File for RTM
rtm.dsp                     - Microsoft Developer Studio Generated 
                              Build File for RTM exe and library
rtm_dll.dsp                 - Microsoft Developer Studio Generated 
                              Build File for RTM dll


version.h                   - Defines Version information
rtm.h                       - Defines Data structures for RTM
rtm_cfg.h                   - Defines Data Structures for 
                            - initialization of tables
rtm_loader.h                - Defines Data Structures to 
                              load or delete routes from file
../../Include/Xact_API.h  - Declaration for all the API's.
../../Include/uclo.h              - loader main header file
../../Include/mem_map.h   - Declarations of shared memory between 
                              core and microcode
../../Include/xact.h       - Transactor declarations.
../../Include/xact_dll.h   - Transactor declarations to build RTM dll.


rtm.c                       - Main RTM file.
rtm_console.c               - Functions to register and run RTM in 
                              console mode
rtm_loader.c                - The function set for loading/deleting    
                              routes from an external file

Libraries needed to be linked to build RTM on NT/Win95
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../lib/[Debug]/uclo.lib         - loader Library [to build it check
                                          ../uclo/readme.txt]
../lib/[Debug]/xact_main.lib    - Transactor library provided with 
                                          the kit.
../lib/[Debug]/xact_io.lib      - Transactor interface library.

Libraries needed to be linked to build RTM on LINUX
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../lib/uclo.a                           - loader Library [to build it check
                                          ../uclo/readme.txt]
../lib/xact_main.a                      - Transactor library provided with 
                                          the kit.
../lib/xactio.a                         - Transactor interface library.
../lib/common.a                         - Library contains some Common Data
                                          Structures

Other Libraries needed to build RTM DLL (rtm_dll.dll) on WinNT/Win95
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../lib/[debug]/xact_dll.lib               
../lib/[debug]/xact_io_dll.lib


Files need to run RTM Tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~
rtm_add.dat                 - Data file contains Routes information for
                              adding routes in tables.

start.ind                   - Transactor script file used to initialize 
                              the chip.
rtm_test.ind                - Transactor script file used to run tests on  
                              RTM.

To build RTM.exe on NT or Windows 95
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using Microsoft Developer Studio 98:
    1) Invoke Microsoft Visual C++ 6.0
    2) Select the menu option File->OpenWorkspace...
    3) Select and open the workspace file .\rtm\rtm.dsw
    4) Set the project to RTM
    5) View the Workspace and select one of the RTM files or rtm_dll files
    6) Select the build type -- Win32 Debug or Win32 Release
    7) Select menu option Buildall
    8) If option chosen in step 5 is RTM files then if the build was 
       successful, then rtm.lib will be placed in either the
       ..\lib\release or the ..\lib\debug directory, rtm.exe will be placed
       in  ..\bin\release or ..\bin\debug directory depending the type of
       build that was selected in step 6. Also if the option chosen in step 5
       is rtm_dll files then if the build is successful then rtm_dll.dll is
       placed in ..\bin\debug or ..\bin\release.

To build RTM binary and library on Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    1) Make sure U have the gnu c++ compiler (egcs-1.0.2 release)
    2) Run make -f linux.mak in the current directory
    3) If the build was successful, RTM will be placed in ..\bin and rtm.a will 
       be placed in ..\lib  directory.

To Run RTM test do following
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once RTM is build then to run a test do following
    1)  Make sure you have uca and ucld in your path. By default they are 
        installed in ..\bin.
    
To Assemble and Link  the required micro code 
	2) uca -O -D STANDALONE -I ..\ucode\include -I ..\ucode\refdes -o ..\rtm\rtm_test.list ..\rtm\rtm_test
	3) ucld -u 0 -o ..\rtm\rtm_test.uof ..\rtm\rtm_test.list

To Run actual Test
    4) Run "..\bin\RTM -i rtm_test.ind"



