Common#

Functions#

int32_t
rsi_bt_set_bd_addr(uint8_t *dev_addr)

Set the device BD address.

int32_t
rsi_bt_ber_enable_or_disable(rsi_bt_ber_cmd_t *ber_cmd)

Enable and disable BER.

int32_t
rsi_bt_set_local_name(uint8_t *local_name)

Set the given name to local device.

int32_t
rsi_bt_cmd_update_gain_table_offset_or_max_pwr(uint8_t node_id, uint8_t payload_len, uint8_t *payload, uint8_t req_type)

Update gain table offset/max power.

int32_t
rsi_bt_get_local_name(rsi_bt_resp_get_local_name_t *bt_resp_get_local_name)
int32_t
rsi_bt_get_rssi(uint8_t *dev_addr, int8_t *resp)

Get the RSSI of the remote device.

int32_t
rsi_bt_get_local_device_address(uint8_t *resp)

Get the local device address.

int32_t
rsi_bt_get_bt_stack_version(rsi_bt_resp_get_bt_stack_version_t *bt_resp_get_bt_stack_version)

Get the BT stack version.

int32_t
rsi_bt_init(void)

Initialize the BT device.

int32_t
rsi_bt_deinit(void)

Deinitialize the BT device.

int32_t
rsi_bt_set_antenna(uint8_t antenna_value)

Select either internal / external antenna on the chip.

int32_t
rsi_bt_set_antenna_tx_power_level(uint8_t protocol_mode, int8_t tx_power)

Enable/Disable the mentioned features.

int32_t
rsi_bt_power_save_profile(uint8_t psp_mode, uint8_t psp_type)

Select the power save profile mode for BT / BLE.

int32_t
rsi_bt_per_stats(uint8_t cmd_type, struct rsi_bt_per_stats_s *per_stats)

Request the local device for BT PER operation.

int32_t
rsi_bt_per_cw_mode(struct rsi_bt_per_cw_mode_s *bt_cw_mode)

Keep the device in continuous wave mode.

Function Documentation#

rsi_bt_set_bd_addr#

int32_t rsi_bt_set_bd_addr (uint8_t * dev_addr)

Set the device BD address.

Parameters
[in]dev_addr

- public address of the device to be set

This is a blocking API.

  • needs to be called immediately after device initialization.

Returns

  • 0 - Success Non-Zero Value - Failure -3 - Command is given in wrong state(i.e not immediate after opermode)

Note

  • Refer Error Codes section for above error codes error-codes .


Definition at line 72 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_ber_enable_or_disable#

int32_t rsi_bt_ber_enable_or_disable (rsi_bt_ber_cmd_t * ber_cmd)

Enable and disable BER.

Parameters
[in]ber_cmd

- pointer address which contains the command structure. Please refer rsi_bt_ber_cmd_s structure for more info

This is a blocking API. Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 83 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_set_local_name#

int32_t rsi_bt_set_local_name (uint8_t * local_name)

Set the given name to local device.

Parameters
[in]local_name

- Name to be set to the local device.

This is a blocking API.

  • Device should be initialized before calling this API.

Note

  • For BLE alone Opermode : When the name of the local device is set to a value with length more than 16 bytes then error is returned with an error code 0x4E66.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 97 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_cmd_update_gain_table_offset_or_max_pwr#

int32_t rsi_bt_cmd_update_gain_table_offset_or_max_pwr (uint8_t node_id, uint8_t payload_len, uint8_t * payload, uint8_t req_type)

Update gain table offset/max power.

Parameters
[in]node_id

- Node ID (0 - BLE, 1 - BT).

[in]payload_len

- Length of the payload.

[in]payload

- Payload containing table data of gain table offset/max power

[in]req_type

- update gain table request type (0 - max power update, 1 - offset update)

This is blocking API.

  • Device should be initialized before calling this API.

Returns

  • 0 - Success 0x4F01 - Invalid gain table payload length 0x4F02 - Invalid region. 0x4F03 - Invalid gain table offset request type 0x4F04 - Invalid node id.

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 116 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_get_local_name#

int32_t rsi_bt_get_local_name (rsi_bt_resp_get_local_name_t * bt_resp_get_local_name)
Parameters
N/Abt_resp_get_local_name

Definition at line 131 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_get_rssi#

int32_t rsi_bt_get_rssi (uint8_t * dev_addr, int8_t * resp)

Get the RSSI of the remote device.

Parameters
[in]dev_addr

- Remote device address.

[out]resp

- Parameter to hold the response of this API, RSSI is filled in this resp parameter.

This is a blocking API.

  • rsi_bt_connect() API need to be called before this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 144 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_get_local_device_address#

int32_t rsi_bt_get_local_device_address (uint8_t * resp)

Get the local device address.

Parameters
[out]resp

- Parameter to hold the response of this API, local bd_addr is filled in this resp parameter.

This is a blocking API.

  • Device should be initialized before calling this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 156 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_get_bt_stack_version#

int32_t rsi_bt_get_bt_stack_version (rsi_bt_resp_get_bt_stack_version_t * bt_resp_get_bt_stack_version)

Get the BT stack version.

Parameters
[out]bt_resp_get_bt_stack_version

