sx_api_port.h File Reference

Go to the source code of this file.

Functions
sx_status_t	sx_api_port_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_port_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_port_device_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_device_id_t device_id, const sx_mac_addr_t *base_mac_addr_p, sx_port_attributes_t *port_attributes_list_p, const uint32_t port_cnt)
sx_status_t	sx_api_port_device_get (const sx_api_handle_t handle, const sx_device_id_t device_id, const sx_swid_t swid, sx_port_attributes_t *port_attributes_list_p, uint32_t *port_cnt_p)
sx_status_t	sx_api_port_device_base_mac_get (const sx_api_handle_t handle, const sx_device_id_t device_id, sx_mac_addr_t *base_mac_addr_p)
sx_status_t	sx_api_port_mapping_set (const sx_api_handle_t handle, const sx_port_log_id_t *log_port_list_p, const sx_port_mapping_t *port_mapping_list_p, const uint32_t port_cnt)
sx_status_t	sx_api_port_mapping_get (const sx_api_handle_t handle, const sx_port_log_id_t *log_port_list_p, sx_port_mapping_t *port_mapping_list_p, const uint32_t port_cnt)
sx_status_t	sx_api_port_device_list_get (const sx_api_handle_t handle, sx_device_info_t *device_info_list_p, uint32_t *device_info_cnt_p)
sx_status_t	sx_api_port_swid_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_swid_t swid)
sx_status_t	sx_api_port_swid_list_get (const sx_api_handle_t handle, sx_swid_t *swid_list_p, uint32_t *swid_cnt_p)
sx_status_t	sx_api_port_swid_bind_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_swid_t swid)
sx_status_t	sx_api_port_swid_bind_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_swid_t *swid_p)
sx_status_t	sx_api_port_swid_port_list_get (const sx_api_handle_t handle, const sx_swid_t swid, sx_port_log_id_t *log_port_list_p, uint32_t *port_cnt_p)
sx_status_t	sx_api_port_mode_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_mode_t mode)
sx_status_t	sx_api_port_mode_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_mode_t *mode_p)
sx_status_t	sx_api_port_mtu_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_mtu_t mtu_size)
sx_status_t	sx_api_port_mtu_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_mtu_t *max_mtu_size_p, sx_port_mtu_t *oper_mtu_size_p)
sx_status_t	sx_api_port_speed_admin_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_speed_capability_t *admin_speed_p)
sx_status_t	sx_api_port_speed_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_speed_capability_t *admin_speed_p, sx_port_oper_speed_t *oper_speed_p)
sx_status_t	sx_api_port_capability_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_capability_t *capability_p)
sx_status_t	sx_api_port_fec_capability_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_fec_capability_t *fec_capability_list_p, uint32_t *fec_cnt_p)
sx_status_t	sx_api_port_phys_addr_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_mac_addr_t *port_mac_addr_p)
sx_status_t	sx_api_port_phys_addr_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_mac_addr_t *port_mac_addr_p)
sx_status_t	sx_api_port_phys_loopback_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_phys_loopback_t phys_loopback)
sx_status_t	sx_api_port_phys_loopback_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_phys_loopback_t *phys_loopback_p)
sx_status_t	sx_api_port_state_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_admin_state_t admin_state)
sx_status_t	sx_api_port_state_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_oper_state_t *oper_state_p, sx_port_admin_state_t *admin_state_p, sx_port_module_state_t *module_state_p)
sx_status_t	sx_api_port_global_fc_enable_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_flow_ctrl_mode_t fc_mode)
sx_status_t	sx_api_port_global_fc_enable_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_flow_ctrl_mode_t *fc_mode_p)
sx_status_t	sx_api_port_pfc_enable_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_flow_ctrl_prio_t pfc_prio, const sx_port_flow_ctrl_mode_t fc_mode)
sx_status_t	sx_api_port_pfc_enable_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_flow_ctrl_prio_t pfc_prio, sx_port_flow_ctrl_mode_t *fc_mode_p)
sx_status_t	sx_api_port_counter_ieee_802_dot_3_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_ieee_802_dot_3_t *cntr_ieee_802_dot_3_p)
sx_status_t	sx_api_port_counter_rfc_2863_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_rfc_2863_t *cntr_rfc_2863_p)
sx_status_t	sx_api_port_counter_rfc_2819_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_rfc_2819_t *cntr_rfc_2819_p)
sx_status_t	sx_api_port_counter_rfc_3635_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_rfc_3635_t *cntr_rfc_3635_p)
sx_status_t	sx_api_port_counter_cli_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_cli_t *cntr_cli_p)
sx_status_t	sx_api_port_counter_prio_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_cos_ieee_prio_t prio_id, sx_port_cntr_prio_t *cntr_prio_p)
sx_status_t	sx_api_port_counter_tc_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_tc_id_t tc_id, sx_port_traffic_cntr_t *cntr_tc_p)
sx_status_t	sx_api_port_counter_buff_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_cos_priority_group_t buff_id, sx_port_cntr_buff_t *cntr_buff_p)
sx_status_t	sx_api_port_counter_perf_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_prio_id_t prio_id, sx_port_cntr_perf_t *cntr_perf_p)
sx_status_t	sx_api_port_counter_discard_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_discard_t *cntr_discard_p)
sx_status_t	sx_api_port_counter_clear_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const boolean_t all_ports, const sx_port_cntr_grp_t cntr_grp)
sx_status_t	sx_api_port_counter_phy_layer_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_cntr_phy_layer_t *cntr_phy_layer_p)
sx_status_t	sx_api_port_init_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port)
sx_status_t	sx_api_port_deinit_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port)
sx_status_t	sx_api_port_storm_control_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_storm_control_id_t storm_control_id, const sx_port_storm_control_params_t *storm_control_params_p)
sx_status_t	sx_api_port_storm_control_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_storm_control_id_t storm_control_id, sx_port_storm_control_params_t *storm_control_params_p)
sx_status_t	sx_api_port_storm_control_counters_clear_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_storm_control_id_t storm_control_id, const sx_policer_counters_clear_t *clear_counters_p)
sx_status_t	sx_api_port_storm_control_counters_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_storm_control_id_t storm_control_id, sx_policer_counters_t *policer_counters_p)
sx_status_t	sx_api_port_sflow_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_sflow_params_t *sflow_params_p)
sx_status_t	sx_api_port_sflow_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_sflow_params_t *sflow_params_p)
sx_status_t	sx_api_port_sflow_statistics_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_sflow_statistics_t *sflow_stat_p)
sx_status_t	sx_api_port_loopback_filter_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_loopback_filter_mode_t lbf_mode)
sx_status_t	sx_api_port_loopback_filter_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_loopback_filter_mode_t *lbf_mode_p)
sx_status_t	sx_api_port_isolate_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_log_id_t *log_port_list_p, const uint32_t log_port_cnt)
sx_status_t	sx_api_port_isolate_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_log_id_t *log_port_list_p, uint32_t *log_port_cnt_p)
sx_status_t	sx_api_port_isolate_mode_set (const sx_api_handle_t handle, const sx_port_isolate_mode_t *port_isolate_mode_p)
sx_status_t	sx_api_port_isolate_mode_get (const sx_api_handle_t handle, sx_port_isolate_mode_t *port_isolate_mode_p)
sx_status_t	sx_api_port_swid_type_get (const sx_api_handle_t handle, const sx_swid_t swid, sx_swid_type_t *swid_type_p)
sx_status_t	sx_api_port_vport_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_vlan_id_t vlan_id, sx_port_log_id_t *log_vport_p)
sx_status_t	sx_api_port_vport_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_vlan_id_t *vlan_id_list_p, uint32_t *vport_vlan_cnt_p)
sx_status_t	sx_api_port_vport_base_get (const sx_api_handle_t handle, const sx_port_log_id_t vport, sx_vlan_id_t *vlan_id_p, sx_port_log_id_t *log_port_p)
sx_status_t	sx_api_port_vport_counter_bind_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t virtual_port, const sx_flow_counter_id_t flow_counter_id)
sx_status_t	sx_api_port_vport_counter_bind_get (const sx_api_handle_t handle, const sx_port_log_id_t virtual_port, sx_flow_counter_id_t *flow_counter_id_p)
sx_status_t	sx_api_port_vport_mirror_set (const sx_api_handle_t handle, const sx_port_log_id_t virtual_port, const sx_mirror_direction_t mirror_direction, const sx_mirror_mode_t mirror_mode)
sx_status_t	sx_api_port_vport_mirror_get (const sx_api_handle_t handle, const sx_port_log_id_t virtual_port, const sx_mirror_direction_t mirror_direction, sx_mirror_mode_t *mirror_mode_p)
sx_status_t	sx_api_port_phy_mode_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_phy_speed_t speed, const sx_port_phy_mode_t admin_mode)
sx_status_t	sx_api_port_phy_mode_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_phy_speed_t speed, sx_port_phy_mode_t *admin_mode_p, sx_port_phy_mode_t *oper_mode_p)
sx_status_t	sx_api_port_discard_reason_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, sx_port_discard_reason_t *discard_reason_list_p, const uint32_t list_count)
sx_status_t	sx_api_port_forwarding_mode_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_forwarding_mode_t admin_fwd_mode)
sx_status_t	sx_api_port_forwarding_mode_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_forwarding_mode_t *admin_fwd_mode_p)
sx_status_t	sx_api_port_parsing_depth_set (const sx_api_handle_t handle, const uint16_t parsing_depth)
sx_status_t	sx_api_port_parsing_depth_get (const sx_api_handle_t handle, uint16_t *parsing_depth_p)
sx_status_t	sx_api_port_vlan_ethertype_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, sx_vlan_ethertype_t *ether_types_list_p, uint32_t ether_type_count)
sx_status_t	sx_api_port_vlan_ethertype_get (const sx_api_handle_t handle, sx_vlan_ethertype_t *ether_types_list_p, uint32_t *ether_type_count_p)
sx_status_t	sx_api_port_ber_threshold_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_ber_fec_profile_e fec_profile, const sx_port_ber_fec_profile_threshold_data_t threshold_data)
sx_status_t	sx_api_port_ber_threshold_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_ber_fec_profile_e fec_profile, sx_port_ber_fec_profile_threshold_data_t *threshold_data_p)
sx_status_t	sx_api_port_ber_monitor_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_ber_monitor_data_t monitor_data)
sx_status_t	sx_api_port_ber_monitor_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_ber_monitor_data_t *monitor_data_p)
sx_status_t	sx_api_port_ber_monitor_operational_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_ber_monitor_oper_data_t *monitor_oper_data_p)
sx_status_t	sx_api_port_sll_set (const sx_api_handle_t handle, const uint64_t sll_max_time)
sx_status_t	sx_api_port_sll_get (const sx_api_handle_t handle, uint64_t *sll_max_time_p)
sx_status_t	sx_api_port_hll_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const uint32_t hll_max_time, const uint32_t hll_stall_cnt)
sx_status_t	sx_api_port_hll_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, uint32_t *hll_max_time_p, uint32_t *hll_stall_cnt_p)
sx_status_t	sx_api_port_crc_params_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_crc_params_t *crc_params_p)
sx_status_t	sx_api_port_crc_params_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_crc_params_t *crc_params_p)
sx_status_t	sx_api_port_ptp_params_set (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, const sx_port_ptp_params_t *port_ptp_params)
sx_status_t	sx_api_port_ptp_params_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_ptp_params_t *port_ptp_params_p)
sx_status_t	sx_api_port_rate_set (const sx_api_handle_t handle, const sx_port_log_id_t log_port, const sx_port_rate_bitmask_t *rate_p)
sx_status_t	sx_api_port_rate_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_rate_e *oper_rate_p)
sx_status_t	sx_api_port_rate_capability_get (const sx_api_handle_t handle, const sx_port_log_id_t log_port, sx_port_rate_bitmask_t *admin_rate_p, sx_port_rate_bitmask_t *capab_rate_p, sx_port_phy_module_type_bitmask_t *capab_type_p)
sx_status_t	sx_api_port_phy_module_type_set (const sx_api_handle_t handle, const sx_port_mod_id_t module_id, const sx_port_phy_module_type_bitmask_t *types_p)
sx_status_t	sx_api_port_phy_module_type_get (const sx_api_handle_t handle, const sx_port_mod_id_t module_id, sx_port_phy_module_type_e *oper_type_p)
sx_status_t	sx_api_port_phy_module_capability_get (const sx_api_handle_t handle, const sx_port_mod_id_t module_id, sx_port_rate_bitmask_t *capab_port_rate_p, sx_port_phy_module_type_bitmask_t *admin_types_p, sx_port_phy_module_type_bitmask_t *capab_types_p)
sx_status_t	sx_api_port_phy_info_get (const sx_api_handle_t handle, const sx_access_cmd_t cmd, const sx_port_log_id_t log_port, sx_port_phy_stat_t *phy_stat_p)

