dect_net_l2_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DECT_NET_L2_MGMT_H_
#define DECT_NET_L2_MGMT_H_
 
#include <zephyr/net/net_mgmt.h>
#include <net/dect/dect_net_l2.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define _NET_DECT_LAYER NET_MGMT_LAYER_L2
#define _NET_DECT_CODE  NET_MGMT_LAYER_CODE_USER1
#define _NET_DECT_BASE                                                                             \
        (NET_MGMT_IFACE_BIT | NET_MGMT_LAYER(_NET_DECT_LAYER) | NET_MGMT_LAYER_CODE(_NET_DECT_CODE))
#define _NET_DECT_EVENT (_NET_DECT_BASE | NET_MGMT_EVENT_BIT)
 
enum net_request_dect_cmd {
        NET_REQUEST_DECT_CMD_ACTIVATE = 1,
 
        NET_REQUEST_DECT_CMD_DEACTIVATE,
 
        NET_REQUEST_DECT_CMD_RSSI_SCAN,
 
        NET_REQUEST_DECT_CMD_SCAN,
 
        NET_REQUEST_DECT_CMD_ASSOCIATION_REQ,
 
        NET_REQUEST_DECT_CMD_ASSOCIATION_RELEASE,
 
        NET_REQUEST_DECT_CMD_CLUSTER_START_REQ,
 
        NET_REQUEST_DECT_CMD_CLUSTER_RECONFIG_REQ,
 
        NET_REQUEST_DECT_CMD_CLUSTER_STOP_REQ,
 
        NET_REQUEST_DECT_CMD_NW_BEACON_START_REQ,
 
        NET_REQUEST_DECT_CMD_NW_BEACON_STOP_REQ,
 
        NET_REQUEST_DECT_CMD_NETWORK_CREATE_REQ,
 
        NET_REQUEST_DECT_CMD_NETWORK_REMOVE_REQ,
 
        NET_REQUEST_DECT_CMD_NETWORK_JOIN,
 
        NET_REQUEST_DECT_CMD_NETWORK_UNJOIN,
 
        NET_REQUEST_DECT_CMD_SETTINGS_READ,
 
        NET_REQUEST_DECT_CMD_SETTINGS_WRITE,
 
        NET_REQUEST_DECT_CMD_STATUS_INFO_GET,
 
        NET_REQUEST_DECT_CMD_NEIGHBOR_LIST_REQ,
 
        NET_REQUEST_DECT_CMD_NEIGHBOR_INFO_REQ,
 
        NET_REQUEST_DECT_CMD_CLUSTER_INFO_REQ,
};
 
#define NET_REQUEST_DECT_ACTIVATE (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_ACTIVATE)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_ACTIVATE);
 
#define NET_REQUEST_DECT_DEACTIVATE (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_DEACTIVATE)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_DEACTIVATE);
 
#define NET_REQUEST_DECT_RSSI_SCAN (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_RSSI_SCAN)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_RSSI_SCAN);
 
#define NET_REQUEST_DECT_SCAN (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_SCAN)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_SCAN);
 
#define NET_REQUEST_DECT_ASSOCIATION (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_ASSOCIATION_REQ)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_ASSOCIATION);
 
#define NET_REQUEST_DECT_ASSOCIATION_RELEASE                                                       \
        (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_ASSOCIATION_RELEASE)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_ASSOCIATION_RELEASE);
 
#define NET_REQUEST_DECT_CLUSTER_START (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_CLUSTER_START_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_CLUSTER_START);
 
#define NET_REQUEST_DECT_CLUSTER_RECONFIGURE                                                       \
        (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_CLUSTER_RECONFIG_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_CLUSTER_RECONFIGURE);
 
#define NET_REQUEST_DECT_CLUSTER_STOP (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_CLUSTER_STOP_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_CLUSTER_STOP);
 
#define NET_REQUEST_DECT_NW_BEACON_START (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NW_BEACON_START_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NW_BEACON_START);
 
#define NET_REQUEST_DECT_NW_BEACON_STOP (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NW_BEACON_STOP_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NW_BEACON_STOP);
 
#define NET_REQUEST_DECT_SETTINGS_READ (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_SETTINGS_READ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_SETTINGS_READ);
 
