nrf_socket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_SOCKET_H__
#define NRF_SOCKET_H__
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#ifdef __cplusplus
        #ifdef __GNUC__
                /* GNU C++ compiler supports restrict as __restrict__ */
                #define restrict __restrict__
        #else
                /* Other C++ compilers may not support restrict */
                #define restrict
        #endif
#endif
 
/* ssize_t is not part of the C library, but is defined by POSIX in <sys/types.h> */
#ifdef __has_include
        #if __has_include(<sys/types.h>)
                #include <sys/types.h>
        #else
                /* <sys/types.h> missing, define ssize_t here */
                typedef int32_t ssize_t;
        #endif
#else
        /* __has_include() not supported, rely on build-system macro */
        #ifdef NRF_MODEM_HAS_SYS_TYPES
                #include <sys/types.h>
        #else
                typedef int32_t ssize_t;
        #endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_MODEM_MAX_SOCKET_COUNT 8
 
#define NRF_HTONS(x) ((uint16_t) ((((x) & 0xff00) >> 8) | (((x) & 0x00ff) << 8)))
 
#define NRF_HTONL(x) ((uint32_t) ((((x) & 0xff000000) >> 24)    | \
                                  (((x) & 0x00ff0000) >> 8)     | \
                                  (((x) & 0x0000ff00) << 8)     | \
                                  (((x) & 0x000000ff) << 24)))
 
#define NRF_NTOHS(x) NRF_HTONS(x)
 
#define NRF_NTOHL(x) NRF_HTONL(x)
 
#define nrf_htons(x) NRF_HTONS(x)
 
#define nrf_htonl(x) NRF_HTONL(x)
 
#define nrf_ntohs(x) NRF_NTOHS(x)
 
#define nrf_ntohl(x) NRF_NTOHL(x)
 
#define NRF_INET_ADDRSTRLEN 16
 
#define NRF_INET6_ADDRSTRLEN 46
 
#define NRF_AF_UNSPEC 0
#define NRF_AF_INET 1
#define NRF_AF_INET6 2
#define NRF_AF_PACKET 3
#define NRF_SOCK_STREAM 1
#define NRF_SOCK_DGRAM 2
#define NRF_SOCK_RAW 3
#define NRF_IPPROTO_IP 0
#define NRF_IPPROTO_TCP 6
#define NRF_IPPROTO_UDP 17
#define NRF_IPPROTO_IPV6 41
#define NRF_IPPROTO_RAW 255
#define NRF_IPPROTO_ALL 512
 
#define NRF_SPROTO_TLS1v2 258
#define NRF_SPROTO_DTLS1v2 273
 
 /* nrf_socket_api_enumerators */
 
#define NRF_SOCKET_TLS_MAX_MESSAGE_SIZE 2048
 
#define NRF_SOCKET_TLS_MAX_SEC_TAG_LIST_SIZE  7
 
#define NRF_SO_SEC_TAG_LIST 1
 
#define NRF_SO_SEC_HOSTNAME 2
 
#define NRF_SO_SEC_CIPHERSUITE_LIST 3
 
#define NRF_SO_SEC_CIPHERSUITE_USED 4
 
#define NRF_SO_SEC_PEER_VERIFY 5
 
#define NRF_SO_SEC_ROLE 6
 
#define NRF_SO_SEC_SESSION_CACHE 12
 
#define NRF_SO_SEC_SESSION_CACHE_PURGE 13
 
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEO 14
 
#define NRF_SO_SEC_DTLS_CID 15
 
#define NRF_SO_SEC_DTLS_CID_STATUS 16
 
#define NRF_SO_SEC_DTLS_CONN_SAVE 17
 
#define NRF_SO_SEC_DTLS_CONN_LOAD 18
 
#define NRF_SO_SEC_HANDSHAKE_STATUS 19
 
#define NRF_SO_SEC_DTLS_FRAG_EXT 20
#define NRF_SO_REUSEADDR 2
 
#define NRF_SO_ERROR 4
 
#define NRF_SO_RCVTIMEO 20
 
#define NRF_SO_SNDTIMEO 21
 
#define NRF_SO_SILENCE_ALL 30
 
#define NRF_SO_IP_ECHO_REPLY 31
 
#define NRF_SO_IPV6_ECHO_REPLY 32
#define NRF_SO_EXCEPTIONAL_DATA 33
#define NRF_SO_KEEPOPEN 34
 
#define NRF_SO_BINDTOPDN 40
 
#define NRF_SO_TCP_SRV_SESSTIMEO 55
 
#define NRF_SO_POLLCB 60
 
#define NRF_SO_RAI 61
 
#define NRF_SO_IPV6_DELAYED_ADDR_REFRESH 62
 
#define NRF_SO_SENDCB 63
struct nrf_modem_sendcb_params {
        int fd;
        int status;
        size_t bytes_sent;
};
 
typedef void (*nrf_modem_sendcb_t)(const struct nrf_modem_sendcb_params *params);
 
struct nrf_modem_sendcb {
        nrf_modem_sendcb_t callback;
};
#define NRF_SOL_SOCKET 1
#define NRF_SOL_SECURE 282
#define NRF_MSG_PEEK 0x02
 
