SF BLE Framework Interface

RTOS-integrated SF BLE Framework Interface. More...

Data Structures
struct	sf_ble_addr_t
struct	sf_ble_adv_data_t
struct	sf_ble_event_info_t
struct	sf_ble_sec_info_t
struct	sf_ble_provisioning_t
struct	sf_ble_scan_info_t
struct	sf_ble_bonding_start_t
struct	sf_ble_bonding_response_t
struct	sf_ble_sm_tk_info_t
struct	sf_ble_sm_tk_ind_t
struct	sf_ble_addr_verify_ind_t
struct	sf_ble_sm_key_ind_t
struct	sf_ble_sm_enc_info_t
struct	sf_ble_sec_enc_start_ind_t
struct	sf_ble_scan_response_data_t
struct	sf_ble_adv_info_t
struct	sf_ble_scan_t
struct	sf_ble_connection_t
struct	sf_ble_disconnect_t
struct	sf_ble_chipset_info_t
struct	sf_ble_info_t
struct	sf_ble_bonding_req_ind_t
struct	sf_ble_connect_info_t
struct	sf_ble_set_tx_pwr_info_t
struct	sf_ble_uuid_t
struct	sf_ble_svc_attribute_t
struct	sf_ble_char_attribute_t
struct	sf_ble_gatt_attr_event_t
struct	sf_ble_service_discovery_rsp_t
struct	sf_ble_service_discovery_req_t
struct	sf_ble_char_discovery_req_t
struct	sf_ble_char_discovery_rsp_t
struct	sf_ble_char_desc_discovery_rsp_t
struct	sf_ble_char_multiple_read_req_t
struct	sf_ble_char_read_req_t
struct	sf_ble_char_multiple_read_rsp_t
struct	sf_ble_char_read_by_uuid_rsp_t
struct	sf_ble_char_read_by_handle_rsp_t
union	sf_ble_char_read_rsp_t
struct	sf_ble_char_write_req_t
struct	sf_ble_gatt_notif_ind_event_data_t
struct	sf_ble_write_cmd_event_data_t
struct	sf_ble_ctrl_t
struct	sf_ble_cfg_t
struct	sf_ble_api_t
struct	sf_ble_instance_t

Macros
#define	SF_BLE_API_VERSION_MAJOR   (2U)
#define	SF_BLE_API_VERSION_MINOR   (0U)
#define	SF_BLE_MAX_BLE_ADV_DATA_LEN   (100U)
	BLE advertising data length.
#define	SF_BLE_MAX_NAME_LEN   (66U)
	Maximum length of name for BLE device.
#define	SF_BLE_MAX_GAP_NAME_LEN   (23U)
	Maximum length of GAP name.
#define	SF_BLE_ADDR_LEN   (6U)
	BLE address length.
#define	SF_BLE_SEC_KEY_LEN   (0x10U)
	BLE Security Key length.
#define	SF_BLE_128BITS_UUID_LENGTH   (16U)
	128 bit UUID length
#define	SF_BLE_RAND_NUM_LENGTH   (8U)
	Rand Number length.
#define	SF_BLE_TRUE   (1U)
	Boolean True Condition.
#define	SF_BLE_FALSE   (0U)
	Boolean False Condition.
#define	SF_BLE_MAX_MULTI_CHAR_READ_CNT   (4U)
#define	SF_BLE_MAX_CHAR_UUID_READ_CNT   (10U)
#define	SF_BLE_GATT_LEN_UNDEF   (0xFF)
#define	SF_BLE_ADV_DATA_LEN   (0x1F)
#define	SF_BLE_GATT_PRI_SERVICE   (0x2800U)
#define	SF_BLE_GATT_INCLUDE_SERVICE   (0x2802U)
#define	SF_BLE_GATT_CHAR_DECLARE   (0x2803U)
#define	SF_BLE_TX_POWER_CONNECTION_HANDLE   (0xFFFFU)

Typedefs
typedef void(*	sf_ble_callback_t) (sf_ble_event_info_t *ev)
typedef uint16_t	sf_ble_conn_handle_t

