nrf_modem_dect_phy.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_DECT_PHY_H__
#define NRF_MODEM_DECT_PHY_H__
 
#include <stdint.h>
#include <nrf_modem_toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ 69120
#define NRF_MODEM_DECT_SYMBOL_DURATION 2880
 
#define NRF_MODEM_DECT_LBT_PERIOD_MAX (110 * NRF_MODEM_DECT_SYMBOL_DURATION)
#define NRF_MODEM_DECT_LBT_PERIOD_MIN (2 * NRF_MODEM_DECT_SYMBOL_DURATION)
 
#define NRF_MODEM_DECT_PHY_SNR_NOT_MEASURED -32768
#define NRF_MODEM_DECT_PHY_RSSI_NOT_MEASURED 0
#define NRF_MODEM_DECT_PHY_RSSI2_NOT_MEASURED -32768
#define NRF_MODEM_DECT_PHY_TEMP_NOT_MEASURED 999
#define NRF_MODEM_DECT_PHY_VOLTAGE_NOT_MEASURED 0
 
#define NRF_MODEM_DECT_PHY_HANDLE_CANCEL_ALL UINT32_MAX
#define NRF_MODEM_DECT_PHY_BS_CQI_NOT_USED 0
#define NRF_MODEM_DECT_PHY_LINK_UNSPECIFIED ((struct nrf_modem_dect_phy_link_id){ 0 })
 
enum nrf_modem_dect_phy_err {
        NRF_MODEM_DECT_PHY_SUCCESS = 0,
        NRF_MODEM_DECT_PHY_ERR_LBT_CHANNEL_BUSY = 0x1,
        NRF_MODEM_DECT_PHY_ERR_UNSUPPORTED_OP = 0x2,
        NRF_MODEM_DECT_PHY_ERR_NOT_FOUND = 0x3,
        NRF_MODEM_DECT_PHY_ERR_NO_MEMORY = 0x4,
        NRF_MODEM_DECT_PHY_ERR_NOT_ALLOWED = 0x5,
        NRF_MODEM_DECT_PHY_OK_WITH_HARQ_RESET = 0x6,
        NRF_MODEM_DECT_PHY_ERR_OP_START_TIME_LATE = 0x1000,
        NRF_MODEM_DECT_PHY_ERR_LBT_START_TIME_LATE = 0x1001,
        NRF_MODEM_DECT_PHY_ERR_RF_START_TIME_LATE = 0x1002,
        NRF_MODEM_DECT_PHY_ERR_INVALID_START_TIME = 0x1003,
        NRF_MODEM_DECT_PHY_ERR_OP_SCHEDULING_CONFLICT = 0x1004,
        NRF_MODEM_DECT_PHY_ERR_OP_TIMEOUT = 0x1005,
        NRF_MODEM_DECT_PHY_ERR_NO_ONGOING_HARQ_RX = 0x1006,
        NRF_MODEM_DECT_PHY_ERR_PARAMETER_UNAVAILABLE = 0x1007,
        NRF_MODEM_DECT_PHY_ERR_PAYLOAD_UNAVAILABLE = 0x1008,
        NRF_MODEM_DECT_PHY_ERR_OP_CANCELED = 0x1009,
        NRF_MODEM_DECT_PHY_ERR_COMBINED_OP_FAILED = 0x100A,
        NRF_MODEM_DECT_PHY_ERR_RADIO_MODE_CONFLICT = 0x100B,
        NRF_MODEM_DECT_PHY_ERR_HANDLE_IN_USE = 0x100C,
        NRF_MODEM_DECT_PHY_ERR_UNSUPPORTED_CARRIER = 0x6000,
        NRF_MODEM_DECT_PHY_ERR_UNSUPPORTED_DATA_SIZE = 0x6001,
        NRF_MODEM_DECT_PHY_ERR_INVALID_NETWORK_ID = 0x6002,
        NRF_MODEM_DECT_PHY_ERR_INVALID_PHY_HEADER = 0x6003,
        NRF_MODEM_DECT_PHY_ERR_INVALID_DURATION = 0x6004,
        NRF_MODEM_DECT_PHY_ERR_INVALID_PARAMETER = 0x6005,
        NRF_MODEM_DECT_PHY_ERR_TX_POWER_OVER_MAX_LIMIT = 0x6006,
        NRF_MODEM_DECT_PHY_ERR_MODEM_ERROR = 0x7000,
        NRF_MODEM_DECT_PHY_ERR_MODEM_ERROR_RF_STATE = 0x7001,
        NRF_MODEM_DECT_PHY_ERR_TEMP_HIGH = 0x7002,
        NRF_MODEM_DECT_PHY_ERR_PROD_LOCK = 0x7003,
};
 
