Event Types#

rsi_ble_event_adv_report_t#

typedef struct rsi_ble_event_adv_report_s rsi_ble_event_adv_report_t

Structure representing a BLE advertising report event.

rsi_ble_event_conn_status_t#

typedef struct rsi_ble_event_conn_status_s rsi_ble_event_conn_status_t

Structure representing the connection status event in the BLE module.

rsi_ble_event_enhance_conn_status_t#

typedef struct rsi_ble_event_enhnace_conn_status_s rsi_ble_event_enhance_conn_status_t

Structure representing the enhanced connection status event in the BLE module.

rsi_ble_event_disconnect_t#

typedef struct rsi_ble_event_disconnect_s rsi_ble_event_disconnect_t

Disconnection event structure for BLE.

This structure contains information about the disconnection event of a BLE device.

rsi_ble_event_le_ping_time_expired_t#

typedef struct rsi_ble_event_le_ping_time_expired_s rsi_ble_event_le_ping_time_expired_t

Structure representing the BLE event for LE ping time expiration.

rsi_bt_event_le_ltk_request_t#

typedef struct rsi_bt_event_le_ltk_request_s rsi_bt_event_le_ltk_request_t

Structure representing a Bluetooth Low Energy (LE) Long Term Key (LTK) request event.

rsi_bt_event_le_security_keys_t#

typedef struct rsi_bt_event_le_security_keys_s rsi_bt_event_le_security_keys_t

Structure representing the Bluetooth Low Energy (BLE) event for security keys.

rsi_bt_event_encryption_enabled_t#

typedef struct rsi_bt_event_encryption_enabled_s rsi_bt_event_encryption_enabled_t

Structure to hold the event data for encryption enabled event.

rsi_bt_event_smp_req_t#

typedef struct rsi_bt_event_smp_req_s rsi_bt_event_smp_req_t

Structure to hold the Security Manager Protocol (SMP) request event.

rsi_bt_event_smp_resp_t#

typedef struct rsi_bt_event_smp_resp_s rsi_bt_event_smp_resp_t

Structure to hold the SMP response event data.

rsi_bt_event_smp_passkey_t#

typedef struct rsi_bt_event_smp_passkey_s rsi_bt_event_smp_passkey_t

Structure to hold the SMP passkey event data.

rsi_bt_event_smp_passkey_display_t#

typedef struct rsi_bt_event_smp_passkey_display_s rsi_bt_event_smp_passkey_display_t

Structure to hold the SMP passkey display event.

rsi_bt_event_sc_passkey_t#

typedef struct rsi_bt_event_sc_passkey_s rsi_bt_event_sc_passkey_t

Structure to hold the Secure Connections (SC) passkey event.

rsi_bt_event_smp_failed_t#

typedef struct rsi_bt_event_smp_failed_s rsi_bt_event_smp_failed_t

Structure to hold the information related to a Bluetooth Low Energy (BLE) Security Manager Protocol (SMP) failed event.

rsi_bt_event_sc_method_t#

typedef struct rsi_bt_event_sc_method_s rsi_bt_event_sc_method_t

Structure to define the Bluetooth event security method.

rsi_ble_event_ctkd_t#

typedef struct rsi_bt_event_ctkd_s rsi_ble_event_ctkd_t

Structure representing the BLE event for Cross Transport Key Derivation (CTKD).

This structure is used to define the parameters for the BLE event related to Cross Transport Key Derivation, including the remote device address and the derived key.

rsi_ble_event_phy_update_t#

typedef struct rsi_ble_event_phy_update_s rsi_ble_event_phy_update_t

Structure to hold the BLE PHY update event information.

rsi_ble_event_conn_update_t#

typedef struct rsi_ble_event_conn_update_s rsi_ble_event_conn_update_t

Structure to hold the data of the BLE connection update event.

rsi_ble_event_remote_conn_param_req_t#

typedef struct rsi_ble_event_remote_conn_param_req_s rsi_ble_event_remote_conn_param_req_t

Structure representing the parameters of a remote connection parameter request event in BLE.

rsi_ble_event_remote_features_t#

typedef struct rsi_ble_event_remote_features_s rsi_ble_event_remote_features_t

Structure to hold the data of the remote features event.

rsi_ble_event_le_dev_buf_ind_t#

typedef struct rsi_ble_event_le_dev_buf_ind_s rsi_ble_event_le_dev_buf_ind_t

Structure to hold the BLE event LE device buffer indication.

rsi_ble_event_data_length_update_t#

typedef struct rsi_ble_event_data_length_update_s rsi_ble_event_data_length_update_t

Structure representing the data for the BLE length update event.

