OpenFlow Data Plane Abstraction (OF-DPA) API Guide and Reference Manual
Functions
ofdpa_api.h File Reference

Go to the source code of this file.

Functions

int ofdpaBcmCommand (ofdpa_buffdesc buffer)
 Execute a BCM command.
 
OFDPA_ERROR_t ofdpaClientEventSockBind (void)
 Opens and binds OF-DPA Client's event socket.
 
int ofdpaClientEventSockFdGet (void)
 Get OF-DPA Client's event socket fd.
 
OFDPA_ERROR_t ofdpaClientInitialize (char *clientName)
 Initialize OF-DPA client or user application.
 
OFDPA_ERROR_t ofdpaClientPktSockBind (void)
 Opens and binds OF-DPA Client's packet socket.
 
int ofdpaClientPktSockFdGet (void)
 Get OF-DPA Client's packet socket fd.
 
int ofdpaCltDebugBuf (ofdpa_buffdesc functionName, ofdpaComponentIds_t component, ofdpaDebugLevels_t verbosity, ofdpa_buffdesc message)
 Generate a debug message using a preformatted buffer.
 
int ofdpaCltDebugPrintf (const char *functionName, ofdpaComponentIds_t component, ofdpaDebugLevels_t verbosity, const char *format,...)
 Generate a debug message using printf formatting.
 
int ofdpaCltLogBuf (int priority, ofdpa_buffdesc message)
 Generate a log message using a preformatted buffer.
 
int ofdpaCltLogPrintf (int priority, char *fmt,...)
 Generate a log message using printf formatting.
 
OFDPA_ERROR_t ofdpaComponentNameGet (int component, ofdpa_buffdesc *name)
 Get the Component Name.
 
int ofdpaDebugComponentGet (int component)
 Get Component debugging mode.
 
int ofdpaDebugComponentSet (int component, int enable)
 Enable/Disable the Component for debugging.
 
int ofdpaDebugLvl (int lvl)
 Set the Debug Verbosity.
 
int ofdpaDebugLvlGet (void)
 Get the Debug Verbosity.
 
OFDPA_ERROR_t ofdpaDevshellCommand (ofdpa_buffdesc buffer)
 
OFDPA_ERROR_t ofdpaDropStatusActionGet (uint32_t lmepId, uint8_t *dropAction)
 Get drop action value.
 
OFDPA_ERROR_t ofdpaDropStatusAdd (ofdpaDropStatusEntry_t *dropEntry)
 Add drop status entry.
 
OFDPA_ERROR_t ofdpaDropStatusDelete (uint32_t lmepId)
 Delete drop status entry.
 
OFDPA_ERROR_t ofdpaDropStatusEntryInit (ofdpaDropStatusEntry_t *dropEntry)
 Initialize drop entry.
 
OFDPA_ERROR_t ofdpaDropStatusGet (uint32_t lmepId, ofdpaDropStatusEntry_t *dropEntry)
 Get drop status entry.
 
OFDPA_ERROR_t ofdpaDropStatusNextGet (uint32_t lmepId, ofdpaDropStatusEntry_t *nextDropEntry)
 Get the next drop entry.
 
OFDPA_ERROR_t ofdpaEventReceive (struct timeval *timeout)
 Receive an event.
 
OFDPA_ERROR_t ofdpaFeatureSupported (OFDPA_FEATURE_t feature)
 Indicates whether the switch supports a particular OF-DPA feature.
 
OFDPA_ERROR_t ofdpaFlowAdd (ofdpaFlowEntry_t *flow)
 Add a new entry to a flow table.
 
OFDPA_ERROR_t ofdpaFlowByCookieDelete (uint64_t cookie)
 Delete the flow entry with the specified cookie.
 
OFDPA_ERROR_t ofdpaFlowByCookieGet (uint64_t cookie, ofdpaFlowEntry_t *flow, ofdpaFlowEntryStats_t *flowStats)
 Returns statistics for the flow entry with the specified cookie value.
 
OFDPA_ERROR_t ofdpaFlowDelete (ofdpaFlowEntry_t *flow)
 Delete an entry from a flow table.
 
OFDPA_ERROR_t ofdpaFlowEntryDecode (ofdpaFlowEntry_t *flow, char *outBuf, int bufSize)
 Decode a flow configuration structure into a descriptive string suitable for display to the user.
 
OFDPA_ERROR_t ofdpaFlowEntryInit (OFDPA_FLOW_TABLE_ID_t tableId, ofdpaFlowEntry_t *flow)
 Initialize Flow entry structure.
 
OFDPA_ERROR_t ofdpaFlowEventNextGet (ofdpaFlowEvent_t *eventData)
 Get the next flow event.
 
OFDPA_ERROR_t ofdpaFlowModify (ofdpaFlowEntry_t *flow)
 Modify an existing entry in a flow table.
 
OFDPA_ERROR_t ofdpaFlowNextGet (ofdpaFlowEntry_t *flow, ofdpaFlowEntry_t *nextFlow)
 Retrieve the next flow entry in the specified flow table.
 