Enumerations
enum	sf_ble_event_t {   SF_BLE_EVENT_NONE, SF_BLE_EVENT_BONDING_INDICATION, SF_BLE_EVENT_CONNECTION_COMP, SF_BLE_EVENT_DISCONNECT_COMP,   SF_BLE_EVENT_SM_TK_REQ_IND, SF_BLE_EVENT_SM_KEY_IND, SF_BLE_EVENT_SM_CHK_BD_ADDR_REQ, SF_BLE_EVENT_SM_ENC_START_IND,   SF_BLE_EVENT_GATT_NOTIFICATION, SF_BLE_EVENT_GATT_INDICATION, SF_BLE_EVENT_GATT_WRITE_CMD_INDICATION, SF_BLE_EVENT_GATT_RESPONSE_TIMEOUT,   SF_BLE_EVENT_GATT_ATTR_WRITE_REQ, SF_BLE_EVENT_GATT_ATTR_READ_REQ, SF_BLE_EVENT_GATT_ATTR_WRITE_COMPLETE, SF_BLE_EVENT_GATT_ATTR_WRITE_CCCD_REQ,   SF_BLE_EVENT_GATT_ATTR_WRITE_CCCD_COMPLETE }
enum	sf_ble_gap_role_t { SF_BLE_GAP_ROLE_MASTER, SF_BLE_GAP_ROLE_SLAVE, SF_BLE_GAP_ROLE_OBSERVER, SF_BLE_GAP_ROLE_BROADCASTER }
enum	sf_ble_addr_type_t { SF_BLE_ADDR_TYPE_PUBLIC, SF_BLE_ADDR_TYPE_RANDOM }
enum	sf_ble_scan_mode_t { SF_BLE_SCAN_MODE_PASSIVE, SF_BLE_SCAN_MODE_ACTIVE }
enum	sf_ble_bonding_mode_t { SF_BLE_BONDING_MODE_NONBONDABLE, SF_BLE_BONDING_MODE_BONDABLE }
enum	sf_ble_sec_mode_t {   SF_BLE_SEC_MODE1_LVL1_NO_SEC, SF_BLE_SEC_MODE1_LVL2_NOAUTH_PAIR_ENC, SF_BLE_SEC_MODE1_LVL3_AUTH_PAIR_ENC, SF_BLE_SEC_MODE1_LVL4_AUTHLE_PAIR_ENC,   SF_BLE_SEC_MODE2_LVL1_NOAUTH_DATA_SIGNED, SF_BLE_SEC_MODE2_LVL2_AUTH_DATA_SIGNED }
enum	sf_ble_disc_type_t { SF_BLE_DISC_TYPE_NON_DISCOVERABLE = 0x01, SF_BLE_DISC_TYPE_GENERAL_DISCOVERABLE = 0x02, SF_BLE_DISC_TYPE_LIMITED_DISCOVERABLE = 0x04 }
enum	sf_ble_conn_type_t { SF_BLE_CONN_TYPE_NON_CONNECTABLE, SF_BLE_CONN_TYPE_UNDIRECTED_CONNECTABLE, SF_BLE_CONN_TYPE_DIRECTED_CONNECTABLE }
enum	sf_ble_adv_type_t {   SF_BLE_ADV_TYPE_CONN_UNDIR, SF_BLE_ADV_TYPE_CONN_DIR_HIGH_DUTY, SF_BLE_ADV_TYPE_DISC_UNDIR, SF_BLE_ADV_TYPE_NONCONN_UNDIR,   SF_BLE_ADV_TYPE_CONN_DIR_LOW_DUTY }
enum	sf_ble_adv_filt_type_t { SF_BLE_ADV_FILT_TYPE_ALLOW_ALL, SF_BLE_ADV_FILT_TYPE_ALLOW_SCAN_WLIST_CON_ANY, SF_BLE_ADV_FILT_TYPE_ALLOW_SCAN_ANY_CON_WLIST, SF_BLE_ADV_FILT_TYPE_ALLOW_WLIST_ONLY }
enum	sf_ble_duplicate_filter_t { SF_BLE_DUPLICATE_FILTER_ENABLE, SF_BLE_DUPLICATE_FILTER_DISABLE }
enum	sf_ble_init_filt_type_t { SF_BLE_INIT_FILT_TYPE_IGNORE_WLIST, SF_BLE_INIT_FILT_TYPE_USE_WLIST }
enum	sf_ble_adv_chnl_map_t { SF_BLE_ADV_CHNL_37, SF_BLE_ADV_CHNL_38, SF_BLE_ADV_CHNL_39, SF_BLE_ADV_CHNL_ALL_CHANNELS }
enum	sf_ble_iocap_t {   SF_BLE_IO_CAP_DISPLAY_ONLY, SF_BLE_IO_CAP_DISPLAY_YES_NO, SF_BLE_IO_CAP_KB_ONLY, SF_BLE_IO_CAP_NO_INPUT_NO_OUTPUT,   SF_BLE_IO_CAP_KB_DISPLAY }
enum	sf_ble_auth_type_t { SF_BLE_AUTH_TYPE_NONE, SF_BLE_AUTH_TYPE_UNAUTHENTICATED_NO_MITM, SF_BLE_AUTH_TYPE_AUTHENTICATED_MITM }
enum	sf_ble_disconnect_reason_t { SF_BLE_DISCONNECT_REASON_LOCAL_HOST, SF_BLE_DISCONNECT_REASON_REMOTE_USER, SF_BLE_DISCONNECT_REASON_ERR }
enum	sf_ble_key_dist_t { SF_BLE_KEY_DIST_NONE = 0x00, SF_BLE_KEY_DIST_ENCKEY = 0x01, SF_BLE_KEY_DIST_IDKEY = 0x02, SF_BLE_KEY_DIST_SIGNKEY = 0x04 }
enum	sf_ble_tx_pwr_state_t { SF_BLE_TX_PWR_STATE_NORMAL, SF_BLE_TX_PWR_STATE_ADAPT_NEAR, SF_BLE_TX_PWR_STATE_ADAPT_MIDDLE, SF_BLE_TX_PWR_STATE_ADAPT_FAR }
enum	sf_ble_char_property_t {   SF_BLE_CHAR_PROPERTY_BCAST = 0x01U, SF_BLE_CHAR_PROPERTY_RD = 0x02U, SF_BLE_CHAR_PROPERTY_WR_NO_RESP = 0x04U, SF_BLE_CHAR_PROPERTY_WR = 0x08U,   SF_BLE_CHAR_PROPERTY_NTF = 0x10U, SF_BLE_CHAR_PROPERTY_IND = 0x20U, SF_BLE_CHAR_PROPERTY_AUTH = 0x40U, SF_BLE_CHAR_PROPERTY_EXT_PROP = 0x80U }
enum	sf_ble_service_discovery_t { SF_BLE_SERVICE_DISCOVERY_PRIMARY_ALL = 0x1, SF_BLE_SERVICE_DISCOVERY_PRIMARY_UUID = 0x10, SF_BLE_SERVICE_DISCOVERY_INCLUDED = 0x100 }
enum	sf_ble_char_discovery_t { SF_BLE_CHAR_DISCOVERY_ALL = 0x1, SF_BLE_CHAR_DISCOVERY_UUID = 0x10 }
enum	sf_ble_uuid_length_t { SF_BLE_UUID_LENGTH_16BITS = 2, SF_BLE_UUID_LENGTH_32BITS = 4, SF_BLE_UUID_LENGTH_128BITS = 16 }
enum	sf_ble_char_read_t {   SF_BLE_CHAR_READ_BY_HANDLE = 1, SF_BLE_CHAR_READ_BY_UUID = 2, SF_BLE_CHAR_READ_LONG_BY_HANDLE = 3, SF_BLE_CHAR_DESC_READ_BY_HANDLE = 4,   SF_BLE_CHAR_DESC_READ_LONG_BY_HANDLE = 5, SF_BLE_CHAR_READ_MULTIPLE_BY_HANDLES = 6 }
enum	sf_ble_char_write_t {   SF_BLE_CHAR_WRITE_NO_RESPONSE = 1, SF_BLE_CHAR_WRITE = 2, SF_BLE_CHAR_WRITE_LONG = 3, SF_BLE_CHAR_DESC_WRITE = 4,   SF_BLE_CHAR_DESC_WRITE_LONG = 5 }
enum	sf_ble_execute_write_t { SF_BLE_EXECUTE_WRITE_FALSE = 0, SF_BLE_EXECUTE_WRITE_TRUE = 1 }
enum	sf_ble_write_response_t { SF_BLE_WRITE_RESPONSE_NOT_REQUIRED = 0, SF_BLE_WRITE_RESPONSE_REQUIRED = 1 }
enum	sf_ble_attribute_error_code_t {   SF_BLE_ATTRIBUTE_ERR_SUCCESS = 0x00, SF_BLE_ATTRIBUTE_ERR_INVALID_HANDLE = 0x01, SF_BLE_ATTRIBUTE_ERR_WRITE_NOT_PERMITTED = 0x03, SF_BLE_ATTRIBUTE_ERR_INSUFF_AUTHEN = 0x05,   SF_BLE_ATTRIBUTE_ERR_REQUEST_NOT_SUPPORTED = 0x06, SF_BLE_ATTRIBUTE_ERR_INVALID_OFFSET = 0x07, SF_BLE_ATTRIBUTE_ERR_INSUFF_AUTHOR = 0x08, SF_BLE_ATTRIBUTE_ERR_ATTRIBUTE_NOT_FOUND = 0x0a,   SF_BLE_ATTRIBUTE_ERR_ATTRIBUTE_NOT_LONG = 0x0b, SF_BLE_ATTRIBUTE_ERR_INVALID_ATTRIBUTE_VAL_LEN = 0x0d, SF_BLE_ATTRIBUTE_ERR_INSUFF_ENC = 0x0f, SF_BLE_ATTRIBUTE_ERR_OUT_OF_RANGE = 0xFF }
enum	sf_ble_char_attr_permissions_t {   SF_BLE_ATT_PERMISSIONS_ALLACCESS = 0x00u, SF_BLE_ATT_PERMISSIONS_READ_AUTHENTICATION = 0x01u, SF_BLE_ATT_PERMISSIONS_READ_ENCRYPTION = 0x02u, SF_BLE_ATT_PERMISSIONS_READ_AUTHORIZATION = 0x04u,   SF_BLE_ATT_PERMISSIONS_READ_FORBIDDEN = 0x08u, SF_BLE_ATT_PERMISSIONS_WRITE_AUTHENTICATION = 0x10u, SF_BLE_ATT_PERMISSIONS_WRITE_ENCRYPTION = 0x20u, SF_BLE_ATT_PERMISSIONS_WRITE_AUTHORIZATION = 0x40u,   SF_BLE_ATT_PERMISSIONS_WRITE_FORBIDDEN = 0x80u, SF_BLE_ATT_PERMISSIONS_NOACCESS = 0x88u }
enum	sf_ble_adv_event_type_t {   SF_BLE_ADV_EVENT_TYPE_CONN_UND_ADV, SF_BLE_ADV_EVENT_TYPE_CONN_DIR_ADV, SF_BLE_ADV_EVENT_TYPE_SCANNABLE_UND_ADV, SF_BLE_ADV_EVENT_TYPE_NON_CONN_UND_ADV,   SF_BLE_ADV_EVENT_TYPE_SCAN_RESPONSE }

