ofdpa_api.h

Go to the documentation of this file.

/*********************************************************************
*
* (C) Copyright Broadcom Corporation 2003-2014
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename     ofdpa_api.h
*
* @purpose      OF-DPA API header
*
* @component    OF-DPA
*
* @note     none
*
* @create       03/22/2013
*
* @end
*
**********************************************************************/
#ifndef INCLUDE_OFDPA_API_H
#define INCLUDE_OFDPA_API_H

#include <stdint.h>
#include <sys/time.h>
#include <netinet/in.h>
#include "ofdpa_datatypes.h"

/*
 * All clients must register first.
 */
/*****************************************************************/
OFDPA_ERROR_t ofdpaClientInitialize(char *clientName);

/*
 * Debugging and Logging definitions
 */

/*****************************************************************/
int ofdpaCltLogPrintf(int priority, char *fmt, ...);

/*****************************************************************/
int ofdpaCltLogBuf(int priority, ofdpa_buffdesc message);

/*****************************************************************/
int ofdpaCltDebugPrintf(const char *functionName, ofdpaComponentIds_t component, ofdpaDebugLevels_t verbosity, const char *format, ...);

/*****************************************************************/
int ofdpaCltDebugBuf(ofdpa_buffdesc functionName, ofdpaComponentIds_t component, ofdpaDebugLevels_t verbosity, ofdpa_buffdesc message);

/* Flow Tables.
*/

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowEntryInit(OFDPA_FLOW_TABLE_ID_t tableId, ofdpaFlowEntry_t *flow);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowAdd(ofdpaFlowEntry_t *flow);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowModify(ofdpaFlowEntry_t *flow);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowDelete(ofdpaFlowEntry_t *flow);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowNextGet(ofdpaFlowEntry_t *flow, ofdpaFlowEntry_t *nextFlow);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowStatsGet(ofdpaFlowEntry_t *flow, ofdpaFlowEntryStats_t *flowStats);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowByCookieGet(uint64_t cookie, ofdpaFlowEntry_t *flow, ofdpaFlowEntryStats_t *flowStats);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowByCookieDelete(uint64_t cookie);

/*------------------------------------------------------------------------------------*/
/* group table APIs */

/*
   The Group Table contains one entry for each Group.  The table is indexed
   by the groupId which identifies the group entry.  Data is encoded into the groupId to specify the OF-DPA
   group entry type and information required by OF-DPA to configure the datapath.

   The groupId encoding method is:

   L2 Interface, L2 Rewrite types:
        (MSB to LSB) 4 bits encode the Group Table Entry type |12 bits of VLAN ID | 16 bits of port identifier

   L2 Multicast, L2 Flood, L3 Multicast, and L3 Interface types:
        (MSB to LSB) 4 bits encode the Group Table Entry type |12 bits of VLAN ID | 16 bits of index

   L3 Unicast and L3 ECMP types:
        (MSB to LSB) 4 bits encode the Group Table Entry type | 28 bits of index

*/