OFDPA_ERROR_t ofdpaFlowStatsGet (ofdpaFlowEntry_t *flow, ofdpaFlowEntryStats_t *flowStats)
 Returns statistics for the flow entry specified.
 
OFDPA_ERROR_t ofdpaFlowTableInfoGet (OFDPA_FLOW_TABLE_ID_t tableId, ofdpaFlowTableInfo_t *info)
 Get Flow Table Info.
 
const char * ofdpaFlowTableNameGet (OFDPA_FLOW_TABLE_ID_t tableId)
 Returns the flow table name as a string suitable for display to the user.
 
OFDPA_ERROR_t ofdpaFlowTableSupported (OFDPA_FLOW_TABLE_ID_t tableId)
 Checks whether a table ID is a supported on the platform.
 
OFDPA_ERROR_t ofdpaGroupAdd (ofdpaGroupEntry_t *group)
 Add Group.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryAdd (ofdpaGroupBucketEntry_t *bucket)
 Add a Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryDecode (ofdpaGroupBucketEntry_t *bucketEntry, char *outBuf, int bufSize)
 Decode a group bucket configuration structure into a descriptive string suitable for display to the user.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryDelete (uint32_t groupId, uint32_t bucketIndex)
 Delete a Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryFirstGet (uint32_t groupId, ofdpaGroupBucketEntry_t *firstGroupBucket)
 Get the first Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryGet (uint32_t groupId, uint32_t bucketIndex, ofdpaGroupBucketEntry_t *groupBucket)
 Get the Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryInit (OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupBucketEntry_t *bucket)
 Initialize Flow entry structure.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryModify (ofdpaGroupBucketEntry_t *bucket)
 Modify Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketEntryNextGet (uint32_t groupId, uint32_t bucketIndex, ofdpaGroupBucketEntry_t *nextBucketEntry)
 Get the next Group Bucket entry.
 
OFDPA_ERROR_t ofdpaGroupBucketsDeleteAll (uint32_t groupId)
 Delete all Buckets from a Group.
 
OFDPA_ERROR_t ofdpaGroupDecode (uint32_t groupId, char *outBuf, int bufSize)
 Decode a group ID value into a descriptive string suitable for display to the user.
 
OFDPA_ERROR_t ofdpaGroupDelete (uint32_t groupId)
 Delete Group.
 
OFDPA_ERROR_t ofdpaGroupEntryInit (OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupEntry_t *group)
 Initialize Flow entry structure.
 
OFDPA_ERROR_t ofdpaGroupIndexGet (uint32_t groupId, uint32_t *index)
 Get the Index encoded in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupIndexSet (uint32_t *groupId, uint32_t index)
 Encode the Index in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupMplsL2TunnelIdGet (uint32_t groupId, uint32_t *tunnelId)
 Get the tunnel Id from the Group Id.
 
OFDPA_ERROR_t ofdpaGroupMplsL2TunnelIdSet (uint32_t *groupId, uint32_t tunnelId)
 Encode the tunnel Id in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupMplsSubTypeGet (uint32_t groupId, uint32_t *subType)
 Get the MPLS Group Sub-type from the Group Id.
 
OFDPA_ERROR_t ofdpaGroupMplsSubTypeSet (uint32_t *groupId, uint32_t subType)
 Encode the MPLS Group Sub-type in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupNextGet (uint32_t groupId, ofdpaGroupEntry_t *nextGroup)
 Get the next Group entry.
 
OFDPA_ERROR_t ofdpaGroupOverlayIndexGet (uint32_t groupId, uint32_t *index)
 Get the Overlay Group index in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupOverlayIndexSet (uint32_t *groupId, uint32_t index)
 Encode the Overlay Group index in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupOverlaySubTypeGet (uint32_t groupId, OFDPA_L2_OVERLAY_SUBTYPE_t *subType)
 Get the Overlay Group Sub-type from the Group Id.
 
OFDPA_ERROR_t ofdpaGroupOverlaySubTypeSet (uint32_t *groupId, OFDPA_L2_OVERLAY_SUBTYPE_t subType)
 Encode the Overlay Group Sub-type in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupOverlayTunnelIdGet (uint32_t groupId, uint32_t *tunnelId)
 Get the tunnel Id from the Group Id.
 
OFDPA_ERROR_t ofdpaGroupOverlayTunnelIdSet (uint32_t *groupId, uint32_t tunnelId)
 Encode the tunnel Id in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupPortIdGet (uint32_t groupId, uint32_t *portId)
 Get the Port ID encoded in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupPortIdSet (uint32_t *groupId, uint32_t portId)
 Encode the Port Id in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupStatsGet (uint32_t groupId, ofdpaGroupEntryStats_t *groupStats)
 Get Group statistics.
 
OFDPA_ERROR_t ofdpaGroupTableInfoGet (uint32_t groupId, ofdpaGroupTableInfo_t *info)
 Get Group table info.
 