Detailed Description

RTOS-integrated SF BLE Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF BLE Framework.

Macro Definition Documentation

SF_BLE_ADV_DATA_LEN

#define SF_BLE_ADV_DATA_LEN   (0x1F)

BLE Advertising Data Length

SF_BLE_API_VERSION_MAJOR

#define SF_BLE_API_VERSION_MAJOR   (2U)

Major Version of the API defined in this file

SF_BLE_API_VERSION_MINOR

#define SF_BLE_API_VERSION_MINOR   (0U)

Minor Version of the API defined in this file

SF_BLE_GATT_CHAR_DECLARE

#define SF_BLE_GATT_CHAR_DECLARE   (0x2803U)

BLE GATT Declare Characteristics

SF_BLE_GATT_INCLUDE_SERVICE

#define SF_BLE_GATT_INCLUDE_SERVICE   (0x2802U)

BLE GATT Service type Included

SF_BLE_GATT_LEN_UNDEF

#define SF_BLE_GATT_LEN_UNDEF   (0xFF)

Variable length characteristic value which can not be defined

SF_BLE_GATT_PRI_SERVICE

#define SF_BLE_GATT_PRI_SERVICE   (0x2800U)

BLE GATT Service type Primary

SF_BLE_MAX_CHAR_UUID_READ_CNT

