out_store.h

Go to the documentation of this file.

#ifndef RCBENCH_OUT_STORE_H
#define RCBENCH_OUT_STORE_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "link_pages.h"
#include "out_store_rec.h"

bool out_store_load(out_store_t *out);

void out_store_save(const out_store_t *cfg, uint32_t now_ms);

#define OUT_STORE_SETTLE_MS  400u

#define OUT_STORE_QUIET_MS  5u

#define OUT_STORE_SECTORS  2u

#define OUT_STORE_GAP_WAIT_MS  1000u
 
/*
 * Where core 1 stands decides how a window opens.  Until either call below,
 * core 1 is taken as not launched: a window is interrupts off and the
 * operation run directly, which is what the boot's reclaims use.  The
 * caller makes one of the two calls straight after launching core 1, with
 * no store call in between.
 */

void out_store_core1_parkable(void);

void out_store_off(void);

bool out_store_is_off(void);

#define OUT_STORE_LOCKOUT_MS  10u

#define OUT_STORE_REFUSED_WAIT_MS  1000u

typedef enum {
    OUT_STORE_IDLE = 0,   
    OUT_STORE_ERASED,     
    OUT_STORE_WROTE,      
    OUT_STORE_REFUSED
} out_store_step_t;

out_store_step_t out_store_tick(bool driving, uint32_t quiet_ms,
                                uint32_t now_ms);

bool out_store_reclaim(bool driving, uint32_t quiet_ms);

bool out_store_pending(void);

uint32_t out_store_last_erase_us(void);

uint32_t out_store_last_program_us(void);

uint8_t out_store_last_record(void);
 
/*
 * The firmware update's flash access (link_update_dev.h), through the same
 * windows as the store's own: interrupts off on this core and core 1 parked,
 * or nothing at all while the store is off.  An erase or a program here
 * holds this core for its length; the panel waits for the answer to the
 * COMMIT that caused it, so no request is in flight to be lost.
 */

bool out_store_window_open(void);

bool out_store_flash_erase(uint32_t off);

bool out_store_flash_program(uint32_t off, const uint8_t *data, uint32_t len);

bool out_store_flash_call(void (*fn)(void *), void *arg);
 
#endif /* RCBENCH_OUT_STORE_H */