OFDPA_ERROR_t ofdpaGroupTableTotalEntryCountGet (uint32_t *entryCount)
 Reports the number of group entries of all types.
 
OFDPA_ERROR_t ofdpaGroupTypeGet (uint32_t groupId, uint32_t *type)
 Get the Group Type encoded in the Group ID.
 
OFDPA_ERROR_t ofdpaGroupTypeNextGet (uint32_t groupId, OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupEntry_t *nextGroup)
 Get the next Group entry of a given type.
 
OFDPA_ERROR_t ofdpaGroupTypeSet (uint32_t *groupId, uint32_t type)
 Encode the Group Type in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupVlanGet (uint32_t groupId, uint32_t *vlanId)
 Get the VLAN ID encoded in the Group Id.
 
OFDPA_ERROR_t ofdpaGroupVlanSet (uint32_t *groupId, uint32_t vlanId)
 Encode the VLAN Id in the Group Id.
 
OFDPA_ERROR_t ofdpaMaxPktSizeGet (uint32_t *pktSize)
 Report the size in bytes of the largest packet that can be received.
 
OFDPA_ERROR_t ofdpaMeterAdd (uint32_t meterId, ofdpaMeterEntry_t *meter)
 Add Meter.
 
OFDPA_ERROR_t ofdpaMeterDelete (uint32_t meterId)
 Delete Meter.
 
OFDPA_ERROR_t ofdpaMeterEntryInit (ofdpaMeterEntry_t *meter)
 Initialize Meter entry.
 
OFDPA_ERROR_t ofdpaMeterGet (uint32_t meterId, ofdpaMeterEntry_t *meter)
 Get the Meter entry.
 
OFDPA_ERROR_t ofdpaMeterNextGet (uint32_t meterId, uint32_t *nextMeterId)
 Get the next Meter entry.
 
OFDPA_ERROR_t ofdpaMeterStatsGet (uint32_t meterId, ofdpaMeterEntryStats_t *meterStats)
 Get Meter statistics.
 
void ofdpaMplsL2PortIndexGet (uint32_t portNum, uint32_t *index)
 Get the MPLS L2 port index encoded in a port number value.
 
void ofdpaMplsL2PortIndexSet (uint32_t *portNum, uint32_t index)
 Encode the MPLS L2 port index in a port number.
 
void ofdpaMplsL2PortTypeGet (uint32_t portNum, uint32_t *type)
 Get the MPLS L2 port type encoded in a port number value.
 
void ofdpaMplsL2PortTypeSet (uint32_t *portNum, uint32_t type)
 Encode the MPLS L2 port type in a port number value.
 
OFDPA_ERROR_t ofdpaMplsQosActionAdd (ofdpaMplsQosEntry_t *mplsQosEntry)
 Add MPLS Set QoS action entry.
 
OFDPA_ERROR_t ofdpaMplsQosActionDelete (ofdpaMplsQosEntry_t *mplsQosEntry)
 Delete MPLS Set QoS action entry.
 
OFDPA_ERROR_t ofdpaMplsQosActionEntryGet (uint8_t qosIndex, uint8_t mpls_tc, ofdpaMplsQosEntry_t *mplsQosEntry)
 Get MPLS Set QoS action entry.
 
OFDPA_ERROR_t ofdpaMplsQosEntryInit (ofdpaMplsQosEntry_t *mplsQosEntry)
 Initialize MPLS QoS entry.
 
OFDPA_ERROR_t ofdpaMplsQosEntryNextGet (ofdpaMplsQosEntry_t *mplsQosEntry, ofdpaMplsQosEntry_t *nextEntry)
 Retrieve the next MPLS QoS entry.
 
OFDPA_ERROR_t ofdpaNumQueuesGet (uint32_t portNum, uint32_t *numQueues)
 The client calls this function to get the number of COS queues on a port.
 
OFDPA_ERROR_t ofdpaOamAisConfigGet (uint32_t lmepId, ofdpaOamAisConfig_t *config)
 Retrieve OAM Alarm Indication Signal configuration for the specified MEP using the configuration parameters provided.
 
OFDPA_ERROR_t ofdpaOamAisDisable (uint32_t lmepId)
 Disable sending OAM Alarm Indication Signal (AIS) messages for the specified MEP.
 
OFDPA_ERROR_t ofdpaOamAisEnable (uint32_t lmepId, ofdpaOamAisConfig_t *config)
 Enable sending OAM Alarm Indication Signal (AIS) messages for the specified MEP using the configuration parameters provided.
 
OFDPA_ERROR_t ofdpaOamCsfDisable (uint32_t lmepId)
 Disable sending OAM Client Signal Fail (CSF) messages for the specified MEP.
 
OFDPA_ERROR_t ofdpaOamCsfEnable (uint32_t lmepId, ofdpaOamCsfConfig_t *config)
 Enable sending OAM Client Signal Fail (CSF) messages for the specified MEP using the configuration parameters provided.
 
OFDPA_ERROR_t ofdpaOamDataCounterAdd (uint32_t lmepId, uint8_t trafficClass)
 Add data counter entry.
 
