rtfw.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef RTFW_RTFW_H_
#define RTFW_RTFW_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RTFW_EVENT_COMMAND_PROCESSED 1U
 
#define RTFW_EVENT_TYPE_FRAMEWORK_MAX 0xffU
#define RTFW_EVENT_TYPE_USER_BASE     0x100U
 
#define RTFW_FAULT_EVENT_OVERFLOW BIT(0)
#define RTFW_FAULT_BACKEND_APPLY  BIT(1)
 
struct rtfw_command {
        uint32_t id;
        uint32_t data_len;
        uint8_t data[CONFIG_RTFW_COMMAND_DATA_SIZE];
};
 
struct rtfw_event {
        uint32_t type;
        uint32_t value;
        uint32_t timestamp;
};
 
struct rtfw_status {
        struct rtfw_command requested;
        struct rtfw_command attempted;
        struct rtfw_command applied;
        int32_t apply_result;
        bool pending;
        uint32_t dropped_events;
        uint32_t max_queue_depth;
        uint32_t faults;
};
 
typedef int (*rtfw_command_handler_t)(const struct rtfw_command *command,
                                      void *user_data);
 
typedef void (*rtfw_fastpath_handler_t)(void *user_data);
 
typedef void (*rtfw_pend_source_irq_t)(void *user_data);
 
typedef void (*rtfw_event_cb_t)(const struct rtfw_event *event, void *user_data);
 
struct rtfw_config {
        rtfw_command_handler_t command_handler;
        rtfw_fastpath_handler_t fastpath_handler;
        rtfw_pend_source_irq_t pend_source_irq;
        rtfw_event_cb_t event_handler;
        void *fastpath_user_data;
        void *event_user_data;
};
 
int rtfw_init(const struct rtfw_config *config);
 
int rtfw_submit(const struct rtfw_command *command);
 
int rtfw_get_status(struct rtfw_status *status);
 
void rtfw_fastpath_run(void);
 
int rtfw_event_push(const struct rtfw_event *event);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTFW_RTFW_H_ */