Common#

rsi_bt_resp_get_bt_stack_version_t#

typedef struct rsi_bt_resp_get_bt_stack_version_s rsi_bt_resp_get_bt_stack_version_t

rsi_bt_per_stats_t#

typedef struct rsi_bt_per_stats_s rsi_bt_per_stats_t

rsi_bt_set_bd_addr#

int32_t rsi_bt_set_bd_addr (uint8_t * dev_addr)

Set the device BD address.

This is a blocking API.

• Pre-conditions:

  • needs to be called immediately after device initialization.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

  • 3 - Command is given in wrong state (i.e., not immediate after opermode)

Note

• This is a blocking API. Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

  • 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

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 0 - Success

  • 0x4F01 - Invalid gain table payload length

  • 0x4F02 - Invalid region.

  • 0x4F03 - Invalid gain table offset request type

  • 0x4F04 - Invalid node id.

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

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

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API. Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes.

rsi_bt_init#

int32_t rsi_bt_init (void )

Initialize the BT device.

This is a blocking API.

• Pre-conditions:

  • 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

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes.

rsi_bt_deinit#

int32_t rsi_bt_deinit (void )

Deinitialize the BT device.

This is a blocking API.

• Pre-conditions:

  • Device should be initialized before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-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 a blocking API.

• Pre-conditions:

  • Device should be initialized before calling this API

Returns

• The following values are returned:

  • 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 to the Status Codes section for the above error codes at additional-status-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.

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.

• Pre-conditions:

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

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

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