Function Documentation

sx_api_port_log_verbosity_level_set()

sx_status_t sx_api_port_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 PORT MODULE. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- set verbosity of : API / MODULE / BOTH
[in]	module_verbosity_level	- PORT module verbosity level
[in]	api_verbosity_level	- PORT 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_port_log_verbosity_level_get()

sx_status_t sx_api_port_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 PORT MODULE. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	verbosity_target	- get verbosity of : API / MODULE / BOTH
[out]	module_verbosity_level_p	- PORT module verbosity level
[out]	api_verbosity_level_p	- PORT 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_port_device_set()

sx_status_t sx_api_port_device_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_device_id_t	device_id,
		const sx_mac_addr_t *	base_mac_addr_p,
		sx_port_attributes_t *	port_attributes_list_p,
		const uint32_t	port_cnt
	)

This API adds/deletes a device to/from the SDK. A device may have a different port width when using a single/double/quad lanes to provide 10/20/40GE. The mapping is done between the local port identifier and the module (cage) identifier that hosts this port. The SDK maps the device's local ports to (unique) logical ports that represent the SDK's ports. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD/DELETE
[in]	device_id	- device ID
[in]	base_mac_addr_p	- device base MAC address pointer
[in,out]	port_attributes_list_p	- IN: port_mode, port_mapping OUT: log_port
[in]	port_cnt	- port attributes lists length

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceed its range

SX_STATUS_CMD_UNSUPPORTED if command is not supported

sx_api_port_device_get()

sx_status_t sx_api_port_device_get	(	const sx_api_handle_t	handle,
		const sx_device_id_t	device_id,
		const sx_swid_t	swid,
		sx_port_attributes_t *	port_attributes_list_p,
		uint32_t *	port_cnt_p
	)

