Data Structures#

rsi_ble_gap_extended_callbacks_s#

rsi_ble_gap_extended_callbacks_s

Enumeration representing the BLE GAP extended callback types.

This enumeration defines the possible callback types for the BLE GAP extended feature.

rsi_bt_common_cmd_request_e#

rsi_bt_common_cmd_request_e

Enumeration of Bluetooth common command requests.

Defines various command requests for Bluetooth operations, including setting and getting local device information, initializing and deinitializing the device, and configuring antenna and power settings.

rsi_bt_common_event_e#

rsi_bt_common_event_e

Enumeration of Bluetooth common events.

Defines various events for Bluetooth operations, including the event indicating that the Bluetooth card is ready.

rsi_bt_common_cmd_resp_e#

rsi_bt_common_cmd_resp_e

Enumeration of Bluetooth common command responses.

Defines various command responses for Bluetooth operations, including responses for setting and querying local device information, initializing and deinitializing the device, and configuring antenna and power settings.

rsi_ble_req_rand_t#

typedef struct rsi_ble_req_rand_s rsi_ble_req_rand_t

Structure representing the BLE request to set a random address.

This structure is used to define the parameters for the BLE request to set a random address, including the random address of the device to be set.

rsi_ble_req_adv_t#

typedef struct rsi_ble_req_adv_s rsi_ble_req_adv_t

Structure representing a BLE advertising request.

rsi_ble_req_adv_data_t#

typedef struct rsi_ble_req_adv_data_s rsi_ble_req_adv_data_t

Structure representing the BLE request to set advertising data.

This structure is used to define the parameters for the BLE request to set advertising data, including the advertising data length and the advertising data itself.

rsi_ble_req_acceptlist_using_payload_t#

typedef struct rsi_ble_req_acceptlist_using_payload_s rsi_ble_req_acceptlist_using_payload_t

Structure representing the BLE request to manage the accept list using a payload.

This structure is used to define the parameters for the BLE request to manage the accept list, including the operation code, enable flag, total length of the payload, data compare index, length of the data to compare, and the advertising data payload.

rsi_ble_set_ble_tx_power_t#

typedef struct rsi_ble_set_ble_tx_power_s rsi_ble_set_ble_tx_power_t

Structure representing the BLE request to set the transmission power.

This structure is used to define the parameters for the BLE request to set the transmission power, including the transmission power value.

rsi_ble_req_scanrsp_data_t#

typedef struct rsi_ble_req_scanrsp_data_s rsi_ble_req_scanrsp_data_t

Structure representing the set scan response data for the BLE scan request.

This structure is used to define the parameters to set scan response data for the BLE scan request, including the scan response data length.

rsi_ble_req_scan_t#

typedef struct rsi_ble_req_scan_s rsi_ble_req_scan_t

Structure representing a BLE scan request.

rsi_ble_encrypt_t#

typedef struct rsi_ble_encrypt_s rsi_ble_encrypt_t

Structure representing the BLE encryption request.

This structure is used to define the parameters for the BLE encryption request, including the encryption key and the data to be encrypted.

rsi_data_packet_t#

typedef struct rsi_data_packet_s rsi_data_packet_t

Structure representing a data packet.

This structure is used to define the parameters for a data packet, including an array to hold the data packet, up to 1024 bytes.

rsi_ble_accept_list_t#

typedef struct rsi_ble_accept_list_s rsi_ble_accept_list_t

Structure representing the BLE accept list.

This structure is used to define the parameters for the BLE accept list, including the operation to add or delete the address, the device address, and the address type.

rsi_ble_req_conn_t#

typedef struct rsi_ble_req_conn_s rsi_ble_req_conn_t

Structure representing the BLE connection request.

This structure is used to define the parameters for a BLE connection request, including the address type and address of the device to connect, scan interval, scan window, connection interval, connection latency, and supervision timeout.

rsi_ble_req_enhance_conn_t#

typedef struct rsi_ble_req_enhance_conn_s rsi_ble_req_enhance_conn_t

Structure representing the BLE enhanced connection request.

This structure is used to define the parameters for a BLE enhanced connection request, including the address type and address of the device to connect, filter policy, own address type, scan interval, scan window, connection interval, connection latency, supervision timeout, and connection event length.

rsi_ble_req_disconnect_t#

typedef struct rsi_ble_req_disconnect_s rsi_ble_req_disconnect_t

Structure representing the BLE request to disconnect.

This structure is used to define the parameters for the BLE request to disconnect, including the device address and the type of disconnect operation.

rsi_ble_strat_encryption_t#

