Device Announce & Seek Manager API

结构体
struct	sle_conn_param
	连接参数，做G时有效。 更多...
struct	sle_announce_param
	设备公开参数。 更多...
struct	sle_announce_data
	设备公开数据。 更多...
struct	sle_announce_enable
	设备公开使能参数。 更多...
struct	sle_seek_params
	设备发现扫描参数。 更多...
struct	sle_seek_result_info
	扫描结果报告设备信息。 更多...
struct	sle_announce_seek_callbacks_t
	SLE 设备公开回调函数接口定义。 更多...

宏定义
#define	SLE_ANNOUNCE_ID_MAX   16
	设备公开多路最大值。
#define	SLE_SEEK_PHY_NUM_MAX   3
	设备发现PHY最大值。

类型定义
typedef struct sle_conn_param	sle_conn_param_t
	连接参数，做G时有效。
typedef struct sle_announce_param	sle_announce_param_t
	设备公开参数。
typedef struct sle_announce_data	sle_announce_data_t
	设备公开数据。
typedef struct sle_announce_enable	sle_announce_enable_t
	设备公开使能参数。
typedef struct sle_seek_params	sle_seek_param_t
	设备发现扫描参数。
typedef struct sle_seek_result_info	sle_seek_result_info_t
	扫描结果报告设备信息。
typedef void(*	sle_announce_enable_callback) (uint32_t announce_id, errcode_t status)
	设备公开使能的回调函数。
typedef void(*	sle_announce_disable_callback) (uint32_t announce_id, errcode_t status)
	设备公开关闭的回调函数。
typedef void(*	sle_announce_terminal_callback) (uint32_t announce_id)
	设备公开停止的回调函数。
typedef void(*	sle_announce_remove_callback) (uint32_t announce_id, errcode_t status)
	删除广播的回调函数。
typedef void(*	sle_start_seek_callback) (errcode_t status)
	扫描使能的回调函数。
typedef void(*	sle_seek_disable_callback) (errcode_t status)
	扫描关闭的回调函数。
typedef void(*	sle_seek_result_callback) (sle_seek_result_info_t *seek_result_data)
	扫描结果上报的回调函数。
typedef void(*	sle_enable_callback) (errcode_t status)
	SLE协议栈使能。
typedef void(*	sle_disable_callback) (errcode_t status)
	SLE协议栈去使能。
typedef void(*	sle_dfr_callback) (void)
	sle协议栈dfr流程

枚举
enum	sle_announce_level_t {   SLE_ANNOUNCE_LEVEL_NONE , SLE_ANNOUNCE_LEVEL_NORMAL , SLE_ANNOUNCE_LEVEL_PRIORITY , SLE_ANNOUNCE_LEVEL_PAIRED ,   SLE_ANNOUNCE_LEVEL_SPECIAL }
	被发现方可发现等级 更多...
enum	sle_announce_gt_role_t { SLE_ANNOUNCE_ROLE_T_CAN_NEGO = 0 , SLE_ANNOUNCE_ROLE_G_CAN_NEGO , SLE_ANNOUNCE_ROLE_T_NO_NEGO , SLE_ANNOUNCE_ROLE_G_NO_NEGO }
	G/T 角色协商指示。 更多...
enum	sle_announce_mode_t {   SLE_ANNOUNCE_MODE_NONCONN_NONSCAN = 0x00 , SLE_ANNOUNCE_MODE_CONNECTABLE_NONSCAN = 0x01 , SLE_ANNOUNCE_MODE_NONCONN_SCANABLE = 0x02 , SLE_ANNOUNCE_MODE_CONNECTABLE_SCANABLE = 0x03 ,   SLE_ANNOUNCE_MODE_CONNECTABLE_DIRECTED = 0x07 }
	设备公开类型。 更多...
enum	sle_seek_phy_t { SLE_SEEK_PHY_1M = 0x1 , SLE_SEEK_PHY_2M = 0x2 , SLE_SEEK_PHY_4M = 0x4 }
	设备发现PHY类型。 更多...
enum	sle_seek_type_t { SLE_SEEK_PASSIVE = 0x00 , SLE_SEEK_ACTIVE = 0x01 }
	设备发现类型。 更多...
enum	sle_seek_filter_t { SLE_SEEK_FILTER_ALLOW_ALL = 0x00 , SLE_SEEK_FILTER_ALLOW_WLST = 0x01 }
	设备发现过滤类型。 更多...
enum	sle_mcs_t {   SLE_MCS_00 = 0 , SLE_MCS_01 , SLE_MCS_02 , SLE_MCS_03 ,   SLE_MCS_04 , SLE_MCS_05 , SLE_MCS_06 , SLE_MCS_07 ,   SLE_MCS_08 , SLE_MCS_09 , SLE_MCS_10 , SLE_MCS_11 ,   SLE_MCS_12 , SLE_MCS_MAX }
	过滤策略 更多...