#define SF_BLE_MAX_CHAR_UUID_READ_CNT   (10U)

Maximum characteristics count in result of characteristic read by UUID

SF_BLE_MAX_MULTI_CHAR_READ_CNT

#define SF_BLE_MAX_MULTI_CHAR_READ_CNT   (4U)

Maximum characteristics count for multiple read

SF_BLE_TX_POWER_CONNECTION_HANDLE

#define SF_BLE_TX_POWER_CONNECTION_HANDLE   (0xFFFFU)

BLE connection handle value when TX power is set

Typedef Documentation

sf_ble_callback_t

typedef void(* sf_ble_callback_t) (sf_ble_event_info_t *ev)

BLE Callback Type

sf_ble_conn_handle_t

typedef uint16_t sf_ble_conn_handle_t

BLE Connection Handle

Enumeration Type Documentation

sf_ble_addr_type_t

enum sf_ble_addr_type_t

BLE address type

Enumerator
SF_BLE_ADDR_TYPE_PUBLIC	BLE address type public.
SF_BLE_ADDR_TYPE_RANDOM	BLE address type random.

sf_ble_adv_chnl_map_t

enum sf_ble_adv_chnl_map_t

BLE advertisement channel map

Enumerator
SF_BLE_ADV_CHNL_37	Enable channel 37 use.
SF_BLE_ADV_CHNL_38	Enable channel 38 use.
SF_BLE_ADV_CHNL_39	Enable channel 39 use.
SF_BLE_ADV_CHNL_ALL_CHANNELS	all channels(37, 38 and 39) enabled