uuid128_t#

typedef struct uuid128_s uuid128_t

Structure representing a 128-bit Universal Unique IDentifier (UUID).

uuid16_t#

typedef uint16_t uuid16_t

16 bit UUID format structure

uuid32_t#

typedef uint32_t uuid32_t

32 bit UUID format structure

uuid_t#

typedef struct uuid_s uuid_t

Structure representing a Universally Unique Identifier (UUID).

This structure encapsulates a UUID, which can be of varying sizes— 16, 32, or 128-bits. It includes the size of the UUID, a reserved field, and a union to hold the value of one of the three types of UUIDs.

rsi_ble_event_error_resp_t#

typedef struct rsi_ble_event_error_resp_s rsi_ble_event_error_resp_t

Structure representing the response for a BLE event error.

rsi_ble_event_gatt_desc_t#

typedef struct rsi_ble_event_gatt_desc_s rsi_ble_event_gatt_desc_t

Structure representing a GATT descriptor event.

rsi_ble_event_profiles_list_t#

typedef struct rsi_ble_event_profiles_list_s rsi_ble_event_profiles_list_t

Structure representing the BLE event profiles list.

This structure is used to define the parameters for the BLE event profiles list, including the remote device address, number of profiles found, and the list of found profiles.

rsi_ble_event_profile_by_uuid_t#

typedef struct rsi_ble_event_profile_by_uuid_s rsi_ble_event_profile_by_uuid_t

Structure to hold the BLE event profile by UUID.

rsi_ble_event_read_by_type1_t#

typedef struct rsi_ble_event_read_by_type1_s rsi_ble_event_read_by_type1_t

Structure representing the BLE event for reading characteristic services by type.

This structure is used to represent the BLE event RSI_BLE_EVENT_GATT_READ_CHAR_SERVS with event ID 0x1503. It provides information related to the read operation of characteristic services.

rsi_ble_event_read_by_type2_t#

typedef struct rsi_ble_event_read_by_type2_s rsi_ble_event_read_by_type2_t

Structure for BLE event read by type 2.

rsi_ble_event_read_by_type3_t#

typedef struct rsi_ble_event_read_by_type3_s rsi_ble_event_read_by_type3_t

Structure definition for the BLE event "Read By Type 3" response.

rsi_ble_event_att_value_t#

typedef struct rsi_ble_event_att_value_s rsi_ble_event_att_value_t

Structure representing the BLE ATT value event.

rsi_ble_set_att_resp_t#

typedef struct rsi_ble_set_att_resp_s rsi_ble_set_att_resp_t

Structure to hold the response for the BLE set attribute request.

rsi_ble_prepare_write_resp_t#

typedef struct rsi_ble_prepare_write_resp_s rsi_ble_prepare_write_resp_t

Structure representing the response for the prepare write operation in BLE.

rsi_ble_resp_profiles_list_t#

typedef struct rsi_ble_resp_profiles_list_s rsi_ble_resp_profiles_list_t

Structure representing the list of received profiles, The maximum value is 5.

rsi_ble_resp_query_profile_descriptor_t#

typedef struct rsi_ble_resp_query_profile_descriptor_s rsi_ble_resp_query_profile_descriptor_t

Structure representing the list of received profile descriptor of a particular profile, The maximum value is 5.

rsi_ble_resp_char_services_t#

typedef struct rsi_ble_resp_char_serv_s rsi_ble_resp_char_services_t

Structure to hold the response of characteristic services.

rsi_ble_resp_inc_services_t#

typedef struct rsi_ble_resp_inc_serv rsi_ble_resp_inc_services_t

Structure representing the list of received included service attributes for a particular included service.

The maximum value is 5.

rsi_ble_resp_att_value_t#

typedef struct rsi_ble_resp_att_value_t rsi_ble_resp_att_value_t

Structure representing the response for an Attribute Protocol (ATT) value in Bluetooth Low Energy (BLE).

rsi_ble_resp_att_descs_t#

typedef struct rsi_ble_resp_att_descs_s rsi_ble_resp_att_descs_t

Structure representing the list of received attribute descriptors, The maximum value is 5.

rsi_ble_resp_add_serv_t#

typedef struct rsi_ble_resp_add_serv_s rsi_ble_resp_add_serv_t

Structure representing the response for adding a service in BLE.

rsi_ble_resp_local_att_value_t#

typedef struct rsi_ble_resp_local_att_value_s rsi_ble_resp_local_att_value_t

Structure representing the response for local attribute value in BLE.

rsi_ble_event_remote_device_info_t#

typedef struct rsi_ble_event_remote_device_info_s rsi_ble_event_remote_device_info_t

