Zephyr Project API 4.1.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
net_mgmt.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_NET_NET_MGMT_H_
13#define ZEPHYR_INCLUDE_NET_NET_MGMT_H_
14
15#include <zephyr/sys/__assert.h>
16#include <zephyr/net/net_core.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
32struct net_if;
33
38#define NET_MGMT_EVENT_MASK GENMASK64(63, 63) /* 0x8000000000000000 */
39#define NET_MGMT_ON_IFACE_MASK GENMASK64(62, 62) /* 0x4000000000000000 */
40#define NET_MGMT_LAYER_MASK GENMASK64(61, 60) /* 0x3000000000000000 */
41#define NET_MGMT_SYNC_EVENT_MASK GENMASK64(59, 59) /* 0x0800000000000000 */
42#define NET_MGMT_LAYER_CODE_MASK GENMASK64(58, 52) /* 0x07F0000000000000 */
43#define NET_MGMT_COMMAND_MASK GENMASK64(51, 0) /* 0x000FFFFFFFFFFFFF */
44
45#define NET_MGMT_MAX_COMMANDS 52 /* TODO: figure out the value from mask */
46
47#define NET_MGMT_EVENT_BIT BIT64(63)
48#define NET_MGMT_IFACE_BIT BIT64(62)
49#define NET_MGMT_SYNC_EVENT_BIT BIT64(59)
50
51#define NET_MGMT_LAYER(_layer) FIELD_PREP(NET_MGMT_LAYER_MASK, (_layer))
52#define NET_MGMT_LAYER_CODE(_code) FIELD_PREP(NET_MGMT_LAYER_CODE_MASK, (_code))
53
54#define NET_MGMT_EVENT(mgmt_request) FIELD_GET(NET_MGMT_EVENT_MASK, mgmt_request)
55#define NET_MGMT_ON_IFACE(mgmt_request) FIELD_GET(NET_MGMT_ON_IFACE_MASK, mgmt_request)
56#define NET_MGMT_EVENT_SYNCHRONOUS(mgmt_request) FIELD_GET(NET_MGMT_SYNC_EVENT_MASK, mgmt_request)
57#define NET_MGMT_GET_LAYER(mgmt_request) FIELD_GET(NET_MGMT_LAYER_MASK, mgmt_request)
58#define NET_MGMT_GET_LAYER_CODE(mgmt_request) FIELD_GET(NET_MGMT_LAYER_CODE_MASK, mgmt_request)
59#define NET_MGMT_GET_COMMAND(mgmt_request) FIELD_GET(NET_MGMT_COMMAND_MASK, mgmt_request)
60
61#define NET_MGMT_CMD(cmd) cmd = BIT64(cmd ##_VAL)
62
63/* Useful generic definitions */
64#define NET_MGMT_LAYER_L2 1
65#define NET_MGMT_LAYER_L3 2
66#define NET_MGMT_LAYER_L4 3
67
95
97
109typedef int (*net_mgmt_request_handler_t)(uint64_t mgmt_request,
110 struct net_if *iface,
111 void *data, size_t len);
112
121#define net_mgmt(_mgmt_request, _iface, _data, _len) \
122 net_mgmt_##_mgmt_request(_mgmt_request, _iface, _data, _len)
123
129#define NET_MGMT_DEFINE_REQUEST_HANDLER(_mgmt_request) \
130 extern int net_mgmt_##_mgmt_request(uint64_t mgmt_request, \
131 struct net_if *iface, \
132 void *data, size_t len)
133
140#define NET_MGMT_REGISTER_REQUEST_HANDLER(_mgmt_request, _func) \
141 FUNC_ALIAS(_func, net_mgmt_##_mgmt_request, int)
142
144
154 uint64_t mgmt_event,
155 struct net_if *iface);
156
168
169 union {
177 };
178
179#ifdef CONFIG_NET_MGMT_EVENT_INFO
180 const void *info;
181 size_t info_length;
182#endif
183
189 union {
203 };
204};
205
217typedef void (*net_mgmt_event_static_handler_t)(uint64_t mgmt_event,
218 struct net_if *iface,
219 void *info, size_t info_length,
220 void *user_data);
221
224/* Structure for event handler registered at compile time */
225struct net_mgmt_event_static_handler {
226 uint64_t event_mask;
228 void *user_data;
229};
230
246#define NET_MGMT_REGISTER_EVENT_HANDLER(_name, _event_mask, _func, _user_data) \
247 const STRUCT_SECTION_ITERABLE(net_mgmt_event_static_handler, _name) = { \
248 .event_mask = _event_mask, \
249 .handler = _func, \
250 .user_data = (void *)_user_data, \
251 }
252
259#ifdef CONFIG_NET_MGMT_EVENT
260static inline
263 uint64_t mgmt_event_mask)
264{
265 __ASSERT(cb, "Callback pointer should not be NULL");
266 __ASSERT(handler, "Handler pointer should not be NULL");
267
268 cb->handler = handler;
269 cb->event_mask = mgmt_event_mask;
270};
271#else
272#define net_mgmt_init_event_callback(...)
273#endif
274
279#ifdef CONFIG_NET_MGMT_EVENT
281#else
282#define net_mgmt_add_event_callback(...)
283#endif
284
289#ifdef CONFIG_NET_MGMT_EVENT
291#else
292#define net_mgmt_del_event_callback(...)
293#endif
294
308#if defined(CONFIG_NET_MGMT_EVENT)
309void net_mgmt_event_notify_with_info(uint64_t mgmt_event, struct net_if *iface,
310 const void *info, size_t length);
311#else
312#define net_mgmt_event_notify_with_info(...)
313#endif
314
321#if defined(CONFIG_NET_MGMT_EVENT)
322static inline void net_mgmt_event_notify(uint64_t mgmt_event,
323 struct net_if *iface)
324{
325 net_mgmt_event_notify_with_info(mgmt_event, iface, NULL, 0);
326}
327#else
328#define net_mgmt_event_notify(...)
329#endif
330
351#ifdef CONFIG_NET_MGMT_EVENT
352int net_mgmt_event_wait(uint64_t mgmt_event_mask,
353 uint64_t *raised_event,
354 struct net_if **iface,
355 const void **info,
356 size_t *info_length,
357 k_timeout_t timeout);
358#else
359static inline int net_mgmt_event_wait(uint64_t mgmt_event_mask,
360 uint64_t *raised_event,
361 struct net_if **iface,
362 const void **info,
363 size_t *info_length,
364 k_timeout_t timeout)
365{
366 ARG_UNUSED(mgmt_event_mask);
367 ARG_UNUSED(raised_event);
368 ARG_UNUSED(iface);
369 ARG_UNUSED(info);
370 ARG_UNUSED(info_length);
371 ARG_UNUSED(timeout);
372 return 0;
373}
374#endif
375
395#ifdef CONFIG_NET_MGMT_EVENT
397 uint64_t mgmt_event_mask,
398 uint64_t *raised_event,
399 const void **info,
400 size_t *info_length,
401 k_timeout_t timeout);
402#else
403static inline int net_mgmt_event_wait_on_iface(struct net_if *iface,
404 uint64_t mgmt_event_mask,
405 uint64_t *raised_event,
406 const void **info,
407 size_t *info_length,
408 k_timeout_t timeout)
409{
410 ARG_UNUSED(iface);
411 ARG_UNUSED(mgmt_event_mask);
412 ARG_UNUSED(raised_event);
413 ARG_UNUSED(info);
414 ARG_UNUSED(info_length);
415 ARG_UNUSED(timeout);
416 return 0;
417}
418#endif
419
424#ifdef CONFIG_NET_MGMT_EVENT
426#else
427#define net_mgmt_event_init(...)
428#endif /* CONFIG_NET_MGMT_EVENT */
429
434#ifdef __cplusplus
435}
436#endif
437
438#endif /* ZEPHYR_INCLUDE_NET_NET_MGMT_H_ */
void(* net_mgmt_event_static_handler_t)(uint64_t mgmt_event, struct net_if *iface, void *info, size_t info_length, void *user_data)
Define the user's callback handler function signature.
Definition net_mgmt.h:217
int net_mgmt_event_wait_on_iface(struct net_if *iface, uint64_t mgmt_event_mask, uint64_t *raised_event, const void **info, size_t *info_length, k_timeout_t timeout)
Used to wait synchronously on an event mask for a specific iface.
void net_mgmt_del_event_callback(struct net_mgmt_event_callback *cb)
Delete a user callback.
static void net_mgmt_init_event_callback(struct net_mgmt_event_callback *cb, net_mgmt_event_handler_t handler, uint64_t mgmt_event_mask)
Helper to initialize a struct net_mgmt_event_callback properly.
Definition net_mgmt.h:261
int(* net_mgmt_request_handler_t)(uint64_t mgmt_request, struct net_if *iface, void *data, size_t len)
Signature which all Net MGMT request handler need to follow.
Definition net_mgmt.h:109
net_mgmt_layer_code
Central place the definition of the layer codes (7 bit value)
Definition net_mgmt.h:71
void net_mgmt_event_notify_with_info(uint64_t mgmt_event, struct net_if *iface, const void *info, size_t length)
Used by the system to notify an event.
int net_mgmt_event_wait(uint64_t mgmt_event_mask, uint64_t *raised_event, struct net_if **iface, const void **info, size_t *info_length, k_timeout_t timeout)
Used to wait synchronously on an event mask.
void net_mgmt_event_init(void)
Used by the core of the network stack to initialize the network event processing.
static void net_mgmt_event_notify(uint64_t mgmt_event, struct net_if *iface)
Used by the system to notify an event without any additional information.
Definition net_mgmt.h:322
void net_mgmt_add_event_callback(struct net_mgmt_event_callback *cb)
Add a user callback.
void(* net_mgmt_event_handler_t)(struct net_mgmt_event_callback *cb, uint64_t mgmt_event, struct net_if *iface)
Define the user's callback handler function signature.
Definition net_mgmt.h:153
@ NET_MGMT_LAYER_CODE_HOSTAP
Hostap (wpa_supplicant) layer code.
Definition net_mgmt.h:80
@ NET_MGMT_LAYER_CODE_USER1
User layer code 1.
Definition net_mgmt.h:90
@ NET_MGMT_LAYER_CODE_IPV4
IPv4 layer code.
Definition net_mgmt.h:75
@ NET_MGMT_LAYER_CODE_IFACE
Network interface layer code.
Definition net_mgmt.h:73
@ NET_MGMT_LAYER_CODE_UNKNOWN
Unknown layer code, do not use.
Definition net_mgmt.h:72
@ NET_MGMT_LAYER_CODE_STATS
Statistics layer code.
Definition net_mgmt.h:79
@ NET_MGMT_LAYER_CODE_IEEE802514
IEEE 802.15.4 layer code.
Definition net_mgmt.h:82
@ NET_MGMT_LAYER_CODE_USER3
User layer code 3.
Definition net_mgmt.h:88
@ NET_MGMT_LAYER_CODE_PPP
PPP layer code.
Definition net_mgmt.h:83
@ NET_MGMT_LAYER_CODE_COAP
CoAP layer code.
Definition net_mgmt.h:78
@ NET_MGMT_LAYER_CODE_WIFI
Wi-Fi layer code.
Definition net_mgmt.h:85
@ NET_MGMT_LAYER_CODE_IPV6
IPv6 layer code.
Definition net_mgmt.h:76
@ NET_MGMT_LAYER_CODE_USER2
User layer code 2.
Definition net_mgmt.h:89
@ NET_MGMT_LAYER_CODE_L4
L4 layer code.
Definition net_mgmt.h:77
@ NET_MGMT_LAYER_CODE_CONN
Connectivity layer code.
Definition net_mgmt.h:74
@ NET_MGMT_LAYER_CODE_VIRTUAL
Virtual network interface layer code.
Definition net_mgmt.h:84
@ NET_MGMT_LAYER_CODE_RESERVED
Reserved layer code for future use.
Definition net_mgmt.h:93
@ NET_MGMT_LAYER_CODE_ETHERNET
Ethernet layer code.
Definition net_mgmt.h:81
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define NULL
Definition iar_missing_defs.h:20
Network core definitions.
Network Events code public header.
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
Semaphore structure.
Definition kernel.h:3275
Kernel timeout type.
Definition sys_clock.h:65
Network Interface structure.
Definition net_if.h:726
Network Management event callback structure Used to register a callback into the network management e...
Definition net_mgmt.h:163
sys_snode_t node
Meant to be used internally, to insert the callback into a list.
Definition net_mgmt.h:167
uint64_t raised_event
Internal place holder when a synchronous event wait is successfully unlocked on a event.
Definition net_mgmt.h:202
struct k_sem * sync_call
Semaphore meant to be used internally for the synchronous net_mgmt_event_wait() function.
Definition net_mgmt.h:176
uint64_t event_mask
A mask of network events on which the above handler should be called in case those events come.
Definition net_mgmt.h:198
net_mgmt_event_handler_t handler
Actual callback function being used to notify the owner.
Definition net_mgmt.h:172