mx31_habtools.c

Nand Flash (SAMSUNG_K9K1G08U0B) boot loader for i.Mx31 (freescale).

DESCRIPTION: 
   	This function is used to prepare the Setup command from PC and prime the endpoint

ARGUMENTS PASSED:
	None
  
RETURN VALUE:
	None
	

IMPORTANT NOTES:
	None
==================================================================================================*/
void EP1OutCommandSetup(void)
{
	U32 TotalBytes = COMMAND;
// OUT
	// setup dTD
	// dTD for status of GET_DEVICE_DESCRIPTOR
	dTDSetup(dTD0_EP1OUT, dTD1_EP1OUT, TERMINATE, TotalBytes, IOC_SET, ACTIVE, BUFPTR_P0_EP1OUT,(BUFPTR_P0_EP1OUT & 0xFFF),0,0,0,0);
	// 1. write dQH next ptr and dQH terminate bit to 0 
	*(P_U32)(dQH2_EP1OUT+0x8)= (dTD0_EP1OUT);
	
	// 2. clear active & halt bit in dQH
	*(P_U32)(dQH2_EP1OUT+0xC) &= ~0xFF;
	
	// 3. prime endpoint by writing '1' in ENDPTPRIME
	*(P_U32)USB_OTG_ENDPTPRIME |= EP1OUT_PRIME;
	

}

/*==================================================================================================

FUNCTION: EP1OutRxData

DESCRIPTION: 
   	This function is used to rx binary data for the download

ARGUMENTS PASSED:
	None
  
RETURN VALUE:
	None
	

IMPORTANT NOTES:
	None
==================================================================================================*/
void EP1OutRxData(U32 Address, U32 Offset, U32 ByteCount)
{
	// setting up the dTD buffer pointer depend on the ByteCounts
	// each page is 0x1000 and the max recommanded transfer is 0x4000 (16k bytes)
	U32 BufferPtrPage0 = Address;
	U32 BufferPtrPage1 = (Address + 0x1000);
	U32 BufferPtrPage2 = (Address + 0x2000);
	U32 BufferPtrPage3 = (Address + 0x3000);
	U32 BufferPtrPage4 = (Address + 0x4000);
	
	// Clear the EP1 OUT complete status if set
	if (*(P_U32)USB_OTG_ENDPTCOMPLETE & BIT1)
		*(P_U32)USB_OTG_ENDPTCOMPLETE = BIT1;
	
// OUT
	// setup dTD
	// dTD for status of GET_DEVICE_DESCRIPTOR
	dTDSetup(dTD0_EP1OUT, dTD1_EP1OUT, TERMINATE, ByteCount, IOC_SET, ACTIVE, BufferPtrPage0,Offset,
	BufferPtrPage1,BufferPtrPage2,BufferPtrPage3,BufferPtrPage4);

	// 1. write dQH next ptr and dQH terminate bit to 0 
	*(P_U32)(dQH2_EP1OUT+0x8)= (dTD0_EP1OUT);
	
	// 2. clear active & halt bit in dQH
	*(P_U32)(dQH2_EP1OUT+0xC) &= ~0xFF;
	
	// 3. prime endpoint by writing '1' in ENDPTPRIME
	*(P_U32)USB_OTG_ENDPTPRIME |= EP1OUT_PRIME;
	
	// 4. Wait for the Complete Status 
	while (!(*(VP_U32)USB_OTG_ENDPTCOMPLETE & BIT1));
	//clear the complete status
	*(VP_U32)USB_OTG_ENDPTCOMPLETE = BIT1;
}

/*==================================================================================================

FUNCTION: EnableEP2IN

DESCRIPTION: 
   	This function is used to enable the EP2 as IN

ARGUMENTS PASSED:
	None
  
RETURN VALUE:
	None
	

IMPORTANT NOTES:
	None
==================================================================================================*/
void EnableEP2IN(void)
{
	U32 TotalBytes = 0x0;

	// EP2 IN response = 4 bytes
	TotalBytes = 0x4;
	dQHSetup(dQH5_EP2IN, ZLT_DISABLE, MPS_64, IOS_SET, dTD0_EP2IN, TERMINATE, 
	TotalBytes, IOC_SET, NO_STATUS, BUFPTR_P0_EP2IN,(BUFPTR_P0_EP2IN & 0xFFF),0,0,0,0);


	// Endpoint 2: MPS = 64, IN (Tx endpoint)
	*(P_U32)USB_OTG_ENDPTCTRL2 = 0x00480008;

	// Enable EP2 IN
	*(P_U32)USB_OTG_ENDPTCTRL2 |= EP2IN_ENABLE;
	
	// 3. prime endpoint by writing '1' in ENDPTPRIME
	*(P_U32)USB_OTG_ENDPTPRIME |= EP2IN_PRIME;
	
}


/*==================================================================================================

FUNCTION: CommandAck

DESCRIPTION: 
   	This function is used to prepare the 4 bytes response to USB Host

ARGUMENTS PASSED:
	U32 ack: response
  
RETURN VALUE:
	None
	

IMPORTANT NOTES:
	None
==================================================================================================*/