This API retrieves a device information (port lists) from the SDK. If all optional output buffers are NULL, this API retrieves the number of ports. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	device_id	- device ID
[in]	swid	- switch ID (use SX_SWID_ID_DONTCARE to get all ports)
[out]	port_attributes_list_p	- port attributes list
[in,out]	port_cnt_p	- IN: port attributes list length OUT:port attributes number

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceed its range

sx_api_port_device_base_mac_get()

sx_status_t sx_api_port_device_base_mac_get	(	const sx_api_handle_t	handle,
		const sx_device_id_t	device_id,
		sx_mac_addr_t *	base_mac_addr_p
	)

This API retrieves a device base MAC from the SDK. The base MAC is used as a base address for the ports MAC. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	device_id	- device ID
[out]	base_mac_addr_p	- device base MAC

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STAUS_ERROR general error.

sx_api_port_mapping_set()

sx_status_t sx_api_port_mapping_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t *	log_port_list_p,
		const sx_port_mapping_t *	port_mapping_list_p,
		const uint32_t	port_cnt
	)

This API sets a ports mapping. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port_list_p	- list of local ports
[in]	port_mapping_list_p	- port mapping list
[in]	port_cnt	- number of ports

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceed its range

sx_api_port_mapping_get()

sx_status_t sx_api_port_mapping_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t *	log_port_list_p,
		sx_port_mapping_t *	port_mapping_list_p,
		const uint32_t	port_cnt
	)

This API retrieves logical port ID mapping from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port_list_p	- list of local ports
[out]	port_mapping_list_p	- port mapping list
[in]	port_cnt	- number of ports

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceed its range

sx_api_port_device_list_get()

sx_status_t sx_api_port_device_list_get	(	const sx_api_handle_t	handle,
		sx_device_info_t *	device_info_list_p,
		uint32_t *	device_info_cnt_p
	)

This API retrieves the devices info list from the SDK. If optional output buffer is NULL, this API retrieves the number of devices. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[out]	device_info_list_p	- list of device info entries
[in,out]	device_info_cnt_p	- In/Out: Input/output list length

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceed its range

sx_api_port_swid_set()

sx_status_t sx_api_port_swid_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_swid_t	swid
	)

This API adds/deletes a SWID to/from the SDK. A SWID which has bound ports cannot be deleted. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- ADD/DELETE
[in]	swid	- switch ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_EXCEEDS_RANGE if SWID exceeds its range or is undefined in profile

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_CMD_UNSUPPORTED if command is not supported

sx_api_port_swid_list_get()

sx_status_t sx_api_port_swid_list_get	(	const sx_api_handle_t	handle,
		sx_swid_t *	swid_list_p,
		uint32_t *	swid_cnt_p
	)

This API retrieves all SWIDs lists from the SDK. If optional output buffer is NULL, this API retrieves the number of SWIDs. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[out]	swid_list_p	- array of SWIDs
[in,out]	swid_cnt_p	- In: Array's length Out: Number of SWIDs

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_EXCEEDS_RANGE: SwIDs list length is 0 (zero)

sx_api_port_swid_bind_set()

sx_status_t sx_api_port_swid_bind_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_swid_t	swid
	)

This API binds/unbinds a logical port to/from a SWID in the SDK. To unbind a port from a SWID, the SWID field should be SX_SWID_ID_DISABLED. Port attributes are being reset during an unbind operation. For example, vlan membership and QinQ. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	swid	- new switch partition ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_EXCEEDS_RANGE if SWID is out of range

sx_api_port_swid_bind_get()

sx_status_t sx_api_port_swid_bind_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_swid_t *	swid_p
	)

This API retrieves a logical port's bound SWID. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	swid_p	- the port's swid

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_EXCEEDS_RANGE if SWID is out of range

sx_api_port_swid_port_list_get()

sx_status_t sx_api_port_swid_port_list_get	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		sx_port_log_id_t *	log_port_list_p,
		uint32_t *	port_cnt_p
	)

This API retrieves the SwID's ports list. If optional output buffer is NULL - this API simply retrieves the number of Ports. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	swid	- switch ID
[out]	log_port_list	- array of device's logical port IDs range
[in,out]	port_cnt_p	- In: Array's length Out: Number of Ports in array

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_EXCEEDS_RANGE if SWID is out of range

sx_api_port_mode_set()

sx_status_t sx_api_port_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_mode_t	mode
	)

This API sets the port's stacking mode in the SDK. Supported devices: SwitchX, SwitchX2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	mode	- new port mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_mode_get()

sx_status_t sx_api_port_mode_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_mode_t *	mode_p
	)

This API retrieves the port's mode from the SDK. Supported devices: SwitchX, SwitchX2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	mode_p	- current port mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_mtu_set()

sx_status_t sx_api_port_mtu_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_mtu_t	mtu_size
	)

This API sets the port MTU size in the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical Port ID
[in]	mtu_size	- new MTU size. The MTU size is L2 frame size (payload size + L2 header size).

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

sx_api_port_mtu_get()

sx_status_t sx_api_port_mtu_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_mtu_t *	max_mtu_size_p,
		sx_port_mtu_t *	oper_mtu_size_p
	)

This API retrieves the port MTU size from the SDK. Note: for Ethernet, maximum MTU and operational MTU are the same. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	max_mtu_size_p	- maximum MTU supported on this port (L2 frame size)
[out]	oper_mtu_size_p	- operational MTU configured on this port (L2 frame size)

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_speed_admin_set()

sx_status_t sx_api_port_speed_admin_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_speed_capability_t *	admin_speed_p
	)

This API sets the port type & speed. It enables the application to set the port enabled mode(s). When the link is up, the current active protocol is retrieved (after SET). When the link is down, the supported protocols are retrieved (after SET). Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	admin_speed_p	- new types and speeds (protocols) enabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_speed_get()

sx_status_t sx_api_port_speed_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_speed_capability_t *	admin_speed_p,
		sx_port_oper_speed_t *	oper_speed_p
	)

This API retrieves the port's admin and operational speed from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	admin_speed_p	- port administrative speed
[out]	oper_speed_p	- Port Operational speed

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_capability_get()

sx_status_t sx_api_port_capability_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_capability_t *	capability_p
	)

This API retrieves the port's supported capabilities from the SDK. HW capabilities are not configurable. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	capability_p	- port capabilities

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_fec_capability_get()

sx_status_t sx_api_port_fec_capability_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_fec_capability_t *	fec_capability_list_p,
		uint32_t *	fec_cnt_p
	)

This API retrieves the port's supported FEC capabilities from the SDK Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	fec_capability_list_p	- List of capabilities and corresponding speeds
[in,out]	fec_cnt_p	- [in] Number of entries to get, [out] Number of entries in returned list If fec_capability_list is NULL or fec_cnt is 0 returns Count instead

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phys_addr_get()

sx_status_t sx_api_port_phys_addr_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_mac_addr_t *	port_mac_addr_p
	)

This API Retrieves the port's physical address (MAC) from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical Port ID
[out]	port_mac_addr_p	- current base MAC address

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phys_addr_set()

sx_status_t sx_api_port_phys_addr_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_mac_addr_t *	port_mac_addr_p
	)

This API sets the port's physical address (MAC). Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	port_mac_addr_p	- new MAC address

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phys_loopback_set()

sx_status_t sx_api_port_phys_loopback_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_phys_loopback_t	phys_loopback
	)

