Crate nrfxlib_sys[][src]

Modules

ctypes

Structs

__IncompleteArrayField
nrf_addrinfo

Address information.

nrf_cc3xx_platform_abort_apis_t

Type definition of structure holding platform abort APIs

nrf_cc3xx_platform_mutex

Type definition of architecture neutral mutex type

nrf_cc3xx_platform_mutex_apis_t

Type definition of structure holding platform mutex APIs

nrf_cc3xx_platform_mutexes_t

Type definition of structure to platform hw mutexes

nrf_gnss_agps_data_almanac_t
nrf_gnss_agps_data_ephemeris_t
nrf_gnss_agps_data_frame_t

AGPS notification data frame used by the GPS module to let the application know it needs new APGS data.

nrf_gnss_agps_data_integrity_t
nrf_gnss_agps_data_klobuchar_t
nrf_gnss_agps_data_location_t
nrf_gnss_agps_data_nequick_t
nrf_gnss_agps_data_system_time_and_sv_tow_t
nrf_gnss_agps_data_tow_element_t
nrf_gnss_agps_data_utc_t
nrf_gnss_data_frame_t

Wrapper struct that used for all data frames read from the GNSS module

nrf_gnss_datetime_t
nrf_gnss_pvt_data_frame_t
nrf_gnss_sv_t
nrf_ifreq

Data type for network interface.

nrf_in6_addr

IPv6 address.

nrf_in_addr

IPv4 address structure.

nrf_modem_full_dfu_digest

Storage for 256-bit digest/hash replies. Endianness not converted.

nrf_modem_full_dfu_uuid

Modem UUID response.

nrf_modem_init_params_t

Modem library initialization parameters.

nrf_modem_shmem_cfg

Shared memory configuration.

nrf_modem_shmem_cfg__bindgen_ty_1

Control memory, used for control structures. The size of this area is build constant, and must be equal to

nrf_modem_shmem_cfg__bindgen_ty_2

TX memory, used to send data to the modem

nrf_modem_shmem_cfg__bindgen_ty_3

RX memory, used to receive data from the modem

nrf_modem_shmem_cfg__bindgen_ty_4

Trace memory, used to receive traces from the modem

nrf_pdn_auth_t

Structure for PDN authentication socket option.

nrf_pollfd

@details This structure is used to describe which events to poll for a given socket. Which is then given as argument to nrf_poll().

nrf_sec_config_t

Data type to combine all security configuration parameters.

nrf_sockaddr

Generic socket address.

nrf_sockaddr_in

Address record for IPv4 addresses.

nrf_sockaddr_in6

Address record for IPv6 addresses.

nrf_timeval

Structure specifying time interval.

Constants