struct nrf_modem_dect_phy_capability {
        uint8_t dect_version;
        uint8_t variant_count;
        struct {
                uint8_t rx_spatial_streams;
                uint8_t rx_tx_diversity;
                uint8_t mcs_max;
                uint32_t harq_soft_buf_size;
                uint8_t harq_process_count_max;
                uint8_t harq_feedback_delay;
                uint8_t mu;
                uint8_t beta;
        } variant[];
};
 
struct nrf_modem_dect_phy_band {
        uint8_t band_group_index;
        uint8_t band_number;
        int8_t rx_gain;
        uint8_t power_class;
        uint16_t min_carrier;
        uint16_t max_carrier;
};
 
enum nrf_modem_dect_phy_rx_mode {
        NRF_MODEM_DECT_PHY_RX_MODE_CONTINUOUS,
        NRF_MODEM_DECT_PHY_RX_MODE_SEMICONTINUOUS,
        NRF_MODEM_DECT_PHY_RX_MODE_SINGLE_SHOT,
};
 
enum nrf_modem_dect_phy_rssi_interval {
        NRF_MODEM_DECT_PHY_RSSI_INTERVAL_OFF = 0,
        NRF_MODEM_DECT_PHY_RSSI_INTERVAL_12_SLOTS = 12,
        NRF_MODEM_DECT_PHY_RSSI_INTERVAL_24_SLOTS = 24,
};
 
struct nrf_modem_dect_phy_hdr_type_1 {
        uint8_t packet_length : 4;
        uint8_t packet_length_type : 1;
        uint8_t header_format : 3;
        uint8_t short_network_id;
        uint8_t transmitter_id_hi;
        uint8_t transmitter_id_lo;
        uint8_t df_mcs : 3;
        uint8_t reserved : 1;
        uint8_t transmit_power : 4;
} __nrf_modem_attr_packed;
 
union nrf_modem_dect_phy_feedback {
        struct {
                uint8_t transmission_feedback0 : 1;
                uint8_t harq_process_number0 : 3;
                uint8_t format : 4;
                uint8_t cqi : 4;
                uint8_t buffer_status : 4;
        } format1;
        struct {
                uint8_t mimo_feedback : 1;
                uint8_t codebook_index : 3;
                uint8_t format : 4;
                uint8_t cqi : 4;
                uint8_t buffer_status : 4;
        } format2;
        struct {
                uint8_t transmission_feedback0 : 1;
                uint8_t harq_process_number0 : 3;
                uint8_t format : 4;
                uint8_t cqi : 4;
                uint8_t transmission_feedback1 : 1;
                uint8_t harq_process_number1 : 3;
        } format3;
        struct {
                uint8_t harq_feedback_bitmap_proc3 : 1;
                uint8_t harq_feedback_bitmap_proc2 : 1;
                uint8_t harq_feedback_bitmap_proc1 : 1;
                uint8_t harq_feedback_bitmap_proc0 : 1;
                uint8_t format : 4;
                uint8_t cqi : 4;
                uint8_t harq_feedback_bitmap_proc7 : 1;
                uint8_t harq_feedback_bitmap_proc6 : 1;
                uint8_t harq_feedback_bitmap_proc5 : 1;
                uint8_t harq_feedback_bitmap_proc4 : 1;
        } format4;
        struct {
                uint8_t transmission_feedback : 1;
                uint8_t harq_process_number : 3;
                uint8_t format : 4;
                uint8_t codebook_index : 6;
                uint8_t mimo_feedback : 2;
        } format5;
        struct {
                uint8_t reserved : 1;
                uint8_t harq_process_number : 3;
                uint8_t format : 4;
                uint8_t cqi : 4;
                uint8_t buffer_status : 4;
        } format6;
} __nrf_modem_attr_packed;
 
struct nrf_modem_dect_phy_hdr_type_2 {
        uint8_t packet_length : 4;
        uint8_t packet_length_type : 1;
        uint8_t header_format : 3;
        uint8_t short_network_id;
        uint8_t transmitter_id_hi;
        uint8_t transmitter_id_lo;
        uint8_t df_mcs : 4;
        uint8_t transmit_power : 4;
        uint8_t receiver_id_hi;
        uint8_t receiver_id_lo;
        uint8_t df_harq_process_num : 3;
        uint8_t df_new_data_indication : 1;
        uint8_t df_redundancy_version : 2;
        uint8_t num_spatial_streams : 2;
        union nrf_modem_dect_phy_feedback feedback;
} __nrf_modem_attr_packed;
 