sf_ble_adv_event_type_t

enum sf_ble_adv_event_type_t

BLE advertising event type

Enumerator
SF_BLE_ADV_EVENT_TYPE_CONN_UND_ADV	Connectable undirected advertising.
SF_BLE_ADV_EVENT_TYPE_CONN_DIR_ADV	Connectable directed advertising.
SF_BLE_ADV_EVENT_TYPE_SCANNABLE_UND_ADV	Scannable undirected advertising.
SF_BLE_ADV_EVENT_TYPE_NON_CONN_UND_ADV	Non connectable undirected advertising.
SF_BLE_ADV_EVENT_TYPE_SCAN_RESPONSE	Scan response.

sf_ble_adv_filt_type_t

enum sf_ble_adv_filt_type_t

BLE advertisement filter type

Enumerator
SF_BLE_ADV_FILT_TYPE_ALLOW_ALL	Filter type allow all.
SF_BLE_ADV_FILT_TYPE_ALLOW_SCAN_WLIST_CON_ANY	Filter type scan only whitelist entries, connect to any.
SF_BLE_ADV_FILT_TYPE_ALLOW_SCAN_ANY_CON_WLIST	Filter type scan any, connect to whitelist entries only.
SF_BLE_ADV_FILT_TYPE_ALLOW_WLIST_ONLY	Filter type allow whitelist only for both scan and connection.

sf_ble_adv_type_t

enum sf_ble_adv_type_t

BLE advertisement type

Enumerator
SF_BLE_ADV_TYPE_CONN_UNDIR	Connectable Undirected advertising.
SF_BLE_ADV_TYPE_CONN_DIR_HIGH_DUTY	Connectable high duty cycle directed advertising.
SF_BLE_ADV_TYPE_DISC_UNDIR	Discoverable undirected advertising.
SF_BLE_ADV_TYPE_NONCONN_UNDIR	Non-connectable undirected advertising.
SF_BLE_ADV_TYPE_CONN_DIR_LOW_DUTY	Connectable low duty cycle directed advertising.

sf_ble_attribute_error_code_t

enum sf_ble_attribute_error_code_t

BLE Attribute write response code

Enumerator
SF_BLE_ATTRIBUTE_ERR_SUCCESS	Success.
SF_BLE_ATTRIBUTE_ERR_INVALID_HANDLE	Invalid handle.
SF_BLE_ATTRIBUTE_ERR_WRITE_NOT_PERMITTED	Writing is not permitted.
SF_BLE_ATTRIBUTE_ERR_INSUFF_AUTHEN	Authentication required for the request.
SF_BLE_ATTRIBUTE_ERR_REQUEST_NOT_SUPPORTED	Unsupported request.
SF_BLE_ATTRIBUTE_ERR_INVALID_OFFSET	Invalid offset.
SF_BLE_ATTRIBUTE_ERR_INSUFF_AUTHOR	Authorization required for the request.
SF_BLE_ATTRIBUTE_ERR_ATTRIBUTE_NOT_FOUND	The attribute could not be found.
SF_BLE_ATTRIBUTE_ERR_ATTRIBUTE_NOT_LONG	The attribute is not long enough.
SF_BLE_ATTRIBUTE_ERR_INVALID_ATTRIBUTE_VAL_LEN	Invalid attribute value size.
SF_BLE_ATTRIBUTE_ERR_INSUFF_ENC	Encryption required for the request.
SF_BLE_ATTRIBUTE_ERR_OUT_OF_RANGE	Out of Range.

