smf.h

Go to the documentation of this file.

/*
 * Copyright 2021 The Chromium OS Authors
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SMF_H_
#define ZEPHYR_INCLUDE_SMF_H_
 
#include <zephyr/sys/util.h>
 
#define SMF_CREATE_STATE(_entry, _run, _exit, _parent, _initial)           \
{                                                                          \
        .entry   = _entry,                                                 \
        .run     = _run,                                                   \
        .exit    = _exit,                                                  \
        IF_ENABLED(CONFIG_SMF_ANCESTOR_SUPPORT, (.parent = _parent,))      \
        IF_ENABLED(CONFIG_SMF_INITIAL_TRANSITION, (.initial = _initial,))  \
}
 
#define SMF_CTX(o) ((struct smf_ctx *)o)
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/kernel.h>
 
typedef void (*state_execution)(void *obj);
 
struct smf_state {
        const state_execution entry;
        const state_execution run;
        const state_execution exit;
#ifdef CONFIG_SMF_ANCESTOR_SUPPORT
        const struct smf_state *parent;
 
#ifdef CONFIG_SMF_INITIAL_TRANSITION
        const struct smf_state *initial;
#endif /* CONFIG_SMF_INITIAL_TRANSITION */
#endif /* CONFIG_SMF_ANCESTOR_SUPPORT */
};
 
struct smf_ctx {
        const struct smf_state *current;
        const struct smf_state *previous;
 
#ifdef CONFIG_SMF_ANCESTOR_SUPPORT
        const struct smf_state *executing;
#endif /* CONFIG_SMF_ANCESTOR_SUPPORT */
        int32_t terminate_val;
        uint32_t internal;
};
 
void smf_set_initial(struct smf_ctx *ctx, const struct smf_state *init_state);
 
void smf_set_state(struct smf_ctx *ctx, const struct smf_state *new_state);
 
void smf_set_terminate(struct smf_ctx *ctx, int32_t val);
 
void smf_set_handled(struct smf_ctx *ctx);
 
int32_t smf_run_state(struct smf_ctx *ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SMF_H_ */