Coexistence#

Coexistence.

Coexistence BGAPI class. Coexistence interface is enabled and initialized with sl_bt_init_coex_hal function.

Enumerations#

enum
sl_bt_coex_option_t {
sl_bt_coex_option_enable = 0x100
sl_bt_coex_option_tx_abort = 0x400
sl_bt_coex_option_high_priority = 0x800
}

Coexistence configuration options.

Functions#

sl_status_t
sl_bt_coex_set_options(uint32_t mask, uint32_t options)
sl_status_t
sl_bt_coex_set_parameters(uint8_t priority, uint8_t request, uint8_t pwm_period, uint8_t pwm_dutycycle)
sl_status_t
sl_bt_coex_get_parameters(uint8_t *priority, uint8_t *request, uint8_t *pwm_period, uint8_t *pwm_dutycycle)
sl_status_t
sl_bt_coex_get_counters(uint8_t reset, size_t max_counters_size, size_t *counters_len, uint8_t *counters)

Macros#

Enumeration Documentation#

sl_bt_coex_option_t#

sl_bt_coex_option_t

Coexistence configuration options.

Enumerator
sl_bt_coex_option_enable

(0x100) Enable coexistence feature

sl_bt_coex_option_tx_abort

(0x400) Abort transmission if grant is denied

sl_bt_coex_option_high_priority

(0x800) Enable priority signal


Definition at line 12302 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

Function Documentation#

sl_bt_coex_set_options#

sl_status_t sl_bt_coex_set_options (uint32_t mask, uint32_t options)
Parameters
[in]mask

Bitmask of following coexistence options to change

[in]options

Bitmask of following coexistence option values to set

Configure coexistence options at runtime.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12333 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_coex_set_parameters#

sl_status_t sl_bt_coex_set_parameters (uint8_t priority, uint8_t request, uint8_t pwm_period, uint8_t pwm_dutycycle)
Parameters
[in]priority

Coexistence priority threshold. Coexistence priority is toggled if priority is below this value.

[in]request

Coexistence request threshold. Coexistence request is toggled if priority is below this value.

[in]pwm_period

PWM functionality period length in 1 ms units

[in]pwm_dutycycle

PWM functionality duty cycle in percentage

Configure coexistence parameters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12349 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_coex_set_directional_priority_pulse#

sl_status_t sl_bt_coex_set_directional_priority_pulse (uint8_t pulse)
Parameters
[in]pulse

Directional priority pulse width in us

Set Directional Priority Pulse Width.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12363 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_coex_get_parameters#

sl_status_t sl_bt_coex_get_parameters (uint8_t * priority, uint8_t * request, uint8_t * pwm_period, uint8_t * pwm_dutycycle)
Parameters
[out]priority

Coexistence priority threshold. Coexistence priority is toggled if priority is below this value.

[out]request

Coexistence request threshold. Coexistence request is toggled if priority is below this value.

[out]pwm_period

PWM functionality period length in 1 ms units

[out]pwm_dutycycle

PWM functionality duty cycle in percentage

Get the coexistence parameters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12379 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_coex_get_counters#

sl_status_t sl_bt_coex_get_counters (uint8_t reset, size_t max_counters_size, size_t * counters_len, uint8_t * counters)
Parameters
[in]reset

Reset counters if parameter value is not zero.

[in]max_counters_size

Size of output buffer passed in counters

[out]counters_len

On return, set to the length of output data written to counters

[out]counters

Coexistence statistic counters

Read coexistence statistic counters from the device. Response contains the list of uint32 type counter values. Counters in the list are in following order: low priority requested, high priority requested, low priority denied, high priority denied, low-priority TX aborted, and high-priority TX aborted. Passing a non-zero value also resets counters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12401 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

Macro Definition Documentation#

sl_bt_cmd_coex_set_options_id#

#define sl_bt_cmd_coex_set_options_id
Value:
0x00200020

Definition at line 12288 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_coex_set_parameters_id#

#define sl_bt_cmd_coex_set_parameters_id
Value:
0x02200020

Definition at line 12289 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_coex_set_directional_priority_pulse_id#

#define sl_bt_cmd_coex_set_directional_priority_pulse_id
Value:
0x03200020

Definition at line 12290 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_coex_get_parameters_id#

#define sl_bt_cmd_coex_get_parameters_id
Value:
0x04200020

Definition at line 12291 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_coex_get_counters_id#

#define sl_bt_cmd_coex_get_counters_id
Value:
0x01200020

Definition at line 12292 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_coex_set_options_id#

#define sl_bt_rsp_coex_set_options_id
Value:
0x00200020

Definition at line 12293 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_coex_set_parameters_id#

#define sl_bt_rsp_coex_set_parameters_id
Value:
0x02200020

Definition at line 12294 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_coex_set_directional_priority_pulse_id#

#define sl_bt_rsp_coex_set_directional_priority_pulse_id
Value:
0x03200020

Definition at line 12295 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_coex_get_parameters_id#

#define sl_bt_rsp_coex_get_parameters_id
Value:
0x04200020

Definition at line 12296 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_coex_get_counters_id#

#define sl_bt_rsp_coex_get_counters_id
Value:
0x01200020

Definition at line 12297 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h