NRF_AF_INET
NRF_AF_INET6
NRF_AF_LOCAL
NRF_AF_LTE
NRF_AF_PACKET
NRF_CC3XX_PLATFORM_ENTROPY_MAX_GATHER
NRF_CC3XX_PLATFORM_ERROR_ENTROPY_NOT_INITIALIZED
NRF_CC3XX_PLATFORM_ERROR_ENTROPY_TRNG_TOO_LONG
NRF_CC3XX_PLATFORM_ERROR_HW_VERSION_FAILED
NRF_CC3XX_PLATFORM_ERROR_INTERNAL
NRF_CC3XX_PLATFORM_ERROR_KDR_INVALID_PUSH
NRF_CC3XX_PLATFORM_ERROR_KDR_INVALID_WRITE
NRF_CC3XX_PLATFORM_ERROR_KMU_ALREADY_FILLED
NRF_CC3XX_PLATFORM_ERROR_KMU_INVALID_SLOT
NRF_CC3XX_PLATFORM_ERROR_KMU_WRITE_INVALID_PERM
NRF_CC3XX_PLATFORM_ERROR_KMU_WRITE_KEY_FAILED
NRF_CC3XX_PLATFORM_ERROR_KMU_WRONG_ADDRESS
NRF_CC3XX_PLATFORM_ERROR_MUTEX_FAILED
NRF_CC3XX_PLATFORM_ERROR_MUTEX_NOT_INITIALIZED
NRF_CC3XX_PLATFORM_ERROR_PARAM_NULL
NRF_CC3XX_PLATFORM_ERROR_PARAM_WRITE_FAILED
NRF_CC3XX_PLATFORM_ERROR_RNG_TEST_FAILED
NRF_CC3XX_PLATFORM_MUTEX_MASK_INVALID
NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_ALLOCATED
NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_ATOMIC
NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_HW_MUTEX
NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_VALID
NRF_CC3XX_PLATFORM_SUCCESS
NRF_CC3XX_PLATFORM_USE_COUNT_MAX
NRF_CC310_PLATFORM_ENTROPY_MAX_GATHER
NRF_CC310_PLATFORM_ERROR_ENTROPY_NOT_INITIALIZED
NRF_CC310_PLATFORM_ERROR_ENTROPY_TRNG_TOO_LONG
NRF_CC310_PLATFORM_ERROR_HW_VERSION_FAILED
NRF_CC310_PLATFORM_ERROR_INTERNAL
NRF_CC310_PLATFORM_ERROR_MUTEX_FAILED
NRF_CC310_PLATFORM_ERROR_MUTEX_NOT_INITIALIZED
NRF_CC310_PLATFORM_ERROR_PARAM_NULL
NRF_CC310_PLATFORM_ERROR_PARAM_WRITE_FAILED
NRF_CC310_PLATFORM_ERROR_RNG_TEST_FAILED
NRF_CC310_PLATFORM_MUTEX_MASK_INVALID
NRF_CC310_PLATFORM_MUTEX_MASK_IS_ALLOCATED
NRF_CC310_PLATFORM_MUTEX_MASK_IS_VALID
NRF_CC310_PLATFORM_SUCCESS
NRF_CC310_PLATFORM_USE_COUNT_MAX
NRF_EACCES
NRF_EADDRINUSE
NRF_EAFNOSUPPORT
NRF_EAGAIN
NRF_EALREADY
NRF_EBADF
NRF_ECANCELED
NRF_ECONNABORTED
NRF_ECONNRESET
NRF_EDOM
NRF_EFAULT
NRF_EHOSTDOWN
NRF_EINPROGRESS
NRF_EINVAL
NRF_EIO
NRF_EISCONN
NRF_EKEYEXPIRED
NRF_EKEYREJECTED
NRF_EKEYREVOKED
NRF_EMFILE
NRF_EMSGSIZE
NRF_ENETDOWN
NRF_ENETRESET
NRF_ENETUNREACH
NRF_ENOBUFS
NRF_ENOENT
NRF_ENOEXEC
NRF_ENOKEY
NRF_ENOMEM
NRF_ENOPROTOOPT
NRF_ENOSPC
NRF_ENOTCONN
NRF_EOPNOTSUPP
NRF_EPERM
NRF_EPROTONOSUPPORT
NRF_EPROTOTYPE
NRF_ESOCKTNOSUPPORT
NRF_ETIMEDOUT
NRF_F_GETFL
NRF_F_SETFL
NRF_GNSS_AGPS_ALMANAC
NRF_GNSS_AGPS_DATA_ID
NRF_GNSS_AGPS_EPHEMERIDES
NRF_GNSS_AGPS_GPS_SYSTEM_CLOCK_AND_TOWS
NRF_GNSS_AGPS_GPS_UTC_REQUEST
NRF_GNSS_AGPS_INTEGRITY
NRF_GNSS_AGPS_INTEGRITY_REQUEST
NRF_GNSS_AGPS_KLOBUCHAR_IONOSPHERIC_CORRECTION
NRF_GNSS_AGPS_KLOBUCHAR_REQUEST
NRF_GNSS_AGPS_LOCATION
NRF_GNSS_AGPS_MAX_SV_TOW
NRF_GNSS_AGPS_NEQUICK_IONOSPHERIC_CORRECTION
NRF_GNSS_AGPS_NEQUICK_REQUEST
NRF_GNSS_AGPS_POSITION_REQUEST
NRF_GNSS_AGPS_SYS_TIME_AND_SV_TOW_REQUEST
NRF_GNSS_AGPS_UTC_PARAMETERS
NRF_GNSS_MAX_SATELLITES
NRF_GNSS_NMEA_DATA_ID
NRF_GNSS_NMEA_GGA_MASK
NRF_GNSS_NMEA_GLL_MASK
NRF_GNSS_NMEA_GSA_MASK
NRF_GNSS_NMEA_GSV_MASK
NRF_GNSS_NMEA_MAX_LEN
NRF_GNSS_NMEA_RMC_MASK
NRF_GNSS_PSM_DISABLED
NRF_GNSS_PSM_DUTY_CYCLING_PERFORMANCE
NRF_GNSS_PSM_DUTY_CYCLING_POWER
NRF_GNSS_PVT_DATA_ID
NRF_GNSS_PVT_FLAG_DEADLINE_MISSED
NRF_GNSS_PVT_FLAG_FIX_VALID_BIT
NRF_GNSS_PVT_FLAG_LEAP_SECOND_VALID
NRF_GNSS_PVT_FLAG_NOT_ENOUGH_WINDOW_TIME
NRF_GNSS_PVT_FLAG_SLEEP_BETWEEN_PVT
NRF_GNSS_SV_FLAG_UNHEALTHY
NRF_GNSS_SV_FLAG_USED_IN_FIX
NRF_GNSS_USE_CASE_LOW_ACCURACY
NRF_GNSS_USE_CASE_MULTIPLE_HOT_START
NRF_GNSS_USE_CASE_NORMAL_ACCURACY
NRF_GNSS_USE_CASE_SINGLE_COLD_START
NRF_IFNAMSIZ
NRF_INET6_ADDRSTRLEN
NRF_INET_ADDRSTRLEN
NRF_IPPROTO_TCP
NRF_IPPROTO_UDP
NRF_MODEM_APPLICATION_IRQ_PRIORITY
NRF_MODEM_AT_MAX_CMD_SIZE
NRF_MODEM_FULL_DFU_DIGEST_LEN
NRF_MODEM_FULL_DFU_SHM_LEN
NRF_MODEM_FULL_DFU_UUID_LEN
NRF_MODEM_IP_MAX_MESSAGE_SIZE
NRF_MODEM_MAX_PDN_COUNT
NRF_MODEM_MAX_SOCKET_COUNT
NRF_MODEM_NETWORK_IRQ_PRIORITY
NRF_MODEM_OS_FOREVER
NRF_MODEM_OS_NO_WAIT
NRF_MODEM_SHMEM_CTRL_SIZE
NRF_MODEM_TLS_MAX_MESSAGE_SIZE
NRF_MSG_DONTROUTE
NRF_MSG_DONTWAIT
NRF_MSG_OOB
NRF_MSG_PEEK
NRF_MSG_TRUNC
NRF_MSG_WAITALL
NRF_O_NONBLOCK
NRF_PDN_MAX_PASSWORD_LEN
NRF_PDN_MAX_USERNAME_LEN
NRF_POLLERR
NRF_POLLHUP
NRF_POLLIN
NRF_POLLNVAL
NRF_POLLOUT
NRF_PROTO_AT
NRF_PROTO_DFU
NRF_PROTO_GNSS
NRF_PROTO_PDN
NRF_SOCK_DGRAM
NRF_SOCK_MGMT
NRF_SOCK_RAW
NRF_SOCK_STREAM
NRF_SOL_DFU
NRF_SOL_GNSS
NRF_SOL_PDN
NRF_SOL_SECURE
NRF_SOL_SOCKET
NRF_SO_BINDTODEVICE
NRF_SO_CIPHERSUITE_LIST
NRF_SO_CIPHER_IN_USE
NRF_SO_DFU_APPLY
NRF_SO_DFU_BACKUP_DELETE
NRF_SO_DFU_ERROR
NRF_SO_DFU_FW_VERSION
NRF_SO_DFU_OFFSET
NRF_SO_DFU_RESOURCES
NRF_SO_DFU_REVERT
NRF_SO_DFU_TIMEO
NRF_SO_ERROR
NRF_SO_GNSS_DISABLE_PRIORITY
NRF_SO_GNSS_ELEVATION_MASK
NRF_SO_GNSS_ENABLE_PRIORITY
NRF_SO_GNSS_FIX_INTERVAL
NRF_SO_GNSS_FIX_RETRY
NRF_SO_GNSS_NMEA_MASK
NRF_SO_GNSS_POWER_SAVE_MODE
NRF_SO_GNSS_START
NRF_SO_GNSS_STOP
NRF_SO_GNSS_SYSTEM
NRF_SO_GNSS_USE_CASE
NRF_SO_HOSTNAME
NRF_SO_PDN_AF
NRF_SO_PDN_AUTH
NRF_SO_PDN_CONTEXT_ID
NRF_SO_PDN_STATE
NRF_SO_RCVTIMEO
NRF_SO_REUSEADDR
NRF_SO_SEC_PEER_VERIFY
NRF_SO_SEC_ROLE
NRF_SO_SEC_SESSION_CACHE
NRF_SO_SEC_TAG_LIST
NRF_SO_SILENCE_ALL
NRF_SO_SILENCE_IPV6_ECHO_REPLY
NRF_SO_SILENCE_IP_ECHO_REPLY
NRF_SO_SNDTIMEO
NRF_SPROTO_DTLS1v2
NRF_SPROTO_TLS1v2
NRF_SPROTO_TLS1v3
nrf_modem_mode_t_FULL_DFU_MODE

