GATT Server#

rsi_ble_get_max_no_of_supp_adv_sets#

int32_t rsi_ble_get_max_no_of_supp_adv_sets (uint8_t * resp, resp)

request to the controller to know the maximum no.of supporting advertising sets

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the controller to know the maximum no.of supporting advertising sets Note

• : The number of advertising sets that can be supported is not fixed and it can be configured through the Opermodes

rsi_ble_get_max_adv_data_len#

int32_t rsi_ble_get_max_adv_data_len (uint8_t * resp, resp)

request to the controller to know the maximum supporting advertising data length

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the controller to know the maximum supporting advertising data length

rsi_ble_set_ae_set_random_address#

rsi_ble_set_ae_set_random_address (uint8_t handle, uint8_t * rand_addr)

sets the ae set random address

Returns

• 0 = success
  !0 = failure
  

description#

This function is used by the host to set the random device address specified by the Random_Address_parameter

rsi_ble_set_ae_params#

int32_t rsi_ble_set_ae_params (void * ble_ae_params, int8_t * sel_tx_pwr)

request the local device to set the extended advertising parameters

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the local device to set Extended Advertising Parameters

rsi_ble_set_ae_data#

int32_t rsi_ble_set_ae_data (void * ble_ae_data)

request the local device to set the AE advertiser data used in advertising PDUs

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the local device to set the AE advertiser data used in advertising PDUs Note

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

rsi_ble_start_ae_advertising#

int32_t rsi_ble_start_ae_advertising (void * adv_enable)

request the local device to enable or disable an advertising set using the advertising sets identified by the Advertising_Handle[i] parameter.

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the local device to enable or disable an advertising set using the advertising sets identified by the Advertising_Handle[i] parameter.

rsi_ble_app_adv_set_clear_or_remove#

int32_t rsi_ble_app_adv_set_clear_or_remove (uint8_t type, uint8_t handle)

request the local device to clear or remove the advertising sets based on the type specified

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the local device to clear or remove an advertising set from the controller based on the type specified

rsi_ble_app_set_periodic_ae_params#

int32_t rsi_ble_app_set_periodic_ae_params (void * periodic_adv_params)

request the local device to set periodic advertising params

Returns

• 0 = success
  !0 = failure
  

description#

This function is used by the host to set the parameters for periodic advertising

rsi_ble_app_set_periodic_ae_enable#

int32_t rsi_ble_app_set_periodic_ae_enable (uint8_t enable, uint8_t handle)

request the Controller to enable or disable the periodic advertising

           0      -  Enable Periodic Advertising  \n               
           1      -  Include the ADI field in AUX_SYNC_IND PDUs \n

        handle - Advertising_Handle - Used to Identify an Advertsing Set \n

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the Controller to enable or disable the periodic advertising for the advertising set specified by the Advertising_Handle parameter

rsi_ble_ae_set_scan_params#

int32_t rsi_ble_ae_set_scan_params (void * ae_scan_params)

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

Returns

• 0 = success
  !0 = failure
  

description#

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

rsi_ble_ae_set_scan_enable#

int32_t rsi_ble_ae_set_scan_enable (void * ae_scan_enable)

request the local device to enable or disable scanning for both legacy and extended advertising PDUs

Returns

• 0 = success
  !0 = failure
  

description#

This function requests the local device to enable or disable scanning for both legacy and extended advertising PDUs

rsi_ble_ae_set_periodic_sync#

int32_t rsi_ble_ae_set_periodic_sync (uint8_t type, void * periodic_sync_data)

rsi_ble_ae_dev_to_periodic_list#

int32_t rsi_ble_ae_dev_to_periodic_list (void * dev_to_list)

used to add,remove or clear the device to the periodic advertiser list

Returns

• 0 = success
  !0 = failure
  

description#

This function used to add,remove or clear the device to 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, resp)

used to read the periodic advertiser list size

Returns

• 0 = success
  !0 = failure
  

description#

This function used to read the periodic advertiser list size

rsi_ble_extended_connect_with_params#

int32_t rsi_ble_extended_connect_with_params (void * ble_extended_conn_params)

This command is used to create an ACL connection, with the local device in the Central role, to a connectable advertiser.

Returns

• 0 = success
  !0 = failure
  

description#

This function used to used to create an ACL connection, with the local device in the Central role, to a connectable advertiser.

rsi_ble_read_transmit_power#

int32_t rsi_ble_read_transmit_power (void * resp)

rsi_ble_read_rf_path_compensation#

int32_t rsi_ble_read_rf_path_compensation (void * resp)

rsi_ble_write_rf_path_compensation#

int32_t rsi_ble_write_rf_path_compensation (uint16_t tx_path_value, uint16_t rx_path_value)

used to indicate the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate components

Returns

• 0 = success
  !0 = failure
  

description#

This function used to indicate the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate components.

rsi_ble_vendor_feature_bitmap#

int32_t rsi_ble_vendor_feature_bitmap (uint32_t bitmap)

Vendor specific BLE command to set bitmap.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success
  Non-Zero Value - Failure

rsi_ble_add_service#

int32_t rsi_ble_add_service (uuid_t service_uuid, rsi_ble_resp_add_serv_t * p_resp_serv)

Add a new service to the local GATT Server. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4046 - Invalid Arguments
  0x4D08 - Profile record full
  

Note

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

rsi_ble_add_attribute#

int32_t rsi_ble_add_attribute (rsi_ble_req_add_att_t * p_attribute)

Add a new attribute to a specific service. This is a Blocking API.

