Functions
sx_status_t	sx_api_bfd_log_verbosity_level_set (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, const sx_verbosity_level_t module_verbosity_level, const sx_verbosity_level_t api_verbosity_level)

sx_status_t	sx_api_bfd_log_verbosity_level_get (const sx_api_handle_t handle, const sx_log_verbosity_target_t verbosity_target, sx_verbosity_level_t module_verbosity_level_p, sx_verbosity_level_t api_verbosity_level_p)

sx_status_t	sx_api_bfd_init_set (const sx_api_handle_t handle, sx_bfd_init_params_t *params_p)

sx_status_t	sx_api_bfd_deinit_set (const sx_api_handle_t handle)

sx_status_t	sx_api_bfd_offload_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_bfd_session_params_t session_params, sx_bfd_session_id_t session_id)

sx_status_t	sx_api_bfd_session_iter_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_bfd_session_id_t session_id_key, sx_bfd_session_id_filter_t session_id_filter_p, sx_bfd_session_id_t session_id_list_p, uint32_t *session_id_cnt_p)

sx_status_t	sx_api_bfd_offload_get_stats (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_bfd_session_type_t session_type, sx_bfd_session_id_t session_id, sx_bfd_offload_stats_t session_stats)

Function Documentation

◆ sx_api_bfd_log_verbosity_level_set()

sx_status_t sx_api_bfd_log_verbosity_level_set	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		const sx_verbosity_level_t	module_verbosity_level,
		const sx_verbosity_level_t	api_verbosity_level
	)

This API sets the log verbosity level of BFD MODULE. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- set verbosity of : API / MODULE / BOTH
[in]	module_verbosity_level	- BFD module verbosity level
[in]	api_verbosity_level	- BFD API verbosity level

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ERROR for a general error

◆ sx_api_bfd_log_verbosity_level_get()

sx_status_t sx_api_bfd_log_verbosity_level_get	(	const sx_api_handle_t	handle,
		const sx_log_verbosity_target_t	verbosity_target,
		sx_verbosity_level_t *	module_verbosity_level_p,
		sx_verbosity_level_t *	api_verbosity_level_p
	)

This API gets the log verbosity level of BFD MODULE. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- get verbosity of : API / MODULE / BOTH
[out]	module_verbosity_level_p	- BFD module verbosity level
[out]	api_verbosity_level_p	- BFD API verbosity level

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_ERROR if an input parameter is invalid; SX_STATUS_ERROR for a general error

◆ sx_api_bfd_init_set()

sx_status_t sx_api_bfd_init_set	(	const sx_api_handle_t	handle,
		sx_bfd_init_params_t *	params_p
	)

This API is used to initialize BFD module. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	params_p	- pointer to init params structure.

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_NO_RESOURCES if cannot allocate resources.; SX_STATUS_ERROR general error

◆ sx_api_bfd_deinit_set()

sx_status_t sx_api_bfd_deinit_set ( const sx_api_handle_t handle )

This API is used to deinit BFD module. Supported devices: Spectrum, Spectrum2.

Parameters

[in] handle - SX-API handle

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_ERROR general error

◆ sx_api_bfd_offload_set()

sx_status_t sx_api_bfd_offload_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_bfd_session_params_t *	session_params,
		sx_bfd_session_id_t *	session_id
	)

This API is used to create/edit/destroy BFD offload for a session. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- command : CREATE / EDIT / DESTROY
[in]	session_params	- parameters of the session
	[in/out]	session_id - BFD session ID

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_NULL, SX_STATUS_PARAM_ERROR or SX_STATUS_PARAM_EXCEEDS_RANGE if any input parameter is invalid SX_STATUS_ERROR general error

◆ sx_api_bfd_session_iter_get()

sx_status_t sx_api_bfd_session_iter_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_bfd_session_id_t	session_id_key,
		sx_bfd_session_id_filter_t *	session_id_filter_p,
		sx_bfd_session_id_t *	session_id_list_p,
		uint32_t *	session_id_cnt_p
	)

This function retrieves a list of BFD session IDs. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	GET/GET_NEXT/GET_FIRST.
[in]	session_id_key	- BFD session ID to use as key.
[in]	session_filter_p	- Filter to use (not supported yet).
[out]	session_id_list_p	- pointer to the list of BFD session IDs returned.
[in,out]	session_id_cnt_p	[in] number of entries to retrieve; [out] retrieved number of entries.

The following use case scenarios apply with different input parameters (X = don't-care)

1) cmd = SX_ACCESS_CMD_GET, key = X, Filter = X, list = X, Count = 0: In this case the API will return the total number of BFD sessions in the Internal db
2) cmd = SX_ACCESS_CMD_GET, key = valid/invalid, Filter = X, list = Valid, Count = 1: In this case the API will check if the specified key exists. if it does the key will be returned in the list along with a count of 1. If the key does not exist an empty list will be returned with count = 0
3) cmd = SX_ACCESS_CMD_GET, key = valid, Filter = X, list = valid, Count > 1: A count > 1 will be treated as a count of 1 and the behaviour will be same as earlier GET use cases.
5) cmd = SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT, key = X, Filter = X, list = Null, Count = 0: For either SX_ACCESS_CMD_GET_FIRST/SX_ACCESS_CMD_GETNEXT a zero count will return an empty list.
6) cmd = SX_ACCESS_CMD_GET_FIRST, key = X, Filter = X, list = Valid, Count > 0: In this case the API will return the first BFD session IDs starting from the head of the database. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. The key is dont-care but a non-Null return list pointer must be provided
7) cmd = SX_ACCESS_CMD_GETNEXT, key = valid/invalid, Filter = X, list = Valid, Count > 0: In this case the API will return the next set of BFD session IDs starting from the next valid ID after the specified key. The total elements fetched will be returned as the return count. Note: return count may be less than or equal to the requested count. If no valid next counter exists in the DB (key = end of list, or invalid key specified, or key too large), an empty list will be returned.

Returns: SX_STATUS_SUCCESS if operation completes successfully.; SX_STATUS_PARAM_ERROR if parameter is invalid.; SX_STATUS_CMD_UNSUPPORTED if command is not supported.; SX_STATUS_INVALID_HANDLE if handle is invalid.; SX_STATUS_ERROR general error.

◆ sx_api_bfd_offload_get_stats()

sx_status_t sx_api_bfd_offload_get_stats	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_bfd_session_type_t	session_type,
		sx_bfd_session_id_t *	session_id,
		sx_bfd_offload_stats_t *	session_stats
	)

This API is used to read/clear BFD offload statistics for a session. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- command : READ / READ_CLEAR
[in]	session_type	- command : SX_BFD_ASYNC_ACTIVE_RX / SX_BFD_ASYNC_ACTIVE_TX
[in]	session_id	- BFD session ID
[out]	session_stats	- statistics for the session Applicable only for READ/READ_CLEAR commands.

Returns: SX_STATUS_SUCCESS if operation completes successfully; SX_STATUS_PARAM_NULL, SX_STATUS_PARAM_ERROR or SX_STATUS_PARAM_EXCEEDS_RANGE if any input parameter is invalid SX_STATUS_ERROR general error

Functions

Function Documentation

◆ sx_api_bfd_log_verbosity_level_set()

◆ sx_api_bfd_log_verbosity_level_get()

◆ sx_api_bfd_init_set()

◆ sx_api_bfd_deinit_set()

◆ sx_api_bfd_offload_set()

◆ sx_api_bfd_session_iter_get()

◆ sx_api_bfd_offload_get_stats()