rdp_opts.h 4.62 KB
/**************************************************************************
 *                                                                        *
 *               Copyright (C) 1994, Silicon Graphics, Inc.               *
 *                                                                        *
 *  These coded instructions, statements, and computer programs  contain  *
 *  unpublished  proprietary  information of Silicon Graphics, Inc., and  *
 *  are protected by Federal copyright  law.  They  may not be disclosed  *
 *  to  third  parties  or copied or duplicated in any form, in whole or  *
 *  in part, without the prior written consent of Silicon Graphics, Inc.  *
 *                                                                        *
 *************************************************************************/

#ifndef RDP_OPTS_INCLD
#define RDP_OPTS_INCLD

/*
 *  Command Line Options for RDP simulator
 *
 *  -c <sim clocks>, RDP will run for this many clocks, including reset.  
 *                   default is 62500000.
 *
 *  -C <reg_clocks>, number of clocks to dump in each dump interval 
 *                   for regression dump 
 *
 *  -d <duty cycle>, floating point number from 0 to 1.0 (e.g. .2 for 20%)
 *		     used to determine amount of time spent in gclock stall
 *		     vs normal rdp processing.
 *
 *  -e,  exit on stobe sync full
 *
 *  -f <output filename>, filename prefix to be used when writing image files
 *		          into the OutData directory.
 *
 *  -F print a warning when the ew to ms fifo overflows.
 *
 *  -h, help message flag, prints a usage message.
 *
 *  -H <height>, override default 240 height
 *
 *  -I <input cmds dir>,  directory where input binary rdp command file
 *			  is located.  can also be specified using the
 *			  RDP_INDATA environment variable.  Default location
 *			  is ./InData.
 *
 *  -i <input cmds name>, binary rdp command file name
 *                        
 *  -k <key>, in multiprocess simulations is used to pass in common key
 *            to reference shared memory to all processes.  Usually set in
 *            the shell script output by 'xnet'.
 *
 *  -L <clocks_till_flush>, number of clocks to run before asserting flush signal.
 *
 *  -m <memory file name>, name of data file to use as main memory (2 Meg)
 *
 *  -M <max delay value>, maximum number of simclocks to randomly delay in
 *			  between fetches of data from the RSP bus.
 *
 *  -o <output dump>, flag indicates which modules I/O to dump to tab file.
 *                    can use flag repeatedly to get several dumps at once.
 *
 *  -P <reg_period>, number of clocks in each dump interval for regression dump 
 *
 *  -Q <seed value>, override seed value; if set, we will ignore any -S seed
 *		     values which have been or will be read (and munged by the
 *		     current date), and will use the -Q value as an absolute
 *		     seed value instead.  Allows you to specifically use a
 *		     random number seed which may have tickled a bug in a 
 *		     unique way.
 *
 *  -S <seed value>, starting seed value for random number generator, which
 *		     will introduce a random number of simclocks in between
 *		     fetches of data from the RSP bus.  The seed value will
 *		     be incremented by one each time a DMA is requested.
 *
 *
 *  -r <reset clocks>, RDP will reset for this many clocks, default is 60.
 *
 *  -T <tmem data dir>,  directory where texture memory data file
 *			  is located.  can also be specified using the
 *			  RDP_TMEMDATA environment variable.  Default location
 *			  is ./TmemData.
 *
 *  -t <tmem file name>, name of data file to load into Tmem, complete name
 *                       is formed to be "./TmemData/<tmem file name>.tmem".
 *                       The file format is 512 lines with the following ASCII
 *                       format:
 *       "<address>: <16b hex> <16b hex> <16b hex> <16b hex>\n"
 *
 *  -v, visual output flag, opens a GL window and paints RGB image as simulation
 *      progresses.
 *
 *  -W <width>,  override default 320 width
 *
 */

#define OPTARG			"d:k:o:i:I:r:c:t:T:M:m:Q:S:W:H:P:C:hveFf:zL:"

/*
 *  Default location for binary input data files.  These files are created by
 *  the RSP.  This location can be overridden by setting the environment 
 *  variable RDP_INDATA or using the -I flag on the command line.
 */
#define DEF_RDP_INDATA		"./InData"


/*
 *  Default location for Texture Memory input data files.  These files are 
 *  created by 'rgb2c' and 'tmemfmt'.  This location can be overridden by 
 *  setting the enironment variable RDP_TMEMDATA or using the -T flag on 
 *  the command line.
 */
#define DEF_RDP_TMEMDATA	"./TmemData"


#endif /* RDP_OPTS_INCLD */