Rebase private OTA libs on 2.7

libs/ota-common/include/mgos_updater_common.h

@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2014-2016 Cesanta Software Limited
+ * All rights reserved
+ *
+ * Common bits of code handling update process.
+ * Driven externaly by data source - mg_rpc or POST file upload.
+ */
+
+#ifndef CS_FW_SRC_MGOS_UPDATER_COMMON_H_
+#define CS_FW_SRC_MGOS_UPDATER_COMMON_H_
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#include "frozen.h"
+#include "mgos_event.h"
+#include "mgos_timers.h"
+#include "mgos_updater.h"
+#include "mgos_updater_hal.h"
+#include "mongoose.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+struct update_context;
+typedef void (*mgos_updater_result_cb)(struct update_context *ctx);
+
+struct mgos_upd_hal_ctx; /* This struct is defined by HAL and is opaque to us */
+
+#define MGOS_EVENT_OTA_BASE MGOS_EVENT_BASE('O', 'T', 'A')
+enum mgos_event_ota {
+  MGOS_EVENT_OTA_BEGIN =
+      MGOS_EVENT_OTA_BASE, /* ev_data: struct mgos_upd_info */
+  MGOS_EVENT_OTA_STATUS,   /* ev_data: struct mgos_ota_status */
+  MGOS_EVENT_OTA_REQUEST,  /* ev_data: struct ota_request_param */
+};
+
+enum mgos_ota_state {
+  MGOS_OTA_STATE_IDLE = 0, /* idle */
+  MGOS_OTA_STATE_PROGRESS, /* "progress" */
+  MGOS_OTA_STATE_ERROR,    /* "error" */
+  MGOS_OTA_STATE_SUCCESS,  /* "success" */
+};
+
+struct mgos_ota_status {
+  bool is_committed;
+  int commit_timeout;
+  int partition;
+  enum mgos_ota_state state;
+  const char *msg;      /* stringified state */
+  int progress_percent; /* valid only for "progress" state */
+};
+
+const char *mgos_ota_state_str(enum mgos_ota_state state);
+
+struct update_context {
+  int update_state;              /* Internal state machine - parsing zip, etc */
+  enum mgos_ota_state ota_state; /* Externally visible */
+  const char *status_msg;
+
+  char *zip_file_url;
+  size_t zip_file_size;
+  size_t bytes_already_downloaded;
+  size_t last_reported_bytes;
+  double last_reported_time;
+
+  const char *data;
+  size_t data_len;
+  struct mbuf unprocessed;
+
+  struct mgos_upd_info info;
+  uint32_t current_file_crc;
+  uint32_t current_file_crc_calc;
+  bool current_file_has_descriptor;
+
+  bool ignore_same_version;
+  bool need_reboot;
+
+  int result;
+  mgos_updater_result_cb result_cb;
+
+  char *manifest_data;
+  char file_name[50];
+
+  struct mgos_upd_hal_ctx *dev_ctx;
+
+  mgos_timer_id wdt;
+  int wdt_timeout_ms;
+
+  /* Network connection associated with this update, if any.
+   * It is only used in case update times out - it is closed. */
+  struct mg_connection *nc;
+
+  /*
+   * At the end of update this struct is written to a file
+   * and then restored after reboot.
+   */
+  struct update_file_context {
+    int commit_timeout;
+  } fctx __attribute__((packed));
+};
+
+struct update_context *updater_context_create(int timeout);
+
+/*
+ * Returns updater context of the update in progress. If no update is in
+ * progress, returns NULL.
+ */
+struct update_context *updater_context_get_current(void);
+int updater_process(struct update_context *ctx, const char *data, size_t len);
+void updater_finish(struct update_context *ctx);
+void updater_context_free(struct update_context *ctx);
+int updater_finalize(struct update_context *ctx);
+int is_write_finished(struct update_context *ctx);
+int is_update_finished(struct update_context *ctx);
+int is_reboot_required(struct update_context *ctx);
+
+void mgos_upd_boot_finish(bool is_successful, bool is_first);
+bool mgos_upd_commit();
+bool mgos_upd_is_committed();
+bool mgos_upd_revert(bool reboot);
+bool mgos_upd_get_status(struct mgos_ota_status *);
+
+int mgos_upd_get_commit_timeout();
+bool mgos_upd_set_commit_timeout(int commit_timeout);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* CS_FW_SRC_MGOS_UPDATER_COMMON_H_ */