/* APIs for getting/setting group IDs -- set APIs must set the type first. */

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupTypeGet(uint32_t groupId, uint32_t *type);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupVlanGet(uint32_t groupId, uint32_t *vlanId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupPortIdGet(uint32_t groupId, uint32_t *portId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupIndexShortGet(uint32_t groupId, uint32_t *index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupIndexGet(uint32_t groupId, uint32_t *index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupTypeSet(uint32_t *groupId, uint32_t type);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupVlanSet(uint32_t *groupId, uint32_t vlanId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupOverlayTunnelIdSet(uint32_t *groupId, uint32_t tunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupOverlaySubTypeSet(uint32_t *groupId, OFDPA_L2_OVERLAY_SUBTYPE_t subType);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupOverlayIndexSet(uint32_t *groupId, uint32_t index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupPortIdSet(uint32_t *groupId, uint32_t portId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupIndexShortSet(uint32_t *groupId, uint32_t index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupIndexSet(uint32_t *groupId, uint32_t index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupDecode(uint32_t groupId, char *outBuf, int bufSize);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupAdd(ofdpaGroupEntry_t *group);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupDelete(uint32_t groupId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupNextGet(uint32_t groupId, ofdpaGroupEntry_t *nextGroup);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupTypeNextGet(uint32_t groupId,
                                    OFDPA_GROUP_ENTRY_TYPE_t groupType,
                                    ofdpaGroupEntry_t *nextGroup);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupStatsGet(uint32_t groupId, ofdpaGroupEntryStats_t *groupStats);

/*
   Group Table entries contain one or more Action Buckets depending on their type.
   The Group Bucket Table stores these references.  It is indexed by groupId and referenceGroupId.  The presence
   of an entry in this table creates a referral by the Group Table entry specified in groupId to the Group Table
   entry specified in referenceGroupId.  Restrictions on the number of references and the allowable type of the
   referenced Group Table entries varies by entry type.
*/

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryAdd(ofdpaGroupBucketEntry_t *bucket);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryDelete(uint32_t groupId, uint32_t bucketIndex);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketsDeleteAll(uint32_t groupId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryGet(uint32_t groupId, uint32_t bucketIndex,
                                       ofdpaGroupBucketEntry_t *groupBucket);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryFirstGet(uint32_t groupId,
                                            ofdpaGroupBucketEntry_t *firstGroupBucket);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryNextGet(uint32_t groupId, uint32_t bucketIndex,
                                           ofdpaGroupBucketEntry_t *nextBucketEntry);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryModify(ofdpaGroupBucketEntry_t *bucket);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupTableInfoGet(OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupTableInfo_t *info);

/*****************************************************************/
void ofdpaPortTypeGet(uint32_t portNum, uint32_t *type);

/*****************************************************************/
void ofdpaPortTypeSet(uint32_t *portNum, uint32_t type);

/*****************************************************************/
void ofdpaPortIndexGet(uint32_t portNum, uint32_t *index);

/*****************************************************************/
void ofdpaPortIndexSet(uint32_t *portNum, uint32_t index);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortNextGet(uint32_t portNum, uint32_t *nextPortNum);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortMacGet(uint32_t portNum, ofdpaMacAddr_t *mac);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortNameGet(uint32_t portNum, ofdpa_buffdesc *name);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortStateGet(uint32_t  portNum, OFDPA_PORT_STATE_t  *state);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortConfigSet(uint32_t portNum, OFDPA_PORT_CONFIG_t config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortConfigGet(uint32_t portNum, OFDPA_PORT_CONFIG_t  *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortMaxSpeedGet(uint32_t portNum, uint32_t  *maxSpeed);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortCurrSpeedGet(uint32_t portNum, uint32_t  *currSpeed);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortFeatureGet(uint32_t portNum, ofdpaPortFeature_t *feature);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortAdvertiseFeatureSet(uint32_t portNum, uint32_t advertise);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortStatsClear(uint32_t portNum);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortStatsGet(uint32_t portNum, ofdpaPortStats_t *stats);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortCreate(uint32_t portNum, ofdpa_buffdesc *name, ofdpaTunnelPortConfig_t *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortDelete(uint32_t portNum);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortGet(uint32_t portNum,
                                 ofdpaTunnelPortConfig_t *config,
                                 ofdpaTunnelPortStatus_t *status);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortNextGet(uint32_t portNum, uint32_t *nextPortNum);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortTenantAdd(uint32_t portNum, uint32_t tunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortTenantDelete(uint32_t portNum, uint32_t tunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortTenantGet(uint32_t portNum, uint32_t tunnelId, ofdpaTunnelPortTenantStatus_t *status);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelPortTenantNextGet(uint32_t portNum, uint32_t tunnelId, uint32_t *nextTunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelTenantCreate(uint32_t tunnelId, ofdpaTunnelTenantConfig_t *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelTenantDelete(uint32_t tunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelTenantGet(uint32_t tunnelId,
                                   ofdpaTunnelTenantConfig_t *config,
                                   ofdpaTunnelTenantStatus_t *status);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelTenantNextGet(uint32_t tunnelId, uint32_t *nextTunnelId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelNextHopCreate(uint32_t nextHopId, ofdpaTunnelNextHopConfig_t *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelNextHopDelete(uint32_t nextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelNextHopModify(uint32_t nextHopId, ofdpaTunnelNextHopConfig_t *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelNextHopGet(uint32_t nextHopId,
                                    ofdpaTunnelNextHopConfig_t *config,
                                    ofdpaTunnelNextHopStatus_t *status);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelNextHopNextGet(uint32_t nextHopId, uint32_t *nextNextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupCreate(uint32_t ecmpNextHopGroupId, ofdpaTunnelEcmpNextHopGroupConfig_t *config);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupDelete(uint32_t ecmpNextHopGroupId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupGet(uint32_t ecmpNextHopGroupId,
                                             ofdpaTunnelEcmpNextHopGroupConfig_t *config,
                                             ofdpaTunnelEcmpNextHopGroupStatus_t *status);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupNextGet(uint32_t ecmpNextHopGroupId, uint32_t *nextEcmpNextHopGroupId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMaxMembersGet(uint32_t *maxMemberCount);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberAdd(uint32_t ecmpNextHopGroupId, uint32_t nextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberDelete(uint32_t ecmpNextHopGroupId, uint32_t nextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberGet(uint32_t ecmpNextHopListGroupId, uint32_t nextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaTunnelEcmpNextHopGroupMemberNextGet(uint32_t ecmpNextHopListGroupId, uint32_t nextHopId, uint32_t *nextNextHopId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPktSend(ofdpa_buffdesc *pkt, uint32_t flags, uint32_t outPortNum, uint32_t inPortNum);

/*****************************************************************/
OFDPA_ERROR_t ofdpaMaxPktSizeGet(uint32_t *pktSize);

/*------------------------------------------------------------------------------------*/
/* Event APIs */

/*
   Asynchronous events: Have classified them into two broad category:
   Packet In : Packet received from the hardware to be sent to the controller
   Control messages: Events like Port creation, deletion, link state, Flow age and Error

   The packet In events can have a high frequency, so we want to ensure that there is
   separate control for polling of these two event types to give flexibility to the agent
*/

/*****************************************************************/
int ofdpaClientEventSockFdGet(void);

/*****************************************************************/
int ofdpaClientPktSockFdGet(void);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPktReceive(struct timeval *timeout, ofdpaPacket_t *pkt);


/*****************************************************************/
OFDPA_ERROR_t ofdpaEventReceive(struct timeval *timeout);

/*****************************************************************/
OFDPA_ERROR_t ofdpaPortEventNextGet(ofdpaPortEvent_t *eventData);

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowEventNextGet(ofdpaFlowEvent_t *eventData);

/*------------------------------------------------------------------------------------*/
/* Table APIs */

/* Get information for a given table Id */

/*****************************************************************/
OFDPA_ERROR_t ofdpaFlowTableInfoGet(OFDPA_FLOW_TABLE_ID_t tableId, ofdpaFlowTableInfo_t *info);

/*------------------------------------------------------------------------------------*/
/* Queue APIs */

/*****************************************************************/
OFDPA_ERROR_t ofdpaNumQueuesGet(uint32_t portNum, uint32_t *numQueues);

/*****************************************************************/
OFDPA_ERROR_t ofdpaQueueStatsGet(uint32_t portNum, uint32_t queueId, ofdpaPortQueueStats_t *stats);

/*****************************************************************/
OFDPA_ERROR_t ofdpaQueueStatsClear(uint32_t portNum, uint32_t queueId);

/*****************************************************************/
OFDPA_ERROR_t ofdpaQueueRateSet(uint32_t portNum, uint32_t queueId, uint32_t minRate, uint32_t maxRate);

/*****************************************************************/
OFDPA_ERROR_t ofdpaQueueRateGet(uint32_t portNum, uint32_t queueId, uint32_t *minRate, uint32_t *maxRate);

/*------------------------------------------------------------------------------------*/
/* Vendor Extension APIs */

/*****************************************************************/
OFDPA_ERROR_t ofdpaSourceMacLearningSet(OFDPA_CONTROL_t mode, ofdpaSrcMacLearnModeCfg_t *srcMacLearnModeCfg);

/*****************************************************************/
OFDPA_ERROR_t ofdpaSourceMacLearningGet(OFDPA_CONTROL_t *mode, ofdpaSrcMacLearnModeCfg_t *srcMacLearnModeCfg);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupEntryInit(OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupEntry_t *group);

/*****************************************************************/
OFDPA_ERROR_t ofdpaGroupBucketEntryInit(OFDPA_GROUP_ENTRY_TYPE_t groupType, ofdpaGroupBucketEntry_t *bucket);


/* Development utility APIs */
/*****************************************************************/
int ofdpaDebugLvl(int lvl);

/*****************************************************************/
int ofdpaDebugLvlGet(void);

/*****************************************************************/
int ofdpaComponentNameGet(int component, ofdpa_buffdesc *name);

/*****************************************************************/
int ofdpaDebugComponentSet(int component, int enable);

/*****************************************************************/
int ofdpaDebugComponentGet(int component);

/*****************************************************************/
int ofdpaBcmCommand(ofdpa_buffdesc buffer);

#endif /* INCLUDE_OFDPA_API_H */