cpssDxChPacketAnalyzer.h File Reference
Packet Analyzer APIs for CPSS. More...
#include <cpss/common/cpssTypes.h>
#include <cpss/dxCh/dxChxGen/packetAnalyzer/cpssDxChPacketAnalyzerTypes.h>
#include <cpssDriver/pp/prvCpssDrvPpDefs.h>
Functions
GT_STATUS cpssDxChPacketAnalyzerManagerCreate (IN GT_U32 managerId)
Create Packet Trace Manager.
GT_STATUS cpssDxChPacketAnalyzerManagerDelete (IN GT_U32 managerId)
Delete Packet Trace Manager.
GT_STATUS cpssDxChPacketAnalyzerManagerDeviceAdd (IN GT_U32 managerId, IN GT_U8 devNum)
Add device to Packet Trace Manager.
GT_STATUS cpssDxChPacketAnalyzerManagerDeviceRemove (IN GT_U32 managerId, IN GT_U8 devNum)
Remove device from Packet Trace Manager.
GT_STATUS cpssDxChPacketAnalyzerManagerEnableSet (IN GT_U32 managerId, IN GT_BOOL enable)
Enable/Disable the packet analyzer on all devices added to manager id.
GT_STATUS cpssDxChPacketAnalyzerManagerDevicesGet (IN GT_U32 managerId, OUT GT_BOOL *deviceStatePtr, INOUT GT_U32 *numOfDevicesPtr, OUT GT_U8 devicesArr[])
Get packet analyzer manager information.
GT_STATUS cpssDxChPacketAnalyzerManagerResetToDefaults (IN GT_U32 managerId)
Reset Packet Trace Manager configuration to default settings.
GT_STATUS cpssDxChPacketAnalyzerFieldSizeGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName, OUT GT_U32 *lengthPtr)
Get packet analyzer field's size.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyCreate (IN GT_U32 managerId, IN GT_U32 keyId, IN CPSS_DXCH_PACKET_ANALYZER_KEY_ATTRIBUTES_STC *keyAttrPtr, IN GT_U32 numOfStages, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[], IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ASSIGNMENT_MODE_ENT fieldMode, IN GT_U32 numOfFields, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Create logical key.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsAdd (IN GT_U32 managerId, IN GT_U32 keyId, IN GT_U32 numOfFields, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Add fields to existing logical key.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsRemove (IN GT_U32 managerId, IN GT_U32 keyId, IN GT_U32 numOfFields, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Remove fields from existing logical key.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyDelete (IN GT_U32 managerId, IN GT_U32 keyId)
Delete existing logical key.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyInfoGet (IN GT_U32 managerId, IN GT_U32 keyId, OUT CPSS_DXCH_PACKET_ANALYZER_KEY_ATTRIBUTES_STC *keyAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ASSIGNMENT_MODE_ENT *fieldModePtr)
Get existing logical key configuration.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyStagesGet (IN GT_U32 managerId, IN GT_U32 keyId, INOUT GT_U32 *numOfStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[])
Get existing logical key stages list.
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet (IN GT_U32 managerId, IN GT_U32 keyId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, INOUT GT_U32 *numOfFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Get existing logical key fields list per stage.
GT_STATUS cpssDxChPacketAnalyzerStagesGet (IN GT_U32 managerId, INOUT GT_U32 *numOfApplicStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT applicStagesListArr[], INOUT GT_U32 *numOfValidStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT validStagesListArr[])
Get applicable stages and Valid stages - stages that are not muxed for current configuration.
GT_STATUS cpssDxChPacketAnalyzerMuxStagesGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, INOUT GT_U32 *numOfMuxStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT muxStagesListArr[])
Get mux stages array for specific stage.
GT_STATUS cpssDxChPacketAnalyzerGroupCreate (IN GT_U32 managerId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_GROUP_ATTRIBUTES_STC *groupAttrPtr)
Create packet analyzer group.
GT_STATUS cpssDxChPacketAnalyzerGroupDelete (IN GT_U32 managerId, IN GT_U32 groupId)
Delete packet analyzer group.
GT_STATUS cpssDxChPacketAnalyzerGroupRuleAdd (IN GT_U32 managerId, IN GT_U32 keyId, IN GT_U32 groupId, IN GT_U32 ruleId, IN CPSS_DXCH_PACKET_ANALYZER_RULE_ATTRIBUTES_STC *ruleAttrPtr, IN GT_U32 numOfFields, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[], IN GT_U32 actionId)
Add packet analyzer rule to packet analyzer group.
GT_STATUS cpssDxChPacketAnalyzerGroupRuleUpdate (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN GT_U32 numOfFields, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[], IN GT_U32 actionId)
Replace content of packet analyzer rule.
GT_STATUS cpssDxChPacketAnalyzerGroupRuleDelete (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId)
Delete packet analyzer rule.
GT_STATUS cpssDxChPacketAnalyzerGroupRuleGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, OUT GT_U32 *keyIdPtr, OUT CPSS_DXCH_PACKET_ANALYZER_RULE_ATTRIBUTES_STC *ruleAttrPtr, INOUT GT_U32 *numOfFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[], OUT GT_U32 *actionIdPtr)
Get packet analyzer rule attributes.
GT_STATUS cpssDxChPacketAnalyzerActionCreate (IN GT_U32 managerId, IN GT_U32 actionId, IN CPSS_DXCH_PACKET_ANALYZER_ACTION_STC *actionPtr)
Create packet analyzer action.
GT_STATUS cpssDxChPacketAnalyzerActionUpdate (IN GT_U32 managerId, IN GT_U32 actionId, IN CPSS_DXCH_PACKET_ANALYZER_ACTION_STC *actionPtr)
Update packet analyzer action.
GT_STATUS cpssDxChPacketAnalyzerActionDelete (IN GT_U32 managerId, IN GT_U32 actionId)
Delete packet analyzer action.
GT_STATUS cpssDxChPacketAnalyzerActionGet (IN GT_U32 managerId, IN GT_U32 actionId, OUT CPSS_DXCH_PACKET_ANALYZER_ACTION_STC *actionPtr)
Get packet analyzer action.
GT_STATUS cpssDxChPacketAnalyzerSampledDataCountersClear (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId)
Clear Sampling Data and Counters for packet analyzer rule.
GT_STATUS cpssDxChPacketAnalyzerActionSamplingEnableSet (IN GT_U32 managerId, IN GT_U32 actionId, IN GT_BOOL enable)
Enable/disable sampling for packet analyzer action.
GT_STATUS cpssDxChPacketAnalyzerGroupActivateEnableSet (IN GT_U32 managerId, IN GT_U32 groupId, IN GT_BOOL enable)
Enable/disable packet analyzer group activation.
GT_STATUS cpssDxChPacketAnalyzerRuleMatchStagesGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, INOUT GT_U32 *numOfMatchedStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT matchedStagesArr[])
Get stages where packet analyzer rule was matched.
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, OUT GT_U32 *numOfHitsPtr, INOUT GT_U32 *numOfSampleFieldsPtr, INOUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[])
Get packet analyzer stage match attributes.
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllFieldsGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, OUT GT_U32 *numOfHitsPtr, INOUT GT_U32 *numOfSampleFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[])
Get packet analyzer stage match attributes for all packet analyzer fields.
GT_STATUS cpssDxChPacketAnalyzerStageFieldsGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, INOUT GT_U32 *numOfFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Get stage fields list array.
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, OUT GT_U32 *numOfHitsPtr, INOUT GT_U32 *numOfSampleFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_INTERNAL_FIELD_VALUE_STC sampleFieldsValueArr[])
Get packet analyzer stage match attributes for all internal fields.
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsByAttributesGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, IN CPSS_DXCH_PACKET_ANALYZER_SEARCH_ATTRIBUTE_STC *searchAttributePtr, OUT GT_U32 *numOfHitsPtr, INOUT GT_U32 *numOfSampleFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_INTERNAL_FIELD_VALUE_STC sampleFieldsValueArr[])
Get packet analyzer stage match attributes for all internal fields by specific search attributes.
GT_STATUS cpssDxChPacketAnalyzerFieldStagesGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName, INOUT GT_U32 *numOfStagesPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[])
Get field's stage list array.
GT_STATUS cpssDxChPacketAnalyzerMuxStageBind (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId)
Set stage that will be valid in group of muxed stages.
GT_STATUS cpssDxChPacketAnalyzerMuxStageUnbind (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId)
Set stage that will be invalid in group of muxed stages.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldAdd (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC *udfAttrPtr, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC *fieldNamePtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT *udfIdPtr)
Add packet analyzer user defined field.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldDelete (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC *udfAttrPtr)
Delete packet analyzer user defined field.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC *udfAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT *udfIdPtr, OUT GT_BOOL *validPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC *fieldNamePtr)
Get packet analyzer user defined field.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldInfoGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT udfId, OUT GT_BOOL *validPtr, OUT CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC *udfAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC *fieldNamePtr)
Get packet analyzer user defined field information.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageAdd (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC *udsAttrPtr, IN CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC *interfaceAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT *udsIdPtr)
Add packet analyzer user defined stage.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageDelete (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC *udsAttrPtr)
Delete packet analyzer user defined stage.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC *udsAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT *udsIdPtr, OUT GT_BOOL *validPtr, OUT CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC *interfaceAttrPtr)
Get packet analyzer user defined stage.
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageInfoGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT udsId, OUT GT_BOOL *validPtr, OUT CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC *udsAttrPtr, OUT CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC *interfaceAttrPtr)
Get packet analyzeruser defined stages information.
GT_STATUS cpssDxChPacketAnalyzerRuleMatchDataAllFieldsByAttributeGet (IN GT_U32 managerId, IN GT_U32 ruleId, IN GT_U32 groupId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, IN CPSS_DXCH_PACKET_ANALYZER_SEARCH_ATTRIBUTE_STC *searchAttributePtr, OUT GT_U32 *numOfHitsPtr, INOUT GT_U32 *numOfSampleFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[])
Get packet analyzer rule match attributes for all packet analyzer fields by specific search attributes.
GT_STATUS cpssDxChPacketAnalyzerStageFieldOverlappingFieldsGet (IN GT_U32 managerId, IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId, IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName, INOUT GT_U32 *numOfFieldsPtr, OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[])
Get packet analyzer overlapping fields for spesific field in stage.
Detailed Description
Packet Analyzer APIs for CPSS.
Version
1
Function Documentation
◆ cpssDxChPacketAnalyzerActionCreate()
GT_STATUS cpssDxChPacketAnalyzerActionCreate ( IN GT_U32 managerId,
IN GT_U32 actionId,
IN CPSS_DXCH_PACKET_ANALYZER_ACTION_STC * actionPtr
)
Create packet analyzer action.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] actionId - action identification (APPLICABLE RANGES: 1..128)
[in] actionPtr - (pointer to) action configuration
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_FOUND - not found action
GT_BAD_PTR - on NULL pointer value
GT_ALREADY_EXIST - already initialized
GT_OUT_OF_CPU_MEM - Cpu memory allocation failed
◆ cpssDxChPacketAnalyzerActionDelete()
GT_STATUS cpssDxChPacketAnalyzerActionDelete ( IN GT_U32 managerId,
IN GT_U32 actionId
)
Delete packet analyzer action.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] actionId - action identification (APPLICABLE RANGES: 1..128)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_NOT_FOUND - not found action
◆ cpssDxChPacketAnalyzerActionGet()
GT_STATUS cpssDxChPacketAnalyzerActionGet ( IN GT_U32 managerId,
IN GT_U32 actionId,
OUT CPSS_DXCH_PACKET_ANALYZER_ACTION_STC * actionPtr
)
Get packet analyzer action.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] actionId - action identification (APPLICABLE RANGES: 1..128)
[out] actionPtr - (pointer to) action configuration
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - not found action
◆ cpssDxChPacketAnalyzerActionSamplingEnableSet()
GT_STATUS cpssDxChPacketAnalyzerActionSamplingEnableSet ( IN GT_U32 managerId,
IN GT_U32 actionId,
IN GT_BOOL enable
)
Enable/disable sampling for packet analyzer action.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] actionId - action identification (APPLICABLE RANGES: 1..128)
[in] enable - enable/disable sampling
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_FOUND - on not found action
◆ cpssDxChPacketAnalyzerActionUpdate()
GT_STATUS cpssDxChPacketAnalyzerActionUpdate ( IN GT_U32 managerId,
IN GT_U32 actionId,
IN CPSS_DXCH_PACKET_ANALYZER_ACTION_STC * actionPtr
)
Update packet analyzer action.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] actionId - action identification (APPLICABLE RANGES: 1..128)
[in] actionPtr - (pointer to) action configuration
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_FOUND - not found action
GT_BAD_PTR - on NULL pointer value
◆ cpssDxChPacketAnalyzerFieldSizeGet()
GT_STATUS cpssDxChPacketAnalyzerFieldSizeGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName,
OUT GT_U32 * lengthPtr
)
Get packet analyzer field's size.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] fieldName - field name
[out] lengthPtr - (pointer to) fields length in bits
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
◆ cpssDxChPacketAnalyzerFieldStagesGet()
GT_STATUS cpssDxChPacketAnalyzerFieldStagesGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName,
INOUT GT_U32 * numOfStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[]
)
Get field's stage list array.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] fieldName - field name
[in,out] numOfStagesPtr - in: (pointer to) allocated number of stages out: (pointer to) actual number of stages
[out] stagesArr - (pointer to) field's stage list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
◆ cpssDxChPacketAnalyzerGroupActivateEnableSet()
GT_STATUS cpssDxChPacketAnalyzerGroupActivateEnableSet ( IN GT_U32 managerId,
IN GT_U32 groupId,
IN GT_BOOL enable
)
Enable/disable packet analyzer group activation.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] enable - enable/disable group activation
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_HW_ERROR - on hardware error
GT_NOT_FOUND - on not found group
GT_BAD_STATE - on invalid parameter
Note
in order to see the results use APIs: cpssDxChPacketAnalyzerRuleMatchStagesGet,cpssDxChPacketAnalyzerRuleMatchDataGet, cpssDxChPacketAnalyzerRuleMatchDataAllFieldsGet
◆ cpssDxChPacketAnalyzerGroupCreate()
GT_STATUS cpssDxChPacketAnalyzerGroupCreate ( IN GT_U32 managerId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_GROUP_ATTRIBUTES_STC * groupAttrPtr
)
Create packet analyzer group.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] groupAttrPtr - (pointer to) group attributes
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_FOUND - not found action
GT_BAD_PTR - on NULL pointer value
GT_ALREADY_EXIST - already initialized
GT_OUT_OF_CPU_MEM - Cpu memory allocation failed
◆ cpssDxChPacketAnalyzerGroupDelete()
GT_STATUS cpssDxChPacketAnalyzerGroupDelete ( IN GT_U32 managerId,
IN GT_U32 groupId
)
Delete packet analyzer group.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_NOT_FOUND - not found group
◆ cpssDxChPacketAnalyzerGroupRuleAdd()
GT_STATUS cpssDxChPacketAnalyzerGroupRuleAdd ( IN GT_U32 managerId,
IN GT_U32 keyId,
IN GT_U32 groupId,
IN GT_U32 ruleId,
IN CPSS_DXCH_PACKET_ANALYZER_RULE_ATTRIBUTES_STC * ruleAttrPtr,
IN GT_U32 numOfFields,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[],
IN GT_U32 actionId
)
Add packet analyzer rule to packet analyzer group.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] ruleAttrPtr - (pointer to) rule attributes
[in] numOfFields - number of fields for rule and group identification
[in] fieldsValueArr - rule content array (Data and Mask)
[in] actionId - rule action identification (APPLICABLE RANGES: 1..128)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - not found group or action
GT_FULL - if array is full
GT_ALREADY_EXIST - already initialized
GT_OUT_OF_CPU_MEM - Cpu memory allocation failed
◆ cpssDxChPacketAnalyzerGroupRuleDelete()
GT_STATUS cpssDxChPacketAnalyzerGroupRuleDelete ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId
)
Delete packet analyzer rule.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_NOT_FOUND - not found group or rule
GT_FAIL - on error
◆ cpssDxChPacketAnalyzerGroupRuleGet()
GT_STATUS cpssDxChPacketAnalyzerGroupRuleGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
OUT GT_U32 * keyIdPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_RULE_ATTRIBUTES_STC * ruleAttrPtr,
INOUT GT_U32 * numOfFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[],
OUT GT_U32 * actionIdPtr
)
Get packet analyzer rule attributes.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[out] keyIdPtr - (pointer to) logical key identification
[out] ruleAttrPtr - (pointer to) rule attributes
[in,out] numOfFieldsPtr - in: (pointer to) allocated number of fields for rule identification out: (pointer to) actual number of fields for rule identification
[out] fieldsValueArr - rule content array (Data and Mask)
[out] actionIdPtr - (pointer to) rule action identification
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - not found group or rule
◆ cpssDxChPacketAnalyzerGroupRuleUpdate()
GT_STATUS cpssDxChPacketAnalyzerGroupRuleUpdate ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN GT_U32 numOfFields,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC fieldsValueArr[],
IN GT_U32 actionId
)
Replace content of packet analyzer rule.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] numOfFields - number of fields for rule and group identification
[in] fieldsValueArr - rule content array (Data and Mask)
[in] actionId - rule action identification (APPLICABLE RANGES: 1..128)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - not found group or action
◆ cpssDxChPacketAnalyzerLogicalKeyCreate()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyCreate ( IN GT_U32 managerId,
IN GT_U32 keyId,
IN CPSS_DXCH_PACKET_ANALYZER_KEY_ATTRIBUTES_STC * keyAttrPtr,
IN GT_U32 numOfStages,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[],
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ASSIGNMENT_MODE_ENT fieldMode,
IN GT_U32 numOfFields,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Create logical key.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[in] keyAttrPtr - (pointer to) key attributes
[in] numOfStages - number of stages
[in] stagesArr - (pointer to) applicable stages list array
[in] fieldMode - field mode assignment
[in] numOfFields - number of fields
[in] fieldsArr - (pointer to) fields list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_ALREADY_EXIST - already initialized
GT_OUT_OF_CPU_MEM - Cpu memory allocation failed
GT_NOT_FOUND - not found manager
GT_FULL - if array is full
Note
in order to see the results use APIs: cpssDxChPacketAnalyzerLogicalKeyStagesGet, cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet
◆ cpssDxChPacketAnalyzerLogicalKeyDelete()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyDelete ( IN GT_U32 managerId,
IN GT_U32 keyId
)
Delete existing logical key.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on wrong state
◆ cpssDxChPacketAnalyzerLogicalKeyFieldsAdd()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsAdd ( IN GT_U32 managerId,
IN GT_U32 keyId,
IN GT_U32 numOfFields,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Add fields to existing logical key.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[in] numOfFields - number of fields
[in] fieldsArr - (pointer to) fields list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
Note
in order to see the results use APIs: cpssDxChPacketAnalyzerLogicalKeyStagesGet, cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet
◆ cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet ( IN GT_U32 managerId,
IN GT_U32 keyId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
INOUT GT_U32 * numOfFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Get existing logical key fields list per stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification
[in] stagesId - stage identification
[in,out] numOfFieldsPtr - in: (pointer to) allocated number of fields out: (pointer to) actual number of fields
[out] fieldsArr - out: (pointer to) field list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_BAD_STATE - on wrong state
◆ cpssDxChPacketAnalyzerLogicalKeyFieldsRemove()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyFieldsRemove ( IN GT_U32 managerId,
IN GT_U32 keyId,
IN GT_U32 numOfFields,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Remove fields from existing logical key.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[in] numOfFields - number of fields
[in] fieldsArr - (pointer to) fields list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
Note
in order to see the results use APIs: cpssDxChPacketAnalyzerLogicalKeyStagesGet, cpssDxChPacketAnalyzerLogicalKeyFieldsPerStageGet
◆ cpssDxChPacketAnalyzerLogicalKeyInfoGet()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyInfoGet ( IN GT_U32 managerId,
IN GT_U32 keyId,
OUT CPSS_DXCH_PACKET_ANALYZER_KEY_ATTRIBUTES_STC * keyAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ASSIGNMENT_MODE_ENT * fieldModePtr
)
Get existing logical key configuration.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[out] keyAttrPtr - (pointer to) key attributes
[out] fieldModePtr - (pointer to) field
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on wrong state
◆ cpssDxChPacketAnalyzerLogicalKeyStagesGet()
GT_STATUS cpssDxChPacketAnalyzerLogicalKeyStagesGet ( IN GT_U32 managerId,
IN GT_U32 keyId,
INOUT GT_U32 * numOfStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stagesArr[]
)
Get existing logical key stages list.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] keyId - logical key identification (APPLICABLE RANGES: 1..1024)
[in,out] numOfStagesPtr - in: (pointer to) allocated number of stages out: (pointer to) actual number of stages
[out] stagesArr - out: (pointer to) stages list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on wrong state
◆ cpssDxChPacketAnalyzerManagerCreate()
GT_STATUS cpssDxChPacketAnalyzerManagerCreate ( IN GT_U32 managerId )
Create Packet Trace Manager.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_ALREADY_EXIST - already initialized
GT_FAIL - on error
GT_OUT_OF_CPU_MEM - Cpu memory allocation failed
GT_BAD_PTR - on NULL pointer value.
◆ cpssDxChPacketAnalyzerManagerDelete()
GT_STATUS cpssDxChPacketAnalyzerManagerDelete ( IN GT_U32 managerId )
Delete Packet Trace Manager.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on invalid parameter
◆ cpssDxChPacketAnalyzerManagerDeviceAdd()
GT_STATUS cpssDxChPacketAnalyzerManagerDeviceAdd ( IN GT_U32 managerId,
IN GT_U8 devNum
)
Add device to Packet Trace Manager.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] devNum - device number
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_ALREADY_EXIST - already initialized
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_FULL - if array is full
◆ cpssDxChPacketAnalyzerManagerDeviceRemove()
GT_STATUS cpssDxChPacketAnalyzerManagerDeviceRemove ( IN GT_U32 managerId,
IN GT_U8 devNum
)
Remove device from Packet Trace Manager.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] devNum - device number
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on invalid parameter
◆ cpssDxChPacketAnalyzerManagerDevicesGet()
GT_STATUS cpssDxChPacketAnalyzerManagerDevicesGet ( IN GT_U32 managerId,
OUT GT_BOOL * deviceStatePtr,
INOUT GT_U32 * numOfDevicesPtr,
OUT GT_U8 devicesArr[]
)
Get packet analyzer manager information.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[out] deviceStatePtr - (pointer to) whether PA is enabled for manager id's devices
[in,out] numOfDevicesPtr - in: (pointer to) allocated number of devices for managerId out: (pointer to) actual number of devices for managerId
[out] devicesArr - devices array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
◆ cpssDxChPacketAnalyzerManagerEnableSet()
GT_STATUS cpssDxChPacketAnalyzerManagerEnableSet ( IN GT_U32 managerId,
IN GT_BOOL enable
)
Enable/Disable the packet analyzer on all devices added to manager id.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] enable - enable/disable PA on manager id
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
◆ cpssDxChPacketAnalyzerManagerResetToDefaults()
GT_STATUS cpssDxChPacketAnalyzerManagerResetToDefaults ( IN GT_U32 managerId )
Reset Packet Trace Manager configuration to default settings.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_BAD_STATE - on invalid parameter
◆ cpssDxChPacketAnalyzerMuxStageBind()
GT_STATUS cpssDxChPacketAnalyzerMuxStageBind ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId
)
Set stage that will be valid in group of muxed stages.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] stageId - stage identification
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
◆ cpssDxChPacketAnalyzerMuxStagesGet()
GT_STATUS cpssDxChPacketAnalyzerMuxStagesGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
INOUT GT_U32 * numOfMuxStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT muxStagesListArr[]
)
Get mux stages array for specific stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] stageId - stage identification
[in,out] numOfMuxStagesPtr - in: (pointer to) allocated number of muxed stages out: (pointer to) actual number of muxed stages
[out] muxStagesListArr - (pointer to) muxed stages list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
◆ cpssDxChPacketAnalyzerMuxStageUnbind()
GT_STATUS cpssDxChPacketAnalyzerMuxStageUnbind ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId
)
Set stage that will be invalid in group of muxed stages.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] stageId - stage identification
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
◆ cpssDxChPacketAnalyzerRuleMatchDataAllFieldsByAttributeGet()
GT_STATUS cpssDxChPacketAnalyzerRuleMatchDataAllFieldsByAttributeGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
IN CPSS_DXCH_PACKET_ANALYZER_SEARCH_ATTRIBUTE_STC * searchAttributePtr,
OUT GT_U32 * numOfHitsPtr,
INOUT GT_U32 * numOfSampleFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[]
)
Get packet analyzer rule match attributes for all packet analyzer fields by specific search attributes.
Note
APPLICABLE DEVICES: Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; Aldrin; AC3X; Bobcat3; Aldrin2.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] stageId - stage identification
[in] searchAttributePtr -(pointer to) search attributes.
[out] numOfHitsPtr - (pointer to) number of hits
[in,out] numOfSampleFieldsPtr - in: (pointer to) allocated number of fields for sample data array out: (pointer to) actual number of fields for sample data array
[out] sampleFieldsValueArr - out: (pointer to) sample data array values for requested fields
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerRuleMatchStagesGet()
GT_STATUS cpssDxChPacketAnalyzerRuleMatchStagesGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
INOUT GT_U32 * numOfMatchedStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT matchedStagesArr[]
)
Get stages where packet analyzer rule was matched.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in,out] numOfMatchedStagesPtr- in: (pointer to) allocated number of matched stages out: (pointer to) actual number of matched stages
[out] matchedStagesArr - (pointer to) matched stages list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
◆ cpssDxChPacketAnalyzerSampledDataCountersClear()
GT_STATUS cpssDxChPacketAnalyzerSampledDataCountersClear ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId
)
Clear Sampling Data and Counters for packet analyzer rule.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_HW_ERROR - on hardware error
GT_NOT_FOUND - on not found group
◆ cpssDxChPacketAnalyzerStageFieldOverlappingFieldsGet()
GT_STATUS cpssDxChPacketAnalyzerStageFieldOverlappingFieldsGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldName,
INOUT GT_U32 * numOfFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Get packet analyzer overlapping fields for spesific field in stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] stageId - stage identification
[in] fieldName - field name
[in,out] numOfFieldsPtr - in: (pointer to) allocated number of fields out: (pointer to) actual number of fields
[out] fieldsArr - out: (pointer to) fields list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerStageFieldsGet()
GT_STATUS cpssDxChPacketAnalyzerStageFieldsGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
INOUT GT_U32 * numOfFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT fieldsArr[]
)
Get stage fields list array.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] stageId - stage identification
[in,out] numOfFieldsPtr - in: (pointer to) allocated number of fields out: (pointer to) actual number of fields
[out] fieldsArr - (pointer to) stage fields list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - on not found manager
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerStageMatchDataAllFieldsGet()
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllFieldsGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
OUT GT_U32 * numOfHitsPtr,
INOUT GT_U32 * numOfSampleFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[]
)
Get packet analyzer stage match attributes for all packet analyzer fields.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] stageId - stage identification
[out] numOfHitsPtr - (pointer to) number of hits
[in,out] numOfSampleFieldsPtr - in: (pointer to) allocated number of fields for sample data array out: (pointer to) actual number of fields for sample data array
[out] sampleFieldsValueArr - out: (pointer to) sample data array values for requested fields
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsByAttributesGet()
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsByAttributesGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
IN CPSS_DXCH_PACKET_ANALYZER_SEARCH_ATTRIBUTE_STC * searchAttributePtr,
OUT GT_U32 * numOfHitsPtr,
INOUT GT_U32 * numOfSampleFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_INTERNAL_FIELD_VALUE_STC sampleFieldsValueArr[]
)
Get packet analyzer stage match attributes for all internal fields by specific search attributes.
Note
APPLICABLE DEVICES: Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; Aldrin; AC3X; Bobcat3; Aldrin2.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] stageId - stage identification
[in] searchAttributePtr -(pointer to) search attributes.
[out] numOfHitsPtr - (pointer to) number of hits
[in,out] numOfSampleFieldsPtr - in: (pointer to) allocated number of fields for sample data array out: (pointer to) actual number of fields for sample data array
[out] sampleFieldsValueArr - out: (pointer to) sample data array values for requested fields
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsGet()
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataAllInternalFieldsGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
OUT GT_U32 * numOfHitsPtr,
INOUT GT_U32 * numOfSampleFieldsPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_INTERNAL_FIELD_VALUE_STC sampleFieldsValueArr[]
)
Get packet analyzer stage match attributes for all internal fields.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] stageId - stage identification
[out] numOfHitsPtr - (pointer to) number of hits
[in,out] numOfSampleFieldsPtr - in: (pointer to) allocated number of fields for sample data array out: (pointer to) actual number of fields for sample data array
[out] sampleFieldsValueArr - out: (pointer to) sample data array values for requested fields
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_SUPPORTED - on not supported parameter
◆ cpssDxChPacketAnalyzerStageMatchDataGet()
GT_STATUS cpssDxChPacketAnalyzerStageMatchDataGet ( IN GT_U32 managerId,
IN GT_U32 ruleId,
IN GT_U32 groupId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT stageId,
OUT GT_U32 * numOfHitsPtr,
INOUT GT_U32 * numOfSampleFieldsPtr,
INOUT CPSS_DXCH_PACKET_ANALYZER_FIELD_VALUE_STC sampleFieldsValueArr[]
)
Get packet analyzer stage match attributes.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] ruleId - rule identification (APPLICABLE RANGES: 1..2048)
[in] groupId - group identification (APPLICABLE RANGES: 1..1024)
[in] stageId - stage identification
[out] numOfHitsPtr - (pointer to) number of hits
[in,out] numOfSampleFieldsPtr - in: (pointer to) allocated number of fields for sample data array out: (pointer to) actual number of fields for sample data array
[in,out] sampleFieldsValueArr - in: (pointer to) requested fields for sample data array out: (pointer to) sample data array values for requested fields
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_FOUND - on not found manager
GT_NOT_APPLICABLE_DEVICE - on not applicable device
◆ cpssDxChPacketAnalyzerStagesGet()
GT_STATUS cpssDxChPacketAnalyzerStagesGet ( IN GT_U32 managerId,
INOUT GT_U32 * numOfApplicStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT applicStagesListArr[],
INOUT GT_U32 * numOfValidStagesPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT validStagesListArr[]
)
Get applicable stages and Valid stages - stages that are not muxed for current configuration.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in,out] numOfApplicStagesPtr - in: (pointer to) size of allocated applicStagesListArr out: (pointer to) actual number of applicable stages in applicStagesListArr
[out] applicStagesListArr - (pointer to) applicable stages list array
[in,out] numOfValidStagesPtr - in: (pointer to) size of allocated ValidStagesListArr out: (pointer to) actual number of valid stages in ValidStagesListArr
[out] ValidStagesListArr - (pointer to) valid stages list array
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_BAD_SIZE - in case not enough memory was allocated to parameters list
GT_BAD_PTR - on NULL pointer value.
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_FOUND - not found manager
◆ cpssDxChPacketAnalyzerUserDefinedFieldAdd()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldAdd ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC * udfAttrPtr,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC * fieldNamePtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT * udfIdPtr
)
Add packet analyzer user defined field.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udfAttrPtr - (pointer to) udf attributes
[in] fieldNamePtr - (pointer to) field name
[out] udfIdPtr - (pointer to)user defined field identification.
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
GT_ALREADY_EXIST - on already initialized
◆ cpssDxChPacketAnalyzerUserDefinedFieldDelete()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldDelete ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC * udfAttrPtr
)
Delete packet analyzer user defined field.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udfAttrPtr - (pointer to) udf attributes
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
◆ cpssDxChPacketAnalyzerUserDefinedFieldGet()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC * udfAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT * udfIdPtr,
OUT GT_BOOL * validPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC * fieldNamePtr
)
Get packet analyzer user defined field.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udfAttrPtr - (pointer to) udf attributes
[out] udfIdPtr - (pointer to) user defined field identification
[out] validPtr - (pointer to) whether udf entry is valid or not
[out] fieldNamePtr - (pointer to) field name
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
◆ cpssDxChPacketAnalyzerUserDefinedFieldInfoGet()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedFieldInfoGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_FIELD_ENT udfId,
OUT GT_BOOL * validPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_UDF_ATTRIBUTES_STC * udfAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_FIELD_NAME_STC * fieldNamePtr
)
Get packet analyzer user defined field information.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udfId - user defined field identification
[out] validPtr - (pointer to) whether udf entry is valid or not
[out] udfAttrPtr - (pointer to) udf attributes. Valid only when validPtr == GT_TRUE
[out] fieldNamePtr - (pointer to) field name. Valid only when validPtr == GT_TRUE
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
◆ cpssDxChPacketAnalyzerUserDefinedStageAdd()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageAdd ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC * udsAttrPtr,
IN CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC * interfaceAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT * udsIdPtr
)
Add packet analyzer user defined stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udsAttrPtr - (pointer to) uds attributes
[in] interfaceAttrPtr - (pointer to) interface attributes
[out] udsIdPtr - (pointer to) user defined stage identification
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
GT_ALREADY_EXIST - on already initialized
◆ cpssDxChPacketAnalyzerUserDefinedStageDelete()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageDelete ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC * udsAttrPtr
)
Delete packet analyzer user defined stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udsAttrPtr - (pointer to) uds attributes
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
◆ cpssDxChPacketAnalyzerUserDefinedStageGet()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC * udsAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT * udsIdPtr,
OUT GT_BOOL * validPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC * interfaceAttrPtr
)
Get packet analyzer user defined stage.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udsAttrPtr - (pointer to) uds attributes
[out] udsIdPtr - (pointer to) user defined stage identification
[out] validPtr - (pointer to) whether uds entry is valid or not
[out] interfaceAttrPtr - (pointer to) interface attributes. Valid only when validPtr == GT_TRUE
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
◆ cpssDxChPacketAnalyzerUserDefinedStageInfoGet()
GT_STATUS cpssDxChPacketAnalyzerUserDefinedStageInfoGet ( IN GT_U32 managerId,
IN CPSS_DXCH_PACKET_ANALYZER_LOOKUP_STAGES_ENT udsId,
OUT GT_BOOL * validPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_UDS_ATTRIBUTES_STC * udsAttrPtr,
OUT CPSS_DXCH_PACKET_ANALYZER_STAGE_INTERFACE_STC * interfaceAttrPtr
)
Get packet analyzeruser defined stages information.
Note
APPLICABLE DEVICES: Aldrin; Aldrin2; Falcon; AC5P; AC5X; Harrier; Ironman.
NOT APPLICABLE DEVICES: xCat3; AC5; Lion2; Bobcat2; Caelum; AC3X; Bobcat3.
Parameters
[in] managerId - manager identification (APPLICABLE RANGES: 1..10)
[in] udsId - user defined stage identification
[out] validPtr - (pointer to) whether uds entry is valid or not
[out] udsAttrPtr - (pointer to) uds attributes. Valid only when validPtr == GT_TRUE
[out] interfaceAttrPtr - (pointer to) interface attributes. Valid only when validPtr == GT_TRUE
Return values
GT_OK - on success
GT_BAD_PARAM - wrong value in any of the parameters
GT_FAIL - on error
GT_NOT_APPLICABLE_DEVICE - on not applicable device
GT_NOT_INITIALIZED - if the driver was not initialized
GT_NOT_FOUND - on not found parameters
最新发布
本文解决了一个常见的Android Studio问题：在尝试构建项目时出现的“Configuration with name ‘default’ not found”错误。问题根源在于settings.gradle文件中包含了已删除的library库。通过删除settings.gradle文件中不再需要的include ':library'行解决了此问题。
扫一扫
4万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