This API sets the port's physical loopback. LAG port cannot be loopback. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	phys_loopback	- new physical loopback

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceeds its range

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_phys_loopback_get()

sx_status_t sx_api_port_phys_loopback_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_phys_loopback_t *	phys_loopback_p
	)

This API retrieves the port's physical loopback. LAG port cannot be loopback. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	phys_loopback_p	- current physical loopback

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceeds its range

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_state_set()

sx_status_t sx_api_port_state_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_admin_state_t	admin_state
	)

This API sets the port administrative state in the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	admin_state	- new administrative status

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_state_get()

sx_status_t sx_api_port_state_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_oper_state_t *	oper_state_p,
		sx_port_admin_state_t *	admin_state_p,
		sx_port_module_state_t *	module_state_p
	)

This API retrieves the port's administrative, operational & module state from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	oper_state_p	- port operational state
[out]	admin_state_p	- port administrative state
[out]	module_state_p	- module operational state

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_global_fc_enable_set()

sx_status_t sx_api_port_global_fc_enable_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_flow_ctrl_mode_t	fc_mode
	)

This API sets the port flow control pause configuration. ENUM sets the mode of both RX & TX with one of 4 possible EN/DIS combinations. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

NOTE: When changing the port flow control configuration between the following states GLOBAL ON/GLOBAL OFF/PFC} the port administrative and operation state must be down.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID (whose flow control configuration to set)
[in]	fc_mode	- ENUM which represents the Tx/Rx flow control state

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_global_fc_enable_get()

sx_status_t sx_api_port_global_fc_enable_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_flow_ctrl_mode_t *	fc_mode_p
	)

This API retrieves the port flow control pause configuration from the SDK. ENUM gets the mode of both RX & TX with one of 4 possible EN/DIS combinations. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID (whose flow control configuration to retrieve)
[out]	fc_mode_p	- ENUM which represents the Tx/Rx flow control state

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_pfc_enable_set()

sx_status_t sx_api_port_pfc_enable_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_flow_ctrl_prio_t	pfc_prio,
		const sx_port_flow_ctrl_mode_t	fc_mode
	)

This API sets the port priority flow control (PFC) configuration. ENUM sets the mode of both RX & TX with one of 4 possible EN/DIS combinations. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

NOTE: When changing the port flow control configuration between the following states {GLOBAL ON/GLOBAL OFF/PFC} the port administrative and operation state must be down.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- port ID
[in]	pfc_prio	- PFC priority
[in]	fc_mode	- ENUM which represents Tx/Rx flow control states

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_pfc_enable_get()

sx_status_t sx_api_port_pfc_enable_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_flow_ctrl_prio_t	pfc_prio,
		sx_port_flow_ctrl_mode_t *	fc_mode_p
	)

This API retrieves the port priority flow control (PFC) configuration the SDK. ENUM gets the mode of both RX & TX with one of 4 possible EN/DIS combinations. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- port ID
[in]	pfc_prio	- PFC priority
[out]	fc_mode_p	- ENUM which represents Tx/Rx flow control state

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_counter_ieee_802_dot_3_get()

sx_status_t sx_api_port_counter_ieee_802_dot_3_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_ieee_802_dot_3_t *	cntr_ieee_802_dot_3_p
	)

This API retrieves the port IEEE 802.3 counters from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_ieee_802_dot_3_p	- IEEE 802.3 counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_counter_rfc_2863_get()

sx_status_t sx_api_port_counter_rfc_2863_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_rfc_2863_t *	cntr_rfc_2863_p
	)

This API retrieves the port RFC 2863 counters from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_rfc_2863_p	- RFC 2863 counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_counter_rfc_2819_get()

sx_status_t sx_api_port_counter_rfc_2819_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_rfc_2819_t *	cntr_rfc_2819_p
	)

This API retrieves the port RFC 2819 counters from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_rfc_2819_p	- RFC 2819 counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_counter_rfc_3635_get()

sx_status_t sx_api_port_counter_rfc_3635_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_rfc_3635_t *	cntr_rfc_3635_p
	)

This API retrieves the port RFC 3635 counters from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_rfc_3635_p	- RFC 3635 counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_counter_cli_get()

sx_status_t sx_api_port_counter_cli_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_cli_t *	cntr_cli_p
	)

This API retrieves the port CLI counters from the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_cli_p	- CLI counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_counter_prio_get()

sx_status_t sx_api_port_counter_prio_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_cos_ieee_prio_t	prio_id,
		sx_port_cntr_prio_t *	cntr_prio_p
	)

This API retrieves the port priority counters from the SDK. When a LAG port is given, the result is the sum of all the LAG ports counters. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[in]	prio_id	- priority ID
[out]	cntr_prio_p	- priority counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_PARAM_ERROR if an input parameter is invalid

sx_api_port_counter_tc_get()

sx_status_t sx_api_port_counter_tc_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_tc_id_t	tc_id,
		sx_port_traffic_cntr_t *	cntr_tc_p
	)

This API retrieves the port's traffic class counters. Note: The API does not support LAG nor VPORT.

For Spectrum device:

• If a switch priority is mapped to any higher TC X [where 8 <= X <= 15], then tx_octet and tx_frames will be counted against TC [X - 8]
• If the port is in MC Aware Mode, valid values of tc_id are [0-7]

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[in]	tc_id	- traffic class ID
[out]	cntr_tc_p	- per port per TC counters

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_PARAM_ERROR if an input parameter is invalid

sx_api_port_counter_buff_get()

sx_status_t sx_api_port_counter_buff_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_cos_priority_group_t	buff_id,
		sx_port_cntr_buff_t *	cntr_buff_p
	)

This API retrieves the port buffer counters from the SDK. When a LAG port is given, the result is the sum of all the LAG ports counters.

In UC mode Rx Uc octets, Rx UC frames, and Rx discard counters are available only for Buff ID 0 - 7. Shared buffer discard counter is not supported on Spectrum.

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[in]	buff_id	- buffer ID
[out]	cntr_buff_p	- buffer counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_PARAM_ERROR if an input parameter is invalid

sx_api_port_counter_perf_get()

sx_status_t sx_api_port_counter_perf_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_prio_id_t	prio_id,
		sx_port_cntr_perf_t *	cntr_perf_p
	)

This API Retrieves the extended port counters from the SDK. Note: This API does not support LAG. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[in]	prio_id	- counters priority ID . In Spectrum only prio_id=0 is supported.
[out]	cntr_perf_p	- performance counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

sx_api_port_counter_discard_get()

sx_status_t sx_api_port_counter_discard_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_discard_t *	cntr_discard_p
	)

This API Retrieves the port discard counters from the SDK. The user has the following options:

1. Read the discard counters (set the cmd to SX_ACCESS_CMD_READ)
2. Read and clear the discard counters (set the cmd to SX_ACCESS_CMD_READ_CLEAR)

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_discard_p	- discard counters entry

Returns

sx_status_t :

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_ERROR if a parameter is NULL or not supported

SX_STATUS_ENTRY_NOT_FOUND if requested element is not found in the DB

sx_api_port_counter_clear_set()

sx_status_t sx_api_port_counter_clear_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const boolean_t	all_ports,
		const sx_port_cntr_grp_t	cntr_grp
	)

This API clears port counters. The user has the following options:

