GAP#

rsi_ble_set_random_address#

int32_t rsi_ble_set_random_address (void )

Request the local device to set a random address. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_set_random_address_with_value#

int32_t rsi_ble_set_random_address_with_value (uint8_t * random_addr)

Request the local device to set a given random address. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_start_advertising#

rsi_ble_start_advertising (void )

Request the local device to start advertising. This is a Blocking API A received event rsi_ble_on_enhance_connect_t/ rsi_ble_on_connect_t indicates remote device given ble connect command and got connected.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_start_advertising_with_values#

int32_t rsi_ble_start_advertising_with_values (void * rsi_ble_adv)

Request the local device to start advertising with specified values. This is a Blocking API A received event rsi_ble_on_enhance_connect_t/ rsi_ble_on_connect_t indicates remote device given ble connect command and got connected.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_encrypt#

int32_t rsi_ble_encrypt (uint8_t * key, uint8_t * data, uint8_t * resp)

Encrypt the plain text data fed by the user using the key provided. It uses the AES-128 bit block cypher alogo to generate encrypted data. Refer to Bluetooth Spec 5.0 for further details.

• Call rsi_wireless_init() before calling this API. This is a Blocking API

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_stop_advertising#

rsi_ble_stop_advertising (void )

Stop advertising. This is a Blocking API.

• Call rsi_ble_start_advertising() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_set_advertise_data#

int32_t rsi_ble_set_advertise_data (uint8_t * data, uint16_t data_len)

Set the advertising data. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

• 1. The maximum length of advertising data payload is 31 bytes.

  1. The basic format of advertising payload record contains length and data.

rsi_ble_set_scan_response_data#

int32_t rsi_ble_set_scan_response_data (uint8_t * data, uint16_t data_len)

Request the local device to set the scan response data. This is a Blocking API .

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_start_scanning#

rsi_ble_start_scanning (void )

Start scanning. This is a Blocking API A received event rsi_ble_on_adv_report_event_t indicates advertise report of remote device received.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_start_scanning_with_values#

int32_t rsi_ble_start_scanning_with_values (void * rsi_ble_scan_params)

Start scanning with values. This is a Blocking API A received event rsi_ble_on_adv_report_event_t indicates advertise report of remote device received.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_stop_scanning#

rsi_ble_stop_scanning (void )

Stop scanning. This is a Blocking API.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E0C - Command disallowed

Note

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

rsi_ble_connect_with_params#

int32_t rsi_ble_connect_with_params (uint8_t remote_dev_addr_type, int8_t * remote_dev_addr, uint16_t scan_interval, uint16_t scan_window, uint16_t conn_interval_max, uint16_t conn_interval_min, uint16_t conn_latency, uint16_t supervision_tout)

Connect to the remote BLE device with the user configured parameters. This is a blocking API. A received event rsi_ble_on_enhance_connect_t / rsi_ble_on_connect_t indicates that the connection successful and a received event rsi_ble_on_disconnect_t indicates that connection failures have occurred.

Note

• If a connection can't be established, for example, the remote device has gone out of range, has entered into deep sleep, or is not advertising, the stack will try to connect forever. In this case, the application will not get an event related to the connection request. To recover from this situation, the application can implement a timeout and call rsi_ble_connect_cancel() to cancel the connection request. Subsequent calls of this command have to wait for the ongoing command to complete.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_connect#

int32_t rsi_ble_connect (uint8_t remote_dev_addr_type, int8_t * remote_dev_addr)

Connect to the remote BLE device. This is a blocking API. A received event rsi_ble_on_enhance_connect_t/ rsi_ble_on_connect_t indicates that the connection successful and a received event rsi_ble_on_disconnect_t indicates that connection failures have occurred.

Note

• If a connection can't be established, for example, the remote device has gone out of range, has entered into deep sleep, or is not advertising, the stack will try to connect forever. In this case, the application will not get an event related to the connection request. To recover from this situation, the application can implement a timeout and call rsi_ble_connect_cancel() to cancel the connection request. Subsequent calls of this command have to wait for the ongoing command to complete.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4046 - Invalid Arguments

Note

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

rsi_ble_connect_cancel#

int32_t rsi_ble_connect_cancel (int8_t * remote_dev_address)

Cancel the connection to the remote BLE device. This is a blocking API. A received event rsi_ble_on_disconnect_t indicates disconnect complete.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4046 - Invalid Arguments 0x4E02 - Unknown Connection Identifier

Note

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

rsi_ble_disconnect#

int32_t rsi_ble_disconnect (int8_t * remote_dev_address)

Disconnect with the remote BLE device. This is a Blocking API.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_get_device_state#

int32_t rsi_ble_get_device_state (uint8_t * resp)

Get the local device state. This is a Blocking API. The state value is filled in "resp".

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_set_smp_pairing_cap_data#