#define NRF_MSG_DONTWAIT 0x40
 
#define NRF_MSG_WAITALL 0x100
 
#define NRF_MSG_WAITACK 0x200
#define NRF_F_GETFL 3
#define NRF_F_SETFL 4
#define NRF_O_NONBLOCK 0x01
#define NRF_RAI_NO_DATA 1
#define NRF_RAI_LAST 2
#define NRF_RAI_ONE_RESP 3
#define NRF_RAI_ONGOING 4
#define NRF_RAI_WAIT_MORE 5
#define NRF_SO_SEC_PEER_VERIFY_NONE 0
#define NRF_SO_SEC_PEER_VERIFY_OPTIONAL 1
#define NRF_SO_SEC_PEER_VERIFY_REQUIRED 2
#define NRF_SO_SEC_ROLE_CLIENT 0
#define NRF_SO_SEC_ROLE_SERVER 1
#define NRF_SO_SEC_SESSION_CACHE_DISABLED 0
#define NRF_SO_SEC_SESSION_CACHE_ENABLED 1
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_NONE 0
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_1S 1
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_3S 3
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_7S 7
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_15S 15
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_31S 31
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_63S 63
#define NRF_SO_SEC_DTLS_HANDSHAKE_TIMEOUT_123S 123
#define NRF_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 0xC024 
#define NRF_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA  0xC00A 
#define NRF_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 0xC023 
#define NRF_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0xC009 
#define NRF_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA 0xC014 
#define NRF_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 0xC027 
#define NRF_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA 0xC013 
#define NRF_TLS_PSK_WITH_AES_256_CBC_SHA 0x008D
#define NRF_TLS_PSK_WITH_AES_128_CBC_SHA256 0x00AE
#define NRF_TLS_PSK_WITH_AES_128_CBC_SHA 0x008C
#define NRF_TLS_PSK_WITH_AES_128_CCM_8 0xC0A8 
#define NRF_TLS_EMPTY_RENEGOTIATIONINFO_SCSV 0x00FF
#define NRF_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B 
#define NRF_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030 
#define NRF_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F 
#define NRF_SO_SEC_DTLS_CID_DISABLED 0
#define NRF_SO_SEC_DTLS_CID_SUPPORTED 1
#define NRF_SO_SEC_DTLS_CID_ENABLED 2
#define NRF_SO_SEC_DTLS_CID_STATUS_DISABLED 0
#define NRF_SO_SEC_DTLS_CID_STATUS_DOWNLINK 1
#define NRF_SO_SEC_DTLS_CID_STATUS_UPLINK 2
#define NRF_SO_SEC_DTLS_CID_STATUS_BIDIRECTIONAL 3
#define NRF_SO_SEC_HANDSHAKE_STATUS_FULL 0
#define NRF_SO_SEC_HANDSHAKE_STATUS_CACHED 1
#define NRF_SO_SEC_DTLS_FRAG_EXT_DISABLED 0
 
#define NRF_SO_SEC_DTLS_FRAG_EXT_512_ENABLED 1
 
#define NRF_SO_SEC_DTLS_FRAG_EXT_1024_ENABLED 2
#define NRF_SEC_TAG_TLS_DECRYPT_BASE 2147483648
#define NRF_SEC_TAG_TLS_DECRYPT_0  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 0)
#define NRF_SEC_TAG_TLS_DECRYPT_1  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 1)
#define NRF_SEC_TAG_TLS_DECRYPT_2  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 2)
#define NRF_SEC_TAG_TLS_DECRYPT_3  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 3)
#define NRF_SEC_TAG_TLS_DECRYPT_4  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 4)
#define NRF_SEC_TAG_TLS_DECRYPT_5  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 5)
#define NRF_SEC_TAG_TLS_DECRYPT_6  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 6)
#define NRF_SEC_TAG_TLS_DECRYPT_7  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 7)
#define NRF_SEC_TAG_TLS_DECRYPT_8  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 8)
#define NRF_SEC_TAG_TLS_DECRYPT_9  (NRF_SEC_TAG_TLS_DECRYPT_BASE + 9)
#define NRF_SEC_TAG_TLS_DECRYPT_10 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 10)
#define NRF_SEC_TAG_TLS_DECRYPT_11 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 11)
#define NRF_SEC_TAG_TLS_DECRYPT_12 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 12)
#define NRF_SEC_TAG_TLS_DECRYPT_13 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 13)
#define NRF_SEC_TAG_TLS_DECRYPT_14 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 14)
#define NRF_SEC_TAG_TLS_DECRYPT_15 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 15)
#define NRF_SEC_TAG_TLS_DECRYPT_16 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 16)
#define NRF_SEC_TAG_TLS_DECRYPT_17 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 17)
#define NRF_SEC_TAG_TLS_DECRYPT_18 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 18)
#define NRF_SEC_TAG_TLS_DECRYPT_19 (NRF_SEC_TAG_TLS_DECRYPT_BASE + 19)
#define NRF_SEC_TAG_TLS_INVALID 0xFFFFFFFF
struct nrf_timeval {
        uint32_t tv_sec;
        uint32_t tv_usec;
};
typedef uint16_t nrf_in_port_t;
 