enum	sle_filter_policy_t { SLE_ANNOUNCE_FLT_ANY_SEEK_ANY_CONNECT , SLE_ANNOUNCE_FLT_WHITE_SEEK_ANY_CONNECT , SLE_ANNOUNCE_FLT_ANY_SEEK_WHITE_CONNECT , SLE_ANNOUNCE_FLT_WHITE_SEEK_WHITE_CONNECT }
	过滤策略 更多...

函数
errcode_t	enable_sle (void)
	使能SLE协议栈。
errcode_t	disable_sle (void)
	关闭SLE协议栈。
errcode_t	sle_set_local_addr (sle_addr_t *addr)
	设置本地设备地址。
errcode_t	sle_get_local_addr (sle_addr_t *addr)
	获取本地设备地址。
errcode_t	sle_set_local_name (const uint8_t *name, uint8_t len)
	设置本地设备名称。
errcode_t	sle_get_local_name (uint8_t *name, uint8_t *len)
	获取本地设备名称。
errcode_t	sle_set_announce_data (uint8_t announce_id, const sle_announce_data_t *data)
	设置设备公开数据。
errcode_t	sle_remove_announce (uint8_t announce_id)
	删除广播。
errcode_t	sle_set_announce_param (uint8_t announce_id, const sle_announce_param_t *param)
	设置设备公开参数。
errcode_t	sle_start_announce (uint8_t announce_id)
	开始设备公开。
errcode_t	sle_stop_announce (uint8_t announce_id)
	结束设备公开。
errcode_t	sle_set_seek_param (sle_seek_param_t *param)
	设置设备公开扫描参数。
errcode_t	sle_start_seek (void)
	开始设备公开扫描。
errcode_t	sle_stop_seek (void)
	停止设备公开扫描。
errcode_t	sle_announce_seek_register_callbacks (sle_announce_seek_callbacks_t *func)
	注册SLE设备发现回调函数。

详细描述

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2022. All rights reserved.

Description: SLE Device Announce, Seek Manager, module.

宏定义说明

SLE_ANNOUNCE_ID_MAX

#define SLE_ANNOUNCE_ID_MAX   16

设备公开多路最大值。

SLE_SEEK_PHY_NUM_MAX

#define SLE_SEEK_PHY_NUM_MAX   3

设备发现PHY最大值。

类型定义说明

sle_announce_data_t

typedef struct sle_announce_data sle_announce_data_t

设备公开数据。

sle_announce_disable_callback

typedef void(* sle_announce_disable_callback) (uint32_t announce_id, errcode_t status)

设备公开关闭的回调函数。

sle_announce_enable_callback

typedef void(* sle_announce_enable_callback) (uint32_t announce_id, errcode_t status)

设备公开使能的回调函数。

sle_announce_enable_t

typedef struct sle_announce_enable sle_announce_enable_t

设备公开使能参数。

sle_announce_param_t

typedef struct sle_announce_param sle_announce_param_t

设备公开参数。

sle_announce_remove_callback

typedef void(* sle_announce_remove_callback) (uint32_t announce_id, errcode_t status)

删除广播的回调函数。

sle_announce_terminal_callback

typedef void(* sle_announce_terminal_callback) (uint32_t announce_id)

设备公开停止的回调函数。

sle_conn_param_t

typedef struct sle_conn_param sle_conn_param_t

连接参数，做G时有效。

sle_dfr_callback

typedef void(* sle_dfr_callback) (void)

sle协议栈dfr流程

sle_disable_callback

typedef void(* sle_disable_callback) (errcode_t status)

SLE协议栈去使能。

sle_enable_callback

typedef void(* sle_enable_callback) (errcode_t status)

SLE协议栈使能。

sle_seek_disable_callback

typedef void(* sle_seek_disable_callback) (errcode_t status)

扫描关闭的回调函数。

sle_seek_param_t

typedef struct sle_seek_params sle_seek_param_t

设备发现扫描参数。

sle_seek_result_callback

typedef void(* sle_seek_result_callback) (sle_seek_result_info_t *seek_result_data)

扫描结果上报的回调函数。

sle_seek_result_info_t

typedef struct sle_seek_result_info sle_seek_result_info_t

扫描结果报告设备信息。

sle_start_seek_callback

typedef void(* sle_start_seek_callback) (errcode_t status)

扫描使能的回调函数。

枚举类型说明

sle_announce_gt_role_t

enum sle_announce_gt_role_t

G/T 角色协商指示。

枚举值
SLE_ANNOUNCE_ROLE_T_CAN_NEGO	期望做T可协商
SLE_ANNOUNCE_ROLE_G_CAN_NEGO	期望做G可协商
SLE_ANNOUNCE_ROLE_T_NO_NEGO	期望做T不可协商
SLE_ANNOUNCE_ROLE_G_NO_NEGO	期望做G不可协商

sle_announce_level_t

enum sle_announce_level_t

被发现方可发现等级

枚举值
SLE_ANNOUNCE_LEVEL_NONE	不可见发现，预留
SLE_ANNOUNCE_LEVEL_NORMAL	一般可发现
SLE_ANNOUNCE_LEVEL_PRIORITY	优先可发现，预留
SLE_ANNOUNCE_LEVEL_PAIRED	被曾配对过的设备发现，预留
SLE_ANNOUNCE_LEVEL_SPECIAL	被指定设备发现

