/*********************************************************************************************
* File:		usbsetup.c
* Author:	Embest
* Desc:		process the USB setup stage operations.
* History:	
*			purnnamu, MAR.25.2002
*				S3C2400X usbsetup.c is ported for S3C2410X.
*			purnnamu, AUG.20.2002
*				rEP0_CSR should be used instead of rOUT_CSR1_REG for EP0 macros.
*			R.X.Huang, March 12, 2005
*				Programming modify, style of the program: nomenclature, commentary
*			J.Y.Guo, April 28, 2005
*				Modifying and reusing  of S3C2410X u24xmon
*********************************************************************************************/

/*------------------------------------------------------------------------------------------*/
/*                                     include files	                                    */
/*------------------------------------------------------------------------------------------*/
#include <string.h>
#include "2410lib.h"

#include "2410usb.h"
#include "usbmain.h"
#include "usb.h"
#include "usblib.h"
#include "usbsetup.h"



// *** VERY IMPORTANT NOTE ***
// Every descriptor size of EP0 should be 8n+m(m=1~7).
// Otherwise, USB will not operate normally because the program
// doesn't prepare the case that the descriptor size is 8n+0.
// If the size of a descriptor is 8n, the 0 length packit should be sent. 
// Special thanks to E.S.Choi for reminding me of this USB specification.
// *** End point information ***
//   EP0: control
//   EP1: bulk in end point
//   EP2: not used
//   EP3: bulk out end point
//   EP4: not used


/*------------------------------------------------------------------------------------------*/
/*	 								Macro defines							 			    */
/*------------------------------------------------------------------------------------------*/
// All following commands will operate only in case - ep0_csr is valid.
#define CLR_EP0_OUT_PKT_RDY() 		rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)| \
						EP0_SERVICED_OUT_PKT_RDY )	 
#define CLR_EP0_OUTPKTRDY_DATAEND() 	rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)| \
						(EP0_SERVICED_OUT_PKT_RDY|EP0_DATA_END) )	 
					
#define SET_EP0_IN_PKT_RDY() 		rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)| \
						(EP0_IN_PKT_READY) )	 
#define SET_EP0_INPKTRDY_DATAEND() 	rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)| \
						(EP0_IN_PKT_READY|EP0_DATA_END) )	 
					
#define CLR_EP0_SETUP_END() 		rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)| \
						(EP0_SERVICED_SETUP_END) )

#define CLR_EP0_SENT_STALL() 		rEP0_CSR=( ep0_csr & (~EP0_WR_BITS)& \
						(~EP0_SENT_STALL) )

#define FLUSH_EP0_FIFO() 		{while(rOUT_FIFO_CNT1_REG)rEP0_FIFO;}

/*------------------------------------------------------------------------------------------*/
/*	 								variables declare						 			    */
/*------------------------------------------------------------------------------------------*/
UINT32T ep0State;
UINT32T ep0SubState;

/*------------------------------------------------------------------------------------------*/
/*	 								extern variables						 			    */
/*------------------------------------------------------------------------------------------*/
extern volatile int isUsbdSetConfiguration;

/*------------------------------------------------------------------------------------------*/
/*	 								struct	 declare						 			    */
/*------------------------------------------------------------------------------------------*/
struct USB_SETUP_DATA descSetup;
struct USB_DEVICE_DESCRIPTOR descDev;
struct USB_CONFIGURATION_DESCRIPTOR descConf;
struct USB_INTERFACE_DESCRIPTOR descIf;
struct USB_ENDPOINT_DESCRIPTOR descEndpt0;
struct USB_ENDPOINT_DESCRIPTOR descEndpt1;



/*------------------------------------------------------------------------------------------*/
/*	 								constant define							 			    */
/*------------------------------------------------------------------------------------------*/
static const UINT8T descStr0[]={
	4,STRING_TYPE,LANGID_US_L,LANGID_US_H,						//codes representing languages
   };

static const UINT8T descStr1[]={								//Manufacturer  
        (0x14+2),STRING_TYPE, 
        'S',0x0,'y',0x0,'s',0x0,'t',0x0,'e',0x0,'m',0x0,' ',0x0,'M',0x0,
        'C',0x0,'U',0x0,
   };
    
static const UINT8T descStr2[]={								//Product  
        (0x2a+2),STRING_TYPE, 
        'S',0x0,'E',0x0,'C',0x0,' ',0x0,'S',0x0,'3',0x0,'C',0x0,'2',0x0,
        '4',0x0,'1',0x0,'0',0x0,'X',0x0,' ',0x0,'T',0x0,'e',0x0,'s',0x0,
        't',0x0,' ',0x0,'B',0x0,'/',0x0,'D',0x0
   };