1. Clear a specific port (set log_port field with the log port ID && all_ports = FALSE): option a. clear specific counter group (set the group in cntr_grp) option b. clear all counter groups (set cntr_grp = SX_PORT_CNTR_GRP_ALL)
2. Clear all ports (set all_ports = TRUE): option a. clear specific counter group (set the group in cntr_grp) option b. clear all counter groups (set cntr_grp = SX_PORT_CNTR_GRP_ALL)

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID.
[in]	all_ports	- clear all ports counters
[in]	cntr_grp	- performance counter group

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_counter_phy_layer_get()

sx_status_t sx_api_port_counter_phy_layer_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_cntr_phy_layer_t *	cntr_phy_layer_p
	)

This API retrieves the port Physical Layer counters from the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	cntr_phy_layer_p	- Physical Layer counters entry

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_init_set()

sx_status_t sx_api_port_init_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port
	)

This API initializes the port in the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_deinit_set()

sx_status_t sx_api_port_deinit_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port
	)

This API de-initializes the port in the SDK. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_COMM_ERROR if client communication fails

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_storm_control_set()

sx_status_t sx_api_port_storm_control_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_storm_control_id_t	storm_control_id,
		const sx_port_storm_control_params_t *	storm_control_params_p
	)

This API sets storm control parameters of a port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_ADD, SX_ACCESS_CMD_EDIT, SX_ACCESS_CMD_DELETE
[in]	log_port	- logical port ID
[in]	storm_control_id	- Storm Control ID
[in]	storm_control_param_p	- Storm Control parameters

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_SXD_RETURNED_NON_ZERO if HW fails

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_storm_control_get()

sx_status_t sx_api_port_storm_control_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_storm_control_id_t	storm_control_id,
		sx_port_storm_control_params_t *	storm_control_params_p
	)

This API retrieves storm control parameters of a port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	storm_control_id	- Storm Control ID
[out]	storm_control_param_p	- Storm Control parameters

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_storm_control_counters_clear_set()

sx_status_t sx_api_port_storm_control_counters_clear_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_storm_control_id_t	storm_control_id,
		const sx_policer_counters_clear_t *	clear_counters_p
	)

This function clears storm control counters values. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	storm_control_id	- Storm Control ID
[in]	clear_counters	- which counters to clear

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any other input error

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_ERROR general error

sx_api_port_storm_control_counters_get()

sx_status_t sx_api_port_storm_control_counters_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_storm_control_id_t	storm_control_id,
		sx_policer_counters_t *	policer_counters_p
	)

This function retrieves storm control counters values. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	storm_control_id	- Storm Control ID
[out]	policer_counters_p	- pointer to a policer counter struct.

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any other input error

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_ERROR general error

sx_api_port_sflow_set()

sx_status_t sx_api_port_sflow_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_sflow_params_t *	sflow_params_p
	)

This API controls sFlow configuration. Using the access command ADD, an sFlow sampling is defined on port. Then after it is set, the user may EDIT the sFlow parameters of a configured port. To remove sFlow sampling from the port use access command DELETE. The API returns the sFlow params configured in practice.Deviation is returned in percentage. It is highly recommended to always check the deviation value returned (SwitchX, SwitchX2 only).

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- access command (ADD/DELETE/EDIT)
[in]	log_port	- logical port ID
[in,out]	sflow_params_p	- sFlow related configuration params (Deviation>0); ignored when CMD=DESTROY

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_NO_RESOURCES if there are not enough resources for sFlow policer (SwitchX, SwitchX2 only)

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_ENTRY_NOT_FOUND if specified port is not exist in DB or port not configured with sflow

SX_STATUS_ENTRY_ALREADY_EXISTS if sflow is requested for add on port already configured with sflow

SX_STATUS_NO_MEMORY if there is no free memory

SX_STATUS_WRONG_POLICER_TYPE if relevant policer is not bound (SwitchX, SwitchX2 only)

SX_STATUS_ENTRY_ALREADY_BOUND if entry is already bound to policer (SwitchX, SwitchX2 only)

SX_STATUS_ERROR for a general error

sx_api_port_sflow_get()

sx_status_t sx_api_port_sflow_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_sflow_params_t *	sflow_params_p
	)

This API gets the ports sFlow state. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	sflow_params_p	- sFlow related configuration parameters

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_ENTRY_NOT_FOUND if sflow is requested for port not configured with sflow

SX_STATUS_ERROR for a general error

sx_api_port_sflow_statistics_get()

sx_status_t sx_api_port_sflow_statistics_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_sflow_statistics_t *	sflow_stat_p
	)

This API retrieves the number of dropped packets from logical port or LAG. Supported devices: devices with dedicated HW for sflow sampling (currently Spectrum).

Packed dropped counter accumulates:

• packets dropped due to lack of host CPU RX buffer resources;
• packets dropped by host CPU policers; Packed dropped counter does not accumulate:
• packets dropped due to lack of shared buffer resources on duplication;

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- access command (READ/READ_CLEAR/CLEAR)
[in]	log_port	- logical port ID
[out]	sflow_stat_p	- sFlow statistics related configuration parameters

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_CMD_UNSUPPORTED if command is not supported

SX_STATUS_ENTRY_NOT_FOUND if sflow is requested for port not configured with sflow

SX_STATUS_NO_MEMORY if there is no free memory

SX_STATUS_ERROR for a general error

sx_api_port_loopback_filter_set()

sx_status_t sx_api_port_loopback_filter_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_loopback_filter_mode_t	lbf_mode
	)

This API controls loopback filter state of the port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	lbf_mode	- loopback filter mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_ERROR for a general error

sx_api_port_loopback_filter_get()

sx_status_t sx_api_port_loopback_filter_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_loopback_filter_mode_t *	lbf_mode_p
	)

This API retrieves the loopback filter state of the port. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	lbf_mode_p	- loopback filter mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_ERROR for a general error

sx_api_port_isolate_set()

sx_status_t sx_api_port_isolate_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_log_id_t *	log_port_list_p,
		const uint32_t	log_port_cnt
	)

This function sets the isolation group of the port (a list of ports from which traffic should not be transmitted to log_port). Isolation is supported only between ports on the same device, and on the same SWID. Set - add ports to isolation group (overwrites previous configuration) Add - add ports to isolation group (additionally to previous configuration) Delete - remove ports from isolation group Delete All - empty isolation group

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SET/ADD/DELETE/DELETE_ALL
[in]	log_port	- logical port ID
[in]	log_port_list_p	- list of logical ports
[in]	log_port_cnt	- number of logical ports in the list

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_ENTRY_NOT_FOUND if requested element is not found in the DB

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

sx_api_port_isolate_get()

sx_status_t sx_api_port_isolate_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_log_id_t *	log_port_list_p,
		uint32_t *	log_port_cnt_p
	)

This function retrieves the isolation group of the port (a list of ports from which traffic should not be transmitted to log_port). Use log_port_cnt_p=0 to retrieve only the size of isolation group.

Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in,out]	log_port_list_p	- list of logical ports
[in,out]	log_port_cnt_p	- In: Number of logical ports in list Out: Number of logical ports in LAG

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_ENTRY_NOT_FOUND if requested element is not found in the DB

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

sx_api_port_isolate_mode_set()

sx_status_t sx_api_port_isolate_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_isolate_mode_t *	port_isolate_mode_p
	)