union nrf_modem_dect_phy_hdr {
        uint8_t type_1[5];
        uint8_t type_2[10];
        struct nrf_modem_dect_phy_hdr_type_1 hdr_type_1;
        struct nrf_modem_dect_phy_hdr_type_2 hdr_type_2;
};
 
enum nrf_modem_dect_phy_hdr_status {
        NRF_MODEM_DECT_PHY_HDR_STATUS_VALID = 0,
        NRF_MODEM_DECT_PHY_HDR_STATUS_INVALID = 1,
        NRF_MODEM_DECT_PHY_HDR_STATUS_VALID_RX_END = 2,
};
 
struct nrf_modem_dect_phy_link_id {
        uint8_t short_network_id;
        uint16_t short_rd_id;
};
 
struct nrf_modem_dect_phy_rx_filter {
        uint8_t short_network_id;
        uint8_t is_short_network_id_used;
        uint16_t receiver_identity;
};
 
struct nrf_modem_dect_phy_rx_params {
        uint64_t start_time;
        uint32_t handle;
        uint32_t network_id;
        enum nrf_modem_dect_phy_rx_mode mode;
        enum nrf_modem_dect_phy_rssi_interval rssi_interval;
        struct nrf_modem_dect_phy_link_id link_id;
        int8_t rssi_level;
        uint16_t carrier;
        uint32_t duration;
        struct nrf_modem_dect_phy_rx_filter filter;
};
 
struct nrf_modem_dect_phy_tx_params {
        uint64_t start_time;
        uint32_t handle;
        uint32_t network_id;
        uint8_t phy_type;
        int8_t lbt_rssi_threshold_max;
        uint16_t carrier;
        uint32_t lbt_period;
        union nrf_modem_dect_phy_hdr *phy_header;
        uint8_t bs_cqi;
        uint8_t *data;
        uint32_t data_size;
};
 
struct nrf_modem_dect_phy_tx_rx_params {
        struct nrf_modem_dect_phy_tx_params tx;
        struct nrf_modem_dect_phy_rx_params rx;
};
 
struct nrf_modem_dect_phy_rssi_params {
        uint64_t start_time;
        uint32_t handle;
        uint16_t carrier;
        uint32_t duration;
        enum nrf_modem_dect_phy_rssi_interval reporting_interval;
};
 
enum nrf_modem_dect_phy_radio_mode {
        NRF_MODEM_DECT_PHY_RADIO_MODE_LOW_LATENCY,
        NRF_MODEM_DECT_PHY_RADIO_MODE_LOW_LATENCY_WITH_STANDBY,
        NRF_MODEM_DECT_PHY_RADIO_MODE_NON_LBT_WITH_STANDBY,
        NRF_MODEM_DECT_PHY_RADIO_MODE_COUNT,
};
 
struct nrf_modem_dect_phy_radio_config_params {
        uint64_t start_time;
        uint32_t handle;
        enum nrf_modem_dect_phy_radio_mode radio_mode;
};
 
struct nrf_modem_dect_phy_latency_info {
        struct {
                uint32_t scheduled_operation_transition;
                uint32_t scheduled_operation_startup;
                uint32_t radio_mode_transition[NRF_MODEM_DECT_PHY_RADIO_MODE_COUNT];
        } radio_mode[NRF_MODEM_DECT_PHY_RADIO_MODE_COUNT];
 
        struct {
                struct {
                        uint32_t idle_to_active;
                        uint32_t active_to_idle_rssi;
                        uint32_t active_to_idle_rx;
                        uint32_t active_to_idle_rx_rssi;
                        uint32_t stop_to_rf_off;
                } receive;
                struct {
                        uint32_t idle_to_active;
                        uint32_t active_to_idle;
                } transmit;
        } operation;
 
        struct {
                uint32_t initialization;
                uint32_t deinitialization;
                uint32_t configuration;
                uint32_t activation;
                uint32_t deactivation;
        } stack;
};
 
struct nrf_modem_dect_phy_link_config_params {
        struct nrf_modem_dect_phy_link_id primary_link_id;
        uint8_t secondary_link_count;
        struct nrf_modem_dect_phy_link_id secondary_link_ids[];
};
 
struct nrf_modem_dect_phy_init_event {
        enum nrf_modem_dect_phy_err err;
        int16_t temp;
        uint16_t voltage;
        uint16_t temperature_limit;
};
 
