openblt/Target/Source/ARM7_LPC2000/nvm.h

61 lines
3.1 KiB
C

/****************************************************************************************
| Description: bootloader non-volatile memory driver header file
| File Name: nvm.h
|
|----------------------------------------------------------------------------------------
| C O P Y R I G H T
|----------------------------------------------------------------------------------------
| Copyright (c) 2011 by Feaser http://www.feaser.com All rights reserved
|
|----------------------------------------------------------------------------------------
| L I C E N S E
|----------------------------------------------------------------------------------------
| This file is part of OpenBLT. OpenBLT is free software: you can redistribute it and/or
| modify it under the terms of the GNU General Public License as published by the Free
| Software Foundation, either version 3 of the License, or (at your option) any later
| version.
|
| OpenBLT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
| without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
| PURPOSE. See the GNU General Public License for more details.
|
| You should have received a copy of the GNU General Public License along with OpenBLT.
| If not, see <http://www.gnu.org/licenses/>.
|
| A special exception to the GPL is included to allow you to distribute a combined work
| that includes OpenBLT without being obliged to provide the source code for any
| proprietary components. The exception text is included at the bottom of the license
| file <license.html>.
|
****************************************************************************************/
#ifndef NVM_H
#define NVM_H
/****************************************************************************************
* Include files
****************************************************************************************/
#include "flash.h" /* LPC2xxx flash driver */
/****************************************************************************************
* Function prototypes
****************************************************************************************/
void NvmInit(void);
blt_bool NvmWrite(blt_addr addr, blt_int32u len, blt_int8u *data);
blt_bool NvmErase(blt_addr addr, blt_int32u len);
blt_bool NvmVerifyChecksum(void);
blt_bool NvmDone(void);
/****************************************************************************************
* Macro definitions
****************************************************************************************/
/* return codes for hook function NvmWrite/Erase */
#define BLT_NVM_ERROR (0x00) /* return code for success */
#define BLT_NVM_OKAY (0x01) /* return code for error */
#define BLT_NVM_NOT_IN_RANGE (0x02) /* return code for not in range */
#endif /* NVM_H */
/*********************************** end of nvm.h **************************************/