ota.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: LGPL-3.0-or-later
 * Copyright (c) 2026 Cryptnox SA
 */

 
#ifndef OTA_H
#define OTA_H
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define OTA_ERR_MAX  160U

bool ota_mark_valid(void);

const char *ota_running_version(void);

bool ota_last_update_failed(void);

bool ota_begin(size_t len, const char **err);

bool ota_write(const void *buf, size_t n);

bool ota_end(char *ver, size_t ver_n, const char **err);

void ota_abort(void);

bool ota_receiving(void);

bool ota_staged(char *version, size_t version_n, bool *older);

bool ota_commit(bool install);
 
/* There is deliberately no ota_forget(). Closing the config portal used to
 * withdraw a staged image, and since an upload spends minutes of the portal's own
 * 15-minute window, that window kept expiring while the operator was reading the
 * Install button — the offer went away and the tap did nothing, which is what "the
 * update did not install" turned out to be. A staged image is signature-verified
 * and gated on the panel, so nothing needs to take it away on a timer:
 * @ref ota_commit is the only thing that resolves it, either way. */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OTA_H */