GAP#

rsi_ble_set_smp_pairing_capabilty_data_t#

typedef struct rsi_ble_set_smp_pairing_capabilty_data rsi_ble_set_smp_pairing_capabilty_data_t

rsi_ble_resp_read_phy_t#

typedef struct rsi_ble_resp_read_phy_s rsi_ble_resp_read_phy_t

rsi_ble_read_max_data_length_t#

typedef struct rsi_ble_resp_read_max_data_length_s rsi_ble_read_max_data_length_t

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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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#

int32_t 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

  • Pre-conditions:

• Device should be initialized before calling this API. Returns

  • The following values are returned:

• 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

  • Pre-conditions:

• Device should be initialized before calling this API.

• This variable is the pointer of the rsi_ble_req_adv_s structure Returns

  • The following values are returned:

• 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 a logo to generate encrypted data. Refer to Bluetooth Spec 5.0 for further details.

  • Pre-conditions:

• Device should be initialized before calling this API. This is a Blocking API Returns

  • The following values are returned:

• 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#

int32_t rsi_ble_stop_advertising (void )

Stop advertising.

This is a Blocking API

• Pre-conditions:

  • Call rsi_ble_start_advertising() before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• • Pre-conditions:

• Device should be initialized before calling this API. Returns

  • The following values are returned:

• 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#

int32_t 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.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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.

  • Pre-conditions:

• Device should be initialized before calling this API. Returns

  • The following values are returned:

• 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#

int32_t rsi_ble_stop_scanning (void )

Stop scanning.

This is a Blocking API

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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.

  • Pre-conditions:

• Device should be initialized before calling this API.

• 0 - Public Address

• 1 - Random Address

• It is defined as the time interval from when the Controller started its last LE scan until it

• begins the subsequent LE scan.

• Range: 0x0004 to 0x4000

• Time = N * 0.625 msec

• Time Range: 2.5 msec to 10 . 24 seconds

• Amount of time for the duration of the LE scan. LE_Scan_Window must be less than or equal to LE_Scan_Interval

• Range: 0x0004 to 0x4000

• Time = N * 0.625 msec

• Time Range: 2.5 msec to 10 . 24 seconds

• Minimum value for the connection event interval, which must

• be greater than or equal to Conn_Interval_Min.

• Range: 0x0006 to 0x0C80

• Time = N * 1.25 msec

• Time Range: 7.5 msec to 4 seconds.

• 0x0000 - 0x0005 and 0x0C81 - 0xFFFF - Reserved for future use

• Minimum value for the connection event interval, which must be greater than or equal to Conn_Interval_Max.

• Range: 0x0006 to 0x0C80

• Time = N * 1.25 msec

• Time Range: 7.5 msec to 4 seconds.

• 0x0000 - 0x0005 and 0x0C81 - 0xFFFF - Reserved for future use

• Peripheral latency for the connection in number of connection events.

• Range: 0x0000 to 0x01F4

• Supervision timeout for the LE Link.

• Range: 0x000A to 0x0C80

• Time = N * 10 msec

• Time Range: 100 msec to 32 seconds

• 0x0000 - 0x0009 and 0x0C81 - 0xFFFF - Reserved for future use Returns

  • The following values are returned:

• 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.

  • Pre-conditions:

• Device should be initialized before calling this API. Returns

  • The following values are returned:

• 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_enhance_connect_with_params#

int32_t rsi_ble_enhance_connect_with_params (void * ble_enhance_conn_params)

Connect to the remote BLE device with the user configured parameters.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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.