#define NET_REQUEST_DECT_SETTINGS_WRITE (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_SETTINGS_WRITE)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_SETTINGS_WRITE);
 
#define NET_REQUEST_DECT_STATUS_INFO_GET (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_STATUS_INFO_GET)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_STATUS_INFO_GET);
 
#define NET_REQUEST_DECT_NEIGHBOR_LIST (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NEIGHBOR_LIST_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NEIGHBOR_LIST);
 
#define NET_REQUEST_DECT_NEIGHBOR_INFO (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NEIGHBOR_INFO_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NEIGHBOR_INFO);
 
#define NET_REQUEST_DECT_CLUSTER_INFO (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_CLUSTER_INFO_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_CLUSTER_INFO);
 
#define NET_REQUEST_DECT_NETWORK_CREATE (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NETWORK_CREATE_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NETWORK_CREATE);
 
#define NET_REQUEST_DECT_NETWORK_REMOVE (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NETWORK_REMOVE_REQ)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NETWORK_REMOVE);
 
#define NET_REQUEST_DECT_NETWORK_JOIN (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NETWORK_JOIN)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NETWORK_JOIN);
 
#define NET_REQUEST_DECT_NETWORK_UNJOIN (_NET_DECT_BASE | NET_REQUEST_DECT_CMD_NETWORK_UNJOIN)
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_DECT_NETWORK_UNJOIN);
 
enum {
        NET_EVENT_DECT_CMD_ACTIVATE_DONE_VAL,
        NET_EVENT_DECT_CMD_DEACTIVATE_DONE_VAL,
        NET_EVENT_DECT_CMD_SCAN_RESULT_VAL,
        NET_EVENT_DECT_CMD_SCAN_DONE_VAL,
        NET_EVENT_DECT_CMD_RSSI_SCAN_RESULT_VAL,
        NET_EVENT_DECT_CMD_RSSI_SCAN_DONE_VAL,
        NET_EVENT_DECT_CMD_NETWORK_STATUS_VAL,
        NET_EVENT_DECT_CMD_SINK_STATUS_VAL,
        NET_EVENT_DECT_CMD_ASSOCIATION_CHANGED_VAL,
        NET_EVENT_DECT_CMD_CLUSTER_START_RESP_VAL,
        NET_EVENT_DECT_CMD_CLUSTER_STOPPED_RESP_VAL,
        NET_EVENT_DECT_CMD_NW_BEACON_START_RESP_VAL,
        NET_EVENT_DECT_CMD_NW_BEACON_STOP_RESP_VAL,
        NET_EVENT_DECT_CMD_NEIGHBOR_LIST_RESP_VAL,
        NET_EVENT_DECT_CMD_NEIGHBOR_INFO_RESP_VAL,
        NET_EVENT_DECT_CMD_CLUSTER_INFO_RESP_VAL,
 
        NET_EVENT_DECT_CMD_MAX
};
 
BUILD_ASSERT(NET_EVENT_DECT_CMD_MAX <= NET_MGMT_MAX_COMMANDS,
             "Number of events in net_event_dect_cmd exceeds the limit");
 
enum net_event_dect_cmd {
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_ACTIVATE_DONE),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_DEACTIVATE_DONE),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_SCAN_RESULT),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_SCAN_DONE),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_RSSI_SCAN_RESULT),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_RSSI_SCAN_DONE),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_NETWORK_STATUS),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_SINK_STATUS),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_ASSOCIATION_CHANGED),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_CLUSTER_START_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_CLUSTER_STOPPED_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_NW_BEACON_START_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_NW_BEACON_STOP_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_NEIGHBOR_LIST_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_NEIGHBOR_INFO_RESP),
        NET_MGMT_CMD(NET_EVENT_DECT_CMD_CLUSTER_INFO_RESP),
};
#define NET_EVENT_DECT_ACTIVATE_DONE (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_ACTIVATE_DONE)
 
#define NET_EVENT_DECT_DEACTIVATE_DONE (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_DEACTIVATE_DONE)
 
#define NET_EVENT_DECT_RSSI_SCAN_RESULT (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_RSSI_SCAN_RESULT)
 