sf_ble_auth_type_t

enum sf_ble_auth_type_t

BLE security authorization requirement

Enumerator
SF_BLE_AUTH_TYPE_NONE	No Security.
SF_BLE_AUTH_TYPE_UNAUTHENTICATED_NO_MITM	No MITM.
SF_BLE_AUTH_TYPE_AUTHENTICATED_MITM	MITM Protected.

sf_ble_bonding_mode_t

enum sf_ble_bonding_mode_t

BLE bonding mode

Enumerator
SF_BLE_BONDING_MODE_NONBONDABLE	BLE bonding not supported.
SF_BLE_BONDING_MODE_BONDABLE	BLE bonding supported.

sf_ble_char_attr_permissions_t

enum sf_ble_char_attr_permissions_t

BLE GATT Attribute characteristics permission

Enumerator
SF_BLE_ATT_PERMISSIONS_ALLACCESS	Full access.
SF_BLE_ATT_PERMISSIONS_READ_AUTHENTICATION	Read with authentication.
SF_BLE_ATT_PERMISSIONS_READ_ENCRYPTION	Read with encryption.
SF_BLE_ATT_PERMISSIONS_READ_AUTHORIZATION	Read with authorization.
SF_BLE_ATT_PERMISSIONS_READ_FORBIDDEN	Read forbidden.
SF_BLE_ATT_PERMISSIONS_WRITE_AUTHENTICATION	Write with authentication.
SF_BLE_ATT_PERMISSIONS_WRITE_ENCRYPTION	Write with encryption.
SF_BLE_ATT_PERMISSIONS_WRITE_AUTHORIZATION	Write with authorization.
SF_BLE_ATT_PERMISSIONS_WRITE_FORBIDDEN	Write forbidden.
SF_BLE_ATT_PERMISSIONS_NOACCESS	No access.

sf_ble_char_discovery_t

enum sf_ble_char_discovery_t

Characteristics discovery type

Enumerator
SF_BLE_CHAR_DISCOVERY_ALL	Discover all characteristics.
SF_BLE_CHAR_DISCOVERY_UUID	Discover characteristics by UUID.

sf_ble_char_property_t

enum sf_ble_char_property_t

Characteristic property

Enumerator
SF_BLE_CHAR_PROPERTY_BCAST	Permits broadcasts of the Characteristic Value.
SF_BLE_CHAR_PROPERTY_RD	Permits reads of the Characteristic Value.
SF_BLE_CHAR_PROPERTY_WR_NO_RESP	Permits writes of the Characteristic Value without response.
SF_BLE_CHAR_PROPERTY_WR	Permits writes of the Characteristic Value with response.
SF_BLE_CHAR_PROPERTY_NTF	Permits notifications of the Characteristic Value without acknowledgment.
SF_BLE_CHAR_PROPERTY_IND	Permits indications of a Characteristic Value with acknowledgment.
SF_BLE_CHAR_PROPERTY_AUTH	Permits signed writes to the Characteristic Value.
SF_BLE_CHAR_PROPERTY_EXT_PROP	Additional characteristic properties.

sf_ble_char_read_t

enum sf_ble_char_read_t

Characteristics read type

Enumerator
SF_BLE_CHAR_READ_BY_HANDLE	Read single characteristic by handle.
SF_BLE_CHAR_READ_BY_UUID	Read single characteristic by UUID.
SF_BLE_CHAR_READ_LONG_BY_HANDLE	Read single long characteristic by handle.
SF_BLE_CHAR_DESC_READ_BY_HANDLE	Read single characteristic descriptor by handle.
SF_BLE_CHAR_DESC_READ_LONG_BY_HANDLE	Read single long characteristic descriptor by handle.
SF_BLE_CHAR_READ_MULTIPLE_BY_HANDLES	Read multiple characteristics by handles.

sf_ble_char_write_t

enum sf_ble_char_write_t

Characteristics write type

