Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_dot1cb.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2019 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ***********************************************************************
26 *
27 * @filename openapi_dot1cb.h
28 *
29 * @purpose This code implements the OpEN Dot1cb API
30 *
31 * @component OPEN
32 *
33 * @create 05/29/2019
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_DOT1CB_H_INCLUDED
39 #define OPENAPI_DOT1CB_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_MAX_DOT1CB_VLANS 16
44 #define OPEN_MAX_DOT1CB_IPV4 512
45 #define OPEN_MAX_DOT1CB_IPV6 512
46 #define OPEN_MIN_DOT1CB_INITIATOR_FLOWS 1
47 #define OPEN_MAX_DOT1CB_INITIATOR_FLOWS 1024
48 #define OPEN_MIN_DOT1CB_TRANSIT_FLOWS 1
49 #define OPEN_MAX_DOT1CB_TRANSIT_FLOWS 1024
50 #define OPEN_MFDB_MAX_MAC_ENTRIES 1024
52 #define OPEN_DOT1CB_IPV4_PREFIX_LEN 32
53 #define OPEN_DOT1CB_IPV6_PREFIX_LEN 128
54 
55 /* 802.1CB flow types */
56 typedef enum
57 {
58  OPEN_DOT1CB_FLOW_TYPE_NONE = 0,
59  OPEN_DOT1CB_FLOW_TYPE_INITIATOR = 1,
60  OPEN_DOT1CB_FLOW_TYPE_TRANSIT = 2,
61 } OPEN_DOT1CB_FLOW_TYPE_t;
62 
63 /* 802.1CB global statistics. These counters are aggregated
64  across all VLANs enabled in the 802.1CB mode.
65 */
66 typedef struct
67 {
68  uint64_t arp_to_cpu;
69  uint64_t bcast_to_cpu;
70  uint64_t mcast_to_cpu;
71  uint64_t ucast_dropped;
72 } OPEN_DOT1CB_GLOBAL_STATS_t;
73 
74 /* 802.1CB statistics on physical ports enabled for R-Tag mode */
75 typedef struct
76 {
77  uint64_t rtag_packets_rx;
78  uint64_t rtag_packets_accepted;
79  uint64_t rtag_packets_dups;
80  uint64_t rtag_packets_tx;
81 } OPEN_DOT1CB_INTF_STATS_t;
82 
83 /*************************************************************************/
101 open_error_t openapiDot1cbModeGet(openapiClientHandle_t *client_handle,
102  uint32_t vlanID, OPEN_CONTROL_t *mode);
103 
104 /*************************************************************************/
122 open_error_t openapiDot1cbModeSet(openapiClientHandle_t *client_handle,
123  uint32_t vlanID, OPEN_CONTROL_t mode);
124 
125 /*************************************************************************/
143 open_error_t openapiDot1cbForwardArpNdpModeGet(openapiClientHandle_t *client_handle,
144  uint32_t vlanID, OPEN_CONTROL_t *mode);
145 
146 /*************************************************************************/
164 open_error_t openapiDot1cbForwardArpNdpModeSet(openapiClientHandle_t *client_handle,
165  uint32_t vlanID, OPEN_CONTROL_t mode);
166 
167 /*************************************************************************/
191 open_error_t openapiFilterFlowIdGet(openapiClientHandle_t *client_handle,
192  open_buffdesc *buf, uint32_t vlanID,
193  uint32_t *flowId);
194 
195 /*************************************************************************/
219 open_error_t openapiFilterFlowTypeGet(openapiClientHandle_t *client_handle,
220  open_buffdesc *buf, uint32_t vlanID,
221  OPEN_DOT1CB_FLOW_TYPE_t *flowType);
222 
223 /*************************************************************************/
248 open_error_t openapiFilterFlowTypeIdSet(openapiClientHandle_t *client_handle,
249  open_buffdesc *buf, uint32_t vlanID,
250  OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId);
251 
252 /*************************************************************************/
268 open_error_t openapiDot1cbRtagModeGet(openapiClientHandle_t *client_handle,
269  uint32_t ifNum, OPEN_CONTROL_t *mode);
270 
271 /*************************************************************************/
287 open_error_t openapiDot1cbRtagModeSet(openapiClientHandle_t *client_handle,
288  uint32_t ifNum, OPEN_CONTROL_t mode);
289 
290 /*************************************************************************/
304 open_error_t openapiDot1cbStatsClear(openapiClientHandle_t *client_handle);
305 
306 /*************************************************************************/
322 open_error_t openapiDot1cbGlobalStatsGet(openapiClientHandle_t *client_handle,
323  OPEN_DOT1CB_GLOBAL_STATS_t *stat);
324 
325 /*************************************************************************/
343 open_error_t openapiDot1cbIntfStatsGet(openapiClientHandle_t *client_handle,
344  uint32_t ifNum, OPEN_DOT1CB_INTF_STATS_t *stat);
345 
346 /*************************************************************************/
363 open_error_t openapiDot1cbIntfNextGet(openapiClientHandle_t *client_handle,
364  uint32_t ifNum, uint32_t *nextIfNum);
365 
366 /*************************************************************************/
388 open_error_t openapiDot1cbIpv4ClassifierAdd(openapiClientHandle_t *client_handle,
389  open_inet_addr_t *srcAddr, uint32_t srcMaskLen,
390  open_inet_addr_t *dstAddr, uint32_t dstMaskLen,
391  OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId);
392 
393 /*************************************************************************/
411 open_error_t openapiDot1cbIpv4ClassifierDelete(openapiClientHandle_t *client_handle,
412  open_inet_addr_t *srcAddr, uint32_t srcMaskLen,
413  open_inet_addr_t *dstAddr, uint32_t dstMaskLen);
414 
415 /*************************************************************************/
435 open_error_t openapiDot1cbIpv4ClassifierGet(openapiClientHandle_t *client_handle,
436  open_inet_addr_t *srcAddr, uint32_t srcMaskLen,
437  open_inet_addr_t *dstAddr, uint32_t dstMaskLen,
438  OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId);
439 
440 /*************************************************************************/
460 open_error_t openapiDot1cbIpv4ClassifierNextGet(openapiClientHandle_t *client_handle,
461  open_inet_addr_t *srcAddr, uint32_t *srcMaskLen,
462  open_inet_addr_t *dstAddr, uint32_t *dstMaskLen,
463  OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId);
464 
465 /*************************************************************************/
479 open_error_t openapiDot1cbIpv4ClassifierCountGet(openapiClientHandle_t *client_handle,
480  uint32_t *value);
481 
482 /*************************************************************************/
496 open_error_t openapiDot1cbIpv4ClassifierInHardwareGet(openapiClientHandle_t *client_handle,
497  uint32_t *value);
498 
499 /*************************************************************************/
522 open_error_t openapiDot1cbIpv6ClassifierAdd(openapiClientHandle_t *client_handle,
523  open_in6_addr_t *srcAddr, uint32_t srcMaskLen,
524  open_in6_addr_t *dstAddr, uint32_t dstMaskLen,
525  OPEN_DOT1CB_FLOW_TYPE_t flowType, uint32_t flowId);
526 
527 /*************************************************************************/
546 open_error_t openapiDot1cbIpv6ClassifierDelete(openapiClientHandle_t *client_handle,
547  open_in6_addr_t *srcAddr, uint32_t srcMaskLen,
548  open_in6_addr_t *dstAddr, uint32_t dstMaskLen);
549 
550 /*************************************************************************/
571 open_error_t openapiDot1cbIpv6ClassifierGet(openapiClientHandle_t *client_handle,
572  open_in6_addr_t *srcAddr, uint32_t srcMaskLen,
573  open_in6_addr_t *dstAddr, uint32_t dstMaskLen,
574  OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId);
575 
576 /*************************************************************************/
597 open_error_t openapiDot1cbIpv6ClassifierNextGet(openapiClientHandle_t *client_handle,
598  open_in6_addr_t *srcAddr, uint32_t *srcMaskLen,
599  open_in6_addr_t *dstAddr, uint32_t *dstMaskLen,
600  OPEN_DOT1CB_FLOW_TYPE_t *flowType, uint32_t *flowId);
601 
602 /*************************************************************************/
617 open_error_t openapiDot1cbIpv6ClassifierCountGet(openapiClientHandle_t *client_handle,
618  uint32_t *value);
619 
620 /*************************************************************************/
635 open_error_t openapiDot1cbIpv6ClassifierInHardwareGet(openapiClientHandle_t *client_handle,
636  uint32_t *value);
637 
638 /*************************************************************************/
652 open_error_t openapiDot1cbNumActiveTransitFlowsGet(openapiClientHandle_t *client_handle,
653  uint32_t *value);
654 
655 /*************************************************************************/
669 open_error_t openapiDot1cbNumActiveInititatorFlowsGet(openapiClientHandle_t *client_handle,
670  uint32_t *value);
671 
672 /*************************************************************************/
686 open_error_t openapiDot1cbNumMfdbClassifiersGet(openapiClientHandle_t *client_handle,
687  uint32_t *value);
688 
689 /*************************************************************************/
703 open_error_t openapiDot1cbApiNumDot1cbVlansGet(openapiClientHandle_t *client_handle,
704  uint32_t *value);
705 
706 /*************************************************************************/
722 open_error_t openapiDot1cbApiDot1cbEnabledVlanNextGet(openapiClientHandle_t *client_handle,
723  uint32_t *vid);
724 
725 /*************************************************************************/
743 open_error_t openapiDot1cbApiInitFlowGet(openapiClientHandle_t *client_handle,
744  uint32_t flowId, uint32_t *classifiers,
745  uint32_t *nextTxSequence, uint64_t *txPackets);
746 
747 /*************************************************************************/
765 open_error_t openapiDot1cbApiInitFlowNextGet(openapiClientHandle_t *client_handle,
766  uint32_t *flowId, uint32_t *classifiers,
767  uint32_t *nextTxSequence, uint64_t *txPackets);
768 
769 /*************************************************************************/
789 open_error_t openapiDot1cbApiTransitFlowGet(openapiClientHandle_t *client_handle,
790  uint32_t flowId, uint32_t *classifiers,
791  uint32_t *lastRxSequence, uint64_t *matchingPackets,
792  uint64_t *acceptedPackets, uint64_t *duplicatePackets);
793 
794 /*************************************************************************/
814 open_error_t openapiDot1cbApiTransitFlowNextGet(openapiClientHandle_t *client_handle,
815  uint32_t *flowId, uint32_t *classifiers,
816  uint32_t *lastRxSequence, uint64_t *matchingPackets,
817  uint64_t *acceptedPackets, uint64_t *duplicatePackets);
818 
819 /*************************************************************************/
837 open_error_t openapiDot1cbApiTransitFlowConfigGet(openapiClientHandle_t *client_handle,
838  uint32_t flowId, uint32_t *historyWindow,
839  uint32_t *acceptanceWindow, uint32_t *ageTime);
840 
841 /*************************************************************************/
857 open_error_t openapiDot1cbApiTransitFlowHistoryWindowSizeSet(openapiClientHandle_t *client_handle,
858  uint32_t flowId, uint32_t historyWindow);
859 
860 /*************************************************************************/
876 open_error_t openapiDot1cbApiTransitFlowAcceptanceWindowSizeSet(openapiClientHandle_t *client_handle,
877  uint32_t flowId, uint32_t acceptanceWindow);
878 
879 /*************************************************************************/
895 open_error_t openapiDot1cbApiTransitFlowAgeTimeSet(openapiClientHandle_t *client_handle,
896  uint32_t flowId, uint32_t ageTime);
897 
898 /*************************************************************************/
912 open_error_t openapiDot1cbSaModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);
913 
914 /*************************************************************************/
929 open_error_t openapiDot1cbSaModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);
930 
931 #endif /* OPENAPI_DOT1CB_H_INCLUDED */
932