typedef struct rsi_ble_start_encryption_s rsi_ble_strat_encryption_t

Structure representing the BLE start encryption request.

This structure is used to define the parameters for a BLE start encryption request, including the address of the connected device, the remote device's Encrypted Diversifier (EDIV) value, Random (RAND) value, and Long Term Key (LTK) value.

rsi_ble_req_smp_pair_t#

typedef struct rsi_ble_req_smp_pair_s rsi_ble_req_smp_pair_t

Structure representing the BLE Security Manager Protocol (SMP) pairing request.

This structure is used to define the parameters for a BLE SMP pairing request, including the device address, IO capability, and MITM (Man-In-The-Middle) protection requirement.

rsi_ble_smp_response_t#

typedef struct rsi_ble_smp_response_s rsi_ble_smp_response_t

Structure representing the BLE Security Manager Protocol (SMP) response.

This structure is used to define the parameters for a BLE SMP response, including the device address, IO capability, and Man-In-The-Middle (MITM) protection requirement.

rsi_ble_smp_passkey_t#

typedef struct rsi_ble_smp_passkey_s rsi_ble_smp_passkey_t

Structure representing the BLE SMP (Security Manager Protocol) passkey.

This structure is used to define the parameters for a BLE SMP passkey, including the device address, reserved bytes for future use, and the passkey used for pairing.

rsi_ble_get_le_ping_timeout_t#

typedef struct rsi_ble_get_le_ping_timeout_s rsi_ble_get_le_ping_timeout_t

Structure representing the BLE command to get the LE ping timeout.

This structure is used to define the parameters for a BLE command to get the LE ping timeout, including the remote device address.

rsi_ble_rsp_get_le_ping_timeout_t#

typedef struct rsi_ble_rsp_get_le_ping_timeout_s rsi_ble_rsp_get_le_ping_timeout_t

Structure representing the BLE response for getting LE ping timeout.

This structure is used to define the parameters for the BLE response to get the LE ping timeout, including the address of the connected device and the LE ping timeout value.

rsi_ble_set_le_ping_timeout_t#

typedef struct rsi_ble_set_le_ping_timeout_s rsi_ble_set_le_ping_timeout_t

Structure representing the BLE request to set LE ping timeout.

This structure is used to define the parameters for a BLE request to set the LE ping timeout, including the address of the connected device and the LE ping timeout value to be set.

rsi_ble_resolvlist_t#

typedef struct rsi_ble_resolvlist_s rsi_ble_resolvlist_t

Structure representing the BLE resolving list entry.

This structure is used to define the parameters for a BLE resolving list entry, including the type of process (e.g., add, remove, clear), the address type and address of the remote device, and the Identity Resolving Keys (IRKs) of both the peer and local devices.

rsi_ble_get_resolving_list_size_t#

typedef struct rsi_ble_get_resolving_list_size_s rsi_ble_get_resolving_list_size_t

Structure representing the BLE request to get the size of the resolving list.

This structure is used to define the parameter for a BLE request to get the size of the resolving list.

rsi_ble_set_addr_resolution_enable_t#

typedef struct rsi_ble_set_addr_resolution_enable_s rsi_ble_set_addr_resolution_enable_t

Structure representing the BLE request to enable or disable address resolution.

This structure is used to define the parameters for a BLE request to enable or disable address resolution, including the enable flag, reserved field for future use, and the timeout value for address resolution.

rsi_ble_cmd_conn_params_update_t#

typedef struct rsi_ble_cmd_conn_params_update_s rsi_ble_cmd_conn_params_update_t

Structure representing the BLE command to update connection parameters.

This structure is used to define the parameters for a BLE command to update connection parameters, including the address of the connected device, minimum and maximum connection intervals, peripheral latency, and supervision timeout.

rsi_ble_req_read_phy_t#

typedef struct rsi_ble_req_read_phy_s rsi_ble_req_read_phy_t

Structure representing the BLE request to read PHY.

This structure is used to define the parameter for a BLE request to read the PHY, including the address of the connected device.

rsi_ble_set_phy_t#

typedef struct rsi_ble_set_phy_s rsi_ble_set_phy_t

Structure representing the BLE request to set PHY.

This structure is used to define the parameters for a BLE request to set the PHY, including the address of the connected device, all PHYs preference, preferred TX PHY, preferred RX PHY, reserved field for future use, and PHY options.

rsi_ble_setdatalength_t#

typedef struct rsi_ble_setdatalength_s rsi_ble_setdatalength_t

Structure representing the BLE request to set data length.