Enumerator
SF_BLE_CHAR_WRITE_NO_RESPONSE	Write single characteristic with no response.
SF_BLE_CHAR_WRITE	Write single characteristic with response.
SF_BLE_CHAR_WRITE_LONG	Write single long characteristic with response.
SF_BLE_CHAR_DESC_WRITE	Write single characteristic descriptor with response.
SF_BLE_CHAR_DESC_WRITE_LONG	Write single long characteristic descriptor with response.

sf_ble_conn_type_t

enum sf_ble_conn_type_t

BLE connection type

Enumerator
SF_BLE_CONN_TYPE_NON_CONNECTABLE	Connection type connection not allowed.
SF_BLE_CONN_TYPE_UNDIRECTED_CONNECTABLE	Connection type undirected.
SF_BLE_CONN_TYPE_DIRECTED_CONNECTABLE	Connection type directed.

sf_ble_disc_type_t

enum sf_ble_disc_type_t

BLE discovery type

Enumerator
SF_BLE_DISC_TYPE_NON_DISCOVERABLE	BLE non-discoverable.
SF_BLE_DISC_TYPE_GENERAL_DISCOVERABLE	BLE discoverable.
SF_BLE_DISC_TYPE_LIMITED_DISCOVERABLE	BLE limited discoverable.

sf_ble_disconnect_reason_t

enum sf_ble_disconnect_reason_t

BLE security authorization requirement

Enumerator
SF_BLE_DISCONNECT_REASON_LOCAL_HOST	Disconnected by local machine.
SF_BLE_DISCONNECT_REASON_REMOTE_USER	Disconnected by remote device.
SF_BLE_DISCONNECT_REASON_ERR	Error in Connection so disconnected.

sf_ble_duplicate_filter_t

enum sf_ble_duplicate_filter_t

BLE Duplicate Filter Configuration

Enumerator
SF_BLE_DUPLICATE_FILTER_ENABLE	Enable Duplicate filter in Scan.
SF_BLE_DUPLICATE_FILTER_DISABLE	Disbale Duplicate filter in Scan.

sf_ble_event_t

enum sf_ble_event_t

BLE events

Enumerator
SF_BLE_EVENT_NONE	BLE user event none.
SF_BLE_EVENT_BONDING_INDICATION	BLE user event indicating reception of bonding request.
SF_BLE_EVENT_CONNECTION_COMP	BLE user event indicating connection completion.
SF_BLE_EVENT_DISCONNECT_COMP	BLE user event indicating disconnect.
SF_BLE_EVENT_SM_TK_REQ_IND	BLE user event indicating request for Temporary key.
SF_BLE_EVENT_SM_KEY_IND	BLE user event indicating received key from user.
SF_BLE_EVENT_SM_CHK_BD_ADDR_REQ	BLE user event indicating validation of remote address.
SF_BLE_EVENT_SM_ENC_START_IND	BLE user event indicating encryption started.
SF_BLE_EVENT_GATT_NOTIFICATION	BLE user event for Notification from peer.
SF_BLE_EVENT_GATT_INDICATION	BLE user event for Indication from peer.
SF_BLE_EVENT_GATT_WRITE_CMD_INDICATION	BLE user event for Write command from peer.
SF_BLE_EVENT_GATT_RESPONSE_TIMEOUT	BLE user event for GATT operation timeout.
SF_BLE_EVENT_GATT_ATTR_WRITE_REQ	BLE user event for Remote Write request on user Attributes.
SF_BLE_EVENT_GATT_ATTR_READ_REQ	BLE user event for Remote Read request on user Attributes.
SF_BLE_EVENT_GATT_ATTR_WRITE_COMPLETE	BLE user event Indicating Remote Write complete for user Attributes.
SF_BLE_EVENT_GATT_ATTR_WRITE_CCCD_REQ	BLE user event for Remote CCCD Write request on user Attributes.
SF_BLE_EVENT_GATT_ATTR_WRITE_CCCD_COMPLETE	BLE user event Indicating Remote CCCD Write complete for user Attributes.

sf_ble_execute_write_t

enum sf_ble_execute_write_t

Characteristic execute write flag

Enumerator
SF_BLE_EXECUTE_WRITE_FALSE	Execute write false i.e. cancel write operations.
SF_BLE_EXECUTE_WRITE_TRUE	Execute write true i.e. execute write operations.

sf_ble_gap_role_t

enum sf_ble_gap_role_t

