Zephyr Project API 4.1.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
conn_mgr_connectivity.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13#ifndef ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
14#define ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_
15
16#include <zephyr/device.h>
17#include <zephyr/net/net_if.h>
19#include <zephyr/net/net_mgmt.h>
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
37/* Connectivity Events */
38#define NET_MGMT_CONN_LAYER NET_MGMT_LAYER(NET_MGMT_LAYER_L2)
39#define NET_MGMT_CONN_CODE NET_MGMT_LAYER_CODE(NET_MGMT_LAYER_CODE_CONN)
40#define NET_MGMT_CONN_BASE (NET_MGMT_CONN_LAYER | NET_MGMT_CONN_CODE | \
41 NET_MGMT_EVENT_BIT)
42#define NET_MGMT_CONN_IF_EVENT (NET_MGMT_IFACE_BIT | NET_MGMT_CONN_BASE)
43
44enum {
45 NET_EVENT_CONN_CMD_IF_TIMEOUT_VAL,
46 NET_EVENT_CONN_CMD_IF_FATAL_ERROR_VAL,
47
48 NET_EVENT_CONN_CMD_MAX
49};
50
51BUILD_ASSERT(NET_EVENT_CONN_CMD_MAX <= NET_MGMT_MAX_COMMANDS,
52 "Number of events in net_event_conn_cmd exceeds the limit");
53
54enum net_event_conn_cmd {
55 NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_TIMEOUT),
56 NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_FATAL_ERROR),
57};
58
64#define NET_EVENT_CONN_IF_TIMEOUT \
65 (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_TIMEOUT)
66
70#define NET_EVENT_CONN_IF_FATAL_ERROR \
71 (NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_FATAL_ERROR)
72
73
85
93
101
107 CONN_MGR_IF_DISCONNECTING,
108
109 /* Total number of flags - must be at the end of the enum */
110 CONN_MGR_NUM_IF_FLAGS,
112};
113
117#define CONN_MGR_IF_NO_TIMEOUT 0
118
135int conn_mgr_if_connect(struct net_if *iface);
136
152
161bool conn_mgr_if_is_bound(struct net_if *iface);
162
182int conn_mgr_if_set_opt(struct net_if *iface, int optname, const void *optval, size_t optlen);
183
210int conn_mgr_if_get_opt(struct net_if *iface, int optname, void *optval, size_t *optlen);
211
224bool conn_mgr_if_get_flag(struct net_if *iface, enum conn_mgr_if_flag flag);
225
239int conn_mgr_if_set_flag(struct net_if *iface, enum conn_mgr_if_flag flag, bool value);
240
252
265int conn_mgr_if_set_timeout(struct net_if *iface, int timeout);
266
290int conn_mgr_all_if_up(bool skip_ignored);
291
292
303int conn_mgr_all_if_down(bool skip_ignored);
304
316int conn_mgr_all_if_connect(bool skip_ignored);
317
329int conn_mgr_all_if_disconnect(bool skip_ignored);
330
335#ifdef __cplusplus
336}
337#endif
338
339#endif /* ZEPHYR_INCLUDE_CONN_MGR_CONNECTIVITY_H_ */
int conn_mgr_all_if_disconnect(bool skip_ignored)
Convenience function that disconnects all available ifaces that support connectivity without putting ...
int conn_mgr_all_if_connect(bool skip_ignored)
Convenience function that takes all available ifaces into the admin-up state, and connects those that...
int conn_mgr_all_if_up(bool skip_ignored)
Convenience function that takes all available ifaces into the admin-up state.
int conn_mgr_all_if_down(bool skip_ignored)
Convenience function that takes all available ifaces into the admin-down state.
bool conn_mgr_if_is_bound(struct net_if *iface)
Check whether the provided network interface supports connectivity / has been bound to a connectivity...
int conn_mgr_if_set_opt(struct net_if *iface, int optname, const void *optval, size_t optlen)
Set implementation-specific connectivity options.
bool conn_mgr_if_get_flag(struct net_if *iface, enum conn_mgr_if_flag flag)
Check the value of connectivity flags.
int conn_mgr_if_set_timeout(struct net_if *iface, int timeout)
Set the connectivity timeout for an iface.
int conn_mgr_if_connect(struct net_if *iface)
Connect interface.
int conn_mgr_if_get_opt(struct net_if *iface, int optname, void *optval, size_t *optlen)
Get implementation-specific connectivity options.
int conn_mgr_if_disconnect(struct net_if *iface)
Disconnect interface.
int conn_mgr_if_get_timeout(struct net_if *iface)
Get the connectivity timeout for an iface.
int conn_mgr_if_set_flag(struct net_if *iface, enum conn_mgr_if_flag flag, bool value)
Set the value of a connectivity flags.
conn_mgr_if_flag
Per-iface connectivity flags.
Definition conn_mgr_connectivity.h:77
@ CONN_MGR_IF_PERSISTENT
Persistent.
Definition conn_mgr_connectivity.h:84
@ CONN_MGR_IF_NO_AUTO_DOWN
No auto-down.
Definition conn_mgr_connectivity.h:100
@ CONN_MGR_IF_NO_AUTO_CONNECT
No auto-connect.
Definition conn_mgr_connectivity.h:92
@ NET_MGMT_CMD
Scan results available.
Definition wifi_mgmt.h:352
Public API for network interface.
Network Management API public header.
Network Interface structure.
Definition net_if.h:726