void CommandAck(U32 ack, U8 channel)
{
	U32 TotalBytes = 0x4;

//#########
// USB
//#########
	if (channel)
	{
	//======
	// IN
	//======
		*(P_U32)BUFPTR_P0_EP2IN = ack;
		
		dTDSetup(dTD0_EP2IN, dTD1_EP2IN, TERMINATE, TotalBytes, IOC_SET, ACTIVE, BUFPTR_P0_EP2IN,(BUFPTR_P0_EP2IN & 0xFFF),0,0,0,0);
		
		// 1. write dQH next ptr and dQH terminate bit to 0 
		*(P_U32)(dQH5_EP2IN+0x8)= (dTD0_EP2IN);
		
		// 2. clear active & halt bit in dQH
		*(P_U32)(dQH5_EP2IN+0xC) &= ~0xFF;
		
		// 3. prime endpoint by writing '1' in ENDPTPRIME
		*(P_U32)USB_OTG_ENDPTPRIME = EP2IN_PRIME;
		
		// wait for complete set and clear
		while (!(*(VP_U32)USB_OTG_ENDPTCOMPLETE & EP2IN_COMPLETE));
		
		*(P_U32)USB_OTG_ENDPTCOMPLETE = EP2IN_COMPLETE;
	}
//#######	
// UART
//#######	
	else
	{
		MX31_PutCharInFIFO((U8)ack & 0xFF);
		MX31_PutCharInFIFO((U8)((ack & 0xFF00)>>8));
		MX31_PutCharInFIFO((U8)((ack & 0xFF0000)>>16));
		MX31_PutCharInFIFO((U8)((ack & 0xFF000000)>>24));
		//wait for TF empty
		while (!(*(VP_U32)UART1_USR2_1 & 0x4000));
	
	}
	
}	

/*==================================================================================================

FUNCTION: EP2INTxData

DESCRIPTION: 
   	This function is used to transmit the data for READ command

ARGUMENTS PASSED:
	U32 BufPtrAddress - Buffer pointer address
	U32 TotalBytes	  - TotalBytes to be read
  
RETURN VALUE:
	None
	

IMPORTANT NOTES:
	None
==================================================================================================*/
void EP2INTxData(U32 BufPtrAddress, U32 TotalBytes)
{
//======
// IN
//======
	dTDSetup(dTD0_EP2IN, dTD1_EP2IN, TERMINATE, TotalBytes, IOC_SET, ACTIVE, BufPtrAddress,0,0,0,0,0);
	
	// 1. write dQH next ptr and dQH terminate bit to 0 
	*(P_U32)(dQH5_EP2IN+0x8)= (dTD0_EP2IN);
	
	// 2. clear active & halt bit in dQH
	*(P_U32)(dQH5_EP2IN+0xC) &= ~0xFF;
	
	// 3. prime endpoint by writing '1' in ENDPTPRIME
	*(P_U32)USB_OTG_ENDPTPRIME = EP2IN_PRIME;
	
	// wait for complete set and clear
	while (!(*(VP_U32)USB_OTG_ENDPTCOMPLETE & EP2IN_COMPLETE));
	
	*(P_U32)USB_OTG_ENDPTCOMPLETE = EP2IN_COMPLETE;

}


/*==================================================================================================

FUNCTION: HandleCommand

DESCRIPTION: 
   	This function is used to handle the PC Command

ARGUMENTS PASSED:
	U8 ErrorCode: Error Code passed from HAB
  
RETURN VALUE:
	DONE (1)	: when Execute = 0xAA, return to Bootstrap
	CONTINUE (0) : for others
	
IMPORTANT NOTES:
	None
		
==================================================================================================*/
int HandleCommand(int status, int count, U8 channel)
{
	int i = 0;
	U16 Header = 0;
	U32 Response = 0;
	P_U8 BufPtr;
	
	// USB
	if (channel)
	{
		BufPtr = (P_U8)BUFPTR_P0_EP1OUT;
		for (i=0; i< 16; i++)
		{
				_gCommand[i] = 0x0;	//clear the array
				_gCommand[i] = *BufPtr;
				BufPtr++;
		}	
	}
		
	// UART here
	else
	{
		for (i=0; i< 16; i++)
		{
			while (!(*(VP_U32)UART1_USR2_1 & 0x1));
			_gCommand[i] = MX31_GetCharFromFIFO(); 
		}
	}

	Header = ((_gCommand[0]<<8) | (_gCommand[1]));

//	if (status == FLASH_ERASE)
	{
		Response =( (status << 16) | (count & 0xFFFF)) ;
		CommandAck(Response, channel);
	}



	return 1;
}



unsigned char MX31_GetCharFromFIFO (void)
{
	return (*(VP_U32)UART1_URXD_1 & 0xFF);
}


// PutCharInFIFO
void MX31_PutCharInFIFO (unsigned char c)
{
	 *(VP_U32)UART1_UTXD_1 = c;

}


void HAB_flash_status(int status, int count, U8 channel)
{
	
	if (channel)
	{
		//if ((*(VP_U32)USB_OTG_ENDPTCOMPLETE) & BIT1)			
		while(! ((*(VP_U32)USB_OTG_ENDPTCOMPLETE) & BIT1));			
		{							
			*(P_U32)USB_OTG_ENDPTCOMPLETE = BIT1;								
			HandleCommand(status, count, channel);
			EP1OutCommandSetup();

		}	
	}
	else
	{
		while (!(*(VP_U32)UART1_USR2_1 & 0x1));
	//	if (*(VP_U32)UART1_USR2_1 & 0x1)				
			HandleCommand(status, count, channel);
	}
}