• The following fields are included in the ble_enhance_conn_params parameter structure:

  • dev_addr_type - Address type of the device to connect.

    • 0 - Public Address

    • 1 - Random Address

  • dev_addr - Address of the device to connect.

  • filter_policy - Policy used to determine whether the filter accept list is used.

    • 0 - Filter accept list is not used to determine which advertiser to connect to.

    • 1 - Filter accept list is used to determine which advertiser to connect to.

  • own_addr_type - Own address type

  • le_scan_interval - The time interval from when the Controller started its last LE scan until it begins the subsequent LE scan.

    • Range: 0x0004 to 0x4000

    • Time = le_scan_interval * 0.625 msec

    • Time Range: 2.5 msec to 10 . 24 seconds

  • le_scan_window - Amount of time for the duration of the LE scan. This must be less than or equal to le_scan_interval.

    • Range: 0x0004 to 0x4000

    • Time = le_scan_window * 0.625 msec

    • Time Range: 2.5 msec to 10 . 24 seconds

  • conn_interval_min - Minimum value for the connection event interval. This must be greater than or equal to conn_interval_max.

    • Range: 0x0006 to 0x0C80

    • Time = conn_interval_min * 1.25 msec

    • Time Range: 7.5 msec to 4 seconds.

    • 0x0000 - 0x0005 and 0x0C81 - 0xFFFF - Reserved for future use

  • conn_interval_max - Maximum value for the connection event interval. This must be greater than or equal to conn_interval_min.

    • Range: 0x0006 to 0x0C80

    • Time = conn_interval_max * 1.25 msec

    • Time Range: 7.5 msec to 4 seconds.

    • 0x0000 - 0x0005 and 0x0C81 - 0xFFFF - Reserved for future use

  • conn_latency - Peripheral latency for the connection in number of connection events.

    • Range: 0x0000 to 0x01F4

  • supervision_tout - Supervision timeout for the LE Link.

    • Range: 0x000A to 0x0C80

    • Time = N * 10 msec

    • Time Range: 100 msec to 32 seconds

    • 0x0000 - 0x0009 and 0x0C81 - 0xFFFF - Reserved for future use

  • min_ce_length - Minimum length of connection event recommended for this LE connection.

    • Range: 0x0000 to 0xFFFF

    • Time = N * 0.625 msec

  • max_ce_length - Maximum length of connection event recommended for this LE connection.

    • Range: 0x0000 to 0xFFFF

    • Time = N * 0.625 msec

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.

  • Pre-conditions:

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

  • The following values are returned:

• 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

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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".

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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.

  • Pre-conditions:

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

• 0 - ACCEPT,

• 1 - REJECT

• Returns

  • The following values are returned:

• 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

  • Pre-conditions:

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

• 0x00 - Display Only

• 0x01 - Display Yes/No

• 0x02 - Keyboard Only

• 0x03 - No Input No Output

• 0 - Disable

• 1 - Enable Returns

  • The following values are returned:

• 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.

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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

• BIT(0) - Positive Reply (Encryption Enabled)

• BIT(1) - Un authenticated LTK or STK-based Encryption Enabled

• BIT(2) - Authenticated LTK or STK-based Encryption Enabled

• BIT(3) - Authenticated LTK with LE Secure Connections based Encryption Enabled

• BIT(4) to BIT(6) - Reserved for Future use

• BIT(7) - LE Secure Connection Enabled

• Returns

  • The following values are returned:

• 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

  • Pre-conditions:

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

• 0x00 - Display Only

• 0x01 - Display Yes/No

• 0x02 - Keyboard Only

• 0x03 - No Input No Output

• 0 - Disable

• 1 - Enable Returns

  • The following values are returned:

• 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

  • Pre-conditions:

• Call rsi_ble_smp_pair_request and rsi_ble_smp_pair_response before calling this API. Returns

  • The following values are returned:

• 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

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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

  • Pre-conditions:

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

• payload command.(in milliseconds) Returns

  • The following values are returned:

• 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_acceptlist#

int32_t rsi_ble_clear_acceptlist (void )

Clear all the BD address present in accept list.

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

  • 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_acceptlist#

int32_t rsi_ble_addto_acceptlist (int8_t * dev_address, uint8_t dev_addr_type)

Add BD address to accept list.

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

  • 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_acceptlist#

int32_t rsi_ble_deletefrom_acceptlist (int8_t * dev_address, uint8_t dev_addr_type)

Delete particular BD address from accept list.

This is a Blocking API

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

• Pre-conditions:

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

Returns

• The following values are returned:

  • 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.

  • Pre-conditions:

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

• BIT(0) - Host prefers to use the LE 1M transmitter PHY (possibly among others)

• BIT(1) - Host prefers to use the LE 2M transmitter PHY (possibly among others)

• BIT(2) - Host prefers to use the LE Coded transmitter PHY (possibly among others)

• BIT(3) - BIT(7) Reserved for future use

• BIT(0) - Host prefers to use the LE 1M receiver PHY (possibly among others)

• BIT(1) - Host prefers to use the LE 2M receiver PHY (possibly among others)

• BIT(2) - Host prefers to use the LE Coded receiver PHY (possibly among others)

• BIT(3) - BIT(7) Reserved for future use