DFU mode

nrf_modem_mode_t_NORMAL_MODE

Normal operation mode

nrf_pdn_auth_type_t_NRF_PDN_AUTH_TYPE_CHAP
nrf_pdn_auth_type_t_NRF_PDN_AUTH_TYPE_NONE
nrf_pdn_auth_type_t_NRF_PDN_AUTH_TYPE_PAP

Functions

nrf_accept

Function for waiting for the next client to connect.

nrf_bind

Function for binding a socket to an address and port.

nrf_cc3xx_platform_abort_init

Function to initialize platform abort APIs

nrf_cc3xx_platform_entropy_get

Function to generate entropy using Arm CryptoCell cc3xx

nrf_cc3xx_platform_mutex_init

Function to initialize RTOS thread-safe mutexes

nrf_cc3xx_platform_set_abort

Function to set platform abort APIs

nrf_cc3xx_platform_set_mutexes

Function to set platform mutex APIs and mutexes

nrf_close

Function for closing a socket and freeing any resources held by it.

nrf_connect

Function for connecting to an endpoint with a given address.

nrf_fcntl

Function for controlling file descriptor options.

nrf_freeaddrinfo

Function for freeing the memory allocated for the result of nrf_getaddrinfo.

nrf_getaddrinfo

Function to resolve the host name into IPv4 and/or IPv6 addresses.