OFDPA_ERROR_t ofdpaOamDataCounterDelete (uint32_t lmepId, uint8_t trafficClass)
 Delete data counter entry.
 
OFDPA_ERROR_t ofdpaOamDataCounterGet (ofdpaOamDataCounterIndex_t index, ofdpaOamDataCounterStatus_t *status)
 Get the data counter entry.
 
OFDPA_ERROR_t ofdpaOamDataCounterNextGet (ofdpaOamDataCounterIndex_t index, ofdpaOamDataCounterIndex_t *nextIndex, ofdpaOamDataCounterStatus_t *status)
 Get the next data counter entry.
 
OFDPA_ERROR_t ofdpaOamDataCountersLMClear (ofdpaOamDataCounterIndex_t index)
 Clear OAM LM counters.
 
OFDPA_ERROR_t ofdpaOamDataCountersLMGet (ofdpaOamDataCounterIndex_t index, uint32_t *TxFCl, uint32_t *RxFCl)
 Get OAM LM counters.
 
OFDPA_ERROR_t ofdpaOamDataCounterStatusGet (uint32_t lmepId, uint8_t trafficClass, ofdpaOamDataCounterStatus_t *status)
 Get data counter entry status.
 
OFDPA_ERROR_t ofdpaOamEventNextGet (ofdpaOamEvent_t *eventData)
 Get the next OAM event.
 
OFDPA_ERROR_t ofdpaOamLbCreate (uint32_t lmepId, ofdpaOamLbConfig_t *config)
 Create an OAM Loopback Entry.
 
OFDPA_ERROR_t ofdpaOamLbGet (uint32_t lmepId, ofdpaOamLbConfig_t *config, ofdpaOamLbStatus_t *status)
 Get the status of loopback.
 
OFDPA_ERROR_t ofdpaOamLbStart (uint32_t lmepId)
 Start on demand loopback.
 
OFDPA_ERROR_t ofdpaOamLbStop (uint32_t lmepId)
 Stop on demand loopback.
 
OFDPA_ERROR_t ofdpaOamLckConfigGet (uint32_t lmepId, ofdpaOamLckConfig_t *config)
 Retrieve OAM Lock Signal configuration for the specified MEP using the configuration parameters provided.
 
OFDPA_ERROR_t ofdpaOamLckDisable (uint32_t lmepId)
 Disable sending OAM Lock Signal (LCK) messages for the.
 
OFDPA_ERROR_t ofdpaOamLckEnable (uint32_t lmepId, ofdpaOamLckConfig_t *config)
 Enable sending OAM Lock Signal (LCK) messages for the specified MEP using the configuration parameters provided.
 
OFDPA_ERROR_t ofdpaOamLtGet (uint32_t lmepId, ofdpaOamLtConfig_t *config, ofdpaOamLtStatus_t *status)
 Retrieve OAM Link Trace configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamLtResultNextGet (uint32_t lmepId, uint32_t sequenceNum, uint32_t receiveOrder, ofdpaOamLtrEntry_t *ltResult)
 Retrieve Next OAM Link Trace record.
 
OFDPA_ERROR_t ofdpaOamLtStart (uint32_t lmepId, ofdpaOamLtConfig_t *config)
 Initiates a OAM Link Trace session.
 
OFDPA_ERROR_t ofdpaOamMegCreate (uint32_t megIndex, ofdpaOamMegConfig_t *config)
 Create an OAM MEG entry.
 
OFDPA_ERROR_t ofdpaOamMegDelete (uint32_t megIndex)
 Delete an OAM MEG entry.
 
OFDPA_ERROR_t ofdpaOamMegGet (uint32_t megIndex, ofdpaOamMegConfig_t *config, ofdpaOamMegStatus_t *status)
 Retrieve OAM MEG configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamMegNextGet (uint32_t megIndex, uint32_t *nextMegIndex)
 Return the MEG index, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaOamMepCCMDatabaseEntryGet (uint32_t lmepId, uint32_t remoteMepId, ofdpaOamCcmDatabaseEntry_t *dbEntry)
 Retrieve OAM MEP CCM database entry status.
 
OFDPA_ERROR_t ofdpaOamMepCCMDatabaseEntryNextGet (uint32_t lmepId, uint32_t remoteMepId, uint32_t *nextRemoteMepId)
 Return the OAM MEP CCM database entry identifier, if any, for the entry after the specified remote MEP.
 
OFDPA_ERROR_t ofdpaOamMepCreate (uint32_t lmepId, ofdpaOamMepConfig_t *config)
 Create an OAM MEP entry.
 
OFDPA_ERROR_t ofdpaOamMepDelete (uint32_t lmepId)
 Delete an OAM MEP entry.
 
OFDPA_ERROR_t ofdpaOamMepGet (uint32_t lmepId, ofdpaOamMepConfig_t *config, ofdpaOamMepStatus_t *status)
 Retrieve OAM MEP configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamMepLtrEntryGet (uint32_t lmepId, uint32_t index, ofdpaOamLtrEntry_t *ltrEntry)
 Retrieve OAM MEP LT Reply entry status.
 
