Module ffi 

FFI (Foreign Function Interface) Module

This module contains implementations of functions that libbsd.a expects to be able to call.

Copyright (c) 42 Technology, 2019

Dual-licensed under MIT and Apache 2.0. See the README for more details.

Structs

NrfxIpcConfig

Used by libmodem to configure the IPC peripheral. See nrfx_ipc_config_t in nrfx/drivers/include/nrfx_ipc.h.

Enums

NrfxErr

IPC error type

Functions

get_last_error

Return the last error stored by the nrfxlib C library.

nrf_ipc_irq_handler^⚠

Call this when we have an IPC IRQ. Not extern C as its not called by the library, only our interrupt handler code.

nrf_modem_os_alloc

The Modem library needs to dynamically allocate memory (a heap) for proper functioning. This memory is used to store the internal data structures that are used to manage the communication between the application core and the modem core. This memory is never shared with the modem core and hence, it can be located anywhere in the application core’s RAM instead of the shared memory regions. This function allocates dynamic memory for the library.

nrf_modem_os_busywait

Function required by BSD library

nrf_modem_os_errno_set

Function required by BSD library. Stores an error code we can read later.

nrf_modem_os_event_notify

Notify the application that an event has occurred.

nrf_modem_os_free^⚠

The Modem library needs to dynamically allocate memory (a heap) for proper functioning. This memory is used to store the internal data structures that are used to manage the communication between the application core and the modem core. This memory is never shared with the modem core and hence, it can be located anywhere in the application core’s RAM instead of the shared memory regions. This function allocates dynamic memory for the library.

nrf_modem_os_init

Function required by BSD library. We have no init to do.

nrf_modem_os_is_in_isr

Check if executing in interrupt context.

nrf_modem_os_log_wrapped^⚠

Generic logging procedure

nrf_modem_os_logdump

Logging procedure for dumping hex representation of object.

nrf_modem_os_mutex_init^⚠

Initialize a mutex.

nrf_modem_os_mutex_lock^⚠

Lock a mutex.

nrf_modem_os_mutex_unlock^⚠

Unlock a mutex.

nrf_modem_os_sem_count_get

Get a semaphore’s count.

nrf_modem_os_sem_give

Give a semaphore.

nrf_modem_os_sem_init^⚠

Initialize a semaphore.

nrf_modem_os_sem_take

Take a semaphore.

nrf_modem_os_shm_tx_alloc

Allocate a buffer on the TX area of shared memory.

nrf_modem_os_shm_tx_free^⚠

Free a shared memory buffer in the TX area.

nrf_modem_os_shutdown

Function required by BSD library. We have no shutdown to do.

nrf_modem_os_timedwait^⚠

Put a thread to sleep for a specific time or until an event occurs.

nrfx_ipc_config_load^⚠

@brief Function for loading configuration directly into IPC peripheral.

nrfx_ipc_init

@brief Function for initializing the IPC driver.

nrfx_ipc_receive_event_disable

nrfx_ipc_receive_event_enable

nrfx_ipc_uninit

Function for uninitializing the IPC module.