int32_t rsi_ble_set_smp_pairing_cap_data (rsi_ble_set_smp_pairing_capabilty_data_t * smp_pair_cap_data)

Set the SMP Pairing Capability of local device. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_set_local_irk_value#

int32_t rsi_ble_set_local_irk_value (uint8_t * l_irk)

Set the IRK value to the local device. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure

Note

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

rsi_ble_conn_param_resp#

int32_t rsi_ble_conn_param_resp (uint8_t * remote_dev_address, uint8_t status)

Give the response for the remote device connection parameter request. This is a Blocking API A received event rsi_ble_on_conn_update_complete_t indicates connection update procedure is successful.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4E0C - Command disallowed 0x4046 - Invalid Arguments 0x4E02 - Unknown Connection Identifier

Note

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

rsi_ble_smp_pair_request#

int32_t rsi_ble_smp_pair_request (uint8_t * remote_dev_address, uint8_t io_capability, uint8_t mitm_req)

Request the SMP pairing process with the remote device. This is a Blocking API A received event rsi_ble_on_smp_request_t indicated remote device is given Security Request and need to respond back with rsi_ble_smp_pair_request A received event rsi_ble_on_smp_response_t indicated remote device is given SMP Pair Request and need to respond back with rsi_ble_smp_pair_response A received event rsi_ble_on_smp_failed_t indicated SMP procedure have failed.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_smp_pair_failed#

int32_t rsi_ble_smp_pair_failed (uint8_t * remote_dev_address, uint8_t reason)

Send SMP pairing failure reason to the remote device.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

rsi_ble_ltk_req_reply#

int32_t rsi_ble_ltk_req_reply (uint8_t * remote_dev_address, uint8_t reply_type, uint8_t * ltk)

Send the local long term key of its associated local EDIV and local Rand. This is a Blocking API A received event rsi_ble_on_encrypt_started_t indicated encrypted event is received from module A received event rsi_ble_on_smp_failed_t indicated SMP procedure have failed.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_smp_pair_response#

int32_t rsi_ble_smp_pair_response (uint8_t * remote_dev_address, uint8_t io_capability, uint8_t mitm_req)

Send SMP pairing response during the process of pairing with the remote device. This is a Blocking API A received event rsi_ble_on_smp_passkey_t indicated Legacy SMP passkey is received and need to respond back with rsi_ble_smp_passkey() A received event rsi_ble_on_sc_passkey_t indicated BLE SC passkey is received and need to respond back with rsi_ble_smp_passkey() A received event rsi_ble_on_smp_passkey_display_t indicates SMP passkey display is received from the module A received event rsi_ble_on_smp_failed_t indicated SMP Failed event is received.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_smp_passkey#

int32_t rsi_ble_smp_passkey (uint8_t * remote_dev_address, uint32_t passkey)

Send SMP passkey during SMP pairing process with the remote device. This is a Blocking API A received event rsi_ble_on_encrypt_started_t indicated encrypted event is received from module A received event rsi_ble_on_le_security_keys_t indicates exchange of security keys completed after encryption A received event rsi_ble_on_smp_failed_t indicated SMP procedure have failed

• Call rsi_ble_smp_pair_request and rsi_ble_smp_pair_response before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_get_le_ping_timeout#

int32_t rsi_ble_get_le_ping_timeout (uint8_t * remote_dev_address, uint16_t * time_out)

Get the timeout value of the LE ping. This is a Blocking API.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

• Currently Get ping is not supported.

rsi_ble_set_le_ping_timeout#

int32_t rsi_ble_set_le_ping_timeout (uint8_t * remote_dev_address, uint16_t time_out)

Set the timeout value of the LE ping. This is a Blocking API A received event of rsi_ble_on_le_ping_payload_timeout_t indicates le ping payload timeout expired.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_clear_whitelist#

int32_t rsi_ble_clear_whitelist (void )

Clear all the BD address present in white list. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_addto_whitelist#

int32_t rsi_ble_addto_whitelist (int8_t * dev_address, uint8_t dev_addr_type)

Add BD address to white list. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

• Maximum number of device address that firmware can store is 10. Refer Error Codes section for above error codes Error Codes .

rsi_ble_deletefrom_whitelist#

int32_t rsi_ble_deletefrom_whitelist (int8_t * dev_address, uint8_t dev_addr_type)

Delete particular BD address from white list. This is a Blocking API.

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

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_resolvlist#

int32_t rsi_ble_resolvlist (uint8_t process_type, uint8_t remote_dev_addr_type, uint8_t * remote_dev_address, uint8_t * peer_irk, uint8_t * local_irk)

resolvlist api used for multiple purpose based on the process type. It will be used to add/remove/clear a device to/from the list. This is a Blocking API

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_get_resolving_list_size#