nrf_getsockopt

Function for getting socket options for a given socket.

nrf_inet_ntop

Function for converting an IP address to a human-readable string form.

nrf_inet_pton

Function for converting a human-readable IP address to a form usable by the socket API.

nrf_listen

Function to put the socket in listening mode for incoming connections.

nrf_modem_build_version

Return version string of the Modem library build.

nrf_modem_full_dfu_apply

Complete previous write cycle.

nrf_modem_full_dfu_bl_write

Write a booloader chunk to the modem.

nrf_modem_full_dfu_digest

Read a digest hash data from the modem.

nrf_modem_full_dfu_fw_write

Write a memory chunk to the modem.

nrf_modem_full_dfu_init

Set modem in full DFU mode.

nrf_modem_full_dfu_uuid

Read an uuid data from the modem.

nrf_modem_full_dfu_verify

Verify the modem firmware signature.

nrf_modem_init

Initialize the Modem library.

nrf_modem_os_alloc

Allocate a buffer on the library heap.

nrf_modem_os_application_irq_clear

Clear the application IRQ, * NRF_MODEM_APPLICATION_IRQ - .

nrf_modem_os_application_irq_handler

Application IRQ handler in the modem library.

nrf_modem_os_application_irq_set

Set the application IRQ, * NRF_MODEM_APPLICATION_IRQ - .

nrf_modem_os_errno_set

Set errno.

nrf_modem_os_free

Free a memory buffer in the library heap.

nrf_modem_os_init

Initialize the glue layer.

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_timedwait
nrf_modem_os_trace_irq_clear

Clear the Trace IRQ.

nrf_modem_os_trace_irq_handler

Trace IRQ handler in the modem library.

nrf_modem_os_trace_irq_set

Set the Trace IRQ.

nrf_modem_os_trace_put

Output Trace data from the trace buffer.

nrf_modem_recoverable_error_handler

Handler for library errors.

nrf_modem_shutdown

Shutdown the Modem library.

nrf_poll

Method to poll for events on one or more sockets.

nrf_read

Function for reading data from a socket. See nrf_recv() for details.

nrf_recv

Function for receiving data on a socket.

nrf_recvfrom

Function for receiving datagram on a socket.

nrf_select

Function for waiting for read, write, or exception events on a socket.

nrf_send

Function for sending data through a socket.

nrf_sendto

