nrf_modem_lib.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_LIB_H_
#define NRF_MODEM_LIB_H_
 
#include <nrf_modem.h>
#include <zephyr/kernel.h>
 
#if CONFIG_NRF_MODEM_LIB_MEM_DIAG
#include <zephyr/sys/sys_heap.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
int nrf_modem_lib_init(void);
 
int nrf_modem_lib_bootloader_init(void);
 
int nrf_modem_lib_shutdown(void);
 
struct nrf_modem_lib_dfu_cb {
        void (*callback)(int dfu_res, void *ctx);
        void *context;
};
 
struct nrf_modem_lib_init_cb {
        void (*callback)(int ret, void *ctx);
        void *context;
};
 
struct nrf_modem_lib_shutdown_cb {
        void (*callback)(void *ctx);
        void *context;
};
 
struct nrf_modem_lib_at_cfun_cb {
        void (*callback)(int mode, void *ctx);
        void *context;
};
 
#define NRF_MODEM_LIB_ON_DFU_RES(name, _callback, _context)                                        \
        static void _callback(int dfu_res, void *ctx);                                             \
        STRUCT_SECTION_ITERABLE(nrf_modem_lib_dfu_cb, nrf_modem_dfu_hook_##name) = {               \
                .callback = _callback,                                                             \
                .context = _context,                                                               \
        };
 
#define NRF_MODEM_LIB_ON_INIT(name, _callback, _context)                                           \
        static void _callback(int ret, void *ctx);                                                 \
        STRUCT_SECTION_ITERABLE(nrf_modem_lib_init_cb, nrf_modem_hook_##name) = {                  \
                .callback = _callback,                                                             \
                .context = _context,                                                               \
        };
 
#define NRF_MODEM_LIB_ON_SHUTDOWN(name, _callback, _context)                                       \
        static void _callback(void *ctx);                                                          \
        STRUCT_SECTION_ITERABLE(nrf_modem_lib_shutdown_cb, nrf_modem_hook_##name) = {              \
                .callback = _callback,                                                             \
                .context = _context,                                                               \
        };
 
#define NRF_MODEM_LIB_ON_CFUN(name, _callback, _context)                                           \
        static void _callback(int mode, void *ctx);                                                \
        STRUCT_SECTION_ITERABLE(nrf_modem_lib_at_cfun_cb, nrf_modem_at_cfun_hook_##name) = {       \
                .callback = _callback,                                                             \
                .context = _context,                                                               \
        };
 
void nrf_modem_fault_handler(struct nrf_modem_fault_info *fault_info);
 
#if defined(CONFIG_NRF_MODEM_LIB_FAULT_STRERROR) || defined(__DOXYGEN__)
const char *nrf_modem_lib_fault_strerror(int fault);
#endif
 
#if defined(CONFIG_NRF_MODEM_LIB_MEM_DIAG) || defined(__DOXYGEN__)
struct nrf_modem_lib_diag_stats {
        struct {
                struct sys_memory_stats heap;
                uint32_t failed_allocs;
        } library;
        struct {
                struct sys_memory_stats heap;
                uint32_t failed_allocs;
        } shmem;
};
int nrf_modem_lib_diag_stats_get(struct nrf_modem_lib_diag_stats *stats);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_LIB_H_ */