nrf71_coex_if.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __NRF71_COEX_IF_H__
#define __NRF71_COEX_IF_H__
 
#include "common/pack_def.h"
 
/*
 * The shared SR priority-range structure (struct coex_sr_priority_range_t) and
 * the CCCONF range constant are defined by the CD to Short-Range interface
 * header. The Coexistence Manager uses only the regular Rx/Tx ranges from it;
 * the critical ranges are consumed by the Short-Range driver.
 */
#include "nrf71_cd_sr_if.h"
 
#define NUM_ELEMENTS_IN_SW_PTI_RANGE 3U
 
#define NRF_COEX_PARAMS                                                                            \
        "0100000001000000140000000100000080000000030000000300000032000000CE0000001000000010000000" \
        "01000000010000000100010100010100010100000100"
 
enum coexc_mode_wifi_t {
        COEXC_MODE_WIFI_2PT4G = 0,
        COEXC_MODE_WIFI_5G,
        COEXC_MODE_WIFI_6G,
};
 
enum coex_wifi_sw_client_req_status_t {
        WIFI_SW_CLIENT_REQ_SUCCESS = 0,
        WIFI_SW_CLIENT_REQ_FAIL
};
 
enum cm_event_to_host_t {
        STATISTICS_EVENT = 0,
        SW_CLIENT_STATUS_EVENT
};
 
struct cm_stats_t {
        unsigned int init_count;
 
        unsigned int ppw_start_msgs_cnt;
        unsigned int ppw_stop_msgs_cnt;
        unsigned int ppw_stop_timeout_cnt;
        unsigned int num_wifi_pti_windows;
        unsigned int num_sr_pti_windows;
        unsigned int wifi_ccconf_wifi_window;
        unsigned int wifi_ccconf_sr_window;
        unsigned int ppw_invalid_params_cnt;
        unsigned int ppw_invalid_request_cnt;
 
        unsigned int cfg_band_sel_5g_cnt;
        unsigned int cfg_band_sel_2pt4g_cnt;
 
        unsigned int wifi_sw_client_req_cnt;
        unsigned int wifi_sw_client_rel_cnt;
        unsigned int wifi_sw_client_gnt_cnt;
        unsigned int wifi_sw_client_rel_timeout_cnt;
        unsigned int wifi_sw_client_req_non2pt4g_band_cnt;
        unsigned int wifi_sw_client_req_2pt4g_band_cnt;
        unsigned int wifi_sw_client_decison_in_favour_cnt_2pt4g;
        unsigned int wifi_sw_client_decison_not_in_favour_cnt_2pt4g;
        unsigned int wifi_sw_client_no_gnt_cnt_2pt4g;
        unsigned int wifi_sw_client_no_gnt_cnt_non_2pt4g;
        unsigned int wifi_sw_client_rel_cnt_2pt4g;
        unsigned int wifi_sw_client_rel_cnt_non_2pt4g;
        unsigned int wifi_sw_client_gnt_cnt_2pt4g;
        unsigned int wifi_sw_client_gnt_cnt_non_2pt4g;
 
        unsigned int wifi_beacon_rx_req_cnt;
        unsigned int wifi_conn_req_cnt;
        unsigned int wifi_calib_req_cnt;
        unsigned int wifi_scan_req_cnt;
 
        unsigned int wifi_beacon_rx_rel_cnt;
        unsigned int wifi_conn_rel_cnt;
        unsigned int wifi_calib_rel_cnt;
        unsigned int wifi_scan_rel_cnt;
 
        unsigned int wifi_beacon_rx_gnt_cnt;
        unsigned int wifi_conn_gnt_cnt;
        unsigned int wifi_calib_gnt_cnt;
        unsigned int wifi_scan_gnt_cnt;
 
        unsigned int wifi_beacon_rx_no_gnt_cnt;
        unsigned int wifi_conn_no_gnt_cnt;
        unsigned int wifi_calib_no_gnt_cnt;
        unsigned int wifi_scan_no_gnt_cnt;
 
        unsigned int wifi_beacon_rx_rel_to_cnt;
        unsigned int wifi_conn_rel_to_cnt;
        unsigned int wifi_calib_rel_to_cnt;
        unsigned int wifi_scan_rel_to_cnt;
 
        /*
         * Additional Debug Statistics for System-Level Debugging
         */
 