int32_t rsi_ble_get_resolving_list_size (uint8_t * resp)

Request to get resolving list size. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 : Buffer not available to serve the command

Note

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

rsi_ble_set_addr_resolution_enable#

int32_t rsi_ble_set_addr_resolution_enable (uint8_t enable, uint16_t tout)

Request to enable address resolution, and to set resolvable private address timeout. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 : Buffer not available to serve the command

rsi_ble_set_privacy_mode#

int32_t rsi_ble_set_privacy_mode (uint8_t remote_dev_addr_type, uint8_t * remote_dev_address, uint8_t privacy_mode)

Request to set privacy mode for particular device. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 : Buffer not available to serve the command

Note

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

rsi_ble_readphy#

int32_t rsi_ble_readphy (int8_t * remote_dev_address, rsi_ble_resp_read_phy_t * resp)

Reads the TX and RX PHY rates of the Connection. This is a Blocking API.

• rsi_ble_connect() 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_ble_setphy#

int32_t rsi_ble_setphy (int8_t * remote_dev_address, uint8_t tx_phy, uint8_t rx_phy, uint16_t coded_phy)

Set TX and RX PHY. This is a Blocking API A received event rsi_ble_on_phy_update_complete_t indicates phy rate update complete.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_conn_params_update#

int32_t rsi_ble_conn_params_update (uint8_t * remote_dev_address, uint16_t min_int, uint16_t max_int, uint16_t latency, uint16_t timeout)

Requests the connection parameters change with the remote device. When the Silabs device is acting as a master, this API is used to update the connection parameters. When the Silabs device is acts as a slave, this API is used to request the master to intiate the connection update procedure. This is a Blocking API A received event rsi_ble_on_conn_update_complete_t indicates connection parameters update complete.

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

Returns

• 0 - Success Non-Zero Value - Failure 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

• min_int and max_int values ranges from 6 to 3200 (Time = N * 1.25 ms, Time Range: 7.5 ms to 4 s) latency : If latency value is greater than 32 ,Limiting the slave latency value to 32 Max supported slave latency is 32 when Device is in Slave Role.

rsi_ble_set_data_len#

int32_t rsi_ble_set_data_len (uint8_t * remote_dev_address, uint16_t tx_octets, uint16_t tx_time)

Sets the TX octets and the TX time of specified link (remote device connection). This is a Blocking API. A received event rsi_ble_on_data_length_update_t indicates data length update complete.

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

Returns

• 0 - LE_Set_Data_Length command succeeded. Non-Zero Value - Failure 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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

rsi_ble_read_max_data_len#

int32_t rsi_ble_read_max_data_len (rsi_ble_read_max_data_length_t * blereaddatalen)

reads the max supported values of TX octets, TX time, RX octets and Rx time. This is a Blocking API

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

Returns

• 0 - command success Non-Zero Value - Failure

Note

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

rsi_ble_vendor_rf_type#

int32_t rsi_ble_vendor_rf_type (uint8_t ble_power_index)

Issue a vendor-specific command to set the RF type in the controller on given inputs. This is a Blocking API.

• Call rsi_wireless_init() before calling this API

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command

Note

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

rsi_ble_white_list_using_adv_data#

int32_t rsi_ble_white_list_using_adv_data (uint8_t enable, uint8_t data_compare_index, uint8_t len_for_compare_data, uint8_t * payload)

Give vendor-specific command to set the whitelist feature based on the advertisers advertising payload. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4E62 Invalid Parameters

Note

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

BT_LE_ADPacketExtract#

void BT_LE_ADPacketExtract (uint8_t * remote_name, uint8_t * pbuf, uint8_t buf_len)

Used to extract remote Bluetooth device name from the received advertising report.

• Call rsi_wireless_init() before calling this API.

Returns

• void

rsi_ble_update_directed_address#

void rsi_ble_update_directed_address (uint8_t * remote_dev_addr)

Update the direct address with the remote device address. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• void

rsi_ble_start_encryption#

int32_t rsi_ble_start_encryption (uint8_t * remote_dev_address, uint16_t ediv, uint8_t * rand, uint8_t * ltk)

Start the encryption process with the remote device. This is a Blocking API A received event rsi_ble_on_encrypt_started_t indicated encrypted event is received from module A received event rsi_ble_on_le_security_keys_t indicates exchange of security keys completed after encryption. A received event rsi_ble_on_smp_failed_t indicated SMP procedure have failed.

• Encryption enabled event should come before calling this API for second time SMP connection.

Returns

• 0 - Success Non-Zero Value - Failure If the return value is less than 0 -4 - Buffer not available to serve the command 0x4D05 BLE socket not available 0x4E62 Invalid Parameters 0x4D04 BLE not connected

Note

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