readme

可用于TM1300/PNX1300系列DSP（主要用于视频处理）压缩库即应用例子。

tmWRB is a tool that converts an executable object file into a compressed form, 
and adds a startup uncompressor. The initial executable can then be written to
flash as 'Flash Boot Code'. 

'tmWRB' accepts a standard executable image (*.out). Firstly tmWRB converts 
the executable into a memory image to reduce the loaded image. The memory image is
them compressed using the zlib compression library.  The compressed image is then stored
as data and compiled with an unpacking startup file to output a standard executable. The
new load image can then be downloaded.

The downloaded image will then uncompress the compressed data. The uncompressed memory
image is then written to flash as the flash boot code using the function
FlashUtil_put_bootimage().

The description above describes the default behaviour. 

The input image is a standard executable and the executable must be converted to a memory
image. This is done at tmWRB run-time. The user may specify the Processor frequency 
"-tm_freq freq " , default 10000000, the MMIO base address "-mmio_base address" 
default 0xefe00000 and the cache support "-cache support", default LeaveCachingToDownloader. 
A complete description of cache support options is described elsewhere in the this file.

The user can choose whether the output file is big endian or little endian. Big endian
is the default.

The user can specify where the root of the TCS tree, if it is not in the defualt location.

The user can specify the path of the c source file, tmunpackboot.c, if it is not
in the default location.

The user can specify which host type the output should run on. 'nohost' is the default.

The defauly output name is 'a.out'. A user can specify a different name using the
following paramater "-o output-file".

If the input file ia a memory image, the user should specify this in the command
line by adding '-inmi'.

If a user is not using the TriMedia Flash the parameter '-nostandard' should be 
added to the command line. By default ths standard Flash Library and Flash source
file (from the directory './tmunpacharch') are pulled in.

If a user is using the Flash BSP then a user should add '-flashbsp' to the
command line. Otherwise the Flash specific driver file in the Makefile will
be used as the Flash driver.

The autogenerated output can be verbose if the user specifies the -v options. However to
view the printfs the user must, link some output device such as a uart object file using
the -ldflags options.

Below is a more syntacital explanation of tmWRB input parameters.

usage: tmWRB -load begin_mem,end_mem input-file [-e[l|b]] [-host type] \
   [-v] [-tm_freq freq] [-mmio_base address] [-cache support] [-nostandard]\
   [-flashbsp] [-inmi] [-cflags "ccstring"] [-ldflags "ldstring"] 
   [-o output-file]  [-tcs "tcspath"] [-cpath "sourcepath"]
   
   'tmWRB' creates a Writable Boot (WRB) output file, given an input
   file. The input image file will be embedded in a compressed form in the output file.
   The output image file can be downloaded and run, where the original memory image will
   be uncompressed written to Flash as the boot image.
 
   -load begin_mem,end_mem : Specify download memory region of input file.
   input-file : name of executable to be extracted by WRB output file.
   -e[lb] : specify endianness of WRB output file
       -eb for big endian (default) 
       -el for little endian;
   -host type : Specify one of the following types of host processor 
       nohost    : No Host (default)
       tmsim     : TM Simulator is Host
       Win95     : Win95 is Host
       MacOS     : MacOS is Host
       WinNT     : WinNT is Host
   -v : Specify that the auto-generated part of output is verbose.
   -tm_freq freq : Specify the TM clock frequency. 100000000 is default.
   -mmio_base address : Specify MMIO base address. 0xefe00000 is default.
   -cache support : Specification of setting the resposiblity of setting the cacheable.
       limit and the cachelocked regions
       LeaveCachingToUser: cacheable limit and cachelocked 
           entirely under control of the user, the regions are downloader code won't
           touch it.
       LeaveCachingToDownloader: cachelocked regions and cacheble limit are entirely
           under control of the downloader, which will use this control to intelligently
           map the different cached/uncached/cachelocked sections within the specified
           sdram, partitioned in different caching property regions, and let the downloaded
           program set cacheable limit and cachelocked regions accordingly. (default)
       CachesOff: cachelocked regions and cacheble limit are entirely under control of the
           downloader, which will let the downloaded program run with 'cache off'.
   -nostandard : Disable usage of 'TriMedia' Flash.
   -flashbsp : Use flash driver that is part of relevant BSP
       default is to use flash specific driver as specified in makefile.
   -inmi : input file is a memory image.
   -cflags "cc_string" : A string of arguements to pass to tmcc when compiling sources for
       WRB application.
   -ldflags "ld_string" : A string of arguements to pass to tmcc when linking WRB
       application.
   -o output-file: name of WRB output-file that will be created. default output name
       is 'a.out'.
   -tcs tcspath : Current TCS path that tmSEI will use to build TriMedia image.
        default is C:\\TriMedia for Windows users and /usr/local/tcs; for Unix users 
        default is /usr/local/tcs
   -cpath sourcepath : path of c source file, tmunpackboot.c, that tmSEI will use
        to create a TriMeida image. default is .\\tmunpackboot for Windows ; for Uxix
        users ./tmunpackboot is default.