- Response buffer to hold the response of this API. Please refer rsi_bt_resp_get_bt_stack_version_s structure for more info

This is a blocking API. Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 167 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_init#

int32_t rsi_bt_init (void )

Initialize the BT device.

Parameters
N/A

This is a blocking API.

  • Device should be initialized before calling this API. If the device is in powersave, get back the device to ACTIVE MODE by using rsi_bt_power_save_profile()

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 180 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_deinit#

int32_t rsi_bt_deinit (void )

Deinitialize the BT device.

Parameters
N/A

This is a blocking API.

  • Device should be initialized before this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 192 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_set_antenna#

int32_t rsi_bt_set_antenna (uint8_t antenna_value)

Select either internal / external antenna on the chip.

Parameters
[in]antenna_value

- Parameter is used to select either internal or external antenna. Possible values: 0x00 RSI_SEL_INTERNAL_ANTENNA 0x01 RSI_SEL_EXTERNAL_ANTENNA

This is a blocking API.

  • Device should be initialized before calling this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 206 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_set_antenna_tx_power_level#

int32_t rsi_bt_set_antenna_tx_power_level (uint8_t protocol_mode, int8_t tx_power)

Enable/Disable the mentioned features.

Parameters
[in]protocol_mode

- protocol mode 1 - BT classic 2 - BT Low Energy

[in]tx_power

- power value Antenna transmit power level Default Value for BLE TX Power Index is 31, The range for the BLE TX Power Index is 1 to 75 (0, 32 indexes are invalid) Default TX power index for BT classic is 14 1 - 31 0DBM Mode. 33 - 63 10DBM Mode. 64 - 75 HP Mode.

This is a blocking API.

  • Device should be initialized before calling this API

Note

  • The default value will vary based on country region and board

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for above error codes error-codes.


Definition at line 228 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_power_save_profile#

int32_t rsi_bt_power_save_profile (uint8_t psp_mode, uint8_t psp_type)

Select the power save profile mode for BT / BLE.

Parameters
[in]psp_mode

Following psp_mode is defined. 0 - RSI_ACTIVE. In this mode module is active and power save is disabled. 1 - RSI_SLEEP_MODE_1. On mode. In this sleep mode, SoC will never turn off, therefore no handshake is required before sending data to the module. BT/BLE does not support this mode. 2 - RSI_SLEEP_MODE_2. Connected sleep mode. In this sleep mode, SoC will go to sleep based on GPIO or Message, therefore handshake is required before sending data to the module. 8 - RSI_SLEEP_MODE_8 :Deep sleep mode with RAM RETENTION. 10- RSI_SLEEP_MODE_10 : Deep sleep mode without RAM RETENTION. In this sleep mode, module will turn off the SoC. Since SoC is turn off, therefore handshake is required before sending data to the module.

[in]psp_type

Following psp_type is defined. 0 - RSI_MAX_PSP. This psp_type will be used for max power saving 1 - Fast PSP 2 - UAPSD

This is a blocking API.

  • Device should be initialized before calling this API

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • If the user wants to enable power save in CoEx mode (WLAN + BT LE) mode - It is mandatory to enable WLAN power save along with BT LE power save.

  • The device will enter into power save if and only if both protocol (WLAN, BLE) power save modes are enabled.

  • Refer Error Codes section for above error codes error-codes.

  • psp_type is only valid in psp_mode 2. BT/BLE does not support in RSI_SLEEP_MODE_1. BT/BLE supports only RSI_MAX_PSP mode. Remaining modes are not supported.


Definition at line 259 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_per_stats#

int32_t rsi_bt_per_stats (uint8_t cmd_type, struct rsi_bt_per_stats_s * rsi_bt_per_stats)

Request the local device for BT PER operation.

Parameters
[in]cmd_type

- Parameter to define the command id type for PER operation. BT_PER_STATS_CMD_ID (0x08) - Command id enables PER statistics BT_TRANSMIT_CMD_ID (0x15) - Command id enables PER transmit BT_RECEIVE_CMD_ID (0x16) - Command id enables PER receive

[in]rsi_bt_per_stats

- reference to the response structure. Please refer to rsi_bt_per_stats_s structure for more info.

  • Call rsi_bt_per_tx() or rsi_bt_per_rx() before calling this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes error-codes .


Definition at line 275 of file components/si91x/ble/inc/rsi_bt_common_apis.h

rsi_bt_per_cw_mode#

int32_t rsi_bt_per_cw_mode (struct rsi_bt_per_cw_mode_s * bt_cw_mode)

Keep the device in continuous wave mode.

Parameters
[in]bt_cw_mode

- continuous wave mode information needs to filled in this structure. Please refer rsi_bt_per_cw_mode_s for more info.

Not necessary to be called if transmit_mode is set to 2 - CONTINUOUS_WAVE_MODE in rsi_bt_tx_per_params_s structure.

  • Call rsi_bt_per_tx() before calling this API.

Returns

  • 0 - Success Non-Zero Value - Failure

Note

  • Refer Error Codes section for common error codes error-codes .


Definition at line 288 of file components/si91x/ble/inc/rsi_bt_common_apis.h