Structure representing the BLE event for remote device information.

This structure is used to define the parameters for a BLE event that provides information about a remote device.

rsi_ble_event_rcp_rcvd_info_t#

typedef struct rsi_ble_event_rcp_rcvd_info_s rsi_ble_event_rcp_rcvd_info_t

Structure representing the BLE event for received Remote Control Protocol (RCP) information.

This structure is used to define the parameters for a BLE event that involves receiving RCP information.

rsi_ble_event_write_t#

typedef struct rsi_ble_event_write_s rsi_ble_event_write_t

Structure representing a BLE write event.

rsi_ble_event_prepare_write_t#

typedef struct rsi_ble_event_prepare_write_s rsi_ble_event_prepare_write_t

Structure definition for preparing a write operation in BLE event.

rsi_ble_execute_write_t#

typedef struct rsi_ble_execute_write_s rsi_ble_execute_write_t

Structure representing the BLE execute write request.

This structure is used to define the parameters for an execute write request to a remote BLE device.

rsi_ble_read_req_t#

typedef struct rsi_ble_read_req_s rsi_ble_read_req_t

Structure representing the BLE read request.

This structure is used to define the parameters for a BLE read request, including the remote device address, attribute handle, request type, and offset.

rsi_ble_event_mtu_t#

typedef struct rsi_ble_event_mtu_s rsi_ble_event_mtu_t

Structure to hold the BLE MTU event information.

rsi_ble_event_mtu_exchange_information_t#

typedef struct rsi_ble_event_mtu_exchange_information_s rsi_ble_event_mtu_exchange_information_t

Structure to hold the MTU exchange information for a BLE event.

rsi_ble_event_directedadv_report_t#

typedef struct rsi_ble_event_directedadv_report_s rsi_ble_event_directedadv_report_t

Structure to hold the information of a directed advertising report event.

rsi_ble_event_cbfc_conn_req_t#

typedef struct rsi_ble_event_cbfc_conn_req_s rsi_ble_event_cbfc_conn_req_t

Structure representing the BLE event for CBFC connection request.

This structure is used to define the parameters for a BLE event that involves a Circular Buffer Flow Control (CBFC) connection request from a remote device.

rsi_ble_event_cbfc_conn_complete_t#

typedef struct rsi_ble_event_cbfc_conn_complete_s rsi_ble_event_cbfc_conn_complete_t

Structure representing the BLE event for CBFC connection complete.

This structure is used to define the parameters for a BLE event that indicates the completion of a Circular Buffer Flow Control (CBFC) connection with a remote device.

rsi_ble_event_cbfc_rx_data_t#

typedef struct rsi_ble_event_cbfc_rx_data_s rsi_ble_event_cbfc_rx_data_t

Structure representing the BLE event for CBFC received data.

This structure is used to define the parameters for a BLE event that involves receiving data over a Circular Buffer Flow Control (CBFC) connection from a remote device.

rsi_ble_event_cbfc_disconn_t#

typedef struct rsi_ble_event_cbfc_disconn_s rsi_ble_event_cbfc_disconn_t

Structure representing the BLE event for CBFC disconnection.

This structure is used to define the parameters for a BLE event that involves the disconnection of a Circular Buffer Flow Control (CBFC) connection with a remote device.

rsi_ble_ae_adv_report_t#

typedef struct rsi_ble_ae_adv_report_s rsi_ble_ae_adv_report_t

ae adv report event

rsi_ble_per_adv_sync_estbl_t#

typedef struct rsi_ble_per_adv_sync_estbl_s rsi_ble_per_adv_sync_estbl_t

ae periodic sync establishment report event

rsi_ble_per_adv_report_t#

typedef struct rsi_ble_per_adv_report_s rsi_ble_per_adv_report_t

ae periodic adv report event

rsi_ble_per_adv_sync_lost_t#

typedef struct rsi_ble_per_adv_sync_lost_s rsi_ble_per_adv_sync_lost_t

ae periodic sync lost report event

rsi_ble_scan_timeout_t#

typedef struct rsi_ble_scan_timeout_s rsi_ble_scan_timeout_t

ae scan timeout report event

rsi_ble_adv_set_terminated_t#

typedef struct rsi_ble_adv_set_terminated_s rsi_ble_adv_set_terminated_t

ae adv set terminated report event

rsi_ble_scan_req_recvd_t#

typedef struct rsi_ble_scan_req_recvd_s rsi_ble_scan_req_recvd_t

ae scan request recvd report event

chip_ble_buffers_stats_t#

typedef struct chip_ble_buffers_stats_s chip_ble_buffers_stats_t