• 0 = Host has no preferred coding when transmitting on the LE Coded PHY

• 1 = Host prefers that S=2 coding be used when transmitting on the LE Coded PHY

• 2 = Host prefers that S=8 coding be used when transmitting on the LE Coded PHY

• 3 = Reserved for future use

• Returns

  • The following values are returned:

• 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 Silicon Labs device acts as a central, this API is used to update the connection parameters.

• When the Silicon Labs device acts as a peripheral, this API is used to request the central to initiate the connection update procedure. This is a Blocking API

• A received event rsi_ble_on_conn_update_complete_t indicates connection parameters update complete.

  • Pre-conditions:

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

• this shall be less than or equal to max_int .

• this shall be greater than or equal to min_int.

• Ranges from 0 to 499

• Ranges from 10 to 3200 (Time = N * 10 ms, Time Range: 100 ms to 32 s) Returns

  • The following values are returned:

• 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 peripheral latency value to 32

• Max supported peripheral latency is 32 when Device is in peripheral 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.

  • Pre-conditions:

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

• should include in a single Link Layer packet on this connection.

• should use to transmit a single Link Layer packet on this connection. Returns

  • The following values are returned:

• 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

• Pre-conditions:

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

Returns

• The following values are returned:

  • 0 - command success

  • Non-Zero Value - Failure

Note

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

rsi_ble_accept_list_using_adv_data#

int32_t rsi_ble_accept_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 acceptlist feature based on the advertisers advertising payload.

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

  • 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.

• Pre-conditions:

  • Device should be initialized before calling this API.

Returns

• The following values are returned:

  • 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

  • Pre-conditions:

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

  • The following values are returned:

• 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_set_ble_tx_power#

int32_t rsi_ble_set_ble_tx_power (int8_t tx_power)

Set TX power.

Returns

• The following values are returned:

  • 0 - Success

  • Non-zero value - Failure

  • 0x4E02 - Unknown connection identifier

  • 0x4E01 - Unknown HCI command

  • 0x4E0C - Command disallowed

  • 0x4046 - Invalid arguments

  • 0x4D04 - BLE not connected

  • 0x4D14 - BLE parameter out of mandatory range

Note

• This is a Blocking API.

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

• The higher power will be backed off based on country region.

• Use the following setting to indicate tx_power as an index: #define RSI_BLE_PWR_INX_DBM 0

  • Default value for power index is 31.

  • Valid values for power index range from 1 to 31 and 33 to 127:

    • 1 to 31: BLE - 0dBm mode.

    • 33 to 63: BLE - 10dBm mode.

    • 64 to 82: BLE - 1dBm - 18dBm HP mode in the resolution of 1dBm.

    • 104 to 126: BLE - 0.5dBm - 11dBm HP mode in the resolution of 0.5dbm.

    • 127: BLE HP Mode, max power supported.

• Use the following setting to indicate tx_power in dBm (-8dBm to 18dBm): #define RSI_BLE_PWR_INX_DBM 1

• When switching between HP mode and LP mode, please ensure that no protocol activity is running.

• For the LP Chain - Power index vs output power in dBm in E2E mode:

  Power Index	Output Power in dBm
  1	-22.3054959
  2	-16.59332574
  3	-13.38278365
  4	-11.19804718
  5	-9.576522466
  6	-8.312070432
  7	-7.294640362
  8	-6.458448154
  9	-5.760963318
  10	-5.173042366
  11	-4.673788189
  12	-4.247653993
  13	-3.882708784
  14	-3.569545894
  15	-3.300567503
  16	-3.069499167
  17	-2.871050592
  18	-2.700672503
  19	-2.554378603
  20	-2.428612817
  21	-2.32014891
  22	-2.226013876
  23	-2.143429275
  24	-2.069766557
  25	-2.002513642
  26	-1.939250859
  27	-1.87763493
  28	-1.815390046
  29	-1.750305305
  30	-1.680237892
  31	-1.603121401
  32	N/A
  33	-10.4822997
  34	-4.9531679
  35	-1.931961022
  36	0.057132993
  37	1.476764101
  38	2.5332116
  39	3.336771823
  40	3.953605265
  41	4.426779615
  42	4.786171523
  43	5.053647759
  44	5.246007208
  45	5.37676618
  46	5.457304255
  47	5.497635316
  48	5.506945838
  49	5.493978354
  50	5.467302132
  51	5.435491631
  52	5.407220119
  53	5.391268248
  54	5.396444507
  55	5.431416481
  56	5.504458826
  57	5.62313521
  58	5.793945208
  59	6.02197959
  60	6.310634089
  61	6.661428559
  62	7.073964236
  63	7.546029076

