/**************************************************************************
 *                                                                        *
 *               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.  *
 *                                                                        *
 *************************************************************************/

/*
 * File:	main.c
 * Creator:	hsa@sgi.com
 * Create Date:	Fri Oct 14 11:54:35 PDT 1994
 *
 *
 * This application is a test-bed of single frame tests for RDP
 * verification. The idea is that each frame possibly uses a different
 * dataset (see static.c) to render a particular test.
 *
 * Since this 'application' is not an animation, it is a sequence
 * of single-frame tests, it is best to run it without double buffering (-s):
 *
 *		emulate -s -a "-o 2" rdpverif rom
 *
 * Use the -a flag to emulate to pass arguments through to this app.
 *
 * NOTE:
 * This test-bed is composed of some shared code, and test-specific
 * code. To add or modify a test case, you should only touch the
 * test-specific code. Modifying shared code might break other tests.
 *
 *  FILES THAT ARE SHARED WITH OTHER TESTS: (don't modify)
 *
 *	main.c
 *	init.c
 *	dynamic.c
 *	zbuffer.c
 *	spec
 *
 *  FILES THAT ARE TEST-SPECIFIC: (may modify)
 *
 *	static.c		(holds static display list data for tests)
 *	rdpverif.h		(exports info to main.c, etc.)
 * 	rdpverif.c		(holds test frame procedures, etc.)
 *	<any related include files>	(textures, etc.)
 *	Makefile			(make test rules)
 *
 *
 * TO ADD A TEST CASE:
 * New test cases require that you add:
 *
 *	static.c	- add static display list for the test.
 *	rdpverif.h	- extern the static display list
 *	rdpverif.c	- add the procedure to be called to
 *			  perform the test case. (also put it
 *			  in the testCaseProc table)
 *			- put the static display list pointer
 *			  in the testList table.
 *
 * plus any new textures, include files, etc.
 *
 * All locations are marked with comments that say "ADD TEST CASE"
 * and give some hints what you need to do there.
 *
 * ADVANCED USAGE:
 * You could re-use test case procedures or data, as long as you
 * coordinate with all the tests that share it. It is a bad idea
 * to share data or procedures with a test that someone else may
 * go in and modify.
 *
 * If your test case needs a command line argument, that isn't handled
 * too cleanly. You would have to add it to main.c, and export the
 * global variables, etc. (messy) 
 *
 * This test suite favors single-frame tests. Animation support is clumsy.
 *
 * Fri Oct 14 11:18:33 PDT 1994
 *
 */

#include <ultra64.h>
#include <os_internal.h>

/* Only if using emulator: */
#include <em.h>
#include <verify.h>

/* local includes: */
#include "rdpverif.h"

/*
 * Symbol genererated by "makerom" to indicate the end of the code segment
 * in virtual (and physical) memory
 */
extern char _codeSegmentEnd[];

/*
 * Symbols generated by "makerom" to tell us where the static segment is
 * in ROM.
 */
extern char _staticSegmentRomStart[], _staticSegmentRomEnd[];

/*
 * Stacks for the threads as well as message queues for synchronization
 */
char	bootStack[STACKSIZE];

static int      uselines  = 0;
static int      useblack  = 0;

static void	idle(void *);
static void	main(void *);

static OSThread	idleThread;
static char	idleThreadStack[STACKSIZE];

static OSThread	mainThread;
static char	mainThreadStack[STACKSIZE];

OSMesgQueue	dmaMessageQ, taskMessageQ, retraceMessageQ;
OSMesg		dmaMessageBuf, taskMessageBuf, retraceMessageBuf;
OSMesg		dummyMessage;

/*
 * necessary for RSP tasks:
 */
unsigned long long int dram_stack[SP_DRAM_STACK_SIZE64];
unsigned long long int dram_yield[OS_YIELD_DATA_SIZE]; /* dram yield storage */

/* put this first for convenience reading octal dumps... */
unsigned long long int rdp_output[4096*16];	/* 64K bytes of rdp output (test) */

/*
 * must be in BSS, not on the stack for this to work:
 */
OSTask    tlist[2];       /* globaltask lists */
Gfx	*glistp;	/* global for test case procs */

/*
 * Double-buffered dynamic segments (?)
 */
Dynamic	dynamicBuffer[2];