#define NET_EVENT_DECT_RSSI_SCAN_DONE (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_RSSI_SCAN_DONE)
 
#define NET_EVENT_DECT_SCAN_RESULT (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_SCAN_RESULT)
 
#define NET_EVENT_DECT_SCAN_DONE (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_SCAN_DONE)
 
#define NET_EVENT_DECT_ASSOCIATION_CHANGED                                                         \
        (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_ASSOCIATION_CHANGED)
 
#define NET_EVENT_DECT_NETWORK_STATUS                                                              \
        (_NET_DECT_EVENT |                                                                         \
         NET_EVENT_DECT_CMD_NETWORK_STATUS) /* created/removed/joined/unjoined */
 
#define NET_EVENT_DECT_SINK_STATUS                                                                 \
        (_NET_DECT_EVENT |                                                                         \
         NET_EVENT_DECT_CMD_SINK_STATUS) /* connected/disconnected */
 
#define NET_EVENT_DECT_CLUSTER_CREATED_RESULT                                                      \
        (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_CLUSTER_START_RESP)
 
#define NET_EVENT_DECT_CLUSTER_STOPPED_RESULT                                                      \
        (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_CLUSTER_STOPPED_RESP)
 
#define NET_EVENT_DECT_NW_BEACON_START_RESULT                                                      \
        (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_NW_BEACON_START_RESP)
 
#define NET_EVENT_DECT_NW_BEACON_STOP_RESULT                                                       \
        (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_NW_BEACON_STOP_RESP)
 
#define NET_EVENT_DECT_NEIGHBOR_LIST (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_NEIGHBOR_LIST_RESP)
 
#define NET_EVENT_DECT_NEIGHBOR_INFO (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_NEIGHBOR_INFO_RESP)
 
#define NET_EVENT_DECT_CLUSTER_INFO (_NET_DECT_EVENT | NET_EVENT_DECT_CMD_CLUSTER_INFO_RESP)
/* Helper functions for driver to send L2 events */
 
void dect_mgmt_activate_done_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_deactivate_done_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_rssi_scan_result_evt(struct net_if *iface,
                                    struct dect_rssi_scan_result_evt result_data);
 
void dect_mgmt_rssi_scan_done_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_association_changed_evt(struct net_if *iface,
                                       struct dect_association_changed_evt evt_data);
 
void dect_mgmt_parent_association_created_evt(struct net_if *iface, uint32_t long_rd_id);
 
void dect_mgmt_child_association_created_evt(struct net_if *iface, uint32_t long_rd_id);
 
void dect_mgmt_association_released_evt(struct net_if *iface, uint32_t neighbor_long_rd_id,
                                        enum dect_neighbor_role neighbor_role,
                                        bool neighbor_initiated,
                                        enum dect_association_release_cause cause);
 
void dect_mgmt_association_req_failed_mdm_result_evt(struct net_if *iface, uint32_t long_rd_id,
                                                     enum dect_status_values cause);
 
void dect_mgmt_association_req_rejected_result_evt(struct net_if *iface, uint32_t long_rd_id,
                                                   enum dect_association_reject_cause reject_cause,
                                                   enum dect_association_reject_time reject_time);
 
void dect_mgmt_cluster_created_evt(struct net_if *iface,
                                   struct dect_cluster_start_resp_evt resp_data);
 
void dect_mgmt_cluster_stopped_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_cluster_info_evt(struct net_if *iface, struct dect_cluster_info_evt resp_data);
 
void dect_mgmt_network_status_evt(struct net_if *iface,
                                  struct dect_network_status_evt network_status_data);
 
void dect_mgmt_sink_status_evt(struct net_if *iface,
                               struct dect_sink_status_evt sink_status_data);
 
void dect_mgmt_nw_beacon_start_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_nw_beacon_stop_evt(struct net_if *iface, enum dect_status_values status);
 
void dect_mgmt_neighbor_list_evt(struct net_if *iface, struct dect_neighbor_list_evt resp_data);
 
void dect_mgmt_neighbor_info_evt(struct net_if *iface, struct dect_neighbor_info_evt resp_data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DECT_NET_L2_MGMT_H_ */