struct nrf_modem_dect_phy_op_complete_event {
        uint32_t handle;
        enum nrf_modem_dect_phy_err err;
        int16_t temp;
        uint16_t voltage;
};
 
struct nrf_modem_dect_phy_rssi_event {
        uint32_t handle;
        uint64_t meas_start_time;
        uint16_t carrier;
        uint16_t meas_len;
        int8_t *meas;
};
 
struct nrf_modem_dect_phy_cancel_event {
        uint32_t handle;
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_pcc_event {
        uint64_t stf_start_time;
        uint32_t handle;
        enum nrf_modem_dect_phy_hdr_status header_status;
        uint8_t phy_type;
        union nrf_modem_dect_phy_hdr hdr;
        int16_t rssi_2;
        int16_t snr;
        uint16_t transaction_id;
};
 
struct nrf_modem_dect_phy_pcc_crc_failure_event {
        uint64_t stf_start_time;
        uint32_t handle;
        int16_t rssi_2;
        int16_t snr;
        uint16_t transaction_id;
};
 
struct nrf_modem_dect_phy_pdc_event {
        uint32_t handle;
        int16_t rssi_2;
        int16_t snr;
        uint16_t transaction_id;
        void *data;
        size_t len;
};
 
struct nrf_modem_dect_phy_pdc_crc_failure_event {
        uint32_t handle;
        int16_t rssi_2;
        int16_t snr;
        uint16_t transaction_id;
};
 
struct nrf_modem_dect_phy_configure_event {
        enum nrf_modem_dect_phy_err err;
        int16_t temp;
        uint16_t voltage;
};
 
struct nrf_modem_dect_phy_radio_config_event {
        uint32_t handle;
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_link_config_event {
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_time_get_event {
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_capability_get_event {
        enum nrf_modem_dect_phy_err err;
        struct nrf_modem_dect_phy_capability *capability;
};
 
struct nrf_modem_dect_phy_band_get_event {
        enum nrf_modem_dect_phy_err err;
        uint32_t supported_bands;
        uint32_t band_count;
        struct nrf_modem_dect_phy_band *band;
};
 
enum nrf_modem_dect_phy_test_rf_tx_cw_oper {
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_OPER_ON,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_OPER_OFF,
};
 
enum nrf_modem_dect_phy_test_rf_tx_cw_err {
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_NO_ERROR = 0,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_ERROR = -1,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_TX_ALREADY_ON = -100,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_TX_ALREADY_OFF = -101,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_BUFFER_RESERVE_FAILED = -102,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_INVALID_OPERATION = -103,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_DSP_CONFIG_FAILURE = -104,
        NRF_MODEM_DECT_PHY_TEST_RF_TX_CW_ERR_MSG_SEND_FAILED = -105,
};
 
struct nrf_modem_dect_phy_test_rf_tx_cw_control_event {
        enum nrf_modem_dect_phy_test_rf_tx_cw_err err;
};
 
struct nrf_modem_dect_phy_stf_control_event {
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_deinit_event {
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_activate_event {
        enum nrf_modem_dect_phy_err err;
        int16_t temp;
        uint16_t voltage;
};
 
struct nrf_modem_dect_phy_deactivate_event {
        enum nrf_modem_dect_phy_err err;
};
 
struct nrf_modem_dect_phy_latency_info_event {
        enum nrf_modem_dect_phy_err err;
        struct nrf_modem_dect_phy_latency_info *latency_info;
};
 
struct nrf_modem_dect_phy_reject_event {
        enum nrf_modem_dect_phy_err err;
};
 
enum nrf_modem_dect_phy_event_id {
        NRF_MODEM_DECT_PHY_EVT_INIT,
        NRF_MODEM_DECT_PHY_EVT_DEINIT,
        NRF_MODEM_DECT_PHY_EVT_CONFIGURE,
        NRF_MODEM_DECT_PHY_EVT_RADIO_CONFIG,
        NRF_MODEM_DECT_PHY_EVT_ACTIVATE,
        NRF_MODEM_DECT_PHY_EVT_DEACTIVATE,
        NRF_MODEM_DECT_PHY_EVT_COMPLETED,
        NRF_MODEM_DECT_PHY_EVT_CANCELED,
        NRF_MODEM_DECT_PHY_EVT_RSSI,
        NRF_MODEM_DECT_PHY_EVT_PCC,
        NRF_MODEM_DECT_PHY_EVT_PCC_ERROR,
        NRF_MODEM_DECT_PHY_EVT_PDC,
        NRF_MODEM_DECT_PHY_EVT_PDC_ERROR,
        NRF_MODEM_DECT_PHY_EVT_TIME,
        NRF_MODEM_DECT_PHY_EVT_CAPABILITY,
        NRF_MODEM_DECT_PHY_EVT_BANDS,
        NRF_MODEM_DECT_PHY_EVT_LATENCY,
        NRF_MODEM_DECT_PHY_EVT_LINK_CONFIG,
        NRF_MODEM_DECT_PHY_EVT_STF_CONFIG,
        NRF_MODEM_DECT_PHY_EVT_TEST_RF_TX_CW_CONTROL_CONFIG,
        NRF_MODEM_DECT_PHY_EVT_REJECT,
};
 
struct nrf_modem_dect_phy_event {
        enum nrf_modem_dect_phy_event_id id;
        uint64_t time;
        union {
                struct nrf_modem_dect_phy_init_event init;
                struct nrf_modem_dect_phy_deinit_event deinit;
                struct nrf_modem_dect_phy_activate_event activate;
                struct nrf_modem_dect_phy_deactivate_event deactivate;
                struct nrf_modem_dect_phy_configure_event configure;
                struct nrf_modem_dect_phy_radio_config_event radio_config;
                struct nrf_modem_dect_phy_op_complete_event op_complete;
                struct nrf_modem_dect_phy_rssi_event rssi;
                struct nrf_modem_dect_phy_cancel_event cancel;
                struct nrf_modem_dect_phy_pcc_event pcc;
                struct nrf_modem_dect_phy_pcc_crc_failure_event pcc_crc_err;
                struct nrf_modem_dect_phy_pdc_event pdc;
                struct nrf_modem_dect_phy_pdc_crc_failure_event pdc_crc_err;
                struct nrf_modem_dect_phy_time_get_event time_get;
                struct nrf_modem_dect_phy_capability_get_event capability_get;
                struct nrf_modem_dect_phy_band_get_event band_get;
                struct nrf_modem_dect_phy_latency_info_event latency_get;
                struct nrf_modem_dect_phy_test_rf_tx_cw_control_event test_rf_tx_cw_control;
                struct nrf_modem_dect_phy_stf_control_event stf_cover_seq_control;
                struct nrf_modem_dect_phy_link_config_event link_config;
                struct nrf_modem_dect_phy_reject_event reject;
        };
};
 
struct nrf_modem_dect_phy_config_params {
        uint8_t band_group_index;
        uint8_t harq_rx_process_count;
        uint32_t harq_rx_expiry_time_us;
};
 
typedef void (*nrf_modem_dect_phy_event_handler_t)(const struct nrf_modem_dect_phy_event *event);
 
int nrf_modem_dect_phy_event_handler_set(nrf_modem_dect_phy_event_handler_t handler);
 
int nrf_modem_dect_phy_capability_get(void);
 
int nrf_modem_dect_phy_init(void);
 
int nrf_modem_dect_phy_deinit(void);
 
int nrf_modem_dect_phy_activate(enum nrf_modem_dect_phy_radio_mode mode);
 
int nrf_modem_dect_phy_deactivate(void);
 
int nrf_modem_dect_phy_rx(const struct nrf_modem_dect_phy_rx_params *params);
 
int nrf_modem_dect_phy_tx(const struct nrf_modem_dect_phy_tx_params *params);
 
int nrf_modem_dect_phy_tx_harq(const struct nrf_modem_dect_phy_tx_params *params);
 
int nrf_modem_dect_phy_tx_rx(const struct nrf_modem_dect_phy_tx_rx_params *params);
 
int nrf_modem_dect_phy_rssi(const struct nrf_modem_dect_phy_rssi_params *params);
 
int nrf_modem_dect_phy_cancel(uint32_t handle);
 
int nrf_modem_dect_phy_configure(const struct nrf_modem_dect_phy_config_params *params);
 
int nrf_modem_dect_phy_radio_config(const struct nrf_modem_dect_phy_radio_config_params *params);
 
int nrf_modem_dect_phy_link_config(const struct nrf_modem_dect_phy_link_config_params *params);
 
int nrf_modem_dect_phy_band_get(void);
 
int nrf_modem_dect_phy_latency_get(void);
 
int nrf_modem_dect_phy_time_get(void);
 
int nrf_modem_dect_phy_test_rf_tx_cw_control(enum nrf_modem_dect_phy_test_rf_tx_cw_oper operation,
                                        uint16_t carrier, int8_t power);
 
int nrf_modem_dect_phy_stf_cover_seq_control(bool rx_enable, bool tx_enable);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_DECT_PHY_H__ */