GAP role

Enumerator
SF_BLE_GAP_ROLE_MASTER	GAP role master/central.
SF_BLE_GAP_ROLE_SLAVE	GAP role slave/peripheral.
SF_BLE_GAP_ROLE_OBSERVER	GAP role Observer.
SF_BLE_GAP_ROLE_BROADCASTER	GAP role Broadcaster.

sf_ble_init_filt_type_t

enum sf_ble_init_filt_type_t

BLE initial filter type

Enumerator
SF_BLE_INIT_FILT_TYPE_IGNORE_WLIST	Ignore whitelist.
SF_BLE_INIT_FILT_TYPE_USE_WLIST	Use whitelist.

sf_ble_iocap_t

enum sf_ble_iocap_t

BLE System IO Capabilities

Enumerator
SF_BLE_IO_CAP_DISPLAY_ONLY	Display Only.
SF_BLE_IO_CAP_DISPLAY_YES_NO	Display Yes No.
SF_BLE_IO_CAP_KB_ONLY	Keyboard Only.
SF_BLE_IO_CAP_NO_INPUT_NO_OUTPUT	No Input No Output.
SF_BLE_IO_CAP_KB_DISPLAY	Keyboard Display.

sf_ble_key_dist_t

enum sf_ble_key_dist_t

BLE security key distribution type

Enumerator
SF_BLE_KEY_DIST_NONE	No Keys to distribute.
SF_BLE_KEY_DIST_ENCKEY	Encryption key in distribution.
SF_BLE_KEY_DIST_IDKEY	IRK (ID key)in distribution.
SF_BLE_KEY_DIST_SIGNKEY	CSRK(Signature key) in distribution.

sf_ble_scan_mode_t

enum sf_ble_scan_mode_t

BLE scan mode

Enumerator
SF_BLE_SCAN_MODE_PASSIVE	BLE scan mode passive.
SF_BLE_SCAN_MODE_ACTIVE	BLE scan mode active.

sf_ble_sec_mode_t

enum sf_ble_sec_mode_t

BLE security mode

Enumerator
SF_BLE_SEC_MODE1_LVL1_NO_SEC	BLE no security.
SF_BLE_SEC_MODE1_LVL2_NOAUTH_PAIR_ENC	BLE no authentication pairing encryption.
SF_BLE_SEC_MODE1_LVL3_AUTH_PAIR_ENC	Authenticated pairing with encryption.
SF_BLE_SEC_MODE1_LVL4_AUTHLE_PAIR_ENC	Authenticated LE Secure Connections pairing with encryption.
SF_BLE_SEC_MODE2_LVL1_NOAUTH_DATA_SIGNED	Unauthenticated pairing with data signing.
SF_BLE_SEC_MODE2_LVL2_AUTH_DATA_SIGNED	Authentication pairing with data signing.

sf_ble_service_discovery_t

enum sf_ble_service_discovery_t

Service discovery type

Enumerator
SF_BLE_SERVICE_DISCOVERY_PRIMARY_ALL	Discover all primary services.
SF_BLE_SERVICE_DISCOVERY_PRIMARY_UUID	Discover primary service by UUID.
SF_BLE_SERVICE_DISCOVERY_INCLUDED	Discover includes services.

sf_ble_tx_pwr_state_t

enum sf_ble_tx_pwr_state_t

BLE Transmit power state

Enumerator
SF_BLE_TX_PWR_STATE_NORMAL	Functionality disabled.
SF_BLE_TX_PWR_STATE_ADAPT_NEAR	RF low-power mode.
SF_BLE_TX_PWR_STATE_ADAPT_MIDDLE	RF normal mode.
SF_BLE_TX_PWR_STATE_ADAPT_FAR	RF high-performance mode.

sf_ble_uuid_length_t

enum sf_ble_uuid_length_t

UUID length

Enumerator
SF_BLE_UUID_LENGTH_16BITS	16 bit UUID
SF_BLE_UUID_LENGTH_32BITS	32 bit UUID
SF_BLE_UUID_LENGTH_128BITS	128 bit UUID

sf_ble_write_response_t

enum sf_ble_write_response_t

Characteristic execute write flag

Enumerator
SF_BLE_WRITE_RESPONSE_NOT_REQUIRED	Write response not required.
SF_BLE_WRITE_RESPONSE_REQUIRED	Write response required.