ota_rollback.cpp

Go to the documentation of this file.

// Copyright (C) 2026 Douglas Quigg (dstroy0) <dquigg123@gmail.com>
// SPDX-License-Identifier: AGPL-3.0-or-later
 
/**
 * @file ota_rollback.cpp
 * @brief OTA rollback decision (pure) + esp_ota_ops commit/rollback (ESP32).
 */
 
#include "services/system/ota_rollback/ota_rollback.h"
 
#if PC_ENABLE_OTA_ROLLBACK
 
#if defined(ARDUINO)
#include "esp_ota_ops.h"
#include "services/system/clock.h" // pc_millis() (pulls in Arduino millis())
#endif
pc_ota_action pc_ota_decide(uint8_t img_state, bool self_test_ok, uint32_t ms_since_boot, uint32_t window_ms)
{
    if (img_state != pc_ota_img::PC_OTA_IMG_PENDING_VERIFY)
    {
        return pc_ota_action::PC_OTA_WAIT; // not a freshly-updated image: nothing to do
    }
    if (self_test_ok)
    {
        return pc_ota_action::PC_OTA_COMMIT;
    }
    if (ms_since_boot >= window_ms)
    {
        return pc_ota_action::PC_OTA_ROLLBACK; // never confirmed in time -> self-heal
    }
    return pc_ota_action::PC_OTA_WAIT;
}
 
#ifdef ARDUINO
 
uint8_t pc_ota_img_state(void)
{
    const esp_partition_t *running = esp_ota_get_running_partition();
    esp_ota_img_states_t st = ESP_OTA_IMG_UNDEFINED;
    if (!running || esp_ota_get_state_partition(running, &st) != ESP_OK)
    {
        return pc_ota_img::PC_OTA_IMG_UNDEFINED;
    }
    return (uint8_t)st;
}
 
void pc_ota_commit(void)
{
    esp_ota_mark_app_valid_cancel_rollback();
}
 
void pc_ota_rollback(void)
{
    esp_ota_mark_app_invalid_rollback_and_reboot(); // does not return
}
 
pc_ota_action pc_ota_rollback_tick(bool self_test_ok)
{
    pc_ota_action a = pc_ota_decide(pc_ota_img_state(), self_test_ok, pc_millis(), PC_OTA_CONFIRM_WINDOW_MS);
    if (a == pc_ota_action::PC_OTA_COMMIT)
    {
        pc_ota_commit();
    }
    else if (a == pc_ota_action::PC_OTA_ROLLBACK)
    {
        pc_ota_rollback();
    }
    return a;
}
 
#else // host build - no OTA partitions
 
uint8_t pc_ota_img_state(void)
{
    return pc_ota_img::PC_OTA_IMG_UNDEFINED;
}
void pc_ota_commit(void)
{
}
void pc_ota_rollback(void)
{
}
pc_ota_action pc_ota_rollback_tick(bool)
{
    return pc_ota_action::PC_OTA_WAIT;
}
 
#endif // ARDUINO
 
#endif // PC_ENABLE_OTA_ROLLBACK