DECT PHY API. More...

Data Structures
struct	nrf_modem_dect_phy_capability
	Modem PHY capabilities. More...

struct	nrf_modem_dect_phy_band
	Band information. More...

struct	nrf_modem_dect_phy_hdr_type_1
	Physical header type 1. More...

union	nrf_modem_dect_phy_feedback
	Feedback format types. More...

struct	nrf_modem_dect_phy_hdr_type_2
	Physical header type 2. More...

union	nrf_modem_dect_phy_hdr
	Physical header. More...

struct	nrf_modem_dect_phy_link_id
	Radio link identifier. More...

struct	nrf_modem_dect_phy_rx_filter
	Specification for reception filter. More...

struct	nrf_modem_dect_phy_rx_params
	RX operation. More...

struct	nrf_modem_dect_phy_tx_params
	TX operation. More...

struct	nrf_modem_dect_phy_tx_rx_params
	Combined TX and RX operation. More...

struct	nrf_modem_dect_phy_rssi_params
	RSSI-1 measurement operation. More...

struct	nrf_modem_dect_phy_radio_config_params
	Radio configuration operation. More...

struct	nrf_modem_dect_phy_latency_info
	DECT PHY latency information. More...

struct	nrf_modem_dect_phy_link_config_params
	Link configuration parameters. More...

struct	nrf_modem_dect_phy_init_event
	Initialization event. More...

struct	nrf_modem_dect_phy_op_complete_event
	Operation complete event. More...

struct	nrf_modem_dect_phy_rssi_event
	RSSI measurement event. More...

struct	nrf_modem_dect_phy_cancel_event

struct	nrf_modem_dect_phy_pcc_event
	PCC reception event. More...

struct	nrf_modem_dect_phy_pcc_crc_failure_event
	PCC reception CRC failure event. More...

struct	nrf_modem_dect_phy_pdc_event
	PDC reception event. More...

struct	nrf_modem_dect_phy_pdc_crc_failure_event
	PDC CRC failure event. More...

struct	nrf_modem_dect_phy_configure_event
	DECT PHY stack configuration event. More...

struct	nrf_modem_dect_phy_radio_config_event
	Radio configuration event. More...

struct	nrf_modem_dect_phy_link_config_event

struct	nrf_modem_dect_phy_time_get_event
	Time get event. More...

struct	nrf_modem_dect_phy_capability_get_event
	Capability get event. More...

struct	nrf_modem_dect_phy_band_get_event
	Band information event. More...

struct	nrf_modem_dect_phy_test_rf_tx_cw_control_event
	Test RF TX CW control event. More...

struct	nrf_modem_dect_phy_stf_control_event
	STF cover sequence control event. More...

struct	nrf_modem_dect_phy_deinit_event
	Deinitialization event. More...

struct	nrf_modem_dect_phy_activate_event
	Activation event. More...

struct	nrf_modem_dect_phy_deactivate_event
	Deactivation event. More...

struct	nrf_modem_dect_phy_latency_info_event
	Latency event. More...

struct	nrf_modem_dect_phy_reject_event
	Reject event. More...

struct	nrf_modem_dect_phy_event
	DECT PHY event. More...

struct	nrf_modem_dect_phy_config_params
	DECT PHY configuration parameters. More...

Macros
#define	NRF_MODEM_DECT_MODEM_TIME_TICK_RATE_KHZ 69120
	Modem time tick rate.

#define	NRF_MODEM_DECT_SYMBOL_DURATION 2880
	Duration of a single DECT symbol in modem time units.

#define	NRF_MODEM_DECT_LBT_PERIOD_MAX (110 * NRF_MODEM_DECT_SYMBOL_DURATION)
	Maximum LBT measurement period in modem time units.

#define	NRF_MODEM_DECT_LBT_PERIOD_MIN (2 * NRF_MODEM_DECT_SYMBOL_DURATION)
	Minimum LBT measurement period in modem time units.

#define	NRF_MODEM_DECT_PHY_SNR_NOT_MEASURED -32768
	Signal to noise ratio not measured.

#define	NRF_MODEM_DECT_PHY_RSSI_NOT_MEASURED 0
	Symbol RSSI not measured.

#define	NRF_MODEM_DECT_PHY_RSSI2_NOT_MEASURED -32768
	RSSI-2 not measured.

#define	NRF_MODEM_DECT_PHY_TEMP_NOT_MEASURED 999
	Temperature not measured.