• For the HP Chain - Power index vs output power in dBm in E2E mode:

  Power Index	Output Power in dBm
  64	1
  65	2
  66	3
  67	4
  68	5
  69	6
  70	7
  71	8
  72	9
  73	10
  74	11
  75	12
  76	13
  77	14
  78	15
  -	-
  -	-
  104	0.5
  105	1
  106	1.5
  107	2
  108	2.5
  109	3
  110	3.5
  111	4
  -	-
  126	10.5
  127	Max Power Supported by Country region

rsi_ble_get_max_adv_data_len#

int32_t rsi_ble_get_max_adv_data_len (uint8_t * resp)

Get maximum advertising data length.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function requests the controller to return the maximum supported advertising data length.

rsi_ble_get_max_no_of_supp_adv_sets#

int32_t rsi_ble_get_max_no_of_supp_adv_sets (uint8_t * resp)

Get maximum number of advertising sets.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function requests the controller to return the maximum number of supporting advertising sets.

• The number of supported advertising sets can be configured through the operating modes.

rsi_ble_set_ae_set_random_address#

rsi_ble_set_ae_set_random_address (uint8_t handle, uint8_t * rand_addr)

Update AE random address.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_set_ae_data#

int32_t rsi_ble_set_ae_data (void * ble_ae_data)

Update AE advertiser data.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function sets the AE advertiser data used in advertising PDUs.

• Refer to Bluetooth specification 5.3 for possible combinations ae_adv/scanresp data can be set for .

rsi_ble_set_ae_params#

int32_t rsi_ble_set_ae_params (void * ble_ae_params, int8_t * sel_tx_pwr)

Update AE parameters.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_start_ae_advertising#

int32_t rsi_ble_start_ae_advertising (void * adv_enable)

Enable or disable AE advertising.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_app_adv_set_clear_or_remove#

int32_t rsi_ble_app_adv_set_clear_or_remove (uint8_t type, uint8_t handle)

Clear or remove an advertising set.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_app_set_periodic_ae_params#

int32_t rsi_ble_app_set_periodic_ae_params (void * periodic_adv_params)

Update periodic AE parameters.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_app_set_periodic_ae_enable#

int32_t rsi_ble_app_set_periodic_ae_enable (uint8_t enable, uint8_t handle)

Enable or disable periodic advertising.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function requests the controller to enable or disable periodic advertising for the specified advertising set.

rsi_ble_ae_set_scan_params#

int32_t rsi_ble_ae_set_scan_params (void * ae_scan_params)

Update AE scan parameters.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function sets the extended scan parameters to be used on the physical advertising channels.

rsi_ble_ae_set_scan_enable#

int32_t rsi_ble_ae_set_scan_enable (void * ae_scan_enable)

Enable or disable legacy and extended scanning.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_ae_set_periodic_sync#

int32_t rsi_ble_ae_set_periodic_sync (uint8_t type, void * periodic_sync_data)

Synchronize periodic advertising with advertiser.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • 0x4E42 = unknown advertising identifier

• The following values are returned:

  • 0x4E0C = command not permitted

Note

• This function performs an operation to synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.

• The operation is either started, cancelled or terminated depending on the type parameter.

rsi_ble_ae_dev_to_periodic_list#

int32_t rsi_ble_ae_dev_to_periodic_list (void * dev_to_list)

Manage a device in the periodic advertiser list.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function adds, removes, or clears a device from the periodic advertiser list.

rsi_ble_ae_read_periodic_adv_list_size#

int32_t rsi_ble_ae_read_periodic_adv_list_size (uint8_t * resp)

Get periodic advertiser list size.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

rsi_ble_extended_connect_with_params#

int32_t rsi_ble_extended_connect_with_params (void * ble_extended_conn_params)

Establish ACL connection to advertiser.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function establishes an ACL connection to an advertiser, with the local device in the BLE central role.

rsi_ble_read_transmit_power#

int32_t rsi_ble_read_transmit_power (void * resp)

Get supported transmit power range.

Returns

• The following values are returned:

  • 0 = success

• The following values are returned:

  • !0 = failure

Note

• This function requests the controller to return the minimum and maximum supported transmit power.