This function defines port isolation mode: whether pass or filter frames, which went through the router. This API is added for backward compatibility and from the performance considerations. In case pass_routed_frames is True, frame performance penalty is possible. pass_routed_frames=True relates to the physical ports and not to the internal tunnel ports.

Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle
[in]	port_isolate_mode_p	- port isolate mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_ERROR if requested element is not found in the DB

SX_STATUS_PARAM_ERROR if a parameters exceeds its range

sx_api_port_isolate_mode_get()

sx_status_t sx_api_port_isolate_mode_get	(	const sx_api_handle_t	handle,
		sx_port_isolate_mode_t *	port_isolate_mode_p
	)

This function retrieves port isolation mode.

Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle
[out]	port_isolate_mode_p	- port isolate mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_swid_type_get()

sx_status_t sx_api_port_swid_type_get	(	const sx_api_handle_t	handle,
		const sx_swid_t	swid,
		sx_swid_type_t *	swid_type_p
	)

This API returns the SWID type as it was configured in the profile, at SDK init time. Supported devices: SwitchX, SwitchX2, Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
	swid	- switch partition ID
	swid_type_p	- DISABLED/ETHERNET/INFINIBAND

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameters exceeds its range

sx_api_port_vport_set()

sx_status_t sx_api_port_vport_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_vlan_id_t	vlan_id,
		sx_port_log_id_t *	log_vport_p
	)

This API creates a virtual port for port log_port and vlan vid. cmd = ADD: create a vport for the given logical port & vlan cmd = DELETE: delete the given vport cmd = DELETE_ALL: delete all vports from the given logical port Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- ADD/DELETE/DELETE_ALL.
[in]	log_port	- Port or LAG.
[in]	vlan_id	- Vlan id.
[in,out]	log_vport	- Logical port representing the virtual port.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_CMD_UNSUPPORTED if cmd is unsupported in this API.

SX_STATUS_ENTRY_NOT_FOUND if port does not exist OR vport for delete cmd.

SX_STATUS_PARAM_ERROR if vid is not in the range or log_port type is invalid

SX_STATUS_ENTRY_ALREADY_EXISTS if virtual port already exists.

SX_STATUS_NO_RESOURCES if there is no more room for vports to be added.

sx_api_port_vport_get()

sx_status_t sx_api_port_vport_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_vlan_id_t *	vlan_id_list_p,
		uint32_t *	vport_vlan_cnt_p
	)

This API returns the vport vlans created over the port. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- Port or LAG.
[out]	vlan_id_p	- A list of all vlans created on the port.
[in,out]	vport_vlan_cnt_p	- The number of vport_vlans to return. If vport_vlan_cnt_p==0, Only the number of vport_vlans will be returned and the list will remain empty.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_ENTRY_NOT_FOUND if log_port does not exist.

SX_STATUS_PARAM_ERROR if vlan_list_p is NULL.

sx_api_port_vport_base_get()

sx_status_t sx_api_port_vport_base_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	vport,
		sx_vlan_id_t *	vlan_id_p,
		sx_port_log_id_t *	log_port_p
	)

This API returns the base port and vlan properties for a given vport. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	vport	- Vport logical ID.
[out]	vlan_id_p	- Vlan.
[out]	log_port_p	- Base port logical ID.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_ENTRY_NOT_FOUND if vport does not exist.

SX_STATUS_PARAM_ERROR if an input parameter is invalid

sx_api_port_vport_counter_bind_set()

sx_status_t sx_api_port_vport_counter_bind_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	virtual_port,
		const sx_flow_counter_id_t	flow_counter_id
	)

This API binds a flow counter to a virtual port. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- BIND/UNBIND.
[in]	virtual_port	- Logical port representing the virtual port.
[in]	flow_counter_id	- The flow counter ID to be bound to the virtual port.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_CMD_UNSUPPORTED if cmd is unsupported in this API.

SX_STATUS_ENTRY_NOT_FOUND if vport or flow counter do not exist.

SX_STATUS_ENTRY_ALREADY_BOUND if virtual port already has a counter.

sx_api_port_vport_counter_bind_get()

sx_status_t sx_api_port_vport_counter_bind_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	virtual_port,
		sx_flow_counter_id_t *	flow_counter_id_p
	)

This API retrieves the flow counter bound to the virtual port. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	virtual_port	- Logical port representing the virtual port.
[out]	flow_counter_id_p	- The flow counter ID bound to the virtual port.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_ENTRY_NOT_FOUND if vport or flow counter do not exist.

sx_api_port_vport_mirror_set()

sx_status_t sx_api_port_vport_mirror_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	virtual_port,
		const sx_mirror_direction_t	mirror_direction,
		const sx_mirror_mode_t	mirror_mode
	)

Supported devices: Spectrum, Spectrum2. This function sets the mirroring state for a virtual port. Currently only ingress direction is supported.

Parameters

[in]	handle	- SX-API handle
[in]	virtual_port	- mirroring vport
[in]	mirror_direction	- ingress\egress
[in]	mirror_mode	- enabled \ disabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ENTRY_NOT_FOUND if virtual_port not found in DB

SX_STATUS_ERROR if unexpected behavior occurs

sx_api_port_vport_mirror_get()

sx_status_t sx_api_port_vport_mirror_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	virtual_port,
		const sx_mirror_direction_t	mirror_direction,
		sx_mirror_mode_t *	mirror_mode_p
	)

Supported devices: Spectrum, Spectrum2. This function gets the mirroring mode for a virtual port by direction. Currently only ingress direction is supported.

Parameters

[in]	handle	- SX-API handle. @ param[in] virtual_port - mirroring vport
[in]	mirror_direction	- ingress/egress
[out]	mirror_mode_p	- the returned mirroring mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ENTRY_NOT_FOUND if virtual_port is not found in DB

SX_STATUS_ERROR if unexpected behaviour occurs

sx_api_port_phy_mode_set()

sx_status_t sx_api_port_phy_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_phy_speed_t	speed,
		const sx_port_phy_mode_t	admin_mode
	)

This API sets the port's phy mode in the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	speed	- Phy Speed - 10G/40G/25G/50G/100G Note: Changing the FEC mode of 25G speed also sets 50G speed mode and vice versa.
[in]	mode	- new phy admin mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceeds its range

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_phy_mode_get()

sx_status_t sx_api_port_phy_mode_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_phy_speed_t	speed,
		sx_port_phy_mode_t *	admin_mode_p,
		sx_port_phy_mode_t *	oper_mode_p
	)

This API retrieves the port's phy mode from the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	speed	- Phy Speed - 10G/40G/25G/50G/100G
[out]	admin_mode_p	- current port Admin phy mode. Administrative phy mode is per speed (i.e. Speed is required for the administrative value).
[out]	oper_mode_p	- current port Operational phy mode.Operational phy mode is global and not per speed (i.e Speed is don't care for the operational value).

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceeds its range

SX_STATUS_INVALID_HANDLE if a NULL handle is received

SX_STATUS_PARAM_NULL if a parameter is NULL

sx_api_port_discard_reason_get()

sx_status_t sx_api_port_discard_reason_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		sx_port_discard_reason_t *	discard_reason_list_p,
		const uint32_t	list_count
	)

This API enables to read/clear discard reason

Supported devices: Spectrum, Spectrum2.