#define	NRF_MODEM_DECT_PHY_VOLTAGE_NOT_MEASURED 0
	Voltage not measured.

#define	NRF_MODEM_DECT_PHY_HANDLE_CANCEL_ALL UINT32_MAX
	Special handle to cancel all operations in nrf_modem_dect_phy_cancel.

#define	NRF_MODEM_DECT_PHY_BS_CQI_NOT_USED 0
	Buffer status and Channel quality indicator not used.

#define	NRF_MODEM_DECT_PHY_LINK_UNSPECIFIED ((struct nrf_modem_dect_phy_link_id){ 0 })
	Unspecified link identifier.

Typedefs
typedef void(*	nrf_modem_dect_phy_event_handler_t) (const struct nrf_modem_dect_phy_event *event)
	Application handler prototype for PHY events.

Enumerations
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 }
	DECT PHY errors. More...

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 }
	Reception mode. More...

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 }
	RSSI reporting interval. More...

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 }
	Physical header status. More...

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 }
	Radio modes. More...

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 }
	Test RF TX CW operation codes. More...

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 }
	Test RF TX CW operation status codes. More...

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 }

Functions
int	nrf_modem_dect_phy_event_handler_set (nrf_modem_dect_phy_event_handler_t handler)
	Set the application event handler for PHY events.

int	nrf_modem_dect_phy_capability_get (void)
	Retrieve DECT PHY capabilities.

int	nrf_modem_dect_phy_init (void)
	Initialize the DECT PHY interface.

int	nrf_modem_dect_phy_deinit (void)
	Deinitialize the DECT PHY interface.

int	nrf_modem_dect_phy_activate (enum nrf_modem_dect_phy_radio_mode mode)
	Activate the DECT PHY software stack in given radio mode.

int	nrf_modem_dect_phy_deactivate (void)
	Deactivate the DECT PHY software stack.

int	nrf_modem_dect_phy_rx (const struct nrf_modem_dect_phy_rx_params *params)
	Schedule a reception.

int	nrf_modem_dect_phy_tx (const struct nrf_modem_dect_phy_tx_params *params)
	Schedule a transmission.

int	nrf_modem_dect_phy_tx_harq (const struct nrf_modem_dect_phy_tx_params *params)
	Schedule a HARQ response TX operation.

int	nrf_modem_dect_phy_tx_rx (const struct nrf_modem_dect_phy_tx_rx_params *params)
	Schedule one TX and one RX operation.

int	nrf_modem_dect_phy_rssi (const struct nrf_modem_dect_phy_rssi_params *params)
	Schedule an RSSI measurement operation.

int	nrf_modem_dect_phy_cancel (uint32_t handle)
	Cancel an operation.

int	nrf_modem_dect_phy_configure (const struct nrf_modem_dect_phy_config_params *params)
	Configure the PHY stack.

int	nrf_modem_dect_phy_radio_config (const struct nrf_modem_dect_phy_radio_config_params *params)
	Configure radio mode.

int	nrf_modem_dect_phy_link_config (const struct nrf_modem_dect_phy_link_config_params *params)
	Configure links.

int	nrf_modem_dect_phy_band_get (void)
	Retrieve band information.

int	nrf_modem_dect_phy_latency_get (void)
	Retrieve latency information.

int	nrf_modem_dect_phy_time_get (void)
	Retrieve modem time.

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)
	Control continuous wave transmission.

int	nrf_modem_dect_phy_stf_cover_seq_control (bool rx_enable, bool tx_enable)
	STF cover sequence control.

Detailed Description

DECT PHY API.

Note

This is only supported by the following modem firmware:

mfw-nr+_nrf91x1

Links to pertaining specification and regulations.

[DECT-2020 NR Part 2: Radio reception and transmission requirements] (https://www.etsi.org/deliver/etsi_ts/103600_103699/10363602/01.05.01_60/ts_10363602v010501p.pdf)
[DECT-2020 NR Part 4: MAC specification] (https://www.etsi.org/deliver/etsi_ts/103600_103699/10363604/01.05.01_60/ts_10363604v010501p.pdf)
[DECT Harmonised Standard for access to radio spectrum; Part 2: DECT-2020 NR ] (https://etsi.org/deliver/etsi_en/301400_301499/30140602/03.01.01_60/en_30140602v030101p.pdf)
[47 CFR Part 15.323] (https://www.ecfr.gov/current/title-47/section-15.323)

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description