typedef unsigned short int nrf_sa_family_t;
 
struct nrf_in6_addr {
        uint8_t s6_addr[16];
};
 
typedef uint32_t nrf_in_addr_t;
 
struct nrf_in_addr {
        nrf_in_addr_t s_addr;
};
 
extern const struct nrf_in6_addr nrf_in6addr_any;
 
extern const struct nrf_in_addr nrf_inaddr_any;
 
struct nrf_sockaddr_in6 {
        nrf_sa_family_t sin6_family;
        nrf_in_port_t sin6_port;
        struct nrf_in6_addr sin6_addr;
        uint8_t sin6_scope_id;
};
 
struct nrf_sockaddr_in {
        nrf_sa_family_t sin_family;
        nrf_in_port_t sin_port;
        struct nrf_in_addr sin_addr;
};
 
typedef uint32_t nrf_socklen_t;
typedef uint32_t nrf_nfds_t;
 
struct nrf_sockaddr {
        nrf_sa_family_t sa_family;
        char sa_data[];
};
 
/* Flags for getaddrinfo() hints. */
 
#define NRF_AI_CANONNAME 0x2
#define NRF_AI_NUMERICSERV 0x400
#define NRF_AI_PDNSERV 0x1000
 
struct nrf_addrinfo {
        int ai_flags;
        int ai_family;
        int ai_socktype;
        int ai_protocol;
        nrf_socklen_t ai_addrlen;
        struct nrf_sockaddr *ai_addr;
        char *ai_canonname;
        struct nrf_addrinfo *ai_next;
};
 
struct nrf_ifaddrs {
        /* Pointer to next struct */
        struct nrf_ifaddrs *ifa_next;
        char *ifa_name;
        uint32_t ifa_flags;
        struct nrf_sockaddr *ifa_addr;
        struct nrf_sockaddr *ifa_netmask;
        struct nrf_sockaddr *ifa_broadaddr;
        struct nrf_sockaddr *ifa_dstaddr;
        void *ifa_data;
};
 
typedef uint32_t nrf_sec_tag_t;
 
int nrf_socket(int family, int type, int protocol);
 
int nrf_close(int fildes);
 
int nrf_fcntl(int fd, int cmd, int flags);
 
int nrf_connect(int socket, const struct nrf_sockaddr *address, nrf_socklen_t address_len);
 
ssize_t nrf_send(int socket, const void *buffer, size_t length, int flags);
 
ssize_t nrf_sendto(int socket, const void *message, size_t length, int flags,
                   const struct nrf_sockaddr *dest_addr, nrf_socklen_t dest_len);
 
ssize_t nrf_recv(int socket, void *buffer, size_t length, int flags);
 
ssize_t nrf_recvfrom(int socket, void *restrict buffer, size_t length, int flags,
                     struct nrf_sockaddr *restrict address, nrf_socklen_t *restrict address_len);
 
struct nrf_pollfd {
        int fd;
        short events;
        short revents;
};
 
#define NRF_POLLIN 0x1
#define NRF_POLLOUT 0x4
#define NRF_POLLERR 0x8
#define NRF_POLLHUP 0x10
#define NRF_POLLNVAL 0x20
 
typedef void (*nrf_modem_pollcb_t)(struct nrf_pollfd *pollfd);
 
struct nrf_modem_pollcb {
        nrf_modem_pollcb_t callback;
        short events;
        bool oneshot;
};
 
int nrf_poll(struct nrf_pollfd fds[], nrf_nfds_t nfds, int timeout);
 
int nrf_setsockopt(int socket, int level, int option_name,
                   const void *option_value, nrf_socklen_t option_len);
 
int nrf_getsockopt(int socket, int level, int option_name,
                   void *restrict option_value, nrf_socklen_t *restrict option_len);
 
int nrf_bind(int socket, const struct nrf_sockaddr *address, nrf_socklen_t address_len);
 
int nrf_listen(int sock, int backlog);
 
int nrf_accept(int socket, struct nrf_sockaddr *restrict address,
               nrf_socklen_t *restrict address_len);
 
int nrf_inet_pton(int af, const char *restrict src, void *restrict dst);
 
const char *nrf_inet_ntop(int af, const void *restrict src, char *restrict dst, nrf_socklen_t size);
 
int nrf_getaddrinfo(const char *restrict nodename,
                    const char *restrict servname,
                    const struct nrf_addrinfo *restrict hints,
                    struct nrf_addrinfo **restrict res);
 
void nrf_freeaddrinfo(struct nrf_addrinfo *ai);
 
int nrf_getifaddrs(struct nrf_ifaddrs **ifa);
 
void nrf_freeifaddrs(struct nrf_ifaddrs *ifa);
 
int nrf_setdnsaddr(int family, const void *in_addr, nrf_socklen_t in_size);
 
int nrf_socket_data_enabled_set(bool enabled);
 
bool nrf_socket_data_enabled_get(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_SOCKET_H__ */