This structure is used to define the parameters for a BLE request to set the data length, including the address of the connected device, the maximum number of payload octets that the local device will send, and the maximum time that the local device will take to send the payload.

rsi_ble_set_privacy_mode_t#

typedef struct rsi_ble_set_privacy_mode_s rsi_ble_set_privacy_mode_t

Structure representing the BLE request to set privacy mode.

This structure is used to define the parameters for a BLE request to set the privacy mode, including the address type and address of the remote device, and the privacy mode to be set.

rsi_ble_cbfc_conn_req_t#

typedef struct rsi_ble_cbfc_conn_req_s rsi_ble_cbfc_conn_req_t

Structure representing the BLE Credit Based Flow Control (CBFC) connection request.

This structure is used to define the parameters for a BLE CBFC connection request, including the address of the remote device and the Protocol/Service Multiplexer (PSM) value.

rsi_ble_tx_test_mode_t#

typedef struct rsi_ble_tx_test_mode_s rsi_ble_tx_test_mode_t

Structure representing the BLE TX test mode parameters.

This structure is used to define the parameters for a BLE TX test mode, including the TX channel, PHY, length of the data to be transmitted, and data mode to be used for the test.

rsi_ble_end_test_mode_t#

typedef struct rsi_ble_end_test_mode_s rsi_ble_end_test_mode_t

Structure representing the BLE end test mode parameters.

This structure is used to define the parameter for a BLE end test mode. Number of TX / RX packets received are displayed when test is stopped.

rsi_ble_set_le_ltkreqreply_t#

typedef struct rsi_ble_set_le_ltkreqreply_s rsi_ble_set_le_ltkreqreply_t

Structure representing the BLE request to set LE Long Term Key (LTK) request reply.

This structure is used to define the parameters for a BLE request to set the LE LTK request reply, including the address of the remote device, the type of reply (e.g., positive or negative), and the local Long Term Key (LTK).

rsi_ble_req_smp_pair_failed_t#

typedef struct rsi_ble_req_smp_pair_failed_s rsi_ble_req_smp_pair_failed_t

Structure representing the BLE Security Manager Protocol (SMP) pairing failure request.

This structure is used to define the parameters for a BLE SMP pairing failure request, including the address of the remote device and the reason for the pairing failure.

rsi_ble_req_profiles_list_t#

typedef struct rsi_ble_req_profiles_list_s rsi_ble_req_profiles_list_t

Structure representing the BLE request for profiles list.

This structure is used to define the parameters for a BLE request to get the profiles list, including the remote device address, the handle from which the profiles search will start, and the handle at which the profiles search will stop.

rsi_ble_req_profile_t#

typedef struct rsi_ble_req_profile_s rsi_ble_req_profile_t

Structure representing the BLE request for a specific profile.

This structure is used to define the parameters for a BLE request to get a specific profile, including the remote device address, reserved bytes for future use, and the profile UUID.

rsi_ble_req_char_services_t#

typedef struct rsi_ble_req_char_services_s rsi_ble_req_char_services_t

Structure representing the BLE request for characteristic services.

This structure is used to define the parameters for a BLE request to get characteristic services, including the remote device address, the handle from which the search will start, and the handle at which the search will end.

rsi_ble_req_inc_services_t#

typedef struct rsi_ble_req_inc_services_s rsi_ble_req_inc_services_t

Structure representing the BLE request for included services.

This structure is used to define the parameters for a BLE request to get included services, including the remote device address, the handle from which the search will start, and the handle at which the search will end.

rsi_ble_req_char_val_by_uuid_t#

typedef struct rsi_ble_req_char_val_by_uuid_s rsi_ble_req_char_val_by_uuid_t

Structure representing the BLE request for characteristic value by UUID.

This structure is used to define the parameters for a BLE request to get a characteristic value by UUID, including the remote device address, the handle from which the search will start, the handle at which the search will end, reserved bytes for future use, and the search UUID value.

rsi_ble_req_att_descs_t#

typedef struct rsi_ble_req_att_descs_s rsi_ble_req_att_descs_t

Structure representing the BLE request for attribute descriptors.

This structure is used to define the parameters for a BLE request to get attribute descriptors, including the remote device address, the handle from which the search will start, and the handle at which the search will end.

rsi_ble_req_att_value_t#

typedef struct rsi_ble_req_att_value_s rsi_ble_req_att_value_t

Structure representing the BLE request for attribute value.

This structure is used to define the parameters for a BLE request to get an attribute value, including the remote device address and the attribute handle.

rsi_ble_req_multi_att_values_t#

