mirror of
https://gitee.com/Armink/EasyFlash.git
synced 2024-12-02 12:18:29 +08:00
107 lines
3.7 KiB
C
107 lines
3.7 KiB
C
/*
|
|
* This file is part of the EasyFlash Library.
|
|
*
|
|
* Copyright (c) 2014, Armink, <armink.ztl@gmail.com>
|
|
*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Function: Is is an head file for this library. You can see all be called functions.
|
|
* Created on: 2014-09-10
|
|
*/
|
|
|
|
|
|
#ifndef FLASH_H_
|
|
#define FLASH_H_
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
|
|
/* using ENV function */
|
|
#define FLASH_USING_ENV
|
|
/* using IAP function */
|
|
#define FLASH_USING_IAP
|
|
/* using CRC32 check when load environment variable from Flash */
|
|
#define FLASH_ENV_USING_CRC_CHECK
|
|
/* the user setting size of ENV, must be word alignment */
|
|
#define FLASH_USER_SETTING_ENV_SIZE (2 * 1024) /* default 2K */
|
|
/* using wear leveling mode or normal mode */
|
|
/* #define FLASH_ENV_USING_WEAR_LEVELING_MODE */
|
|
#define FLASH_ENV_USING_NORMAL_MODE
|
|
|
|
/* Flash debug print function. Must be implement by user. */
|
|
#define FLASH_DEBUG(...) flash_log_debug(__FILE__, __LINE__, __VA_ARGS__)
|
|
/* Flash routine print function. Must be implement by user. */
|
|
#define FLASH_INFO(...) flash_log_info(__VA_ARGS__)
|
|
/* Flash assert for developer. */
|
|
#define FLASH_ASSERT(EXPR) \
|
|
if (!(EXPR)) \
|
|
{ \
|
|
FLASH_DEBUG("(%s) has assert failed at %s.\n", #EXPR, __FUNCTION__); \
|
|
while (1); \
|
|
}
|
|
/* EasyFlash software version number */
|
|
#define FLASH_SW_VERSION "1.05.16"
|
|
|
|
typedef struct _flash_env{
|
|
char *key;
|
|
char *value;
|
|
}flash_env, *flash_env_t;
|
|
|
|
/* Flash error code */
|
|
typedef enum {
|
|
FLASH_NO_ERR,
|
|
FLASH_ERASE_ERR,
|
|
FLASH_WRITE_ERR,
|
|
FLASH_ENV_NAME_ERR,
|
|
FLASH_ENV_NAME_EXIST,
|
|
FLASH_ENV_FULL,
|
|
} FlashErrCode;
|
|
|
|
/* flash.c */
|
|
FlashErrCode flash_init(void);
|
|
|
|
#ifdef FLASH_USING_ENV
|
|
/* flash_env.c flash_env_wl.c */
|
|
void flash_load_env(void);
|
|
void flash_print_env(void);
|
|
char *flash_get_env(const char *key);
|
|
FlashErrCode flash_set_env(const char *key, const char *value);
|
|
FlashErrCode flash_save_env(void);
|
|
FlashErrCode flash_env_set_default(void);
|
|
size_t flash_get_env_total_size(void);
|
|
size_t flash_get_env_write_bytes(void);
|
|
#endif
|
|
|
|
#ifdef FLASH_USING_IAP
|
|
/* flash_iap.c */
|
|
FlashErrCode flash_erase_bak_app(size_t app_size);
|
|
FlashErrCode flash_erase_user_app(uint32_t user_app_addr, size_t user_app_size);
|
|
FlashErrCode flash_erase_bl(uint32_t bl_addr, size_t bl_size);
|
|
FlashErrCode flash_write_data_to_bak(uint8_t *data, size_t size, size_t *cur_size,
|
|
size_t total_size);
|
|
FlashErrCode flash_copy_app_from_bak(uint32_t user_app_addr, size_t app_size);
|
|
FlashErrCode flash_copy_bl_from_bak(uint32_t bl_addr, size_t bl_size);
|
|
#endif
|
|
|
|
/* flash_port.c */
|
|
FlashErrCode flash_read(uint32_t addr, uint32_t *buf, size_t size);
|
|
FlashErrCode flash_erase(uint32_t addr, size_t size);
|
|
FlashErrCode flash_write(uint32_t addr, const uint32_t *buf, size_t size);
|
|
void flash_log_debug(const char *file, const long line, const char *format, ...);
|
|
void flash_log_info(const char *format, ...);
|
|
void flash_print(const char *format, ...);
|
|
|
|
#endif /* FLASH_H_ */
|