OFDPA_ERROR_t ofdpaOamMepLtrEntryNextGet (uint32_t lmepId, uint32_t index, uint32_t *nextIndex)
 Return the OAM MEP LT Reply entry identifier, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaOamMepNextGet (uint32_t lmepId, uint32_t *nextLmepId)
 Return the MEP identifier, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaOamMepProtectionAdd (uint32_t mlpGroupIndex, uint32_t lmepId)
 Add a local MEP to the specfied MPLS-TP Linear Protection Group.
 
OFDPA_ERROR_t ofdpaOamMepProtectionGet (uint32_t mlpGroupIndex, uint32_t lmepId)
 Checks whether local MEP is associated with this MPLS-TP Linear Protection Group.
 
OFDPA_ERROR_t ofdpaOamMepProtectionNextGet (uint32_t mlpGroupIndex, uint32_t lmepId, uint32_t *nextLmepId)
 Returns the index of the next local MEP associated with this MPLS-TP Linear Protection Group, if any exists.
 
OFDPA_ERROR_t ofdpaOamMepProtectionRemove (uint32_t mlpGroupIndex, uint32_t lmepId)
 Remove a local MEP to the specfied MPLS-TP Linear Protection Group.
 
OFDPA_ERROR_t ofdpaOamMipCreate (uint32_t localMpId, ofdpaOamMipConfig_t *config)
 Create an OAM MIP entry.
 
OFDPA_ERROR_t ofdpaOamMipDelete (uint32_t localMpId)
 Delete an OAM MIP entry.
 
OFDPA_ERROR_t ofdpaOamMipGet (uint32_t localMpId, ofdpaOamMipConfig_t *config, ofdpaOamMipStatus_t *status)
 Retrieve OAM MIP configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamMipNextGet (uint32_t localMpId, uint32_t *nextLocalMpId)
 Return the MIP identifier, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaOamMLPGroupCreate (uint32_t index, ofdpaOamMLPGroupConfig_t *config)
 Create an MPLS-TP Linear Protection Group entry.
 
OFDPA_ERROR_t ofdpaOamMLPGroupDelete (uint32_t index)
 Delete an MPLS-TP Linear Protection Group entry.
 
OFDPA_ERROR_t ofdpaOamMLPGroupGet (uint32_t index, ofdpaOamMLPGroupConfig_t *config, ofdpaOamMLPGroupStatus_t *status)
 Retrieve an MPLS-TP Linear Protection Group entry.
 
OFDPA_ERROR_t ofdpaOamMLPGroupNextGet (uint32_t index, uint32_t *nextIndex)
 Return the MPLS-TP Linear Protection Group entry identifier, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaOamMLPGroupRequest (uint32_t index, OFDPA_PROTECTION_SWITCH_REQUEST_TYPE_t request)
 Issue a request to the MPLS-TP Linear Protection Group.
 
OFDPA_ERROR_t ofdpaOamOdDmCountersGet (uint32_t lmepId, ofdpaOamOdDmSnapshot_t *counters)
 Retrieve OAM Performance Measurement OnDemand Delay Measurement counters.
 
OFDPA_ERROR_t ofdpaOamOdDmCreate (uint32_t lmepId, ofdpaOamOdDmConfig_t *config)
 Create an OAM Performance Measurement OnDemand Delay Measurement entry.
 
OFDPA_ERROR_t ofdpaOamOdDmDelete (uint32_t lmepId)
 Delete an OAM Performance Measurement OnDemand Delay Measurement entry.
 
OFDPA_ERROR_t ofdpaOamOdDmGet (uint32_t lmepId, ofdpaOamOdDmConfig_t *config, ofdpaOamOdDmStatus_t *status)
 Retrieve OAM Performance Measurement OnDemand Delay Measurement configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamOdDmStart (uint32_t lmepId)
 Start OAM Performance Measurement OnDemand Delay Measurement session.
 
OFDPA_ERROR_t ofdpaOamOdDmStop (uint32_t lmepId)
 Stop OAM Performance Measurement OnDemand Delay Measurement session.
 
OFDPA_ERROR_t ofdpaOamOdLmCountersGet (uint32_t lmepId, ofdpaOamOdLmSnapshot_t *counters)
 Retrieve OAM Performance Measurement OnDemand Loss Measurement counters.
 
OFDPA_ERROR_t ofdpaOamOdLmCreate (uint32_t lmepId, ofdpaOamOdLmConfig_t *config)
 Create an OAM Performance Measurement OnDemand Loss Measurement entry.
 
OFDPA_ERROR_t ofdpaOamOdLmDelete (uint32_t lmepId)
 Delete an OAM Performance Measurement OnDemand Loss Measurement entry.
 