        unsigned int sr_rx_prot_success_cnt_2pt4g;
        unsigned int sr_rx_prot_fail_cnt_2pt4g;
        unsigned int sr_rx_prot_success_cnt_non_2pt4g;
        unsigned int sr_rx_prot_fail_cnt_non_2pt4g;
        unsigned int sr_rx_prot_inact2listen_ps_cnt_2pt4g;
        unsigned int sr_rx_prot_listen2inact_ps_cnt_2pt4g;
        unsigned int sr_rx_prot_inact2listen_calib_cnt_2pt4g;
        unsigned int sr_rx_prot_listen2inact_calib_cnt_2pt4g;
        unsigned int sr_rx_prot_inact2listen_ps_cnt_non_2pt4g;
        unsigned int sr_rx_prot_listen2inact_ps_cnt_non_2pt4g;
        unsigned int sr_rx_prot_inact2listen_calib_cnt_non_2pt4g;
        unsigned int sr_rx_prot_listen2inact_calib_cnt_non_2pt4g;
 
        unsigned int sr_rx_prot_2pt4g_band_cnt;
        unsigned int sr_rx_prot_non2pt4g_band_cnt;
        unsigned int sr_rx_prot_force_wifi_cnt_2pt4g;
 
        unsigned int coex_enable_cnt;
        unsigned int coex_disable_cnt;
 
        unsigned int antswc_inhibit_cfg_cnt;
        unsigned int antswc_anten_override_cfg_cnt;
        unsigned int antswc_pa_override_cfg_cnt;
        unsigned int antswc_lnasw_override_cfg_cnt;
 
        unsigned int wifi_ccconf_save_cnt;
        unsigned int wifi_ccconf_restore_cnt;
 
        unsigned int cmd_update_coex_params_cnt;
        unsigned int cmd_update_user_params_cnt;
        unsigned int cmd_enable_coex_cnt;
        unsigned int cmd_allocate_ppw_cnt;
        unsigned int cmd_set_pti_ranges_cnt;
        unsigned int cmd_get_stats_cnt;
        unsigned int cmd_sw_client_req_cnt;
 
        unsigned int stats_event_to_host_cnt;
        unsigned int sw_client_event_to_host_cnt;
 
        unsigned int cd2cm_null_cmd_buf_cnt;
        unsigned int cd2cm_invalid_msg_id_cnt;
        unsigned int coex_params_buf_error;
        unsigned int user_params_buf_error;
        unsigned int en_coex_buf_error;
        unsigned int ppw_buf_error;
        unsigned int set_pti_ranges_buf_error;
        unsigned int sw_client_req_buf_error;
        unsigned int event_buf_unavailable_cnt;
        unsigned int unknown_event_to_host;
        unsigned int wifi_wrong_sw_client_id_cnt;
        unsigned int wifi_wrong_sw_client_request_type_cnt;
        unsigned int wrong_antswc_ctrl_type_cnt;
        unsigned int wrong_wifi_hw_client_pti_level_cnt;
        unsigned int wrong_input_populate_pti_cnt;
        unsigned int wrong_sr_rx_prot_scenario_cnt;
        unsigned int wrong_sr_rx_prot_perc_prob_cnt;
        unsigned int wrong_wifi_sw_client_id_cnt;
        unsigned int wrong_wifi_sw_client_perc_prob_cnt;
        unsigned int zero_ppw_win_duration_cnt;
        unsigned int zero_ppw_timeout_cnt;
};
 
enum cd2cm_msg_id_t {
        CD2CM_ENABLE_COEXISTENCE = 0,
        CD2CM_ALLOCATE_PPW,
        CD2CM_SET_PRIORITY_RANGES,
        CD2CM_UPDATE_COEX_USER_PARAMS,
        CD2CM_UPDATE_COEX_PARAMS,
        CD2CM_WIFI_SW_CLIENT_REQUEST,
        CD2CM_GET_STATS,
        CD2CM_MSG_ID_COUNT
};
 
enum start_stop_ppw_t {
        STOP_ALLOC_WINDOWS = 0,
        START_ALLOC_WINDOWS
};
 
enum coex_radios_t {
        WIFI_RADIO = 0,
        SR_RADIO
};
 
enum antenna_allocation_t {
        ANT_ALLOC_DYNAMIC = 0,
        ANT_ALLOC_STATIC_WIFI,
        ANT_ALLOC_STATIC_SR
};
 