typedef struct rsi_ble_req_multiple_att_val_s rsi_ble_req_multi_att_values_t

Structure representing the BLE request for multiple attribute values.

This structure is used to define the parameters for a BLE request to get multiple attribute values, including the remote device address, the number of attribute handles, reserved bytes for future use, and the list of attribute handles.

rsi_ble_req_long_att_value_t#

typedef struct rsi_ble_req_long_att_value_s rsi_ble_req_long_att_value_t

Structure representing the BLE request for a long attribute value.

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

rsi_ble_set_att_value_t#

typedef struct rsi_ble_set_att_val_s rsi_ble_set_att_value_t

Structure representing the BLE request to set an attribute value.

This structure is used to define the parameters for a BLE request to set an attribute value, including the remote device address, the attribute handle, the length of the attribute value, and the attribute value itself. The module will receive the acknowledgement from the remote device.

rsi_ble_set_att_cmd_t#

typedef struct rsi_ble_set_att_cmd_s rsi_ble_set_att_cmd_t

Structure representing the BLE command to set an attribute value.

This structure is used to define the parameters for a BLE command to set an attribute value, including the remote device address, the attribute handle, the length of the attribute value, and the attribute value itself. The module won't receive the acknowledgement from the remote device.

rsi_ble_set_long_att_value_t#

typedef struct rsi_ble_set_long_att_val_s rsi_ble_set_long_att_value_t

Structure representing the BLE command to set a long attribute value.

This structure is used to define the parameters for a BLE command to set a long attribute value, including the remote device address, the attribute handle, the attribute value offset, the length of the attribute value, and the attribute value itself.

rsi_ble_req_prepare_write_t#

typedef struct rsi_ble_req_prepare_write_s rsi_ble_req_prepare_write_t

Structure representing the BLE request to prepare a write operation.

This structure is used to define the parameters for a BLE request to prepare a write operation, including the remote device address, the attribute handle, the attribute value offset, the length of the attribute value, and the attribute value itself.

rsi_ble_req_execute_write_t#

typedef struct rsi_ble_req_execute_write_s rsi_ble_req_execute_write_t

Structure representing the BLE request to execute a write operation.

This structure is used to define the parameters for a BLE request to execute a write operation, including the remote device address and the execute flag indicating whether to write or not.

rsi_ble_cmd_conn_param_resp_t#

typedef struct rsi_ble_cmd_conn_param_resp rsi_ble_cmd_conn_param_resp_t

Structure representing the BLE command response for connection parameters.

This structure is used to define the parameters for a BLE command response to a connection parameter request, including the remote device address and the status indicating whether to accept or reject the request.

rsi_ble_req_add_serv_t#

typedef struct rsi_ble_req_add_serv_s rsi_ble_req_add_serv_t

Structure representing the BLE request to add a service.

This structure is used to define the parameters for a BLE request to add a service, including the service UUID, the number of attributes in the service, and the total size of the attributes' values (data).

rsi_ble_set_local_att_value_t#

typedef struct rsi_ble_set_local_att_value_s rsi_ble_set_local_att_value_t

Structure representing the BLE command to set a local attribute value.

This structure is used to define the parameters for a BLE command to set a local attribute value, including the attribute handle, the length of the attribute value, and the attribute value itself.

rsi_ble_notify_att_value_t#

typedef struct rsi_ble_notify_att_value_s rsi_ble_notify_att_value_t

Structure representing the BLE notification for an attribute value.

This structure is used to define the parameters for a BLE notification of an attribute value, including the remote device address, the attribute handle, the length of the attribute value, and the attribute value itself.

rsi_ble_set_wo_resp_notify_buf_info_t#

typedef struct rsi_ble_set_wo_resp_notify_buf_info_s rsi_ble_set_wo_resp_notify_buf_info_t

Structure representing the BLE configuration for write without response notification buffer.

This structure is used to define the parameters for configuring the buffer for write without response notifications, including the remote device address, the buffer configuration mode, and the buffer count.

rsi_ble_indicate_confirm_t#

typedef struct rsi_ble_indicate_confirm_s rsi_ble_indicate_confirm_t

Structure representing the BLE indication confirmation.

This structure is used to define the parameters for a BLE indication confirmation, including the remote device address.

rsi_ble_get_local_att_value_t#

typedef struct rsi_ble_get_local_att_value_s rsi_ble_get_local_att_value_t

Structure representing the BLE request to get a local attribute value.

This structure is used to define the parameters for a BLE request to get a local attribute value, including the attribute handle.

rsi_ble_gatt_read_response_t#