OFDPA_ERROR_t ofdpaOamOdLmGet (uint32_t lmepId, ofdpaOamOdLmConfig_t *config, ofdpaOamOdLmStatus_t *status)
 Retrieve OAM Performance Measurement Ondemand Loss Measurement configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamOdLmStart (uint32_t lmepId)
 Start OAM Performance Measurement OnDemand Loss Measurement session.
 
OFDPA_ERROR_t ofdpaOamOdLmStop (uint32_t lmepId)
 Stop OAM Performance Measurement OnDemand Loss Measurement session.
 
OFDPA_ERROR_t ofdpaOamOnDemandDmStart (uint32_t lmepId, ofdpaOamOdDmConfig_t *config)
 Start an on demand Delay Measurement session.
 
OFDPA_ERROR_t ofdpaOamOnDemandLmStart (uint32_t lmepId, ofdpaOamOdLmConfig_t *config)
 Start an on demand Loss Measurement session.
 
OFDPA_ERROR_t ofdpaOamProDmCountersGet (uint32_t lmepId, ofdpaOamProDmCounters_t *counters)
 Retrieve OAM Performance Measurement Proactive Delay Measurement counters.
 
OFDPA_ERROR_t ofdpaOamProDmCreate (uint32_t lmepId, ofdpaOamProDmConfig_t *config)
 Create an OAM Performance Measurement Proactive Delay Measurement entry.
 
OFDPA_ERROR_t ofdpaOamProDmDelete (uint32_t lmepId)
 Delete an OAM Performance Measurement Proactive Delay Measurement entry.
 
OFDPA_ERROR_t ofdpaOamProDmGet (uint32_t lmepId, ofdpaOamProDmConfig_t *config, ofdpaOamProDmStatus_t *status)
 Retrieve OAM Performance Measurement Proactive Delay Measurement configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamProDmStart (uint32_t lmepId)
 Start OAM Performance Measurement Proactive Delay Measurement session.
 
OFDPA_ERROR_t ofdpaOamProDmStop (uint32_t lmepId)
 Stop OAM Performance Measurement Proactive Delay Measurement session.
 
OFDPA_ERROR_t ofdpaOamProLmCountersGet (uint32_t lmepId, ofdpaOamProLmCounters_t *counters)
 Retrieve OAM Performance Measurement Proactive Loss Measurement counters.
 
OFDPA_ERROR_t ofdpaOamProLmCreate (uint32_t lmepId, ofdpaOamProLmConfig_t *config)
 Create an OAM Performance Measurement Proactive Loss Measurement entry.
 
OFDPA_ERROR_t ofdpaOamProLmDelete (uint32_t lmepId)
 Delete an OAM Performance Measurement Proactive Loss Measurement entry.
 
OFDPA_ERROR_t ofdpaOamProLmDisable (uint32_t lmepId)
 Disable OAM Performance Measurement Proactive Loss Measurement session.
 
OFDPA_ERROR_t ofdpaOamProLmEnable (uint32_t lmepId)
 Enable OAM Performance Measurement Proactive Loss Measurement session.
 
OFDPA_ERROR_t ofdpaOamProLmGet (uint32_t lmepId, ofdpaOamProLmConfig_t *config, ofdpaOamProLmStatus_t *status)
 Retrieve OAM Performance Measurement Proactive Loss Measurement configuration and/or status.
 
OFDPA_ERROR_t ofdpaOamRemoteMpCreate (uint32_t remoteMpId, ofdpaOamRemoteMpConfig_t *config)
 Create an OAM Remote MP entry.
 
OFDPA_ERROR_t ofdpaOamRemoteMpDelete (uint32_t remoteMpId)
 Delete an OAM Remote MP entry.
 
OFDPA_ERROR_t ofdpaOamRemoteMpGet (uint32_t remoteMpId, ofdpaOamRemoteMpConfig_t *config)
 Retrieve OAM Remote MP.
 
OFDPA_ERROR_t ofdpaOamRemoteMpNextGet (uint32_t remoteMpId, uint32_t *nextRemoteMpId)
 Return the Remote MP identifier, if any, for the entry after the one specified for the given local MEP ID.
 
OFDPA_ERROR_t ofdpaPktReceive (struct timeval *timeout, ofdpaPacket_t *pkt)
 The client calls this function to retrieve a single packet that the hardware has punted to the CPU.
 
OFDPA_ERROR_t ofdpaPktSend (ofdpa_buffdesc *pkt, uint32_t flags, uint32_t outPortNum, uint32_t inPortNum)
 Packet out API.
 
OFDPA_ERROR_t ofdpaPortAdvertiseFeatureSet (uint32_t portNum, uint32_t advertise)
 Set the port features that can be advertized durng Auto-Negotiation.
 
OFDPA_ERROR_t ofdpaPortConfigGet (uint32_t portNum, uint32_t *config)
 Get the port administrative state.
 
OFDPA_ERROR_t ofdpaPortConfigSet (uint32_t portNum, OFDPA_PORT_CONFIG_t config)
 Set the port administrative state.
 
OFDPA_ERROR_t ofdpaPortCurrSpeedGet (uint32_t portNum, uint32_t *currSpeed)
 Get the port current speed.
 