enum coex_en_or_dis_t {
        COEX_DISABLE = 0,
        COEX_ENABLE
};
 
enum coex_wifi_sw_client_req_type_t {
        WIFI_SW_CLIENT_RELEASE = 0,
        WIFI_SW_CLIENT_REQUEST = 1
};
 
enum coex_wifi_sw_client_req_pti_level_t {
        WIFI_SW_CLIENT_REQ_PTI_LOW = 0,
        WIFI_SW_CLIENT_REQ_PTI_MEDIUM,
        WIFI_SW_CLIENT_REQ_PTI_HIGH,
        WIFI_SW_CLIENT_REQ_PTI_HIGHEST,
        WIFI_SW_CLIENT_REQ_PTI_COUNT
};
 
enum wifi_sw_client_t {
        WIFI_BEACON_RECEPTION = 0,
        WIFI_CONNECTION,
        WIFI_CALIBRATIONS,
        WIFI_SCAN,
        WIFI_SW_CLIENT_COUNT
};
 
struct coex_ppw_parameters_t {
        unsigned int start_or_stop_ppw;
        unsigned int first_window_to_wifi_or_sr;
        unsigned int wifi_pti_window_duration;
        unsigned int sr_pti_window_duration;
        unsigned int ppws_timeout;
} __NRF_WIFI_PKD;
 
struct cd2cm_genarate_ppw_t {
        unsigned int message_id;
        struct coex_ppw_parameters_t ppw_parameters;
} __NRF_WIFI_PKD;
 
struct coex_wifi_priority_range_t {
        unsigned char sw_request_priority_range[NUM_ELEMENTS_IN_SW_PTI_RANGE];
        unsigned char client0_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char client1_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char client2_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char client3_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char hw_client_priority_level;
} __NRF_WIFI_PKD;
 
/*
 * struct coex_sr_priority_range_t is defined by nrf71_cd_sr_if.h (included
 * above). The Coexistence Manager uses only its regular SR Rx/Tx ranges.
 */
 
struct cd2cm_enable_coexistence_t {
        unsigned int message_id;
        unsigned int coex_en_or_dis;
} __NRF_WIFI_PKD;
 
struct cd2cm_set_priority_ranges_t {
        unsigned int message_id;
        struct coex_wifi_priority_range_t wifi_pti_range;
        struct coex_sr_priority_range_t sr_pti_range;
} __NRF_WIFI_PKD;
 
struct cd2cm_get_coex_stats_t {
        unsigned int message_id;
        unsigned int reserved;
} __NRF_WIFI_PKD;
 
struct coex_sw_client_params_t {
        unsigned int sw_client_request;
        unsigned int sw_client_pti_level;
        unsigned int sw_client_type;
        unsigned int request_timeout_in_ms;
        unsigned int wifi_operating_band;
} __NRF_WIFI_PKD;
 
struct cd2cm_wifi_sw_client_request_t {
        unsigned int message_id;
        struct coex_sw_client_params_t sw_client_parameters;
} __NRF_WIFI_PKD;
 
struct wifi_scan_puncture_info_t {
        unsigned int wifi_scan_prot_prob;
} __NRF_WIFI_PKD;
 
struct coex_user_params_t {
        unsigned int message_id;
        unsigned int listen2inactive_sr_rx_prot_prob_ps;
        unsigned int inactive2listen_sr_rx_prot_prob_ps;
        unsigned int inactive2listen_sr_rx_prot_prob_calib;
        unsigned int listen2inactive_sr_rx_prot_prob_calib;
 
        struct wifi_scan_puncture_info_t wifi_scan_puncture_info;
 
        unsigned int wifi_beacon_prot_prob;
        unsigned int wifi_conn_prot_prob;
        unsigned int wifi_calib_prot_prob;
 
        unsigned int shared_ant_control;
} __NRF_WIFI_PKD;
 
struct cd2cm_coex_user_params_t {
        unsigned int message_id;
        struct coex_user_params_t user_params;
} __NRF_WIFI_PKD;
 
enum coex_wifi_power_event_t {
        COEX_WIFI_PREPARE_POWER_DOWN = 0,
        COEX_WIFI_POWERED_UP_READY
};
 
int coex_cd_wifi_power_notify(enum coex_wifi_power_event_t event);
 
#endif /* __NRF71_COEX_IF_H__ */