/*
 * global variables for arguments, to control test cases
 */
static int	keep_mem = 0;
static int	automated = 0;
static int	frame_count = 0;
static int	output_frame = -1;
static int	ani_frame = -1;
static int	ani_count = 0, ani_count_max = 0;
static char	*output_prefix = "rdpcov";
static int	rdp_DRAM_io = 0;
static int	rdp_regressionFlag = 0;
static int	rdp_mspanFlushFlag = 0;
static int	cfb_size = G_IM_SIZ_16b;
static int	doyieldtest=0;


/*
 * private routine used to parse args.
 */
static int
myatoi(char *str)
{
    int		log10[5], logn = 0, val = 0, i, pow10 = 1;

    if (str == NULL || *str == '\0')
	return(-1);
    
    while (*str != '\0') {
	if (!(*str == '0' ||
	      *str == '1' ||
	      *str == '2' ||
	      *str == '3' ||
	      *str == '4' ||
	      *str == '5' ||
	      *str == '6' ||
	      *str == '7' ||
	      *str == '8' ||
	      *str == '9')) {
	    logn = 0;
	    break;
	}

	log10[logn++] = *str - '0';
	str++;
    }
    
    if (logn == 0)
	return(-1);
    
    for (i=logn-1; i>= 0; i--) {
	val += log10[i] * pow10;
	pow10 *= 10;
    }
    return (val);
}

/*
 * private routine used to parse args.
 */
static void
parse_args(char *argstring)
{
    int		argc = 1, i;
    char	*arglist[32], **argv = arglist;	/* max 32 args */
    char	*c, *ptr;

    if (argstring == NULL || argstring[0] == '\0')
	return;

    /* re-organize argstring to be like main(argv,argc) */
    ptr = argstring;
    while (*ptr != '\0') {
	while (*ptr != '\0' && (*ptr == ' ')) {
	    *ptr = '\0';
	    ptr++;
	}
	if (*ptr != '\0')
	    arglist[argc++] = ptr;
	while (*ptr != '\0' && (*ptr != ' ')) {
	    ptr++;
	}
    }

    /* ADD TEST CASE:
     * might want to pick off special arguments here.
     */

    /* process the arguments: */
    while ((argc > 1) && (argv[1][0] == '-')) {
	switch(argv[1][1]) {

	  case 'a':
	    automated = 1;	/* exit after doing cases */
	    break;
	    
	  case 'd':
	    rdp_DRAM_io = 1;	/* route RSP output for RDP back to DRAM */
	    break;
	    
	  case 'f':
	    frame_count = myatoi(argv[2]); /* start frame */
	    if (frame_count < 0) {
		frame_count = 0;
		emPrintf("bad frame_count [-f]!\n");
	    }
	    argc--;
	    argv++;
	    break;
	  case 'F':
	    rdp_mspanFlushFlag = 1; /* flush mspan cache by enabling 1PRIM */
            break;
	    
	  case 'm':
	    keep_mem = 1;	/* keep DRAM memory image */
	    break;
	    
	  case 'n':
	    output_prefix = argv[2]; /* output name prefix */
	    argc--;
	    argv++;
	    break;

	  case 'o':
	    output_frame = myatoi(argv[2]); /* frame to output */
	    if (output_frame < 0) {
		emPrintf("bad output_frame [-o]!\n");
	    }
	    argc--;
	    argv++;
	    break;

	  case 'r':
	    rdp_regressionFlag = 1; /* when set, shrink viewport for brevity */
	    break;
	    
	  case 's':
	    ani_frame = myatoi(argv[2]); /* animation frame */
	    if (ani_frame < 0) {
		emPrintf("bad frame_count [-s]!\n");
	    }
	    argc--;
	    argv++;
	    ani_count_max = myatoi(argv[2]); /* animation frame count */
	    if (ani_count_max < 0) {
		ani_count_max = 0;
		emPrintf("bad ani_count_max [-s]!\n");
	    }
	    argc--;
	    argv++;
	    break;
	    
	  case 't':		/* "true color" ie 24 bit RGB */
	    cfb_size = G_IM_SIZ_32b;
	    break;

	case 'l':
	    uselines = 1;
	    break;
	    
	case 'b':
	    useblack = 1;
	    break;
	    
	case 'y':
	    doyieldtest = 1;
	    break;
	    
	  default:
	    emPrintf("option [%s] not recognized.\n", argv[1]);
	    break;
	}
	argc--;
	argv++;
    }
}

