luat/include/luat_flash.h

   1
   2 #ifndef LUAT_flash_H
   3 #define LUAT_flash_H
   4 #include "luat_base.h"
   5 /**
   6  * @defgroup luatos_flash 片上Flash操作
   7  * @{
   8  */
   9
  10 /**
  11  * @brief 读取指定区域的Flash数据
  12  *
  13  * @param buff[OUT] 读出的数据
  14  * @param addr 偏移量, 与具体设备相关
  15  * @param len 读取长度
  16  * @return int <= 0错误 >0实际读取的大小
  17  */
  18 int luat_flash_read(char* buff, size_t addr, size_t len);
  19
  20 /**
  21  * @brief 写入指定区域的flash数据
  22  *
  23  * @param buff[IN] 写入的数据
  24  * @param addr 偏移量, 与具体设备相关
  25  * @param len 写入长度
  26  * @return int <= 0错误 >0实际写入的大小
  27  */
  28 int luat_flash_write(char* buff, size_t addr, size_t len);
  29
  30 /**
  31  * @brief 抹除指定区域的flash数据
  32  *
  33  * @param addr 偏移量, 与具体设备相关
  34  * @param len 抹除长度,通常为区域大小, 例如4096
  35  * @return int != 0错误 =0 正常
  36  */
  37 int luat_flash_erase(size_t addr, size_t len);
  38
  39
  40 /**
  41  * @brief 获取kv起始地址与长度
  42  * @param len kv大小, 与具体设备相关
  43  * @return size_t = 0错误 !=0 正常
  44  */
  45 size_t luat_flash_get_fskv_addr(size_t *len);
  46
  47 /**
  48  * @}
  49  */
  50 #endif