OFDPA_ERROR_t ofdpaPortEventGet (ofdpaPortEvent_t *eventData)
 Get the port event.
 
OFDPA_ERROR_t ofdpaPortEventNextGet (ofdpaPortEvent_t *eventData)
 Get the next port event.
 
OFDPA_ERROR_t ofdpaPortFeatureGet (uint32_t portNum, ofdpaPortFeature_t *feature)
 Get the port features.
 
void ofdpaPortIndexGet (uint32_t portNum, uint32_t *index)
 Get the port index encoded in a port number value.
 
void ofdpaPortIndexSet (uint32_t *portNum, uint32_t index)
 Encode the port index in a port number.
 
OFDPA_ERROR_t ofdpaPortMacGet (uint32_t portNum, ofdpaMacAddr_t *mac)
 Get the MAC address of the given port.
 
OFDPA_ERROR_t ofdpaPortMaxSpeedGet (uint32_t portNum, uint32_t *maxSpeed)
 Get the port maximum speed.
 
OFDPA_ERROR_t ofdpaPortNameGet (uint32_t portNum, ofdpa_buffdesc *name)
 Get the port name.
 
OFDPA_ERROR_t ofdpaPortNextGet (uint32_t portNum, uint32_t *nextPortNum)
 Get the next port from the port table.
 
OFDPA_ERROR_t ofdpaPortStateGet (uint32_t portNum, uint32_t *state)
 Get the port link state.
 
OFDPA_ERROR_t ofdpaPortStatsClear (uint32_t portNum)
 Clear port statistics.
 
OFDPA_ERROR_t ofdpaPortStatsGet (uint32_t portNum, ofdpaPortStats_t *stats)
 Get port statistics.
 
void ofdpaPortTypeGet (uint32_t portNum, uint32_t *type)
 Get the port type encoded in a port number value.
 
void ofdpaPortTypeSet (uint32_t *portNum, uint32_t type)
 Encode the port type in a port number value.
 
const char * ofdpaQosColorDecode (OFDPA_QOS_COLORS_t color)
 Returns the a string suitable for display to the user representing the color value.
 
OFDPA_ERROR_t ofdpaQueueRateGet (uint32_t portNum, uint32_t queueId, uint32_t *minRate, uint32_t *maxRate)
 The client calls this function to get minimum and maximum bandwidth on a queue on a given port.
 
OFDPA_ERROR_t ofdpaQueueRateSet (uint32_t portNum, uint32_t queueId, uint32_t minRate, uint32_t maxRate)
 The client calls this function to set minimum and maximum bandwidth on a queue on a given port.
 
OFDPA_ERROR_t ofdpaQueueStatsClear (uint32_t portNum, uint32_t queueId)
 The client calls this function to clear all the statistics of a queue on a port.
 
OFDPA_ERROR_t ofdpaQueueStatsGet (uint32_t portNum, uint32_t queueId, ofdpaPortQueueStats_t *stats)
 The client calls this function to get the statistics of a queue on a port.
 
OFDPA_ERROR_t ofdpaRemarkActionAdd (ofdpaRemarkActionEntry_t *remarkEntry)
 Add remark action entry.
 
OFDPA_ERROR_t ofdpaRemarkActionDelete (ofdpaRemarkActionEntry_t *remarkEntry)
 Delete remark action entry.
 
OFDPA_ERROR_t ofdpaRemarkActionEntryGet (ofdpaRemarkActionEntry_t *remarkEntry)
 Get remark action entry.
 
OFDPA_ERROR_t ofdpaRemarkEntryNextGet (ofdpaRemarkActionEntry_t *remarkEntry, ofdpaRemarkActionEntry_t *nextEntry)
 Retrieve the next remark entry.
 
OFDPA_ERROR_t ofdpaSourceMacLearningGet (OFDPA_CONTROL_t *mode, ofdpaSrcMacLearnModeCfg_t *srcMacLearnModeCfg)
 The client calls this function to get the Source Mac Learning Mode with other config parameters.
 
OFDPA_ERROR_t ofdpaSourceMacLearningSet (OFDPA_CONTROL_t mode, ofdpaSrcMacLearnModeCfg_t *srcMacLearnModeCfg)
 The client calls this function to set the Source Mac Learning Mode with other config parameters.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupCreate (uint32_t ecmpNextHopGroupId, ofdpaTunnelEcmpNextHopGroupConfig_t *config)
 Create a tunnel ECMP next hop group entry.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupDelete (uint32_t ecmpNextHopGroupId)
 Delete a tunnel ECMP next hop group entry.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupGet (uint32_t ecmpNextHopGroupId, ofdpaTunnelEcmpNextHopGroupConfig_t *config, ofdpaTunnelEcmpNextHopGroupStatus_t *status)
 Retrieve tunnel ECMP next hop group configuration and/or status.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMaxMembersGet (uint32_t *maxMemberCount)
 Return the number of ECMP next hop group members supported by the switch.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberAdd (uint32_t ecmpNextHopGroupId, uint32_t nextHopId)
 Adds a next hop member to an ECMP next hop group entry.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberDelete (uint32_t ecmpNextHopGroupId, uint32_t nextHopId)
 Adds a next hop member to an ECMP next hop group entry.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberGet (uint32_t ecmpNextHopListGroupId, uint32_t nextHopId)
 Test whether a next hop is a member in the specified ECMP next hop group.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberNextGet (uint32_t ecmpNextHopListGroupId, uint32_t nextHopId, uint32_t *nextNextHopId)
 Gets the next member next hop in the ECMP next hop group.
 
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupNextGet (uint32_t ecmpNextHopGroupId, uint32_t *nextEcmpNextHopGroupId)
 Return the ECMP tunnel next hop group identifier, if any, for the entry after the one specified.
 
