fprime.h

Go to the documentation of this file.

// ======================================================================
// \title  fprime.h
// \author tumbar
// \brief  Header for the F Prime WebAssembly System Interface (fwasi)
// ======================================================================

#ifndef FPRIME_SPACEWASM_GUEST_H
#define FPRIME_SPACEWASM_GUEST_H

#include <Fw/Deprecate.hpp>

#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus

#include <Fw/FPrimeBasicTypes.h>

#if defined(__wasm__)
#define WASM_IMPORT(module, name) __attribute__((__import_module__(module), __import_name__(name)))
#else
#define WASM_IMPORT(module, name)
#endif  // defined(__wasm__)

#define WASM_MODULE_NAME ("fprime_v1")

//               be reported in an event and the sequence will exit
//               with failure status
WASM_IMPORT(WASM_MODULE_NAME, "exit")
extern void fprime_wasm_exit(I32 code);

WASM_IMPORT(WASM_MODULE_NAME, "panic")
extern void fprime_wasm_panic(I32 code);

WASM_IMPORT(WASM_MODULE_NAME, "args")
extern U32 DEPRECATED(fprime_wasm_get_args(U32 destination_ptr, U32 destination_size),
                      "args always returns 0. Pass inputs through the sequence's exported function signature instead");

WASM_IMPORT(WASM_MODULE_NAME, "time")
extern void fprime_wasm_get_time(U32 time_ptr, U32 time_size);

enum FprimeTlmValid {
    FPRIME_TLM_VALID = 0,
    FPRIME_TLM_INVALID = 1,
};

WASM_IMPORT(WASM_MODULE_NAME, "tlm")
extern FprimeTlmValid fprime_wasm_read_telemetry(I64 id, U32 time_ptr, U32 time_size, U32 value_ptr, U32 value_size);

enum FprimeParamValid {
    FPRIME_PARAM_UNINIT = 0,   
    FPRIME_PARAM_VALID = 1,    
    FPRIME_PARAM_INVALID = 2,  
    FPRIME_PARAM_DEFAULT = 3,  
};

WASM_IMPORT(WASM_MODULE_NAME, "prm")
extern FprimeParamValid fprime_wasm_read_parameter(I64 id, U32 value_ptr, U32 value_size);

enum FprimeCmdResponse {
    FPRIME_CMD_OK = 0,
    FPRIME_CMD_INVALID_OPCODE = 1,
    FPRIME_CMD_VALIDATION_ERROR = 2,
    FPRIME_CMD_FORMAT_ERROR = 3,
    FPRIME_CMD_EXECUTION_ERROR = 4,
    FPRIME_CMD_BUSY = 5,
    FPRIME_CMD_CLEARED = 6,
    FPRIME_CMD_DISPATCHED_UNTRACKED = 7,
};

WASM_IMPORT(WASM_MODULE_NAME, "cmd")
extern FprimeCmdResponse fprime_wasm_command(U32 buf_ptr, U32 buf_size);

enum FprimeEventSeverity : I32 {
    FPRIME_EVENT_FATAL = 1,        
    FPRIME_EVENT_WARNING_HI = 2,   
    FPRIME_EVENT_WARNING_LO = 3,   
    FPRIME_EVENT_COMMAND = 4,      
    FPRIME_EVENT_ACTIVITY_HI = 5,  
    FPRIME_EVENT_ACTIVITY_LO = 6,  
    FPRIME_EVENT_DIAGNOSTIC = 7,   
};

WASM_IMPORT(WASM_MODULE_NAME, "event")
extern void fprime_wasm_event(FprimeEventSeverity severity, U32 msg_ptr, U32 msg_size);

WASM_IMPORT(WASM_MODULE_NAME, "rsleep")
extern void fprime_wasm_rsleep(U64 us);

WASM_IMPORT(WASM_MODULE_NAME, "asleep")
extern void fprime_wasm_asleep(U64 us);

WASM_IMPORT(WASM_MODULE_NAME, "serial_send")
extern void fprime_wasm_serial_out(I32 index, U32 data_ptr, U32 data_size);

enum FprimeBlockingType {
    FPRIME_BLOCK_BLOCKING = 0,     
    FPRIME_BLOCK_NONBLOCKING = 1,  
};

enum FprimeQueueStatus {
    FPRIME_QUEUE_OK = 0,     
    FPRIME_QUEUE_EMPTY = 1,  
};

WASM_IMPORT(WASM_MODULE_NAME, "serial_recv")
extern FprimeQueueStatus fprime_wasm_serial_receive(I32 index,
                                                    U32 data_ptr,
                                                    U32 data_size,
                                                    U32 actual_size_ptr,
                                                    FprimeBlockingType block_type);

#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus

#endif  // FPRIME_SPACEWASM_GUEST_H