socket_ncs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_SOCKET_NCS_H_
#define ZEPHYR_INCLUDE_NET_SOCKET_NCS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdbool.h>
 
/* When CONFIG_NET_SOCKETS_OFFLOAD is enabled, offloaded sockets take precedence
 * when creating a new socket. Combine this flag with a socket type when
 * creating a socket, to enforce native socket creation (e. g. SOCK_STREAM | SOCK_NATIVE).
 * If it's desired to create a native TLS socket, but still offload the
 * underlying TCP/UDP socket, use e. g. SOCK_STREAM | SOCK_NATIVE_TLS.
 */
#define SOCK_NATIVE 0x80000000
#define SOCK_NATIVE_TLS 0x40000000
 
#define NET_SOCKET_NCS_BASE 1000
 
/* NCS specific TLS level socket options */
 
#define TLS_DTLS_HANDSHAKE_TIMEO (NET_SOCKET_NCS_BASE + 18)
 
#define TLS_DTLS_CONN_SAVE (NET_SOCKET_NCS_BASE + 19)
 
#define TLS_DTLS_CONN_LOAD (NET_SOCKET_NCS_BASE + 20)
 
#define TLS_DTLS_HANDSHAKE_STATUS (NET_SOCKET_NCS_BASE + 21)
 
/* Valid values for TLS_DTLS_HANDSHAKE_TIMEO option */
#define TLS_DTLS_HANDSHAKE_TIMEO_NONE 0 
#define TLS_DTLS_HANDSHAKE_TIMEO_1S 1 
#define TLS_DTLS_HANDSHAKE_TIMEO_3S 3 
#define TLS_DTLS_HANDSHAKE_TIMEO_7S 7 
#define TLS_DTLS_HANDSHAKE_TIMEO_15S 15 
#define TLS_DTLS_HANDSHAKE_TIMEO_31S 31 
#define TLS_DTLS_HANDSHAKE_TIMEO_63S 63 
#define TLS_DTLS_HANDSHAKE_TIMEO_123S 123 
/* Valid values for TLS_DTLS_HANDSHAKE_STATUS option */
#define TLS_DTLS_HANDSHAKE_STATUS_FULL          0
#define TLS_DTLS_HANDSHAKE_STATUS_CACHED        1
 
#define TLS_DTLS_FRAG_EXT (NET_SOCKET_NCS_BASE + 22)
 
#define DTLS_FRAG_EXT_DISABLED 0
#define DTLS_FRAG_EXT_512_ENABLED 1
#define DTLS_FRAG_EXT_1024_ENABLED 2
 
/* NCS specific socket options */
 
#define SO_EXCEPTIONAL_DATA (NET_SOCKET_NCS_BASE + 33)
#define SO_KEEPOPEN (NET_SOCKET_NCS_BASE + 34)
#define SO_BINDTOPDN (NET_SOCKET_NCS_BASE + 40)
 
#define SO_RAI (NET_SOCKET_NCS_BASE + 61)
 
#define RAI_NO_DATA 1
#define RAI_LAST 2
#define RAI_ONE_RESP 3
#define RAI_ONGOING 4
#define RAI_WAIT_MORE 5
 
#define SO_SENDCB (NET_SOCKET_NCS_BASE + 63)
 
struct socket_ncs_sendcb_params {
        int fd;
        int status;
        size_t bytes_sent;
};
 
typedef void (*socket_ncs_sendcb_t)(const struct socket_ncs_sendcb_params *params);
 
struct socket_ncs_sendcb {
        socket_ncs_sendcb_t callback;
};
 
#define SO_POLLCB (NET_SOCKET_NCS_BASE + 64)
 
struct socket_ncs_pollcb_params {
        int fd;
        short events;
        short revents;
};
 
typedef void (*socket_ncs_pollcb_t)(const struct socket_ncs_pollcb_params *params);
 
struct socket_ncs_pollcb {
        socket_ncs_pollcb_t callback;
        short events;
        bool oneshot;
};
 
/* NCS specific IPPROTO_ALL level socket options */
 
#define IPPROTO_ALL 512
#define SO_SILENCE_ALL (NET_SOCKET_NCS_BASE + 30)
 
/* NCS specific IPPROTO_IP level socket options */
 
#define SO_IP_ECHO_REPLY (NET_SOCKET_NCS_BASE + 31)
 
/* NCS specific IPPROTO_IPV6 level socket options */
 
#define SO_IPV6_ECHO_REPLY (NET_SOCKET_NCS_BASE + 32)
 
#define SO_IPV6_DELAYED_ADDR_REFRESH (NET_SOCKET_NCS_BASE + 62)
 
/* NCS specific TCP level socket options */
 
#define SO_TCP_SRV_SESSTIMEO (NET_SOCKET_NCS_BASE + 55)
 
/* NCS specific gettaddrinfo() flags */
 
#define AI_PDNSERV 0x1000
 
/* NCS specific send() and sendto() flags */
 
#define MSG_WAITACK 0x200
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_SOCKET_NCS_H_ */