sle_announce_mode_t

enum sle_announce_mode_t

设备公开类型。

枚举值
SLE_ANNOUNCE_MODE_NONCONN_NONSCAN	不可连接不可扫描。
SLE_ANNOUNCE_MODE_CONNECTABLE_NONSCAN	可连接不可扫描。
SLE_ANNOUNCE_MODE_NONCONN_SCANABLE	不可连接可扫描。
SLE_ANNOUNCE_MODE_CONNECTABLE_SCANABLE	可连接可扫描。
SLE_ANNOUNCE_MODE_CONNECTABLE_DIRECTED	可连接可扫描定向。

sle_filter_policy_t

enum sle_filter_policy_t

过滤策略

枚举值
SLE_ANNOUNCE_FLT_ANY_SEEK_ANY_CONNECT	接受所有seek_req/conn_req
SLE_ANNOUNCE_FLT_WHITE_SEEK_ANY_CONNECT	只接受符合过滤器的seek_req
SLE_ANNOUNCE_FLT_ANY_SEEK_WHITE_CONNECT	只接受符合过滤器的conn_req
SLE_ANNOUNCE_FLT_WHITE_SEEK_WHITE_CONNECT	接受符合过滤器的seek_req/conn_req

sle_mcs_t

enum sle_mcs_t

过滤策略

枚举值
SLE_MCS_00	MCS0: BPSK1/4
SLE_MCS_01	MCS1: BPSK3/8
SLE_MCS_02	MCS2: QPSK1/4
SLE_MCS_03	MCS3: QPSK3/8
SLE_MCS_04	MCS4: QPSK1/2
SLE_MCS_05	MCS5: QPSK5/8
SLE_MCS_06	MCS6: QPSK3/4
SLE_MCS_07	MCS7: QPSK7/8
SLE_MCS_08	MCS8: QPSK 1
SLE_MCS_09	MCS9: 8PSK5/8
SLE_MCS_10	MCS10: 8PSK3/4
SLE_MCS_11	MCS11: 8PSK7/8
SLE_MCS_12	MCS12：8PSK 1
SLE_MCS_MAX

sle_seek_filter_t

enum sle_seek_filter_t

设备发现过滤类型。

枚举值
SLE_SEEK_FILTER_ALLOW_ALL	允许来自任何人的设备发现数据包
SLE_SEEK_FILTER_ALLOW_WLST	允许来自白名单设备的设备发现数据包，预留

sle_seek_phy_t

enum sle_seek_phy_t

设备发现PHY类型。

枚举值
SLE_SEEK_PHY_1M	1M PHY
SLE_SEEK_PHY_2M	2M PHY
SLE_SEEK_PHY_4M	4M PHY

sle_seek_type_t

enum sle_seek_type_t

设备发现类型。

枚举值
SLE_SEEK_PASSIVE	被动扫描
SLE_SEEK_ACTIVE	主动扫描

函数说明

disable_sle()

errcode_t disable_sle

(

void

)

关闭SLE协议栈。

enable_sle()

errcode_t enable_sle

(

void

)

使能SLE协议栈。

sle_announce_seek_register_callbacks()

errcode_t sle_announce_seek_register_callbacks

(

sle_announce_seek_callbacks_t *

func

)

注册SLE设备发现回调函数。

sle_get_local_addr()

errcode_t sle_get_local_addr

(

sle_addr_t *

addr

)

获取本地设备地址。

sle_get_local_name()

errcode_t sle_get_local_name	(	uint8_t *	name,
		uint8_t *	len
	)

获取本地设备名称。

sle_remove_announce()

errcode_t sle_remove_announce

(

uint8_t

announce_id

)

删除广播。

sle_set_announce_data()

errcode_t sle_set_announce_data	(	uint8_t	announce_id,
		const sle_announce_data_t *	data
	)

设置设备公开数据。

sle_set_announce_param()

errcode_t sle_set_announce_param	(	uint8_t	announce_id,
		const sle_announce_param_t *	param
	)

设置设备公开参数。

sle_set_local_addr()

errcode_t sle_set_local_addr

(

sle_addr_t *

addr

)

设置本地设备地址。

sle_set_local_name()

errcode_t sle_set_local_name	(	const uint8_t *	name,
		uint8_t	len
	)

设置本地设备名称。

sle_set_seek_param()

errcode_t sle_set_seek_param

(

sle_seek_param_t *

param

)

设置设备公开扫描参数。

sle_start_announce()

errcode_t sle_start_announce

(

uint8_t

announce_id

)

开始设备公开。

sle_start_seek()

errcode_t sle_start_seek

(

void

)

开始设备公开扫描。

sle_stop_announce()

errcode_t sle_stop_announce

(

uint8_t

announce_id

)

结束设备公开。

sle_stop_seek()

errcode_t sle_stop_seek

(

void

)

停止设备公开扫描。