luat_fota.h 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. #ifndef LUAT_FOTA_H
  2. #define LUAT_FOTA_H
  3. #include "luat_base.h"
  4. #include "luat_spi.h"
  5. /**
  6. * @defgroup luatos_fota 远程升级接口
  7. * @{
  8. */
  9. /**
  10. * @brief 用于初始化fota,创建写入升级包数据的上下文结构体
  11. *
  12. * @param start_address,开始地址 718/716系列填0
  13. * @param len 长度 718/716系列填0
  14. * @param spi_device 长度 718/716系列填NULL
  15. * @param path 长度 718/716系列填NULL
  16. * @param pathlen 长度 718/716系列填0
  17. * @return
  18. */
  19. int luat_fota_init(uint32_t start_address, uint32_t len, luat_spi_device_t* spi_device, const char *path, uint32_t pathlen);
  20. /// @brief 用于向本地 Flash 中写入升级包数据
  21. /// @param data 升级包数据
  22. /// @param len 升级包数据长度
  23. /// @return int >=0成功,其他失败
  24. int luat_fota_write(uint8_t *data, uint32_t len);
  25. /// @brief 用于结束升级包下载
  26. /// @return int =0成功,其他失败
  27. int luat_fota_done(void);
  28. /**
  29. * @brief 结束fota流程
  30. *
  31. * @param is_ok 是否结束流程
  32. * @return int =0成功,其他失败
  33. */
  34. int luat_fota_end(uint8_t is_ok);
  35. /// @brief 等待fota 准备,目前没有什么作用
  36. /// @param
  37. /// @return uint8_t =1 准备好
  38. uint8_t luat_fota_wait_ready(void);
  39. /** @}*/
  40. #endif