/*********************************************************************************************
* name:		Ep0Handler
* func:		Interrupt handler for EP0 
* para:		none
* ret:		none
* modify:
* comment:		
*********************************************************************************************/
void Ep0Handler(void)
{
    static int ep0SubState;
    int i;
    UINT8T ep0_csr;

    rINDEX_REG=0;
    ep0_csr=rEP0_CSR;
    
    DbgPrintf("<0:%x]",ep0_csr);

    //DATAEND interrupt(ep0_csr==0x0) will be ignored 
    //because ep0State==EP0_STATE_INIT when the DATAEND interrupt is issued.
    if(ep0_csr & EP0_SETUP_END)
    {   
    	 // Host may end GET_DESCRIPTOR operation without completing the IN data stage.
    	 // If host does that, SETUP_END bit will be set.
    	 // OUT_PKT_RDY has to be also cleared because status stage sets OUT_PKT_RDY to 1.
		DbgPrintf("[SETUPEND]");
		CLR_EP0_SETUP_END();
	if(ep0_csr & EP0_OUT_PKT_READY) 
	{
	    FLUSH_EP0_FIFO(); //(???)
	    	//I think this isn't needed because EP0 flush is done automatically.   
	    CLR_EP0_OUT_PKT_RDY();
	}
	
	ep0State=EP0_STATE_INIT;
	return;
   }	

    //I think that EP0_SENT_STALL will not be set to 1.
    if(ep0_csr & EP0_SENT_STALL)
    {   
	   	DbgPrintf("[STALL]");
	   	CLR_EP0_SENT_STALL();
	if(ep0_csr & EP0_OUT_PKT_READY) 
	{
	    CLR_EP0_OUT_PKT_RDY();
	}
	
	ep0State=EP0_STATE_INIT;
	return;
   }	

    if((ep0_csr & EP0_OUT_PKT_READY) && (ep0State==EP0_STATE_INIT))
    {	
		RdPktEp0((UINT8T *)&descSetup,EP0_PKT_SIZE);

		PrintEp0Pkt((UINT8T *)(&descSetup));					//DEBUG
    
		switch(descSetup.bRequest)
    	{
    		case GET_DESCRIPTOR:
	            switch(descSetup.bValueH)        
	            {
		            case DEVICE_TYPE:
			 	    	DbgPrintf("[GDD]");
			 	    	CLR_EP0_OUT_PKT_RDY();
				    	ep0State=EP0_STATE_GD_DEV_0;	        
				    	break;	
				    case CONFIGURATION_TYPE:
			 	    	DbgPrintf("[GDC]");
			 	    	CLR_EP0_OUT_PKT_RDY();
			 	    	if((descSetup.bLengthL+(descSetup.bLengthH<<8))>0x9)
							//bLengthH should be used for bLength=0x209 at WIN2K.    	
							ep0State=EP0_STATE_GD_CFG_0;		//for WIN98,WIN2K
					else	    	    
			  		    ep0State=EP0_STATE_GD_CFG_ONLY_0;		//for WIN2K
				    	break;
			   	    case STRING_TYPE:
			 	    	DbgPrintf("[GDS]");
			 	    	CLR_EP0_OUT_PKT_RDY();
				    	
				    	switch(descSetup.bValueL)
				    	{
				    	    case 0:
				    	    	ep0State=EP0_STATE_GD_STR_I0;
				    	    	break;
				    	    case 1:
			       	    	    	ep0State=EP0_STATE_GD_STR_I1;
				    	    	break;
				    	    case 2:	
				    	    	ep0State=EP0_STATE_GD_STR_I2;
				    	    	break;
				    	    default:
				    			DbgPrintf("[UE:STRI?]");
				    		break;
						}
				    	ep0SubState=0;
				    	break;
				    case INTERFACE_TYPE:
			 	    	DbgPrintf("[GDI]");
			 	    	CLR_EP0_OUT_PKT_RDY();
				    	ep0State=EP0_STATE_GD_IF_ONLY_0; //for WIN98
				    	break;
				    case ENDPOINT_TYPE:	    	
			 	    	DbgPrintf("[GDE]");
			 	    	CLR_EP0_OUT_PKT_RDY();
			 	    	switch(descSetup.bValueL&0xf)
				    	{
					    	case 0:
					    	    ep0State=EP0_STATE_GD_EP0_ONLY_0;
					    	    break;
					    	case 1:
				       	    	    ep0State=EP0_STATE_GD_EP1_ONLY_0;
					    	    break;
					    	default:
					    	    DbgPrintf("[UE:GDE?]");
					    	    break;
				    	}
				    	break;
				    default:
				    	DbgPrintf("[UE:GD?]");
				    	break;
				   }	
				break;
	    	case SET_ADDRESS:
	            DbgPrintf("[SA:%d]",descSetup.bValueL);
	            rFUNC_ADDR_REG=descSetup.bValueL | 0x80;
		    	CLR_EP0_OUTPKTRDY_DATAEND();						//Because of no data control transfers.
	            ep0State=EP0_STATE_INIT;
	            break;
			case SET_CONFIGURATION:
				DbgPrintf("[SC]");
				CLR_EP0_OUTPKTRDY_DATAEND(); 						//Because of no data control transfers.
				ep0State=EP0_STATE_INIT;
		
				isUsbdSetConfiguration=1; 
				break;
			default:
				DbgPrintf("[UE:SETUP=%x]",descSetup.bRequest);
				CLR_EP0_OUTPKTRDY_DATAEND(); //Because of no data control transfers.
				ep0State=EP0_STATE_INIT;
				break;