void ofdpaTunnelIdIndexGet (uint32_t tunnelId, uint32_t *index)
 Get the tunnel index encoded in a tunnel ID value.
 
void ofdpaTunnelIdIndexSet (uint32_t *tunnelId, uint32_t index)
 Encode the tunnel index in a tunnelId number.
 
void ofdpaTunnelIdTypeGet (uint32_t tunnelId, uint32_t *type)
 Get the tunnel type encoded in a tunnel ID value.
 
void ofdpaTunnelIdTypeSet (uint32_t *tunnelId, uint32_t type)
 Encode the tunnel type in a tunnel ID value.
 
OFDPA_ERROR_t ofdpaTunnelNextHopCreate (uint32_t nextHopId, ofdpaTunnelNextHopConfig_t *config)
 Create a tunnel next hop entry.
 
OFDPA_ERROR_t ofdpaTunnelNextHopDelete (uint32_t nextHopId)
 Delete a tunnel next hop entry.
 
OFDPA_ERROR_t ofdpaTunnelNextHopGet (uint32_t nextHopId, ofdpaTunnelNextHopConfig_t *config, ofdpaTunnelNextHopStatus_t *status)
 Retrieve tunnel next hop configuration and/or status.
 
OFDPA_ERROR_t ofdpaTunnelNextHopModify (uint32_t nextHopId, ofdpaTunnelNextHopConfig_t *config)
 Modify a tunnel next hop entry.
 
OFDPA_ERROR_t ofdpaTunnelNextHopNextGet (uint32_t nextHopId, uint32_t *nextNextHopId)
 Return the tunnel next hop identifier, if any, for the entry after the one specified.
 
OFDPA_ERROR_t ofdpaTunnelPortCreate (uint32_t portNum, ofdpa_buffdesc *name, ofdpaTunnelPortConfig_t *config)
 Create a tunnel logical port.
 
OFDPA_ERROR_t ofdpaTunnelPortDelete (uint32_t portNum)
 Delete a tunnel logical port.
 
OFDPA_ERROR_t ofdpaTunnelPortGet (uint32_t portNum, ofdpaTunnelPortConfig_t *config, ofdpaTunnelPortStatus_t *status)
 Retrieve tunnel logical port configuration and/or status.
 
OFDPA_ERROR_t ofdpaTunnelPortNextGet (uint32_t portNum, uint32_t *nextPortNum)
 Return the tunnel logical port identifier, if any, for the logical port after the one specified in the logical port table.
 
OFDPA_ERROR_t ofdpaTunnelPortTenantAdd (uint32_t portNum, uint32_t tunnelId)
 Adds a tenant reference to a logical port tunnel entry.
 
OFDPA_ERROR_t ofdpaTunnelPortTenantDelete (uint32_t portNum, uint32_t tunnelId)
 Deletes a tenant reference to a logical port tunnel entry.
 
OFDPA_ERROR_t ofdpaTunnelPortTenantGet (uint32_t portNum, uint32_t tunnelId, ofdpaTunnelPortTenantStatus_t *status)
 Test whether a tenant reference to a logical port exists for the port and tenant combination.
 
OFDPA_ERROR_t ofdpaTunnelPortTenantNextGet (uint32_t portNum, uint32_t tunnelId, uint32_t *nextTunnelId)
 Gets the next logical port tunnel entry after the port and tenant identified.
 
OFDPA_ERROR_t ofdpaTunnelTenantCreate (uint32_t tunnelId, ofdpaTunnelTenantConfig_t *config)
 Create a tunnel tenant entry.
 
OFDPA_ERROR_t ofdpaTunnelTenantDelete (uint32_t tunnelId)
 Delete a tunnel tenant entry.
 
OFDPA_ERROR_t ofdpaTunnelTenantGet (uint32_t tunnelId, ofdpaTunnelTenantConfig_t *config, ofdpaTunnelTenantStatus_t *status)
 Retrieve tunnel tenant configuration and/or status.
 
OFDPA_ERROR_t ofdpaTunnelTenantNextGet (uint32_t tunnelId, uint32_t *nextTunnelId)
 Return the tunnel identifier, if any, for the entry after the one specified.