flash_lib.c

freescale atk source code

/*****************************************************************************
** flash_lib.c
**
** Copyright 2007 Freescale Semiconductor, Inc. All Rights Reserved.
**
** This file contains copyrighted material. Use of this file is
** restricted by the provisions of a Freescale Software License
** Agreement, which has either been electronically accepted by
** you or has been expressly executed between the parties.
**
** Description: Explanation for the usage of this file.
**
** Revision History:
** -----------------
*****************************************************************************/

/*!
 * @file flash_lib.c
 *
 * @brief source code for the interfaces of flash lib
 *
 * @ingroup mx31_nor_flash
 * @{
 */

/*****************************************************************************
* <Includes>
*****************************************************************************/
#include "type.h"
#include "nor_flash.h"
#include "protocol.h"

/*!
 * Function to initialize the flash library device, including check device vendor, 
 * id and other physical geometric, etc
 * @return	- If initialization is ok, return RET_SUCCESS, otherwise error information will be returned
 */
s16 atk_flash_lib_initial (void)
{
	return (nor_flash_init());
		
}
/*!
 * Function to erase an area of flash
 *
 * @param	[in] addr	-flash offset address where to be erased
 * @param	[in] size -erase size in bytes.
 * 
 * @return 	- If erase successful, return RET_SUCCESS; otherwise return FLASH_FAILED
 */
s16 atk_flash_lib_erase (u32 addr, u32 size, response_callback callback)
{
	return (nor_flash_erase(addr, size, callback));
}
/*!
 * Function to read an area of flash and return the actually read data size
 *
 * @param	[in]	addr	-the flash offset address where to be dumped
 * @param	[out] buffer	-an input buffer for library function to fill data in
 * @param	[in/out] pcount 	-dump size in bytes, and return the actually dump size.
 * @param	[in] callback	-send response to host during progress
 * @return	- If read successful, return RET_SUCCESS; if the dump range exceed the flash size,
 *							return FLASH_PARTLY; if ECC error, return FLASH_ECC_FAILED;
 *							otherwise return FLASH_FAILED.
 */
s16 atk_flash_lib_read (u32 addr, u8 *buffer, u32 count, 
					dump_callback callback, u32 bufsize)
{
	return (nor_flash_read(addr, (u32)buffer, count, callback, bufsize));
}
/*!
 * Function to Program an area of flash, return the actual programmed size and checksum.
 *
 * @param	[in] addr	-the flash offset address where to be program
 * @param	[in] buffer	-buffer contains the program data
 * @param	[in/out] pcount	-program size in bytes, and return the actually program size.
 * @param	[out] pcsum	-return the actually programmed data checksum on flash
 * @param	[in] mode	-boundary or un-boundary mode
 * @param	[in] file_format	-used for nb0
 * @param	[in] callback	-send response to host during progress
 * @return 	0 successful, less than 0 error
 */
s16 atk_flash_lib_program (u32 addr, const u8 *buffer, u32 *pcount, 
				u16 *pcsum, u8 mode,u8 file_format,
				response_callback callback)
{
	s16 ret;
	if  ((ret = nor_flash_program((u32)buffer, addr,*pcount, callback))
		== RET_SUCCESS) {
		return nor_flash_compare((u32)buffer, addr, *pcount, 
							pcsum, callback);
	} else {
		return ret;
	}
		
}

/*!
 * Function to get the flash model
 * @param	[out] fmodel- the flash model
 * @param	[out] len		-the len
 * @return 	void
 */
void atk_flash_get_model(u8 *fmodel, u32 *len)
{
	nor_flash_get_model(fmodel, len);
}
/**@}*/