This release does not support the following causes: ip_discard: sx_port_cause_t packet_to_router_is_not_ip sx_port_cause_t dip_is_loopback sx_port_cause_t sip_is_in_class sx_port_cause_t sip is loopback sx_port_cause_t ip header not okay sx_port_cause_t ipv4 sip is limited broadcast sx_port_cause_t lpm ipv6 miss sx_port_cause_t IPv4 dip is limited broadcast sx_port_cause_t IPv4 dip is local sx_port_cause_t NVE packet to overlay router

MPLS_discard: sx_port_cause_t outer_label_is_not_valid sx_port_cause_t no_IP_after_decap sx_port_cause_t expected_Bos_but_pop_did_not_expose_BoS; sx_port_cause_t php_decap_and_no_ip_header_or_ip_header_is_not_okay

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- READ/READ_CLEAR
[in,out]	discard_reason_list_p	- array of discard reason
[in]	list_count	- array's length

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received O/W, the appropriate error code it returned.

sx_api_port_forwarding_mode_set()

sx_status_t sx_api_port_forwarding_mode_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_forwarding_mode_t	admin_fwd_mode
	)

This API sets the port's forwarding mode (cut-through vs. store-and-forward) in the SDK. Note: Port operational forwarding mode will be updated only after port toggling. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical Port ID
[in]	admin_fwd_mode	- new administrative forwarding mode

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_EXCEEDS_RANGE if a parameter exceeds its range

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_forwarding_mode_get()

sx_status_t sx_api_port_forwarding_mode_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_forwarding_mode_t *	admin_fwd_mode_p
	)

This API retrieves the port's forwarding mode (cut-through vs. store-and-forward) from the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	admin_fwd_mode_p	- administrative forwarding mode configured on this port

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_parsing_depth_set()

sx_status_t sx_api_port_parsing_depth_set	(	const sx_api_handle_t	handle,
		const uint16_t	parsing_depth
	)

This API set the chip parsing depth in bytes . Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	parsing_depth	- parsing depth in bytes

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_parsing_depth_get()

sx_status_t sx_api_port_parsing_depth_get	(	const sx_api_handle_t	handle,
		uint16_t *	parsing_depth_p
	)

This API retrieves the chip parsing depth . Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[out]	parsing_depth_p	- return parsing depth in bytes

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_vlan_ethertype_set()

sx_status_t sx_api_port_vlan_ethertype_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		sx_vlan_ethertype_t *	ether_types_list_p,
		uint32_t	ether_type_count
	)

This API is used to set Ethertypes globally. Note that Ethertype 0x8100 will always be configured by default. This API allows the user to configure additional Ethertypes per function.

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	cmd	- ADD/DELETE .
[in]	ether_types_p	- a pointer to struct holding a list of ether_types
[in]	ether_type_count	- number of Ethertypes being configured (Max 1 in Spectrum)

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any of the parameters are in Error.

SX_STATUS_NO_RESOURCES if no resources are available

SX_STATUS_ENTRY_NOT_FOUND if a DELETE is called on a non-existent Ethertype

SX_STATUS_RESOURCE_IN_USE if a DELETE is called while a resource is in use

SX_STATUS_ERROR for a general error

sx_api_port_vlan_ethertype_get()

sx_status_t sx_api_port_vlan_ethertype_get	(	const sx_api_handle_t	handle,
		sx_vlan_ethertype_t *	ether_types_list_p,
		uint32_t *	ether_type_count_p
	)

This API gets a list of user configured Ethertypes. Note that 0x8100 is always configured and will not be retrieved. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[out]	ether_types_p	- a pointer to struct to hold the retrieved list
[in,out]	ether_type_count	- number of Ethertypes being retrieved. If ether_type_count==0,returns count instead.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any of the parameters are in Error.

SX_STATUS_ERROR for a general error

sx_api_port_ber_threshold_set()

sx_status_t sx_api_port_ber_threshold_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_ber_fec_profile_e	fec_profile,
		const sx_port_ber_fec_profile_threshold_data_t	threshold_data
	)

This API is used to set values to the different Bit Error Rate profiles. Supported devices: Spectrum.

Min/max values: |-----------------------------—| | Monitor | Min | Max | |-----------------------------—| |RS-FEC Pre-FEC | 1e-9 | 1e-4 | |-----------------------------—| |FC-FEC PRE-FEC | 1e-11 | 1e-4 | |-----------------------------—| |NO-FEC/Post-FEC | 1e-14 | 1e-8 | |-----------------------------—|

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- Network port only.
[in]	fec_profile	- The FEC profile to be used (RS/FC/NO).
[in]	threshold_data	- Threshold values to set. Values of fraction of errors. Final BER monitor threshold should be between 0 and 1.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ERROR general error.

sx_api_port_ber_threshold_get()

sx_status_t sx_api_port_ber_threshold_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_ber_fec_profile_e	fec_profile,
		sx_port_ber_fec_profile_threshold_data_t *	threshold_data_p
	)

This API is used to retrieve values of the different Bit Error Rate profiles. Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- Network port only.
[in]	fec_profile	- The FEC profile to retrieve (RS/FC/NO).
[out]	threshold_data_p	- Threshold values.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ERROR general error.

sx_api_port_ber_monitor_set()

sx_status_t sx_api_port_ber_monitor_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_ber_monitor_data_t	monitor_data
	)

This API is used to configure the Bit Error Rate Monitor. It is recommended to use sx_api_port_ber_monitor_operational_get after configuring this API to retrieve the FEC status that is configured. This API is orthogonal to the port FEC configuration. It is recommended to first register to SX_TRAP_ID_BER_MONITOR and then setting the monitor data so the first event will be the current status. Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- The port to which to set the monitor. Only network ports are supported.
[in]	monitor_data	- The monitor attributes to configure.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ERROR general error.

sx_api_port_ber_monitor_get()

sx_status_t sx_api_port_ber_monitor_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_ber_monitor_data_t *	monitor_data_p
	)

This API is used to retrieve values configured to the Bit Error Rate Monitor. Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- The port to which the monitor is configured. Only network ports are supported.
[out]	monitor_data_p	- Structure to hold the desired data.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_ERROR general error.

sx_api_port_ber_monitor_operational_get()

sx_status_t sx_api_port_ber_monitor_operational_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_ber_monitor_oper_data_t *	monitor_oper_data_p
	)

This API is used to retrieve the current state of the Bit Error Rate Monitor. Supported devices: Spectrum.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- The port to which the monitor is configured. Only network ports are supported.
[out]	monitor_oper_data_p	- Structure to hold the desired data.

Returns

SX_STATUS_SUCCESS if operation completes successfully.

SX_STATUS_PARAM_ERROR if any input parameter is invalid.

SX_STATUS_NO_RESOURCES if cannot allocate resources.

SX_STATUS_ERROR general error

sx_api_port_sll_set()

sx_status_t sx_api_port_sll_set	(	const sx_api_handle_t	handle,
		const uint64_t	sll_max_time
	)

SLL is the max lifetime of a frame within the switch after which it is discarded. This function SETs the sll_max_time in microseconds.

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	sll_max_time	- The sll duration in micro seconds Min val = 32usec. Max val = 4398046511 usec (or 4398sec) Any value greater than max implies NO SLL i.e packets are never aged & discarded. SDK will round the sll duration to: (the lowest power of 2 >= sll) * 4.096 For e.g. 500000 will be rounded up to 536871

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ERROR if unexpected behaviour occurs

SX_STATUS_INVALID_HANDLE if handle is invalid

