nrf_modem_os_rpc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_OS_RPC_H__
#define NRF_MODEM_OS_RPC_H__
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*nrf_modem_os_rpc_signal_cb_t)(uint32_t ch, void *priv);
 
struct nrf_modem_os_rpc_config {
        struct {
                uintptr_t sigdev;
                uint32_t ch;
                uintptr_t addr;
                size_t size;
        } tx;
        struct {
                uintptr_t sigdev;
                uint32_t ch;
                uintptr_t addr;
                size_t size;
        } rx;
        struct {
                void *priv;
                void (*bound)(void *priv);
                void (*received)(const void *data, size_t len, void *priv);
        } cb;
};
 
struct nrf_modem_os_rpc_signal_config {
        uintptr_t sigdev;
        uint32_t ch;
        void *priv;
        nrf_modem_os_rpc_signal_cb_t recv;
};
 
struct nrf_modem_os_rpc;
 
struct nrf_modem_os_rpc_signal;
 
extern struct nrf_modem_os_rpc inst_ctrl;
extern struct nrf_modem_os_rpc inst_data;
 
extern struct nrf_modem_os_rpc_signal inst_app_fault;
extern struct nrf_modem_os_rpc_signal inst_modem_fault;
extern struct nrf_modem_os_rpc_signal inst_modem_sysoff;
 
uintptr_t nrf_modem_os_rpc_sigdev_app_get(void);
 
uintptr_t nrf_modem_os_rpc_sigdev_modem_get(void);
 
int nrf_modem_os_rpc_open(struct nrf_modem_os_rpc *instance,
                          const struct nrf_modem_os_rpc_config *conf);
 
int nrf_modem_os_rpc_send(struct nrf_modem_os_rpc *instance, const void *msg, size_t len);
 
int nrf_modem_os_rpc_close(struct nrf_modem_os_rpc *instance);
 
int nrf_modem_os_rpc_rx_suspend(struct nrf_modem_os_rpc *instance);
 
int nrf_modem_os_rpc_rx_resume(struct nrf_modem_os_rpc *instance);
 
int nrf_modem_os_rpc_signal_init(struct nrf_modem_os_rpc_signal *instance,
                                 struct nrf_modem_os_rpc_signal_config *conf);
 
int nrf_modem_os_rpc_signal_send(struct nrf_modem_os_rpc_signal *instance);
 
int nrf_modem_os_rpc_signal_deinit(struct nrf_modem_os_rpc_signal *instance);
 
int nrf_modem_os_rpc_cache_data_flush(void *addr, size_t size);
 
int nrf_modem_os_rpc_cache_data_invalidate(void *addr, size_t size);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_OS_RPC_H__ */