Function for sending datagram through a socket.

nrf_setdnsaddr

Set a secondary DNS address.

nrf_setsockopt

Function for setting socket options for a given socket.

nrf_socket

Function for creating a socket.

nrf_write

Function for writing data to a socket. See nrf_send() for details.

Type Definitions

nrf_cc3xx_platform_abort_fn_t

Type definition of platform abort function

nrf_cc3xx_platform_abort_handle_t

Type definition of handle used for abort

nrf_cc3xx_platform_mutex_free_fn_t

Type definition of function pointer to free a mutex

nrf_cc3xx_platform_mutex_init_fn_t

Type definition of function pointer to initialize a mutex

nrf_cc3xx_platform_mutex_lock_fn_t

Type definition of function pointer to lock a mutex

nrf_cc3xx_platform_mutex_t

Type definition of architecture neutral mutex type

nrf_cc3xx_platform_mutex_unlock_fn_t

Type definition of function pointer to unlock a mutex

nrf_dfu_err_t

DFU socket error.

nrf_dfu_fw_offset_t

Size of the firmware image stored in flash, in bytes.

nrf_dfu_fw_version_t

Universally unique identifier of the modem firmware version. The UUID format is defined by RFC 4122.

nrf_dfu_resources_t

Maximum size for a firmware image, in bytes.

nrf_fd_set

@defgroup nrf_fd_set_api Descriptor sets API Types and macros used to manipulate the input data argument to the nrf_select() function. s File descriptor sets are used as input to the nrf_select() function for doing I/O multiplexing. The maximum number of descriptors contained in a set is defined by NRF_FD_SETSIZE.

nrf_gnss_agps_data_type_t

Type used to select which AGPS data is written to the GPS module. s Goes into the * p_servaddr - parameter in the * nrf_sendto - function prototype. Possible values:

nrf_gnss_delete_mask_t

Defines a mask of non-volatile data types to delete. s

nrf_gnss_elevation_mask_t

Defines at which elevation the GPS should track a satellite. s This option is used to make the GPS stop tracking GPSes on a certain elevation, because the information sent from the GPS gets more inaccurate as it gets closer to the horizon. Acceptable values are between 0 and 30 degrees.

nrf_gnss_fix_interval_t

Defines the interval between each fix in seconds. s Allowed values are 0, 1, 10..1800, value 0 denotes single fix. Default interval is 1 second (continous mode), 0 denotes a single fix.

nrf_gnss_fix_retry_t

Defines how long (in seconds) the receiver should try to get a fix. s The default retry wait time is 60 seconds before it gives up. 0 denotes an infinite limit.

nrf_gnss_nmea_data_frame_t

Single null-terminated NMEA sentence

nrf_gnss_nmea_mask_t

Defines if NMEA frames should be added.

nrf_gnss_power_save_mode_t

Defines which power mode policy to use for the GNSS module. s

nrf_gnss_system_t

Defines which GNSS system to use. s 0 denotes GPS. Currently, only GPS is supported and any other value returns an error.

nrf_gnss_use_case_t

Defines the targeted start performance. s 0 denotes single cold start performance. 1 denotes multiple hot start performance.

nrf_in6_addr_t
nrf_in_addr_t

IPv4 address.

nrf_in_port_t

Socket port type.

nrf_modem_mode_t

Modem library mode

nrf_pdn_af_list_t

@addtogroup nrf_socket_pdn Data types defined to set and get socket options on a PDN socket. @{ List of address family(ies) for the PDN.

nrf_pdn_auth_type_t

PDN authentication type.

nrf_pdn_context_id_t

Context ID for the PDN.

nrf_pdn_state_t

PDN state. 1 - PDN is active. 0 - PDN is inactive.

nrf_sa_family_t
nrf_sec_cipher_t

A IANA cipher suite identifier.

nrf_sec_peer_verify_t

Peer verification level for the TLS connection.

nrf_sec_role_t

TLS role for the connection.

nrf_sec_session_cache_t

Session cache configuration for the TLS connection.

nrf_sec_tag_t

Security tags used on the TLS socket.

nrf_sockaddr_in6_t
nrf_sockaddr_in_t
nrf_sockaddr_t
nrf_socket_family_t

Socket families.

nrf_socklen_t

Socket module size type.

size_t
ssize_t

Unions

nrf_gnss_data_frame_t__bindgen_ty_1