nrf_modem.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */

#ifndef NRF_MODEM_H__
#define NRF_MODEM_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define NRF_MODEM_MAX_SHMEM_SIZE (128 << 10) /* 128KiB */



#define NRF_MODEM_DFU_RESULT_OK 0x5500001u
#define NRF_MODEM_DFU_RESULT_INTERNAL_ERROR 0x4400001u
#define NRF_MODEM_DFU_RESULT_HARDWARE_ERROR 0x4400002u
#define NRF_MODEM_DFU_RESULT_AUTH_ERROR 0x4400003u
#define NRF_MODEM_DFU_RESULT_UUID_ERROR 0x4400004u
#define NRF_MODEM_DFU_RESULT_VOLTAGE_LOW 0x4400005u



#define NRF_MODEM_CELLULAR_SHMEM_CTRL_SIZE 0x4e8
#define NRF_MODEM_DECT_SHMEM_CTRL_SIZE 0x728

struct nrf_modem_shmem_cfg {
        struct {
                uint32_t base;
                uint32_t size;
        } ctrl;
        struct {
                uint32_t base;
                uint32_t size;
        } tx;
        struct {
                uint32_t base;
                uint32_t size;
        } rx;
        struct {
                uint32_t base;
                uint32_t size;
        } trace;
};

#if defined(CONFIG_SOC_SERIES_NRF91)
#define NRF_MODEM_SHMEM_BOOTLOADER_SIZE 0x2018
#elif defined(CONFIG_SOC_SERIES_NRF92)
#define NRF_MODEM_SHMEM_BOOTLOADER_SIZE 0x481C
#endif

struct nrf_modem_bootloader_shmem_cfg {
        uint32_t base;
        uint32_t size;
};



#define NRF_MODEM_FAULT_UNDEFINED 0x001
#define NRF_MODEM_FAULT_HW_WD_RESET 0x002
#define NRF_MODEM_FAULT_HARDFAULT 0x003
#define NRF_MODEM_FAULT_MEM_MANAGE 0x004
#define NRF_MODEM_FAULT_BUS 0x005
#define NRF_MODEM_FAULT_USAGE 0x006
#define NRF_MODEM_FAULT_SECURE_RESET 0x007
#define NRF_MODEM_FAULT_PANIC_DOUBLE 0x008
#define NRF_MODEM_FAULT_PANIC_RESET_LOOP 0x009
#define NRF_MODEM_FAULT_ASSERT 0x010
#define NRF_MODEM_FAULT_PANIC 0x011
#define NRF_MODEM_FAULT_FLASH_ERASE 0x012
#define NRF_MODEM_FAULT_FLASH_WRITE 0x013
#define NRF_MODEM_FAULT_POFWARN 0x014
#define NRF_MODEM_FAULT_THWARN 0x015
 

struct nrf_modem_fault_info {
        uint32_t reason;
        uint32_t program_counter;
};

typedef void (*nrf_modem_fault_handler_t)(struct nrf_modem_fault_info *fault_info);

typedef void (*nrf_modem_dfu_handler_t)(uint32_t dfu_result);


struct nrf_modem_init_params {
        struct nrf_modem_shmem_cfg shmem;
        uint32_t ipc_irq_prio;
        nrf_modem_fault_handler_t fault_handler;
        nrf_modem_dfu_handler_t dfu_handler;
};

struct nrf_modem_bootloader_init_params {
        struct nrf_modem_bootloader_shmem_cfg shmem;
        uint32_t ipc_irq_prio;
        nrf_modem_fault_handler_t fault_handler;
};

char *nrf_modem_build_version(void);

int nrf_modem_init(const struct nrf_modem_init_params *init_params);

int nrf_modem_bootloader_init(const struct nrf_modem_bootloader_init_params *init_params);

bool nrf_modem_is_initialized(void);

int nrf_modem_shutdown(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_H__ */