CI130X SDK API手册  2.2.0
本手册用于描述CI130X SDK各个组件和驱动API
枚举 | 函数
nv_data

用于保存用户数据到flash,包含对用户数据的初始化,写入、读取、删除等功能。 更多...

枚举

enum  cinv_item_ret_t {
  CINV_ITEM_UNINIT,
  CINV_OPER_FAILED,
  CINV_OPER_SUCCESS,
  CINV_ITEM_LEN_ERR
}
 nvdata 函数返回值 更多...
 

函数

void cinv_init (uint32_t flash_addr, uint32_t size)
 初始化nvdata管理信息和nvdata区域 更多...
 
cinv_item_ret_t cinv_item_init (uint32_t id, uint16_t len, void *buf)
 如果nvdata 项不存在,会创建和初始化传入的id参数项,在调用cinv_item_read()或cinv_item_write()函数前,必须先调用该函数。 更多...
 
cinv_item_ret_t cinv_item_read (uint32_t id, uint16_t len, void *buf, uint16_t *real_len)
 从nvdata里读数据。该函数可以读nvdata项的全部内容或一部分。数据会拷贝到*buf数据指针,如果传入的长度大于实际长度,只会将实际长度的数据拷贝到*buf数据指针。 更多...
 
cinv_item_ret_t cinv_item_write (uint32_t id, uint16_t len, void *buf)
 将数据项写到nvdata中 更多...
 
cinv_item_ret_t cinv_item_delete (uint32_t id)
 删除nvdata里的数据项. 更多...
 

详细描述

用于保存用户数据到flash,包含对用户数据的初始化,写入、读取、删除等功能。

枚举类型说明

◆ cinv_item_ret_t

nvdata 函数返回值

枚举值
CINV_ITEM_UNINIT 

Id不存在且已创建成功

CINV_OPER_FAILED 

Id已存在, 无动作标记

CINV_OPER_SUCCESS 

Id查找和创建失败

CINV_ITEM_LEN_ERR 

项长度错误

函数说明

◆ cinv_init()

void cinv_init ( uint32_t  flash_addr,
uint32_t  size 
)

初始化nvdata管理信息和nvdata区域

参数
flash_addrnvdata区域起始地址
sizenvdata区域大小

◆ cinv_item_delete()

cinv_item_ret_t cinv_item_delete ( uint32_t  id)

删除nvdata里的数据项.

参数
idNvdata 项 id
返回值
CINV_ITEM_UNINITId不存在且已创建成功
CINV_OPER_SUCCESS删除成功
CINV_OPER_FAILED删除失败
CINV_ITEM_LEN_ERR项长度错误

◆ cinv_item_init()

cinv_item_ret_t cinv_item_init ( uint32_t  id,
uint16_t  len,
void *  buf 
)

如果nvdata 项不存在,会创建和初始化传入的id参数项,在调用cinv_item_read()或cinv_item_write()函数前,必须先调用该函数。

参数
idNvdata 项 id
lenNvdata 项 长度
bufNvdata 项 数据指针
返回值
CINV_ITEM_UNINITId不存在且已创建成功
CINV_OPER_SUCCESSId已存在, 无动作标记
CINV_OPER_FAILEDId查找和创建失败
CINV_ITEM_LEN_ERR项长度错误

◆ cinv_item_read()

cinv_item_ret_t cinv_item_read ( uint32_t  id,
uint16_t  len,
void *  buf,
uint16_t *  real_len 
)

从nvdata里读数据。该函数可以读nvdata项的全部内容或一部分。数据会拷贝到*buf数据指针,如果传入的长度大于实际长度,只会将实际长度的数据拷贝到*buf数据指针。

参数
idNvdata 项 id
lenNvdata 项 长度
bufNvdata 项 数据指针
real_lenNvdata 项 实际长度
返回值
CINV_ITEM_UNINITId不存在
CINV_OPER_SUCCESS读取成功
CINV_OPER_FAILED读取失败

◆ cinv_item_write()

cinv_item_ret_t cinv_item_write ( uint32_t  id,
uint16_t  len,
void *  buf 
)

将数据项写到nvdata中

参数
idNvdata 项 id
lenNvdata 项 长度
bufNvdata 项 数据指针
返回值
CINV_ITEM_UNINITId不存在
CINV_OPER_SUCCESS写入成功
CINV_OPER_FAILED写入失败
CINV_ITEM_LEN_ERR项长度错误