typedef struct rsi_ble_gatt_read_response_s rsi_ble_gatt_read_response_t

Structure representing the BLE GATT read response.

This structure is used to define the parameters for a BLE GATT read response, including the remote device address, the type of the read response, reserved field for future use, the length of the attribute value, and the attribute value itself.

rsi_ble_gatt_write_response_t#

typedef struct rsi_ble_gatt_write_response_s rsi_ble_gatt_write_response_t

Structure representing the BLE GATT write response.

This structure is used to define the parameters for a BLE GATT write response, including the remote device address and the response type.

rsi_ble_gatt_prepare_write_response_t#

typedef struct rsi_ble_gatt_prepare_write_response_s rsi_ble_gatt_prepare_write_response_t

Structure representing the BLE GATT prepare write response.

This structure is used to define the parameters for a BLE GATT prepare write response, including the remote device address, the attribute handle, the attribute value offset, the length of the attribute value, and the attribute value itself.

rsi_ble_set_local_irk_t#

typedef struct rsi_ble_set_local_irk_s rsi_ble_set_local_irk_t

Structure representing the BLE command to set the local Identity Resolving Key (IRK).

This structure is used to define the parameters for a BLE command to set the local IRK, including the local device IRK.

rsi_ble_gap_extended_callbacks_t#

typedef enum rsi_ble_gap_extended_callbacks_s rsi_ble_gap_extended_callbacks_t

Enumeration representing the BLE GAP extended callback types.

This enumeration defines the possible callback types for the BLE GAP extended feature.

rsi_ble_att_error_response_t#

typedef struct rsi_ble_att_error_response_s rsi_ble_att_error_response_t

Structure representing the BLE attribute error response.

This structure is used to define the parameters for a BLE event that involves an error response for an attribute operation from a remote device.

rsi_ble_gatt_remove_serv_t#

typedef struct rsi_ble_gatt_remove_serv_s rsi_ble_gatt_remove_serv_t

Structure representing the BLE GATT remove service request.

This structure is used to define the parameters for a BLE event that involves removing a GATT service from a remote device.

rsi_ble_gatt_remove_att_t#

typedef struct rsi_ble_gatt_remove_att_s rsi_ble_gatt_remove_att_t

Structure representing the BLE GATT command to remove an attribute.

This structure is used to define the parameters for a BLE GATT command to remove an attribute, including the service handler and the attribute handle.

rsi_ble_vendor_rf_type_t#

typedef struct rsi_ble_vendor_rf_type_s rsi_ble_vendor_rf_type_t

Structure representing the BLE vendor-specific RF type command.

This structure is used to define the parameters for a BLE vendor-specific RF type command, including the opcode and the BLE power index.

rsi_ble_mtu_exchange_t#

typedef struct rsi_ble_mtu_exchange_s rsi_ble_mtu_exchange_t

Structure representing the BLE MTU exchange request.

This structure is used to define the parameters for a BLE MTU exchange request, including the remote device address and the requested MTU size.

rsi_ble_mtu_exchange_resp_t#

typedef struct rsi_ble_mtu_exchange_resp_s rsi_ble_mtu_exchange_resp_t

Structure representing the BLE MTU exchange response.

This structure is used to define the parameters for a BLE MTU exchange response, including the Bluetooth device address of the peer device and the requested MTU size from the peer device.

rsi_ble_ae_get_supported_no_of_adv_sets_t#

typedef struct rsi_ble_ae_get_supported_no_of_adv_sets_s rsi_ble_ae_get_supported_no_of_adv_sets_t

Structure representing the BLE Advertising Extensions (AE) command to get the supported number of advertising sets.

This structure is used to define the parameters for a BLE AE command to get the supported number of advertising sets, including a reserved field.

rsi_ble_ae_read_supported_max_adv_data_t#

typedef struct rsi_ble_ae_read_supported_max_adv_data_s rsi_ble_ae_read_supported_max_adv_data_t

Structure representing the BLE Advertising Extensions (AE) command to read the supported maximum advertising data.

This structure is used to define the parameters for a BLE AE command to read the supported maximum advertising data, including a reserved field for future use or alignment.

rsi_ble_ae_set_random_address_t#

typedef struct rsi_ble_ae_set_random_address_s rsi_ble_ae_set_random_address_t

Structure representing the BLE Advertising Extensions (AE) command to set a random address.

This structure is used to define the parameters for a BLE AE command to set a random address, including the advertising handle and the random address.

rsi_ble_ae_adv_params_t#

typedef struct ae_adv_params_s rsi_ble_ae_adv_params_t

