nrf71_cd_sr_if.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __NRF71_CD_SR_IF_H__
#define __NRF71_CD_SR_IF_H__
 
#include "common/pack_def.h"
 
#define NUM_ELEMENTS_IN_CCCONF_PTI_RANGE 3U
 
#define MAX_NUM_SR_CCCONF_PTI_VALUES 6U
 
#define COEX_SR_PRIORITY_LEVEL_UNUSED 0xFF
 
enum coex_sr_sw_client_req_status_t {
        SR_SW_CLIENT_REQ_SUCCESS = 0,
        SR_SW_CLIENT_REQ_FAIL
};
 
enum coex_sr_sw_client_req_type_t {
        SR_SW_CLIENT_RELEASE = 0,
        SR_SW_CLIENT_REQUEST = 1
};
 
enum coex_sr_sw_client_req_pti_level_t {
        SR_SW_CLIENT_REQ_PTI_LOW = 0,
        SR_SW_CLIENT_REQ_PTI_MEDIUM,
        SR_SW_CLIENT_REQ_PTI_HIGH,
        SR_SW_CLIENT_REQ_PTI_HIGHEST,
        SR_SW_CLIENT_REQ_PTI_COUNT
};
 
enum coex_sr_power_event_t {
        COEX_SR_PREPARE_POWER_DOWN = 0,
        COEX_SR_POWERED_UP_READY
};
 
enum sr_sw_client_t {
        SR_CONNECTION,
        SR_CALIBRATIONS,
        SR_CONNECTION_EVENT,
        MAX_SR_SW_CLIENT_COUNT
};
 
enum sr_rf_freq_band_t {
        SR_BAND_2PT4G,
        SR_BAND_NON_2PT4G
};
 
enum short_range_activity_type_t {
        SR_BLE_ADV = 0,
        SR_BLE_SCAN,
        SR_BLE_CONNECTED_DATA_TRANSFER,
        SR_THREAD_DISCOVERY,
        SR_THREAD_ED_DATA_TRANSFER,
        SR_THREAD_ED_POLLING,
};
 
enum short_range_activity_action_t {
        SR_ACTIVITY_START,
        SR_ACTIVITY_END
};
 
struct short_range_activity_info_t {
        unsigned int sr_activity_type;
        unsigned int sr_activity_action;
        /*
         * Start time of the periodic activity. An absolute timestamp in the common GRTC domain,
         * expressed in milliseconds and rounded down to the nearest integer.
         * Set to zero for a non-aligned activity.
         */
        unsigned int start_time_of_activity;
 
        unsigned int activity_interval;
        unsigned int activity_duration;
        unsigned int activity_timeout;
        unsigned int parameter4;
        unsigned int parameter5;
} __NRF_WIFI_PKD;
 
struct coex_sr_priority_range_t {
        unsigned char sr_rx_client_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char sr_tx_client_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char sr_rx_client_critical_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char sr_tx_client_critical_ccconf_pti_range[NUM_ELEMENTS_IN_CCCONF_PTI_RANGE];
        unsigned char client_priority_level;
} __NRF_WIFI_PKD;
 
struct coex_sr_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 sr_operating_band;
} __NRF_WIFI_PKD;
 
unsigned int coex_sr_enable(unsigned int enable_coex);
 
unsigned int coex_sr_set_client_priority(const struct coex_sr_priority_range_t *sr_priority_range);
 
int coex_cd_sr_software_client_request(const struct coex_sr_sw_client_params_t *client_params,
                                       enum coex_sr_sw_client_req_status_t *grant_status);
 
int coex_cd_update_short_range_activity_info(
        const struct short_range_activity_info_t *activity_info);
 
int coex_cd_sr_power_notify(enum coex_sr_power_event_t event);
 
#endif /* __NRF71_CD_SR_IF_H__ */