Structure representing the BLE buffer statistics.

This structure is used to define the parameters for BLE buffer statistics, including the utilization of Asynchronous Connection-Less (ACL) buffers and command packet buffers.

rsi_ble_on_cbfc_conn_req_event_t#

void(* rsi_ble_on_cbfc_conn_req_event_t)(rsi_ble_event_cbfc_conn_req_t *rsi_ble_cbfc_conn_req) )(rsi_ble_event_cbfc_conn_req_t *rsi_ble_cbfc_conn_req)

Callback function to handle an L2CAP CBFC connection request event.

This callback function is called when a Circular Buffer Flow Control (CBFC) connection request is received from a remote BLE device. It provides the necessary connection parameters to process the request. This callback has to be registered using rsi_ble_l2cap_cbfc_callbacks API.

rsi_ble_on_cbfc_conn_complete_event_t#

void(* rsi_ble_on_cbfc_conn_complete_event_t)(rsi_ble_event_cbfc_conn_complete_t *rsi_ble_cbfc_conn_complete, uint16_t status) )(rsi_ble_event_cbfc_conn_complete_t *rsi_ble_cbfc_conn_complete, uint16_t status)

Callback function to indicate L2CAP CBFC connection complete status.

This callback function will be called when Circular Buffer Flow Control (CBFC) connection has been successfully established or when the connection attempt fails. The function provides detailed information about the connection parameters and the status of the operation. This callback has to be registered using rsi_ble_l2cap_cbfc_callbacks API.

rsi_ble_on_cbfc_rx_data_event_t#

void(* rsi_ble_on_cbfc_rx_data_event_t)(rsi_ble_event_cbfc_rx_data_t *rsi_ble_cbfc_rx_data) )(rsi_ble_event_cbfc_rx_data_t *rsi_ble_cbfc_rx_data)

Callback function to indicate L2CAP CBFC RX data event.

This callback function will be called when data is received over a Circular Buffer Flow Control (CBFC) connection from a remote device. This callback has to be registered using rsi_ble_l2cap_cbfc_callbacks API.

rsi_ble_on_cbfc_disconn_event_t#

void(* rsi_ble_on_cbfc_disconn_event_t)(rsi_ble_event_cbfc_disconn_t *rsi_ble_cbfc_disconn) )(rsi_ble_event_cbfc_disconn_t *rsi_ble_cbfc_disconn)

Callback function to indicate L2CAP CBFC disconnection event.

This callback function will be called whenever a Circular Buffer Flow Control (CBFC) disconnection event occurs. This callback has to be registered using rsi_ble_l2cap_cbfc_callbacks API.

chip_ble_buffers_stats_handler_t#

void(* chip_ble_buffers_stats_handler_t)(chip_ble_buffers_stats_t *chip_ble_buffers_stats) )(chip_ble_buffers_stats_t *chip_ble_buffers_stats)

Typedef for the chip_ble_buffers_stats_handler_t function pointer.

This function pointer type is used to define a callback function that handles the statistics of the BLE buffers in the chip.

rsi_ble_ae_report_complete_t#

void(* rsi_ble_ae_report_complete_t)(uint16_t resp_status, rsi_ble_ae_adv_report_t *rsi_ble_event_ae_report) )(uint16_t resp_status, rsi_ble_ae_adv_report_t *rsi_ble_event_ae_report)

Callback function to report the AE Advertisements.

This callback function will be called when AE adv report event is received. This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_per_adv_sync_estbl_t#

void(* rsi_ble_ae_per_adv_sync_estbl_t)(uint16_t resp_status, rsi_ble_per_adv_sync_estbl_t *rsi_ble_event_per_adv_sync_estbl) )(uint16_t resp_status, rsi_ble_per_adv_sync_estbl_t *rsi_ble_event_per_adv_sync_estbl)

Callback function to report the AE periodic sync established event.

This callback function will be called when AE periodic sync established event is received. This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_per_adv_report_t#

void(* rsi_ble_ae_per_adv_report_t)(uint16_t resp_status, rsi_ble_per_adv_report_t *rsi_ble_event_per_adv_report) )(uint16_t resp_status, rsi_ble_per_adv_report_t *rsi_ble_event_per_adv_report)

Callback function to report the AE periodic advertisement event This callback function will be called when AE periodic advertisement event is received This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_per_adv_sync_lost_t#

void(* rsi_ble_ae_per_adv_sync_lost_t)(uint16_t resp_status, rsi_ble_per_adv_sync_lost_t *rsi_ble_event_per_adv_sync_lost) )(uint16_t resp_status, rsi_ble_per_adv_sync_lost_t *rsi_ble_event_per_adv_sync_lost)