AE Advertising Params.

rsi_ble_ae_data_t#

typedef struct rsi_ble_ae_data_s rsi_ble_ae_data_t

Structure representing the AE (Application Event) data for BLE.

rsi_ble_ae_adv_enable_t#

typedef struct rsi_ble_ae_adv_enabel_s rsi_ble_ae_adv_enable_t

AE Advertising enable.

rsi_ble_ae_adv_set_clear_or_remove_t#

typedef struct rsi_ble_ae_adv_set_clear_or_remove_s rsi_ble_ae_adv_set_clear_or_remove_t

Structure for Advertising Event (AE) Advertisement (ADV) Set, Clear, or Remove.

rsi_ble_ae_periodic_adv_params_t#

typedef struct ae_periodic_adv_params rsi_ble_ae_periodic_adv_params_t

Structure representing the parameters for periodic advertising in BLE.

rsi_ble_ae_periodic_adv_enable_t#

typedef struct ae_periodic_adv_enable rsi_ble_ae_periodic_adv_enable_t

Structure representing the enable/disable state of periodic advertising.

ae_scan_params_t#

typedef struct ae_scan_params_s ae_scan_params_t

Structure representing the scan parameters for Active Energy (AE) scanning.

rsi_ble_ae_set_scan_params_t#

typedef struct rsi_ble_ae_set_scan_params_s rsi_ble_ae_set_scan_params_t

Structure to set the scan parameters for BLE Active Scanning.

rsi_ble_ae_set_scan_enable_t#

typedef struct rsi_ble_ae_set_scan_enable_s rsi_ble_ae_set_scan_enable_t

Structure to configure BLE scanning parameters.

This structure is used to set various parameters for enabling or disabling scanning in the module. It allows the configuration of scan enablement, duplicate filtering, scan duration, and scan period.

rsi_ble_ae_set_periodic_adv_create_sync_t#

typedef struct rsi_ble_ae_set_periodic_adv_create_sync_s rsi_ble_ae_set_periodic_adv_create_sync_t

Structure representing the parameters for setting periodic advertising and creating synchronization.

This structure is used in BLE operations to configure periodic advertising and create synchronization.

rsi_ble_ae_set_periodic_adv_terminate_sync_t#

typedef struct rsi_ble_ae_set_periodic_adv_terminate_sync_s rsi_ble_ae_set_periodic_adv_terminate_sync_t

Structure to set periodic advertising and terminate synchronization.

rsi_ble_ae_set_periodic_sync_t#

typedef struct rsi_ble_ae_set_periodic_sync_s rsi_ble_ae_set_periodic_sync_t

Structure representing the BLE Advertising Extension(AE) set periodic synchronization.

This structure is used to define the parameters for setting periodic synchronization for Advertising Extension in a BLE device.

rsi_ble_ae_dev_to_periodic_list_t#

typedef struct rsi_ble_ae_dev_to_periodic_list_s rsi_ble_ae_dev_to_periodic_list_t

Structure representing the AE (Advertising extension) device to periodic list.

rsi_ble_initiation_params_t#

typedef struct rsi_ble_initiation_params_s rsi_ble_initiation_params_t

Structure representing connection initiation parameters.

This structure is used to define various parameters required for initiating a BLE connection. It includes parameters for scan intervals, scan window, connection intervals, peripheral latency, supervision timeout, and minimum and maximum length of the connection events.

rsi_ble_ae_extended_create_connect_t#

typedef struct rsi_ble_ae_extended_create_connect_s rsi_ble_ae_extended_create_connect_t

Structure representing the extended create connect command for BLE AE.

rsi_ble_tx_pwr_t#

typedef struct rsi_ble_tx_pwr_s rsi_ble_tx_pwr_t

Structure representing the BLE transmit power.

rsi_ble_query_rf_path_comp_t#

typedef struct rsi_ble_query_rf_path_comp_s rsi_ble_query_rf_path_comp_t

Structure to hold the information for querying RF path compensation.

rsi_ble_write_rf_path_comp_t#

typedef struct rsi_ble_write_rf_path_comp_s rsi_ble_write_rf_path_comp_t

Structure representing the parameters for writing RF path compensation values.

rsi_ble_ae_pdu_t#

typedef struct rsi_ble_ae_pdu rsi_ble_ae_pdu_t

Structure representing the BLE Advertising Extensions (AE) Protocol Data Unit (PDU).

This structure is used to define the BLE Advertising Extensions PDU. It contains a command sub-opcode and a union of various possible PDU types related to advertising, scanning, and connection parameters.

