sdc.h

Go to the documentation of this file.

/*
 * Copyright (c) Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 

 
 
#ifndef SDC_H__
#define SDC_H__
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#include <stdint.h>
#include <stdbool.h>
#include "nrf_errno.h"

#define SDC_DEFAULT_RESOURCE_CFG_TAG  0

#define SDC_DEFAULT_ADV_COUNT     1

#define SDC_DEFAULT_PERIODIC_ADV_COUNT 0

#define SDC_DEFAULT_PERIODIC_SYNC_COUNT 0

#define SDC_DEFAULT_PERIODIC_ADV_RSP_COUNT 0

#define SDC_DEFAULT_PERIODIC_ADV_RSP_TX_BUFFER_COUNT 1

#define SDC_DEFAULT_PERIODIC_ADV_RSP_MAX_TX_DATA 73

#define SDC_DEFAULT_PERIODIC_ADV_RSP_RX_BUFFER_COUNT 0

#define SDC_DEFAULT_PERIODIC_SYNC_RSP_TX_BUFFER_COUNT 1

#define SDC_DEFAULT_PERIPHERAL_COUNT   1

#define SDC_DEFAULT_CENTRAL_COUNT  1

#define SDC_DEFAULT_TX_PACKET_SIZE 27

#define SDC_DEFAULT_RX_PACKET_SIZE 27

#define SDC_DEFAULT_TX_PACKET_COUNT 3

#define SDC_DEFAULT_RX_PACKET_COUNT 2

#define SDC_DEFAULT_FAL_SIZE 8

#define SDC_DEFAULT_SCAN_BUFFER_COUNT 3

#define SDC_DEFAULT_PERIODIC_SYNC_BUFFER_COUNT 2

#define SDC_DEFAULT_ADV_BUF_SIZE 31

#define SDC_DEFAULT_PERIODIC_ADV_LIST_SIZE 0

#define SDC_DEFAULT_CIG_COUNT 0

#define SDC_DEFAULT_CIS_COUNT 0

#define SDC_DEFAULT_BIG_COUNT 0

#define SDC_DEFAULT_BIS_SINK_COUNT 0

#define SDC_DEFAULT_BIS_SOURCE_COUNT 0

#define SDC_DEFAULT_ISO_RX_PDU_BUFFER_PER_STREAM_COUNT 0

#define SDC_DEFAULT_ISO_RX_SDU_BUFFER_COUNT 0

#define SDC_DEFAULT_ISO_RX_SDU_BUFFER_SIZE 251

#define SDC_DEFAULT_ISO_TX_SDU_BUFFER_COUNT 0

#define SDC_DEFAULT_ISO_TX_SDU_BUFFER_SIZE 247

#define SDC_DEFAULT_ISO_TX_PDU_BUFFER_PER_STREAM_COUNT 0

#define SDC_DEFAULT_CS_COUNT 0

#define SDC_DEFAULT_CS_MAX_ANTENNA_PATHS_SUPPORTED 1

#define SDC_DEFAULT_CS_NUM_ANTENNAS_SUPPORTED 1

#define SDC_DEFAULT_EXTENDED_FEATURE_PAGE_COUNT 10

#define SDC_BUILD_REVISION_SIZE 20

#define SDC_DEFAULT_SCAN_DECISION_INSTRUCTIONS_COUNT 8


#define __MEM_MINIMAL_CENTRAL_LINK_SIZE    803
#define __MEM_MINIMAL_PERIPHERAL_LINK_SIZE 883
#define __MEM_TX_BUFFER_OVERHEAD_SIZE 15
#define __MEM_RX_BUFFER_OVERHEAD_SIZE 15
 
#define __MEM_ADDITIONAL_LINK_SIZE(tx_size, rx_size, tx_count, rx_count) \
    ((tx_count) * ((tx_size) + __MEM_TX_BUFFER_OVERHEAD_SIZE) - \
     (SDC_DEFAULT_TX_PACKET_SIZE + __MEM_TX_BUFFER_OVERHEAD_SIZE) + \
     (rx_count) * ((rx_size) + __MEM_RX_BUFFER_OVERHEAD_SIZE) - \
     (SDC_DEFAULT_RX_PACKET_SIZE + __MEM_RX_BUFFER_OVERHEAD_SIZE))

#define SDC_MEM_PER_CENTRAL_LINK(tx_size, rx_size, tx_count, rx_count) \
    (__MEM_MINIMAL_CENTRAL_LINK_SIZE + \
     __MEM_ADDITIONAL_LINK_SIZE(tx_size, rx_size, tx_count, rx_count))

#define SDC_MEM_PER_PERIPHERAL_LINK(tx_size, rx_size, tx_count, rx_count) \
    (__MEM_MINIMAL_PERIPHERAL_LINK_SIZE + \
     __MEM_ADDITIONAL_LINK_SIZE(tx_size, rx_size, tx_count, rx_count))

#define SDC_MEM_CENTRAL_LINKS_SHARED 21

#define SDC_MEM_PERIPHERAL_LINKS_SHARED  17

#define SDC_MEM_LE_POWER_CONTROL(num_links) ((num_links) > 0 ? (13 + (num_links) * 123) : 0)

#define SDC_MEM_SUBRATING(num_links) ((num_links) > 0 ? (12 + (num_links) * 60) : 0)

#define SDC_MEM_CHANNEL_CLASSIFICATION(num_links) ((num_links) > 0 ? (13 + (num_links) * 67) : 0)

#define SDC_MEM_SYNC_TRANSFER(num_links) ((num_links) > 0 ? (13 + (num_links) * 139) : 0)

#define __MEM_PER_EXTENDED_FEATURE_PAGE 24

#define SDC_MEM_EXTENDED_FEATURE_SET(num_links, num_pages) \
     ((num_links) > 0 ? (11 + (num_links) * (19 + (num_pages) * __MEM_PER_EXTENDED_FEATURE_PAGE)) : 0)

#define SDC_MEM_FRAME_SPACE_UPDATE(num_links) ((num_links) > 0 ? (12 + (num_links) * 68) : 0)

#define SDC_MEM_SHORTER_CONNECTION_INTERVALS(num_links) ((num_links) > 0 ? (12 + (num_links) * 52) : 0)

#define SDC_MEM_QOS_CHANNEL_SURVEY (40)

#define SDC_MEM_SCAN(buffer_count) (408 + (buffer_count) * 104)

#define SDC_MEM_SCAN_EXT(buffer_count) (408 + (buffer_count) * 320)

#define SDC_MEM_INITIATOR (384)

#define SDC_MEM_FAL(max_num_entries) ((max_num_entries) > 0 ? (4 + (max_num_entries) * 8) : 0)

#define __MEM_PER_ADV_SET_LOW(max_adv_data) ((5184+(max_adv_data)*18)/10)
#define __MEM_PER_ADV_SET_HIGH(max_adv_data) (706+(max_adv_data))
#define __MEM_PER_PERIODIC_ADV_SET_LOW(max_adv_data) ((3104+(max_adv_data)*18)/10)
#define __MEM_PER_PERIODIC_ADV_SET_HIGH(max_adv_data) (498+(max_adv_data))

#define SDC_MEM_PER_ADV_SET(max_adv_data) ((max_adv_data<255)?\
    (__MEM_PER_ADV_SET_LOW(max_adv_data)):\
    (__MEM_PER_ADV_SET_HIGH(max_adv_data)))

#define SDC_MEM_PER_PERIODIC_ADV_SET(max_adv_data) ((max_adv_data<255)?\
     (__MEM_PER_PERIODIC_ADV_SET_LOW(max_adv_data)):\
     (__MEM_PER_PERIODIC_ADV_SET_HIGH(max_adv_data)))

#define SDC_MEM_PER_PERIODIC_SYNC(buffer_count) (254 + (buffer_count) * 278)

#define SDC_MEM_PER_PERIODIC_SYNC_RSP(tx_buffer_count, rx_buffer_count) \
    (420 + (tx_buffer_count) * 254 + (rx_buffer_count) * 278)

#define SDC_MEM_PERIODIC_ADV_LIST(list_size) ((list_size) * 8)

#define __MEM_PER_PERIODIC_ADV_RSP_TX_BUFFER(max_tx_data_size) ((max_tx_data_size) + 5)
#define __MEM_PER_PERIODIC_ADV_RSP_RX_BUFFER (282)
#define __MEM_MINIMAL_PERIODIC_ADV_RSP_SET_SIZE_WITH_RX (188)
#define __MEM_MINIMAL_PERIODIC_ADV_RSP_SET_SIZE_WITHOUT_RX (170)
#define __MEM_FOR_PERIODIC_ADV_RSP_FAILURE_REPORTING (224)
#define __MEM_PER_ISO_PDU_POOL(count) ((count) > 0 ? (16 + (count) * 288) : 0)

#define SDC_MEM_PER_PERIODIC_ADV_RSP_SET(max_adv_data, tx_buffer_count, rx_buffer_count, max_tx_data_size, failure_reporting_enabled) \
     (SDC_MEM_PER_PERIODIC_ADV_SET(max_adv_data) \
     + ((rx_buffer_count) > 0 ? __MEM_MINIMAL_PERIODIC_ADV_RSP_SET_SIZE_WITH_RX : \
                             __MEM_MINIMAL_PERIODIC_ADV_RSP_SET_SIZE_WITHOUT_RX ) \
     + (tx_buffer_count) * __MEM_PER_PERIODIC_ADV_RSP_TX_BUFFER(max_tx_data_size) \
     + (rx_buffer_count) * __MEM_PER_PERIODIC_ADV_RSP_RX_BUFFER \
     + ((failure_reporting_enabled) ? __MEM_FOR_PERIODIC_ADV_RSP_FAILURE_REPORTING : 0))

#define SDC_MEM_PER_CIG(count) ((count) > 0 ? (13 + (count) * 163) : 0)

#define SDC_MEM_PER_CIS(count) ((count) > 0 ? (13 + (count) * 547) : 0)

#define SDC_MEM_PER_BIG(count) ((count) > 0 ? (13 + (count) * 331) : 0)

#define SDC_MEM_PER_BIS(count) ((count) > 0 ? (13 + (count) * 259) : 0)

#define SDC_MEM_ISO_RX_PDU_POOL_PER_STREAM_SIZE(rx_pdu_buffer_per_stream_count, cis_count, bis_sink_count)     \
      (__MEM_PER_ISO_PDU_POOL(rx_pdu_buffer_per_stream_count) * ((cis_count) + (bis_sink_count)))

#define SDC_MEM_ISO_RX_SDU_POOL_SIZE(count, size) ((count) > 0 ? (8 + (count) * ((size) + 13)) : 0)

#define SDC_MEM_ISO_TX_PDU_POOL_SIZE(tx_pdu_buffer_per_stream_count, cis_count, bis_source_count)     \
      ((tx_pdu_buffer_per_stream_count) > 0 ? \
       __MEM_PER_ISO_PDU_POOL(tx_pdu_buffer_per_stream_count) * ((cis_count) + (bis_source_count)) : 0)

#define SDC_MEM_ISO_TX_SDU_POOL_SIZE(count, size) ((count) > 0 ? (12 + (count) * ((size) + 49)) : 0)

#define __MEM_CS_ANTENNA_PATHS(max_antenna_paths_supported) (((max_antenna_paths_supported) - 1) * 1024)
#define __MEM_CS_STEP_MODE3(step_mode3_supported) ((step_mode3_supported) ? 1536 : 0)

#define SDC_MEM_CS(count, max_antenna_paths_supported, step_mode3_supported) \
     ((count) > 0 ? (13 + (count) * (4283 + __MEM_CS_ANTENNA_PATHS(max_antenna_paths_supported) \
      + __MEM_CS_STEP_MODE3(step_mode3_supported))) : 0)

#define SDC_MEM_CS_SETUP_PHASE_LINKS(count) ((count) > 0 ? (11 + (count) * 379) : 0)

#define SDC_MEM_SCAN_DECISION_INSTRUCTIONS(num_tests) (17 + (num_tests) * 19)


typedef void (*sdc_fault_handler_t)(const char * file, const uint32_t line);
 

typedef void (*sdc_callback_t)(void);
 

typedef void (*sdc_cs_antenna_switch_callback_t)(uint8_t antenna_index);
 
 
enum sdc_cfg_type
{
    SDC_CFG_TYPE_NONE = 0,
    SDC_CFG_TYPE_CENTRAL_COUNT,
    SDC_CFG_TYPE_PERIPHERAL_COUNT,
    SDC_CFG_TYPE_BUFFER_CFG,
    SDC_CFG_TYPE_ADV_COUNT,
    SDC_CFG_TYPE_SCAN_BUFFER_CFG,
    SDC_CFG_TYPE_ADV_BUFFER_CFG,
    SDC_CFG_TYPE_FAL_SIZE,
    SDC_CFG_TYPE_PERIODIC_ADV_COUNT,
    SDC_CFG_TYPE_PERIODIC_SYNC_COUNT,
    SDC_CFG_TYPE_PERIODIC_SYNC_BUFFER_CFG,
    SDC_CFG_TYPE_PERIODIC_ADV_LIST_SIZE,
    SDC_CFG_TYPE_PERIODIC_ADV_RSP_COUNT,
    SDC_CFG_TYPE_PERIODIC_ADV_RSP_BUFFER_CFG,
    SDC_CFG_TYPE_PERIODIC_ADV_RSP_FAILURE_REPORTING_CFG,
    SDC_CFG_TYPE_PERIODIC_SYNC_RSP_TX_BUFFER_CFG,
    SDC_CFG_TYPE_CIG_COUNT,
    SDC_CFG_TYPE_CIS_COUNT,
    SDC_CFG_TYPE_BIG_COUNT,
    SDC_CFG_TYPE_BIS_SINK_COUNT,
    SDC_CFG_TYPE_BIS_SOURCE_COUNT,
    SDC_CFG_TYPE_ISO_BUFFER_CFG,
    SDC_CFG_TYPE_CS_COUNT,
    SDC_CFG_TYPE_CS_CFG,
    SDC_CFG_TYPE_EXTENDED_FEATURE_PAGE_COUNT,
    SDC_CFG_TYPE_SCAN_DECISION_INSTRUCTIONS_COUNT,
};
 

typedef struct
{
    uint8_t count;   
} sdc_cfg_role_count_t;
 

typedef struct
{
    uint16_t tx_packet_size; 
    uint16_t rx_packet_size; 
    uint8_t tx_packet_count; 
    uint8_t rx_packet_count; 
} sdc_cfg_buffer_cfg_t;
 

typedef struct
{
    uint8_t count;   
} sdc_cfg_buffer_count_t;
 
 
typedef struct
{
    uint16_t max_adv_data;
} sdc_cfg_adv_buffer_cfg_t;
 
 
typedef struct
{
    uint8_t tx_buffer_count;
    uint8_t max_tx_data_size;
    uint8_t rx_buffer_count;
} sdc_cfg_periodic_adv_rsp_buffer_cfg_t;
 
 
typedef struct
{
    uint8_t tx_sdu_buffer_count;
    uint16_t tx_sdu_buffer_size;
    uint8_t tx_pdu_buffer_per_stream_count;
    uint8_t rx_pdu_buffer_per_stream_count;
    uint8_t rx_sdu_buffer_count;
    uint16_t rx_sdu_buffer_size;
} sdc_cfg_iso_buffer_cfg_t;
 
 
typedef struct
{
    uint8_t max_antenna_paths_supported;
    uint8_t num_antennas_supported;
} sdc_cfg_cs_cfg_t;
 

typedef union
{
    sdc_cfg_role_count_t   central_count;
    sdc_cfg_role_count_t   peripheral_count;
    sdc_cfg_buffer_cfg_t   buffer_cfg;
    sdc_cfg_role_count_t   adv_count;
    sdc_cfg_buffer_count_t scan_buffer_cfg;
    sdc_cfg_adv_buffer_cfg_t adv_buffer_cfg;
    uint16_t fal_size;
    sdc_cfg_role_count_t periodic_adv_count;
    sdc_cfg_role_count_t periodic_sync_count;
    sdc_cfg_buffer_count_t periodic_sync_buffer_cfg;
    uint8_t periodic_adv_list_size;
    sdc_cfg_role_count_t periodic_adv_rsp_count;
    sdc_cfg_periodic_adv_rsp_buffer_cfg_t periodic_adv_rsp_buffer_cfg;
    uint8_t periodic_adv_rsp_failure_reporting_cfg;
    sdc_cfg_buffer_count_t periodic_sync_rsp_tx_buffer_cfg;
    sdc_cfg_role_count_t cig_count;
    sdc_cfg_role_count_t cis_count;
    sdc_cfg_role_count_t big_count;
    sdc_cfg_role_count_t bis_sink_count;
    sdc_cfg_role_count_t bis_source_count;
    sdc_cfg_iso_buffer_cfg_t iso_buffer_cfg;
    sdc_cfg_role_count_t cs_count;
    sdc_cfg_cs_cfg_t cs_cfg;
    uint8_t extended_feature_page_count;
    uint8_t scan_decision_instructions_count;
} sdc_cfg_t;
 

int32_t sdc_init(sdc_fault_handler_t fault_handler);
 

int32_t sdc_cfg_set(uint8_t config_tag,
                    uint8_t config_type,
                    sdc_cfg_t const * p_resource_cfg);
 

int32_t sdc_enable(sdc_callback_t callback,
                   uint8_t * p_mem);
 

int32_t sdc_disable(void);
 

int32_t sdc_build_revision_get(uint8_t * p_build_revision);

void sdc_iso_host_timestamps_ignore(bool ignore);

int32_t sdc_default_tx_power_set(int8_t requested_power_level);

void sdc_cs_antenna_switch_callback_set(sdc_cs_antenna_switch_callback_t antenna_switch_cb);

void sdc_use_global_channel_map_on_connection(void);

int32_t sdc_support_helper(void (*sdc_support_func)(void));

void sdc_support_adv(void);

void sdc_support_ext_adv(void);

void sdc_support_peripheral(void);

void sdc_support_scan(void);

void sdc_support_ext_scan(void);

void sdc_support_central(void);

void sdc_support_ext_central(void);

void sdc_support_parallel_scanning_and_initiating(void);

void sdc_support_le_power_class_1(void);

void sdc_support_dle_central(void);

void sdc_support_dle_peripheral(void);

void sdc_support_le_2m_phy(void);

void sdc_support_le_coded_phy(void);

void sdc_support_phy_update_central(void);

void sdc_support_phy_update_peripheral(void);

void sdc_support_le_periodic_adv(void);

void sdc_support_le_periodic_sync(void);

void sdc_support_le_periodic_adv_with_rsp(void);

void sdc_support_le_periodic_sync_with_rsp(void);

void sdc_support_le_power_control_central(void);

void sdc_support_le_power_control_peripheral(void);

void sdc_support_le_path_loss_monitoring(void);

void sdc_support_sca_central(void);

void sdc_support_sca_peripheral(void);

void sdc_support_le_conn_cte_rsp_central(void);

void sdc_support_le_conn_cte_rsp_peripheral(void);

void sdc_support_le_connectionless_cte_transmitter(void);

void sdc_support_le_privacy(void);

void sdc_support_periodic_adv_sync_transfer_sender_central(void);

void sdc_support_periodic_adv_sync_transfer_sender_peripheral(void);

void sdc_support_periodic_adv_sync_transfer_receiver_central(void);

void sdc_support_periodic_adv_sync_transfer_receiver_peripheral(void);

void sdc_support_cis_peripheral(void);

void sdc_support_cis_central(void);

void sdc_support_bis_source(void);

void sdc_support_bis_sink(void);

void sdc_support_qos_channel_survey(void);

void sdc_support_chan_idx_in_adv_report(void);

void sdc_support_connection_subrating_central(void);

void sdc_support_connection_subrating_peripheral(void);

void sdc_support_channel_classification_central(void);

void sdc_support_channel_classification_peripheral(void);

__attribute__((deprecated)) void sdc_support_extended_feature_set(void);

void sdc_support_extended_feature_set_central(void);

void sdc_support_extended_feature_set_peripheral(void);

void sdc_support_frame_space_update_central(void);

void sdc_support_frame_space_update_peripheral(void);

 void sdc_support_lowest_frame_space(void);

void sdc_support_shorter_connection_intervals_central(void);

void sdc_support_shorter_connection_intervals_peripheral(void);

void sdc_support_channel_sounding_test(void);

void sdc_support_channel_sounding_mode3(void);

__attribute__((deprecated)) void sdc_support_channel_sounding_initiator_role(void);

void sdc_support_channel_sounding_initiator_role_central(void);

void sdc_support_channel_sounding_initiator_role_peripheral(void);

__attribute__((deprecated)) void sdc_support_channel_sounding_reflector_role(void);

void sdc_support_channel_sounding_reflector_role_central(void);

void sdc_support_channel_sounding_reflector_role_peripheral(void);

void sdc_support_direct_test_mode(void);

void sdc_support_flushable_acl_data(void);

void sdc_support_mpsl_coex(void);

void sdc_support_mpsl_fem(void);

void sdc_support_decision_scan(void);

void sdc_support_decision_adv(void);
 
#ifdef __cplusplus
}
#endif

 
#endif /* SDC_H__ */