Callback function to report the AE periodic sync lost event This callback function will be called when AE periodic sync lost event is received This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_scan_timeout_t#

void(* rsi_ble_ae_scan_timeout_t)(uint16_t resp_status, rsi_ble_scan_timeout_t *rsi_ble_event_scan_timeout) )(uint16_t resp_status, rsi_ble_scan_timeout_t *rsi_ble_event_scan_timeout)

Callback function to report the AE scan timeout event This callback function will be called when AE scan timeout event is received This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_adv_set_terminated_t#

void(* rsi_ble_ae_adv_set_terminated_t)(uint16_t resp_status, rsi_ble_adv_set_terminated_t *rsi_ble_event_adv_set_terminated) )(uint16_t resp_status, rsi_ble_adv_set_terminated_t *rsi_ble_event_adv_set_terminated)

Callback function to report the AE advertising set terminated event This callback function will be called when AE advertising set terminated is received.

This callback has to be registered using rsi_ble_ae_events_register_callbacks API.

rsi_ble_ae_scan_req_recvd_t#

void(* rsi_ble_ae_scan_req_recvd_t)(uint16_t resp_status, rsi_ble_scan_req_recvd_t *rsi_ble_event_scan_req_recvd) )(uint16_t resp_status, rsi_ble_scan_req_recvd_t *rsi_ble_event_scan_req_recvd)

Callback function to report the AE scan request received event This callback function will be called when AE scan request is received.

it provides AE scan request information. This callback has to be registered using rsi_ble_ae_events_register_callbacks API

rsi_convert_db_to_powindex#

uint8_t rsi_convert_db_to_powindex (int8_t tx_power_in_dBm)

Converts the given transmit power in dBm to power index.

This function takes a transmit power value in dBm and converts it to a power index value. The power index is used to set the transmit power level in the BLE module.

Returns

• The power index corresponding to the given transmit power.

rsi_ble_cbfc_connreq#

uint32_t rsi_ble_cbfc_connreq (uint8_t * dev_addr, uint16_t psm)

Sends a connection request to a remote device using the Credit Based Flow Control (CBFC) mechanism.

This function sends a connection request to a remote device using the CBFC mechanism. It takes the device address and the Protocol Service Multiplexer (PSM) as input parameters.

Returns

• Returns a 32-bit unsigned integer indicating the status of the connection request.

  • 0: If the connection request is successful.

  • Non-zero: If there is an error in sending the connection request.

rsi_ble_cbfc_connresp#

uint32_t rsi_ble_cbfc_connresp (uint8_t * dev_addr, uint16_t lcid, uint8_t result)

Sends a connection response for a credit-based flow control (CBFC) connection.

This function is used to send a connection response for a CBFC connection in the Bluetooth Low Energy (BLE) module.

Returns

• The status of the operation. Returns a 32-bit unsigned integer.

rsi_ble_cbfc_data_tx#

uint32_t rsi_ble_cbfc_data_tx (uint8_t * dev_addr, uint16_t lcid, uint16_t len, uint8_t * p_data)

Transmits data over a Connection-Based Flow Control (CBFC) channel in the Bluetooth Low Energy (BLE) module.

This function is used to transmit data over a CBFC channel in the BLE module. It takes the device address, logical channel ID (LCID), length of the data, and a pointer to the data as input parameters. The function returns a 32-bit unsigned integer as the status of the transmission.

Returns

• 32-bit unsigned integer representing the status of the transmission.

rsi_ble_cbfc_disconnect#

uint32_t rsi_ble_cbfc_disconnect (uint8_t * dev_addr, uint16_t lcid)

Disconnects a Connection-Based Flow Control (CBFC) connection with the specified device address and logical channel ID.

This function is used to disconnect a CBFC connection with the specified device address and logical channel ID.

Returns

• The status code indicating the success or failure of the operation.

  • Returns 0 on success.

  • Returns a non-zero value on failure.

rsi_ble_l2cap_cbsc_register_callbacks#

void rsi_ble_l2cap_cbsc_register_callbacks (rsi_ble_on_cbfc_conn_req_event_t ble_on_cbsc_conn_req, rsi_ble_on_cbfc_conn_complete_event_t ble_on_cbsc_conn_complete, rsi_ble_on_cbfc_rx_data_event_t ble_on_cbsc_rx_data, rsi_ble_on_cbfc_disconn_event_t ble_on_cbsc_disconn)

Register callbacks for BLE L2CAP Credit Based Flow Control (CBFC) events.

This function is used to register callbacks for various CBFC events in BLE L2CAP. The registered callbacks will be invoked when the corresponding events occur.