profile_descriptors_t#

typedef struct profile_descriptor_s profile_descriptors_t

Represents the data of the particular profile descriptor.

att_desc_t#

typedef struct att_desc_s att_desc_t

Structure representing an attribute descriptor.

This structure is used to define the parameters for an attribute descriptor, including the attribute handle, reserved field, and attribute UUID.

char_serv_data_t#

typedef struct char_serv_data_s char_serv_data_t

Structure representing characteristic service data.

This structure is used to define the parameters for characteristic service data, including the characteristic value property, handle, and UUID.

char_serv_t#

typedef struct char_serv_s char_serv_t

Structure representing a characteristic service.

This structure is used to define the parameters for a characteristic service, including the attribute handle, reserved space for future use, and the characteristic service attribute value.

inc_serv_data_t#

typedef struct inc_serv_data_s inc_serv_data_t

Structure representing the included service data.

inc_serv_t#

typedef struct inc_serv_s inc_serv_t

Structure representing an included service attribute in a GATT server.

rsi_ble_req_add_att_t#

typedef struct rsi_ble_req_add_att_s rsi_ble_req_add_att_t

Structure representing a request to add an attribute in the BLE stack.

rsi_ble_cb_t#

typedef struct rsi_ble_cb_s rsi_ble_cb_t

Typedef for the BLE control block structure.

rsi_bt_classic_cb_t#

typedef struct rsi_bt_classic_cb_s rsi_bt_classic_cb_t

Typedef for the Bluetooth Classic control block structure.

rsi_bt_common_specific_cb_t#

typedef struct rsi_bt_common_specific_cb_s rsi_bt_common_specific_cb_t

Typedef for the Bluetooth common specific control block structure.

rsi_bt_get_ber_pkt_t#

typedef int32_t(* rsi_bt_get_ber_pkt_t) (uint8_t *pkt, uint16_t pkt_len) )(uint8_t *pkt, uint16_t pkt_len)

Typedef for a function pointer to get BER packet.

rsi_bt_common_cmd_request_t#

typedef enum rsi_bt_common_cmd_request_e rsi_bt_common_cmd_request_t

Enumeration of Bluetooth common command requests.

Defines various command requests for Bluetooth operations, including setting and getting local device information, initializing and deinitializing the device, and configuring antenna and power settings.

rsi_bt_common_event_t#

typedef enum rsi_bt_common_event_e rsi_bt_common_event_t

Enumeration of Bluetooth common events.

Defines various events for Bluetooth operations, including the event indicating that the Bluetooth card is ready.

rsi_bt_common_cmd_resp_t#

typedef enum rsi_bt_common_cmd_resp_e rsi_bt_common_cmd_resp_t

Enumeration of Bluetooth common command responses.

Defines various command responses for Bluetooth operations, including responses for setting and querying local device information, initializing and deinitializing the device, and configuring antenna and power settings.

rsi_bt_global_cb_t#

typedef struct rsi_bt_global_cb_s rsi_bt_global_cb_t

Structure representing the Bluetooth global callback.

This structure is used to define the parameters for Bluetooth global callbacks, including common specific callbacks, BLE specific callbacks, and BT Classic specific callbacks.

rsi_remote_ble_info_t#

typedef struct rsi_remote_ble_info_s rsi_remote_ble_info_t

Structure representing the remote BLE device information.

This structure is used to define the parameters for storing information about a remote BLE device, including its address, buffer counts, and synchronization mechanisms.

RSI_BT_HCI_CMD_PKT#

#define RSI_BT_HCI_CMD_PKT

0x1

Specifies that packet type is Bluetooth HCI command packet.

RSI_BT_HCI_ACL_PKT#

#define RSI_BT_HCI_ACL_PKT

0x2

Represents the HCI ACL packet type.

RSI_BT_HCI_PER_CMD_PKT#

#define RSI_BT_HCI_PER_CMD_PKT

0x3

Specifies the number of packets that can be sent per HCI command.

RSI_BT_DUAL_MODE#

#define RSI_BT_DUAL_MODE

0x8

Indicates dual mode operation in Bluetooth.

BLE_PROTO_ENABLE#

#define BLE_PROTO_ENABLE

BIT(2)

This macro is used to enable the Bluetooth Low Energy (BLE) protocol.

BT_CLASSIC_PROTO_ENABLE#

#define BT_CLASSIC_PROTO_ENABLE

BIT(3)

This macro is used to enable the Bluetooth Classic protocol.

PROP_PROTO_ENABLE#

#define PROP_PROTO_ENABLE