boot(void *arg)
{
    osInitialize();
    osCreateThread(&mainThread, 1, main, arg, mainThreadStack+STACKSIZE, 10);
    osStartThread(&mainThread);
}

static void
main(void *arg)
{
    int		current = 0, keep_going = 1;
    OSMesg	dummyMesg;
    OSTask	*tlistp;
    Dynamic	*dynamicp;
    char	*staticSegment;
    MouseState	ms;
    int 	testListCount;
    /* this structure must be aligned to 64-bit boundary: */
    VerifyInfo	*info = (VerifyInfo *)osPhysicalToVirtual(VERIFY_INFO_PHYSADDR);
    
    /*
     * This is how arguments are passed via emulator:
     *
     *		emulate -a "<app args>" rdpverif rom
     */
    parse_args(arg);
    
    /*
     * Create idle thread
     */
    osCreateThread(&idleThread, 2, idle, (void *)0,
		   idleThreadStack+STACKSIZE, 0);
    osStartThread(&idleThread);
    
    /*
     * Setup the message queues
     */
    osCreateMesgQueue(&dmaMessageQ, &dmaMessageBuf, 1);
    osSetEventMesg(OS_EVENT_PI, &dmaMessageQ, dummyMessage);
    
    osCreateMesgQueue(&taskMessageQ, &taskMessageBuf, 1);
    osSetEventMesg(OS_EVENT_SP, &taskMessageQ, dummyMessage);
    
    osCreateMesgQueue(&retraceMessageQ, &retraceMessageBuf, 1);
    osSetEventMesg(OS_EVENT_VI, &retraceMessageQ, dummyMessage);
    
    /*
     * Stick the static segment right after the code/data segment
     */
    staticSegment = _codeSegmentEnd;
    osPiRawStartDma(OS_READ, (u32)_staticSegmentRomStart, staticSegment,
		    _staticSegmentRomEnd - _staticSegmentRomStart);
    
    /*
     * Wait for DMA to finish
     */
    (void)osRecvMesg(&dmaMessageQ, &dummyMesg, OS_MESG_BLOCK);
    
    /* 
     * count the test cases. Can't use sizeof(), do it
     * here.
     */
    testListCount = 0;
    while (testList[testListCount] != (Gfx *) NULL)
	testListCount++;
    testListCount--;

    current = (frame_count % 2);

    /*
     * Main game loop
     */
    while (keep_going) {

	/*
	 * pointers to build the display list.
	 */
	tlistp = &tlist[current];
	dynamicp = &dynamicBuffer[current];
	glistp = dynamicp->glist;


	/*
	 * This test suite assumes the initialization
	 * sequences are all the same. You can un-do some state
	 * in your private test display list, if you like.
	 * You should also reset things you change.
	 *
	 */

	/*
	 * Tell RCP where each segment is
	 */
	gSPSegment(glistp++, STATIC_SEGMENT,
		   osVirtualToPhysical(staticSegment));
	gSPSegment(glistp++, DYNAMIC_SEGMENT,
		   osVirtualToPhysical(dynamicp));

	/*
	 * Graphics pipeline state initialization
	 */
	gSPDisplayList(glistp++, setup_rspstate);

	/*
	 * If the rdp_regressionFlag is set, apply a 1/4 shrink to the 
	 * viewport so that the tests will render more quickly (because they
	 * won't be as fill limited).  Do this after we invoke the display
	 * list pointed to by setup_rspstate.
	 */
	if (rdp_regressionFlag) {
	    gSPDisplayList(glistp++, regression_viewport);
	} 
	
	gSPDisplayList(glistp++, setup_rdpstate);
	
	if (rdp_mspanFlushFlag) {
	    /*
	     * Force the pipeline to empty after the rendering of each
	     * display list item, to avoid incurring span buffer cache 
	     * coherency problems with DRAM r-m-w cycles.
	     */
	    gDPPipelineMode(glistp++, G_PM_1PRIMITIVE);
	}
	
	/*
	 * Clear framebuffer
	 */
	if (cfb_size == G_IM_SIZ_32b) {
	    gSPDisplayList(glistp++, clear_32fb);
	} else {
	    gSPDisplayList(glistp++, clear_fb);
	}
	
	/* end of standard display list part. */

	/*
	 * Setup our dynamic segment, depending on which test:
	 */
	if (ani_frame < 0 || ani_frame > testListCount) {
	    if (frame_count > testListCount) {
		frame_count = 0;
		if (automated)
		    keep_going = 0;
	    }
	    (*testCaseProcs[frame_count])(dynamicp, frame_count);
	    
	} else {
	    if (automated && ani_count >= ani_count_max)
		keep_going = 0;
	    
	    (*testCaseProcs[ani_frame])(dynamicp, ani_frame);
	}
	
	/*
	 * Force top-level display list to have an END.
	 */
	gSPEndDisplayList(glistp++);
	
	/* 
	 * Build graphics task:
	 *
	 */
	tlistp->t.type = M_GFXTASK;
	tlistp->t.flags = 0x0;
	tlistp->t.ucode_boot = (unsigned long long *) rspbootTextStart;
	tlistp->t.ucode_boot_size = ((int)rspbootTextEnd - 
				     (int)rspbootTextStart);
	/*
	 * choose which ucode to run:
	 */
	if (rdp_DRAM_io) {
	    /* re-direct output to DRAM: */
	    if (uselines) {
		tlistp->t.ucode = (unsigned long long *)
		    gspLine3D_dramTextStart;
		tlistp->t.ucode_data = (unsigned long long *)
		    gspLine3D_dramDataStart;
	    } else {
		tlistp->t.ucode = (unsigned long long *)
		    gspFast3D_dramTextStart;
		tlistp->t.ucode_data = (unsigned long long *)
		    gspFast3D_dramDataStart; 
	    }
	} else {
	    /* SP output over XBUS to DP: */
	    if (uselines) {
		tlistp->t.ucode = (unsigned long long *)
		    gspLine3DTextStart;
		tlistp->t.ucode_data = (unsigned long long *)
		    gspLine3DDataStart;
	    } else {
		tlistp->t.ucode = (unsigned long long *)
		    gspFast3DTextStart;
		tlistp->t.ucode_data = (unsigned long long *)
		    gspFast3DDataStart;
	    }
	}
	tlistp->t.ucode_size = 4096;
	tlistp->t.ucode_data_size = 2048;
	
	tlistp->t.dram_stack = (unsigned long long *) &(dram_stack[0]);
	tlistp->t.dram_stack_size = SP_DRAM_STACK_SIZE8;

	if (rdp_DRAM_io) {
	    tlistp->t.output_buff = (unsigned long long *) &(rdp_output[0]);
	    tlistp->t.output_buff_size = (unsigned long long *)
		&(info->rdpListSize);
	} else {
	    tlistp->t.output_buff = (unsigned long long *) 0x0;
	    tlistp->t.output_buff_size = (unsigned long long *) 0x0;
	}

	/* initial display list: */
	tlistp->t.data_ptr = (unsigned long long *)
	    dynamicBuffer[current].glist;
	tlistp->t.data_size = ((int)(glistp - dynamicBuffer[current].glist) *
			       sizeof (Gfx));
	tlistp->t.yield_data_ptr = (unsigned long long *) &(dram_yield[0]);
	tlistp->t.yield_data_size = OS_YIELD_DATA_SIZE;

	/*
	 * Fill in verify info structure: (for verification ONLY)
	 */
	info->rspListAddr    = (unsigned int) tlistp->t.data_ptr;
	info->rspListSize    = tlistp->t.data_size;
	info->rspListType    = ((4096-128) << 12) | tlistp->t.type;
	info->ucodeTextAddr  = (unsigned int) tlistp->t.ucode;
	info->ucodeDataAddr  = (unsigned int) tlistp->t.ucode_data;
	info->ucodeDataSize  = tlistp->t.ucode_data_size;
	info->dramStackAddr  = (unsigned int) tlistp->t.dram_stack;
	info->dramStackSize  = tlistp->t.dram_stack_size;
	info->rdpListSize    = 0;
	info->rdpListAddr    = (unsigned int) osVirtualToPhysical(tlistp->t.output_buff);
	info->bootUcodeAddr  = (unsigned int) tlistp->t.ucode_boot;
	info->width          = SCREEN_WD;
	info->height         = SCREEN_HT;
	info->frameBuffer0Addr = osVirtualToPhysical(cfb_16_a);
	info->frameBuffer1Addr = osVirtualToPhysical(cfb_16_b);
	info->zBufferAddr    = osVirtualToPhysical(zbuffer);
	info->magicNumber    = MAGICNUMBER; /* Kaelyn's birthday: 0x102594 */
	info->version        = VERSION;
	info->frameBufferFormat = G_IM_FMT_RGBA;
	info->frameBufferSize =  cfb_size;
        info->staticSegSize =  (_staticSegmentRomEnd - _staticSegmentRomStart+1);
        info->staticSegAddr =  osVirtualToPhysical(staticSegment);

	
	/*
	 * Can just flush 16KB and forget about each individual pieces
	 * of data to flush.
	 */
	osWritebackDCacheAll();
	
	/* possibly send display list to RSP simulator: */
        if (ani_frame < 0 || ani_frame > testListCount) {
	    if (frame_count == output_frame) {
		emRSPFrame(output_prefix, frame_count, keep_mem, rdp_DRAM_io, 0);
		output_frame = -1;	/* only output once... */
	    }
	} else {
            /*
	     * using the -s flag (ani_frame) will always cause
	     * the RSP to be invoked.
	     *
	     */
	    emRSPFrame(output_prefix, ani_count++, keep_mem, rdp_DRAM_io, 0);
	}

	osSpTaskStart(tlistp);
	
	if (doyieldtest) {
/*
 * YIELD STUFF START
 */
{
	static int firstone=0;
	u32 yieldstatus;
	if (!firstone) {

/* #define DELAYLEN 350 */
/* #define DELAYLEN 345 */
/* #define DELAYLEN 150 */
/* #define DELAYLEN 75 */
#define DELAYLEN 60
	{ static int doone=0; volatile int delay; if (!(doone++)) for(delay=0;delay<DELAYLEN;delay++) emPrintf("--->delay[stat=%x]{%d}\n",(int)__osSpGetStatus(),delay); }

emPrintf("--->DELAY DONE, stat=%X\n",(int)__osSpGetStatus());

	while( osRecvMesg(&taskMessageQ, &dummyMesg, OS_MESG_NOBLOCK) == -1) {
	    emPrintf("--->yielding[stat=%x]\n",(int)__osSpGetStatus());
	    osSpTaskYield();
	}
	if (osSpTaskYielded(tlistp)) {
	    emPrintf("Yielded.  About to restart[stat=%x]\n",(int)__osSpGetStatus());
	    info->ucodeDataAddr  = (unsigned int) tlistp->t.yield_data_ptr;
	    info->ucodeDataSize  = tlistp->t.yield_data_size;
emPrintf("--->about to restarted[stat=%x]\n",(int)__osSpGetStatus());
	    osSpTaskStart(tlistp);
emPrintf("--->just restarted[stat=%x]\n",(int)__osSpGetStatus());
	    while( osRecvMesg(&taskMessageQ, &dummyMesg, OS_MESG_NOBLOCK) == -1) {
/*
		    emPrintf("--->restarted[stat=%x]\n",(int)__osSpGetStatus());
*/
	    }
	}

	emPrintf("exited from Message-Wait loop[stat=%x]\n",(int)__osSpGetStatus());
	}
	firstone=1;
}
/*
 * YIELD STUFF END
 */
} else {
	(void)osRecvMesg(&taskMessageQ, &dummyMesg, OS_MESG_BLOCK);
}

	emDisplayBuffer(osVirtualToPhysical(cfb_16_a));

	(void)osRecvMesg(&retraceMessageQ, &dummyMesg, OS_MESG_BLOCK);

	current = 1 - current;

	if (automated) {
	    frame_count++;
	} else {
	    emGetMouseState(&ms);
	    if (ms.buttons & BUTTON_LEFT) {
		frame_count++;
		while (ms.buttons & BUTTON_LEFT)/* de-bounce mouse state: */
		    emGetMouseState(&ms);
	    } else if (ms.buttons & BUTTON_MIDDLE) {
		;
	    } else if (ms.buttons & BUTTON_RIGHT) {
		;
	    }
	}

    }

    emRSPQuit();
    for(;;);   
}

static void
idle(void *arg)
{
    for(;;);
}