/******************************************************************************
													Copyright (c) Motorola 2001
File Name		 :	$RCSfile: ProgFlash.c,v $		
	
Engineer		 :	$Author: estyger $

Location		 :	EKB

Date Created	 :	05/06/2001

Current Revision :	$Revision: 1.1.1.1 $

Notes	:					

*******************************************************************************
Motorola reserves the right to make changes without further notice to any
product	herein to improve reliability, function	or design. Motorola does not
assume any liability arising out of the	application or use of any product,
circuit, or software described	herein;	neither	does it	convey any license
under its patent rights	nor the rights of others. Motorola products are	not
designed, intended, or authorized for use as components in systems intended for
surgical implant into the body, or other applications intended to support life,
or for any other application in which the failure of the  Motorola product
could create a	situation where	personal injury	or death may occur. Should
Buyer purchase or use Motorola products for any such unintended or
unauthorized application, Buyer shall idemnify and hold Motorola and its
officers, employees, subsidiaries, affiliates, and distributors	harmless
against	all claims costs, damages, and expenses, and reasonable	attorney fees 
arising	out of,	directly or indirectly,	any claim of personal injury or	death
associated with	such unintended	or unauthorized use, even if such claim alleges
that Motorola was negligent regarding the design or manufacture	of the part.
Motorola and the Motorola logo*	are registered trademarks of Motorola Ltd.
******************************************************************************/

/************************* System Include Files ******************************/

/************************* Project Include Files *****************************/
#include "stdtypes.h"
#include "mcucfg.h"
#include "s12_fectl.h"

/************************* typedefs ******************************************/

/************************* #Defines ******************************************/
#ifndef ALIGNED_WORD_MASK
#define ALIGNED_WORD_MASK	0x0001
#endif

#ifndef PASS
#define PASS				   1
#endif

#ifndef FAIL
#define FAIL				   0
#endif

/************************* Global Variables **********************************/
static tFLASH flash @(REG_BASE + 0x100);

/************************* External Variables ********************************/

/******************************************************************************
Function Name	:	ConfigFCLKDIV
Engineer		   :	r27624
Date			   :	17/9/2001

Arguments		:	none
                  
Return			:	none

Notes				:	This function configures the flash clock prescaler.
******************************************************************************/
void
ConfigFCLKDIV(void)
{
	if(flash.fclkdiv.bit.fdivld == 0)
	{															/* configure flash clock prescaler */
		flash.fclkdiv.byte  = (UINT8)FCLK_PRESCALER; 
	}

	return;
}

/******************************************************************************
Function Name	:	ProgFlash
Engineer		:	r27624
Date			:	17/9/2001

Arguments		:	progAdr		Pointer to the start of the destination 
								Flash location to be programmed
                                    
					bufferPtr	Pointer to the start of the source data 
                                    
					size        Number of WORDS to be programmed
                  
Return			:	FAIL 		if progAdr does not point to an aligned word, or
								the ACCERR bit is set during programming sequence, or
								the PVIOL bit is set during programming sequence.

                  	PASS		if not FAIL.

Notes			:	This function does not check if the flash is erased.
               		This function does not verify that the data has been 
					sucessfully programmed.
					This function will program non-paged flash only 
					This function must NOT be located in pages $3C to $3F
******************************************************************************/
UINT8
ProgFlash(UINT16* progAdr, UINT16* bufferPtr, UINT16 size)
{
	UINT8 CCRCopy;
																
	if(((UINT16)progAdr & ALIGNED_WORD_MASK) != 0)				/* Check for aligned word */
	{
		return(FAIL);
	}

	asm	
	{
		TFR 	CCR,A																
		STAA	CCRCopy											;store CCR			
		ORCC	#$10											;mask interrupts 	
	}
																/* Clear error flags for ALL arrays */	
	flash.fcnfg.byte = 3;
	flash.fstat.byte = (PVIOL | ACCERR); 
	flash.fcnfg.byte = 2;
	flash.fstat.byte = (PVIOL | ACCERR);
	flash.fcnfg.byte = 1;
	flash.fstat.byte = (PVIOL | ACCERR);
	flash.fcnfg.byte = 0;										/* this array to be programmed */
	flash.fstat.byte = (PVIOL | ACCERR);

	while(size != 0)
	{															
																/* Is the command buffer empty? */
		if(flash.fstat.bit.cbeif == 1)
		{
																/* Write word to FLASH buffer. */
			*progAdr++ = *bufferPtr++;
																/* Initiate program command */	
			flash.fcmd.byte = PROG;
																/* Clear command buffer empty flag by writing a 1 to it
																   This launches the command. */
			flash.fstat.byte = CBEIF;
																/* Was the access error flag set */
																/* Was the protection violation error flags set */
			if((flash.fstat.bit.accerr == 1) || 
			   (flash.fstat.bit.pviol == 1))
			{
				asm	
				{
					LDAA	CCRCopy								
					TFR 	A,CCR								;restore CCR		
				}
																/* Return status. */
				return(FAIL);
			}
																/* One less word to program */																																/* One less word to write */
			size--;
		}
	}
																/* wait for last command to complete */
	while(flash.fstat.bit.ccif != 1)								
	{
	}

	asm	
	{
		LDAA	CCRCopy											
		TFR 	A,CCR											;restore CCR		
	}
																/* Return status. */
	return(PASS);
}

/******************************************************************************/