(BIT(8))

This macro is used to enable the proprietary protocol. It sets the 8th bit of the property.

BT_DUAL_MODE_PROTO_ENABLE#

#define BT_DUAL_MODE_PROTO_ENABLE

(BLE_PROTO_ENABLE | BT_CLASSIC_PROTO_ENABLE)

Enable both BLE and Classic Bluetooth protocols.

RSI_BT_BLE_MODE_BITS#

#define RSI_BT_BLE_MODE_BITS

(BIT(2) | BIT(3))

Define the bits for Bluetooth Low Energy (BLE) mode.

RSI_BT_STATUS_OFFSET#

#define RSI_BT_STATUS_OFFSET

0x0C

Offset of the BT status in the Bluetooth module.

RSI_BT_RSP_TYPE_OFFSET#

#define RSI_BT_RSP_TYPE_OFFSET

0x02

Offset value for the response type in the Bluetooth module.

RSI_BT_RSP_LEN_OFFSET#

#define RSI_BT_RSP_LEN_OFFSET

0x00

Offset value for the length field in the Bluetooth response.

RSI_BT_RSP_LEN_MASK#

#define RSI_BT_RSP_LEN_MASK

0x0FFF

Mask used to extract the response length from a Bluetooth response.

RSI_PROTO_BT_COMMON#

#define RSI_PROTO_BT_COMMON

0x01

Protocol identifier for Bluetooth Common.

RSI_PROTO_BT_CLASSIC#

#define RSI_PROTO_BT_CLASSIC

0x02

Bluetooth protocol type for classic Bluetooth.

RSI_PROTO_BLE#

#define RSI_PROTO_BLE

0x03

Defines the protocol value for Bluetooth Low Energy (BLE).

RSI_PROTO_BT_BLE_STACK#

#define RSI_PROTO_BT_BLE_STACK

0x05

Definition of the Bluetooth Low Energy (BLE) stack protocol.

RSI_DEV_NAME_LEN#

#define RSI_DEV_NAME_LEN

50

The maximum length of the device name.

RSI_DEV_ADDR_LEN#

#define RSI_DEV_ADDR_LEN

6

Length of the device address in bytes.

RSI_DEV_ATT_LEN#

#define RSI_DEV_ATT_LEN

240

Length of the Attribute Protocol (ATT) buffer for the device.

RSI_BT_CLASSIC_DEVICE#

#define RSI_BT_CLASSIC_DEVICE

0x00

Defines the Bluetooth classic device type.

RSI_BT_LE_DEVICE#

#define RSI_BT_LE_DEVICE

0x01

Defines the Bluetooth Low Energy (LE) device type.

RSI_BT_UNKWON_DEVICE#

#define RSI_BT_UNKWON_DEVICE

0xFF

Macro definition for an unknown Bluetooth device. The value of this macro is 0xFF.

STACK_BT_MODE#

#define STACK_BT_MODE

0x01

Defines the stack mode for Bluetooth.

STACK_BTLE_MODE#

#define STACK_BTLE_MODE

0x02

Defines the stack mode for Bluetooth Low Energy (BLE).

RSI_EXTERNAL_RF#

#define RSI_EXTERNAL_RF

0x00

Specify the external RF mode.

RSI_INTERNAL_RF#

#define RSI_INTERNAL_RF

0x01

Specify the internal RF mode.

RSI_RF_TYPE#

#define RSI_RF_TYPE

RSI_INTERNAL_RF

Defines the RF type for the Bluetooth module.

This macro is used to specify the RF type for the Bluetooth module. The value RSI_INTERNAL_RF indicates that the module uses an internal RF.

Note

• This macro should be defined before including this header file.

RSI_MAX_ATT#

#define RSI_MAX_ATT

5

Maximum number of attributes supported by the Bluetooth module.

RSI_OPERMODE_WLAN_BT_DUAL_MODE#

#define RSI_OPERMODE_WLAN_BT_DUAL_MODE

9

Defines the operating mode for WLAN and Bluetooth dual mode.

This macro is used to specify the operating mode for WLAN and Bluetooth dual mode. The value 9 represents the dual mode operation.

RSI_BT_STATE_NONE#

#define RSI_BT_STATE_NONE

0

Bluetooth state indicating none.

RSI_BT_STATE_OPERMODE_DONE#

#define RSI_BT_STATE_OPERMODE_DONE

1

Defines the state value indicating that the Bluetooth operation mode is done.

LOWERNIBBLE#

#define LOWERNIBBLE

0x0F

Mask to extract the lower nibble of a byte.