• Call rsi_wireless_init() before calling this API.

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4046 - Invalid Arguments
  0x4D09 - Attribute record full
  

Note

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

rsi_ble_set_local_att_value#

int32_t rsi_ble_set_local_att_value (uint16_t handle, uint16_t data_len, uint8_t * p_data)

Change the local attribute value. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4046 - Invalid Arguments
  0x4D06 - Attribute record not found
  0x4E60 - Invalid Handle Range
  

Note

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

• This API can only be used if the service is maintained inside the firmware.
  The services which are maintained by firmware must follow the below rules.
  Rule 1: The attribute_data_size is less than 20 bytes during the service_creation
  Rule 2: while creating the service, don't use the RSI_BLE_ATT_MAINTAIN_IN_HOST bit
  in the RSI_BLE_ATT_CONFIG_BITMAP macro.
  Rule 3: The data_len must be less than or equal to the dat_length mentioned while
  creating the service/attribute
  Rule 4: If the services are maintained in the Application/Host,
  then need to use rsi_ble_notify_value() API to send the notifications to the remote devices.
  

rsi_ble_set_wo_resp_notify_buf_info#

int32_t rsi_ble_set_wo_resp_notify_buf_info (uint8_t * dev_addr, uint8_t buf_mode, uint8_t buf_cnt)

Configure the buf mode for Notify and WO response commands for the remote device. This is a Blocking API.

Returns

• 0 - Success
  Non-Zero Value - Failure 0x4046 - Invalid Arguments
  0x4D05 - BLE socket not available
  0x4D06 - Attribute record not found
  0x4E60 - Invalid Handle Range
  0x4E63 - BLE Buffer Count Exceeded
  0x4E64 - BLE Buffer already in use
  

Note

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

rsi_ble_notify_value#

int32_t rsi_ble_notify_value (uint8_t * dev_addr, uint16_t handle, uint16_t data_len, uint8_t * p_data)

Notify the local value to the remote device. This is a Blocking API. If the API returns RSI_ERROR_BLE_DEV_BUF_FULL (-31) error then wait untill the rsi_ble_on_le_more_data_req_t event gets received from the module.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4046 - Invalid Arguments
  0x4A0D - Invalid attribute value length
  0x4D05 - BLE socket not available
  0x4D06 - Attribute record not found
  0x4E60 - Invalid Handle Range
  0x4E65 - Invalid Attribute Length When Small Buffer Mode is Configured
  

Note

• Refer Error Codes section for above error codes Error Codes
  

• If the services are maintained in the Application/Host,
  then need to use rsi_ble_notify_value() API instead of using rsi_ble_set_local_att_value() API
  to send the notifications to the remote devices.

rsi_ble_indicate_value#

int32_t rsi_ble_indicate_value (uint8_t * dev_addr, uint16_t handle, uint16_t data_len, uint8_t * p_data)

Indicate the local value to the remote device. This is a blocking API and can unblock the application on the reception of the callback functions either rsi_ble_on_event_indicate_confirmation_t.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4D05 - BLE socket not available
  0x4E60 - Invalid Handle Range
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_get_local_att_value#

int32_t rsi_ble_get_local_att_value (uint16_t handle, rsi_ble_resp_local_att_value_t * p_resp_local_att_val)

Get the local attribute value. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4046 - Invalid Arguments
  0x4D06 - Attribute record not found
  

Note

• Refer Error Codes section for above error codes Error Codes
  

• This API can only be used if the service is maintained inside the firmware. The services which are maintained by firmware must follow the below rules.
  Rule 1: The attribute_data_size is less than 20 bytes during the service_creation
  Rule 2: While creating the service, don't use the RSI_BLE_ATT_MAINTAIN_IN_HOST bit in the RSI_BLE_ATT_CONFIG_BITMAP macro.

rsi_ble_gatt_read_response#

int32_t rsi_ble_gatt_read_response (uint8_t * dev_addr, uint8_t read_type, uint16_t handle, uint16_t offset, uint16_t length, uint8_t * p_data)

Send the response for the read request received from the remote device. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4D04 - BLE not connected
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_remove_gatt_service#

int32_t rsi_ble_remove_gatt_service (uint32_t service_handler)

Remove the GATT service record. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4D0A - BLE profile not found (profile handler invalid)
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_remove_gatt_attibute#

int32_t rsi_ble_remove_gatt_attibute (uint32_t service_handler, uint16_t att_hndl)

Remove the GATT attribute record. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure
  0x4D06 - Attribute record not found
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_att_error_response#

int32_t rsi_ble_att_error_response (uint8_t * dev_addr, uint16_t handle, uint8_t opcode, uint8_t err)

Send attribute error response for any of the att request. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure 0x4D04 - BLE not Connected
  0x4E62 - Invalid Parameters
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_gatt_write_response#

int32_t rsi_ble_gatt_write_response (uint8_t * dev_addr, uint8_t type)

Send the response to the write request received from the remote device. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure 0x4046 - Invalid Arguments
  0x4D04 - BLE not Connected
  

Note

• Refer Error Codes section for above error codes Error Codes
  

rsi_ble_gatt_prepare_write_response#

int32_t rsi_ble_gatt_prepare_write_response (uint8_t * dev_addr, uint16_t handle, uint16_t offset, uint16_t length, uint8_t * data)

Send the response for the prepare write requests received from the remote device. This is a Blocking API.

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

Returns

• 0 - Success
  Non-Zero Value - Failure 0x4046 - Invalid Arguments
  0x4D04 - BLE not Connected
  

Note

• Refer Error Codes section for above error codes Error Codes