conn_mgr_connectivity.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
#define ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
 
#include <zephyr/device.h>
#include <zephyr/net/net_if.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/net/net_mgmt.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 

 
/* Connectivity Events */
#define NET_MGMT_CONN_LAYER                     NET_MGMT_LAYER(NET_MGMT_LAYER_L2)
#define NET_MGMT_CONN_CODE                      NET_MGMT_LAYER_CODE(NET_MGMT_LAYER_CODE_CONN)
#define NET_MGMT_CONN_BASE                      (NET_MGMT_CONN_LAYER | NET_MGMT_CONN_CODE | \
                                                 NET_MGMT_EVENT_BIT)
#define NET_MGMT_CONN_IF_EVENT                  (NET_MGMT_IFACE_BIT | NET_MGMT_CONN_BASE)
 
enum {
        NET_EVENT_CONN_CMD_IF_TIMEOUT_VAL,
        NET_EVENT_CONN_CMD_IF_FATAL_ERROR_VAL,
        NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT_VAL,
        NET_EVENT_CONN_CMD_IF_NO_CONFIGURATION_VAL,
 
        NET_EVENT_CONN_CMD_MAX
};
 
BUILD_ASSERT(NET_EVENT_CONN_CMD_MAX <= NET_MGMT_MAX_COMMANDS,
             "Number of events in net_event_conn_cmd exceeds the limit");
 
enum net_event_conn_cmd {
        NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_TIMEOUT),
        NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_FATAL_ERROR),
        NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT),
        NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_NO_CONFIGURATION),
};


#define NET_EVENT_CONN_IF_TIMEOUT                                       \
        (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_TIMEOUT)

#define NET_EVENT_CONN_IF_FATAL_ERROR                                   \
        (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_FATAL_ERROR)

#define NET_EVENT_CONN_IF_IDLE_TIMEOUT                                  \
        (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT)

#define NET_EVENT_CONN_IF_NO_CONFIGURATION                                      \
        (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_NO_CONFIGURATION)

enum conn_mgr_if_flag {
        CONN_MGR_IF_PERSISTENT,

        CONN_MGR_IF_NO_AUTO_CONNECT,

        CONN_MGR_IF_NO_AUTO_DOWN,

        CONN_MGR_IF_DISCONNECTING,
 
        /* Total number of flags - must be at the end of the enum */
        CONN_MGR_NUM_IF_FLAGS,
};

#define CONN_MGR_IF_NO_TIMEOUT 0

int conn_mgr_if_connect(struct net_if *iface);

int conn_mgr_if_disconnect(struct net_if *iface);

bool conn_mgr_if_is_bound(struct net_if *iface);

int conn_mgr_if_set_opt(struct net_if *iface, int optname, const void *optval, size_t optlen);

int conn_mgr_if_get_opt(struct net_if *iface, int optname, void *optval, size_t *optlen);

bool conn_mgr_if_get_flag(struct net_if *iface, enum conn_mgr_if_flag flag);

int conn_mgr_if_set_flag(struct net_if *iface, enum conn_mgr_if_flag flag, bool value);

int conn_mgr_if_get_timeout(struct net_if *iface);

int conn_mgr_if_set_timeout(struct net_if *iface, int timeout);

int conn_mgr_if_get_idle_timeout(struct net_if *iface);

int conn_mgr_if_set_idle_timeout(struct net_if *iface, int timeout);
 
#if defined(CONFIG_NET_CONNECTION_MANAGER) || defined(__DOXYGEN__)
void conn_mgr_if_used(struct net_if *iface);
#else
#define conn_mgr_if_used(iface) (void)(iface)
#endif /* defined(CONFIG_NET_CONNECTION_MANAGER) || defined(__DOXYGEN__) */



int conn_mgr_all_if_up(bool skip_ignored);
 

int conn_mgr_all_if_down(bool skip_ignored);

int conn_mgr_all_if_connect(bool skip_ignored);

int conn_mgr_all_if_disconnect(bool skip_ignored);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_ */