BroadView™ API Guide and Reference Manual
Functions
BroadView Packet Trace SB Redirector Feature Declarations And Definitions [BVIEW SB REDIRECTOR]
API Definitions

Functions

BVIEW_STATUS sbapi_pt_5_tuple_profile_create (int asic, int request_id, BVIEW_PORT_MASK_t *port_list, PT_5_TUPLE_PARAMS_t *tuple_params)
 
BVIEW_STATUS sbapi_pt_5_tuple_profile_delete (int asic, int request_id)
 
BVIEW_STATUS sbapi_pt_asic_supported_drop_reason_get_cb (int asic, BVIEW_PT_DROP_REASON_MASK_t *mask)
 Get Mask of ASIC Configurable drop reasons.
 
BVIEW_STATUS sbapi_pt_clear_drop_reason_cb (int asic)
 Clear all configured Drop Reasons.
 
BVIEW_STATUS sbapi_pt_drop_counter_get_cb (int asic, BVIEW_PT_DROP_COUNTER_REPORT_t *data, BVIEW_TIME_t *time)
 Obtain Drop Counter Report for all Drop Reasons.
 
BVIEW_STATUS sbapi_pt_drop_reason_config_get_cb (int asic, BVIEW_PT_DROP_REASON_CONFIG_t *config)
 Get Packet Trace configuration.
 
BVIEW_STATUS sbapi_pt_drop_reason_config_set (int asic, BVIEW_PT_DROP_REASON_CONFIG_t *config)
 Set Packet Trace configuration Paramters.
 
BVIEW_STATUS sbapi_pt_register_trigger_cb (int asic, BVIEW_PT_TRIGGER_CALLBACK_t callback, void *cookie)
 Register hw trigger callback.
 
BVIEW_STATUS sbapi_pt_trace_profile_get_cb (int asic, int port, BVIEW_PT_PACKET_t *packet, BVIEW_PT_TRACE_PROFILE_t *traceProfile, BVIEW_TIME_t *time)
 Obtain Trace Profile for a given packet.
 

Detailed Description

Function Documentation

BVIEW_STATUS sbapi_pt_asic_supported_drop_reason_get_cb ( int  asic,
BVIEW_PT_DROP_REASON_MASK_t mask 
)

Get Mask of ASIC Configurable drop reasons.

Parameters
[in]asicunit
[out]maskMask of drop reasons
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSDevice stat get is successful
BVIEW_STATUS_UNSUPPORTEDDevice stat get functionality is not supported on this unit

none

BVIEW_STATUS sbapi_pt_clear_drop_reason_cb ( int  asic)

Clear all configured Drop Reasons.

Parameters
[in]asicunit
[out]datai_sp structure
[out]timetime
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSIngress Service Pools stat get is successful
BVIEW_STATUS_UNSUPPORTEDIngress Service Pools stat get functionality is not supported on this unit

none

BVIEW_STATUS sbapi_pt_drop_counter_get_cb ( int  asic,
BVIEW_PT_DROP_COUNTER_REPORT_t data,
BVIEW_TIME_t *  time 
)

Obtain Drop Counter Report for all Drop Reasons.

Parameters
[in]asicunit
[out]datai_p_sp data structure
[out]timetime
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSIngress Port + Service Pools stat get is successful
BVIEW_STATUS_UNSUPPORTEDIngress Port + Service Pools stat get functionality is not supported on this unit

none

BVIEW_STATUS sbapi_pt_drop_reason_config_get_cb ( int  asic,
BVIEW_PT_DROP_REASON_CONFIG_t config 
)

Get Packet Trace configuration.

Parameters
[in]asicUnit number
[out]configPacket Trace config structure
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSPacket Trace config get is successful
BVIEW_STATUS_UNSUPPORTEDPacket Trace config get functionality is not supported on this unit

none

BVIEW_STATUS sbapi_pt_drop_reason_config_set ( int  asic,
BVIEW_PT_DROP_REASON_CONFIG_t config 
)

Set Packet Trace configuration Paramters.

Parameters
[in]asicUnit number
[in]configPacket Trace config structure
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSPacket Trace config set is successful
BVIEW_STATUS_UNSUPPORTEDPacket Trace config set functionality is not supported on this unit

none

BVIEW_STATUS sbapi_pt_register_trigger_cb ( int  asic,
BVIEW_PT_TRIGGER_CALLBACK_t  callback,
void *  cookie 
)

Register hw trigger callback.

Parameters
[in]asicunit
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSCallback is successfully registered
BVIEW_STATUS_UNSUPPORTEDTrigger callback registration is not supported

none

BVIEW_STATUS sbapi_pt_trace_profile_get_cb ( int  asic,
int  port,
BVIEW_PT_PACKET_t packet,
BVIEW_PT_TRACE_PROFILE_t traceProfile,
BVIEW_TIME_t *  time 
)

Obtain Trace Profile for a given packet.

Parameters
[in]asicunit
[out]traceProfileTrace Profile Data Struture
[out]timetime
Return values
BVIEW_STATUS_FAILUREDue to lock acquistion failure or Not able to get asic type of this unit or Packet Trace feature is not present or Packet Trace south bound function has returned failure
BVIEW_STATUS_SUCCESSIngress Port + Priority Groups stat get is successful
BVIEW_STATUS_UNSUPPORTEDIngress Port + Priority Groups stat get functionality is not supported on this unit

none