Common APIs#

rsi_bt_set_bd_addr#

int32_t rsi_bt_set_bd_addr (uint8_t * dev_addr)

Set the device BD address. This is blocking API.

• needs to be called immediately after rsi_wireless_init() OPERMODE command.

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 .

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. This is blocking API.

Returns

• 0 - Success
  Non-Zero Value - Failure

Note

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

rsi_bt_set_local_name#

int32_t rsi_bt_set_local_name (uint8_t * local_name)

Set the given name to local device. This is blocking API.

• rsi_wireless_init() API need to be called before 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 .

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. This is blocking API.

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

Note

• This API is applicable for High performance(HP) mode only.

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 .

rsi_bt_get_local_name#

int32_t rsi_bt_get_local_name (rsi_bt_resp_get_local_name_t * bt_resp_get_local_name)

Get the local device name. This is blocking API.

• rsi_wireless_init() 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 .

rsi_bt_get_rssi#

int32_t rsi_bt_get_rssi (uint8_t * dev_addr, int8_t * resp)

Get the RSSI of the remote device. This is 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 .

rsi_bt_get_local_device_address#

int32_t rsi_bt_get_local_device_address (uint8_t * resp)

Get the local device address. This is blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success
  Non-Zero Value - Failure

Note

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

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. This is blocking API.

Returns

• 0 - Success
  Non-Zero Value - Failure

Note

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

rsi_bt_init#

rsi_bt_init (void )

Initialize the BT device. This is blocking API.

• rsi_wireless_init() API needs to be called before 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 .

rsi_bt_deinit#

rsi_bt_deinit (void )

Deinitialize the BT device. This is blocking API.

• rsi_wireless_init() API needs to be called before 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 .

rsi_bt_set_antenna#

int32_t rsi_bt_set_antenna (uint8_t antenna_value)

Select either internal / external antenna on the chip. This is blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success
  Non-Zero Value - Failure

Note

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

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. This is blocking API.

• rsi_wireless_init() API need to be called before 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 .

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. This is blocking API.

• rsi_wireless_init() API needs to be called before 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 doesnot support in RSI_SLEEP_MODE_1.
  BT/BLE supports only RSI_MAX_PSP mode. Remaining modes are not supported.