sx_api_port_sll_get()

sx_status_t sx_api_port_sll_get	(	const sx_api_handle_t	handle,
		uint64_t *	sll_max_time_p
	)

SLL is the max lifetime of a frame within the switch after which it is discarded. This function GETs the system sll_max_time in microseconds.

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[out]	sll_max_time_p	- The sll duration in micro seconds .

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ERROR if unexpected behaviour occurs

SX_STATUS_INVALID_HANDLE if handle is invalid

sx_api_port_hll_set()

sx_status_t sx_api_port_hll_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const uint32_t	hll_max_time,
		const uint32_t	hll_stall_cnt
	)

HLL is a mechanism that discards packets that are awaiting transmission at the head of a scheduling group queue. The max duration a packet can wait in the queue is configurable After a certain number of packets are discarded, this scheduling group may enter the STALL state if enabled. This function SETs hll_max_time and the hll_stall_cnt for a given port

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- the local port. Only Physical ports and LAG Ports are allowed.
[in]	hll_max_time	- The HLL duration in micro seconds. Min val = 4usec. Max val = 2147483usec (or 2sec) Any value greater than max implies infinite HLL(or No HLL) SDK will round the hll time to: (the lowest power of 2 >= hll) * 4.096 For e.g. 10000 will be rounded up to 16777
[in]	hll_stall_cnt	- Number of packets that need to be discarded after which the queue enters stall state. Valid range [0-7]; Default = 7; 0 = Stall Disabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ERROR if unexpected behavior occurs

SX_STATUS_INVALID_HANDLE if handle is invalid

sx_api_port_hll_get()

sx_status_t sx_api_port_hll_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		uint32_t *	hll_max_time_p,
		uint32_t *	hll_stall_cnt_p
	)

HLL is a mechanism that discards packets that are awaiting transmission at the head of a scheduling group queue. The max duration a packet can wait in the queue is configurable After a certain number of packets are discarded, this scheduling group may enter the STALL state if enabled. This function GETs hll_max_time and the hll_stall_cnt for a given port

Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle.
[in]	log_port	- the local port. Only Physical ports and LAG Ports are allowed.
[out]	hll_max_time_p	- The HLL duration in micro seconds rounded up to: ((nearest power of 2) * 4.096)
[out]	hll_stall_cnt_p	- Number of packets that need to be discarded after which the queue enters stall state. Valid range [0-7]; 0 = Stall Disabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if any input parameter is invalid

SX_STATUS_ERROR if unexpected behavior occurs

SX_STATUS_INVALID_HANDLE if handle is invalid

sx_api_port_crc_params_set()

sx_status_t sx_api_port_crc_params_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_crc_params_t *	crc_params_p
	)

This API sets the options for how the port handles CRCs in the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical Port ID
[in]	crc_params	- CRC handling options

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_crc_params_get()

sx_status_t sx_api_port_crc_params_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_crc_params_t *	crc_params_p
	)

This API gets the current options for how the port handles CRCs in the SDK. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical Port ID
[out]	crc_params	- CRC handling options

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_ptp_params_set()

sx_status_t sx_api_port_ptp_params_set	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		const sx_port_ptp_params_t *	port_ptp_params
	)

This function sets PTP port parameters Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_EDIT : change grand master port
[in]	log_port	- The log port to set
[in]	port_ptp_params	- The ptp port parameters

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_port_ptp_params_get()

sx_status_t sx_api_port_ptp_params_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_ptp_params_t *	port_ptp_params_p
	)

This function gets PTP port role Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_GET : change grand master port
[in]	log_port	- The log port to query
[out]	port_ptp_params	- The ptp port parameters

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_port_rate_set()

sx_status_t sx_api_port_rate_set	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		const sx_port_rate_bitmask_t *	rate_p
	)

This API sets the port rate values bitmask only (speed value and not physical connector type). Note that this API is mutually exclusive with sx_api_port_admin_set, so per single SDK life cycle only one of them can be used. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[in]	rate_p	- bitmask of new rates to enabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_rate_get()

sx_status_t sx_api_port_rate_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_rate_e *	oper_rate_p
	)

This API gets the port operation rate value only. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]	oper_rate_p	- operational rate value

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_rate_capability_get()

sx_status_t sx_api_port_rate_capability_get	(	const sx_api_handle_t	handle,
		const sx_port_log_id_t	log_port,
		sx_port_rate_bitmask_t *	admin_rate_p,
		sx_port_rate_bitmask_t *	capab_rate_p,
		sx_port_phy_module_type_bitmask_t *	capab_type_p
	)

This API gets bitmask of configured port rates values and supported by ASIC bitmasks of rates and module types. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	log_port	- logical port ID
[out]

sx_api_port_phy_module_type_set()

sx_status_t sx_api_port_phy_module_type_set	(	const sx_api_handle_t	handle,
		const sx_port_mod_id_t	module_id,
		const sx_port_phy_module_type_bitmask_t *	types_p
	)

This API sets the Physical Medium Depended (PMD) port type. By default all types are enabled, hence this API allows to reduce the set of allowed port types. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	module_id	- module ID
[in]	types_p	- new types enabled

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phy_module_type_get()

sx_status_t sx_api_port_phy_module_type_get	(	const sx_api_handle_t	handle,
		const sx_port_mod_id_t	module_id,
		sx_port_phy_module_type_e *	oper_type_p
	)

This API gets the operational Physical Medium Depended port type. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	module_id	- module ID
[out]	oper_type_p	- operational types

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phy_module_capability_get()

sx_status_t sx_api_port_phy_module_capability_get	(	const sx_api_handle_t	handle,
		const sx_port_mod_id_t	module_id,
		sx_port_rate_bitmask_t *	capab_port_rate_p,
		sx_port_phy_module_type_bitmask_t *	admin_types_p,
		sx_port_phy_module_type_bitmask_t *	capab_types_p
	)

This API gets the electrical interface types which hare supported by module. Supported devices: Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	module_id	- module ID
[out]	capab_port_rate_p	- supported by module rate values
[out]	admin_types_p	- configured by user port types to enable
[out]	capab_types_p	- supported by module electrical interfaces

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_MESSAGE_SIZE_ZERO if message size is zero

SX_STATUS_MESSAGE_SIZE_EXCEEDS_LIMIT if message size exceeds limit

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received

sx_api_port_phy_info_get()

sx_status_t sx_api_port_phy_info_get	(	const sx_api_handle_t	handle,
		const sx_access_cmd_t	cmd,
		const sx_port_log_id_t	log_port,
		sx_port_phy_stat_t *	phy_stat_p
	)

This API gets port physical information. It returns the port's current operational state and how many times the operational state has changed. It also returns the possible reasons if the port is down. If the command is SX_ACCESS_CMD_READ_CLEAR, it will clear the port state change count after reading it, and it won't clear the port down reason. Supported devices: Spectrum, Spectrum2.

Parameters

[in]	handle	- SX-API handle
[in]	cmd	- SX_ACCESS_CMD_READ | SX_ACCESS_CMD_READ_CLEAR
[in]	log_port	- logical port ID
[out]	phy_stat_p	- port physical information

Returns

SX_STATUS_SUCCESS if operation completes successfully

SX_STATUS_PARAM_ERROR if an input parameter is invalid

SX_STATUS_PARAM_NULL if a parameter is NULL

SX_STATUS_INVALID_HANDLE if a NULL handle is received