Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_dot1s.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 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_dot1s.h
28 *
29 * @purpose Spanning Tree Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 10/25/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DOT1S_H_INCLUDED
39 #define OPENAPI_DOT1S_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 typedef enum
44 {
45  OPEN_DOT1S_FORCE_VERSION_DOT1D = 0,
46  OPEN_DOT1S_FORCE_VERSION_UNUSED = 1,
47  OPEN_DOT1S_FORCE_VERSION_DOT1W = 2,
48  OPEN_DOT1S_FORCE_VERSION_DOT1S = 3,
49  OPEN_DOT1S_FORCE_VERSION_LAST
50 }OPEN_DOT1S_FORCE_VERSION_t;
51 
52 typedef enum
53 {
54  OPEN_DOT1S_PORT_GUARD_LOOP = 0,
55  OPEN_DOT1S_PORT_GUARD_ROOT = 1,
56  OPEN_DOT1S_PORT_GUARD_NONE = 2
57 }OPEN_DOT1S_PORT_GUARD_t;
58 
59 typedef enum
60 {
61  OPEN_DOT1S_MGMT_STR_CONFIG_NAME = 0
62 }OPEN_DOT1S_MGMT_STR_t;
63 
64 typedef enum
65 {
66  OPEN_DOT1S_PORT_DISCARDING = 1,
67  OPEN_DOT1S_PORT_LEARNING = 2,
68  OPEN_DOT1S_PORT_FORWARDING = 3,
69  OPEN_DOT1S_PORT_DISABLED = 4,
70  OPEN_DOT1S_PORT_MANUAL_FWD = 5,
71  OPEN_DOT1S_PORT_NOT_PARTICIPATE = 6
72 }OPEN_DOT1S_PORT_FWD_STATE_t;
73 
74 typedef enum
75 {
76  OPEN_DOT1S_ROLE_DISABLED = 0,
77  OPEN_DOT1S_ROLE_ROOT = 1,
78  OPEN_DOT1S_ROLE_DESIGNATED = 2,
79  OPEN_DOT1S_ROLE_ALTERNATE = 3,
80  OPEN_DOT1S_ROLE_BACKUP = 4,
81  OPEN_DOT1S_ROLE_MASTER = 5
83 }OPEN_DOT1S_PORT_ROLE_t;
84 
85 #define OPENAPI_DOT1S_CST_ID 0
86 #define OPENAPI_DOT1S_MSTID_MAX 4094
87 
88 #define OPEN_DOT1S_VLAN_ID_LEN 2
89 #define OPEN_DOT1S_MAC_ID_LEN OPEN_MAC_ADDR_LEN
90 #define OPEN_DOT1S_VID_MAC_ADDR_LEN (OPEN_DOT1S_VLAN_ID_LEN + OPEN_DOT1S_MAC_ID_LEN)
91 
96 typedef struct
97 {
98  uint8_t octets[OPEN_DOT1S_VID_MAC_ADDR_LEN];
99 } OPEN_DOT1S_BRIDGEID_t;
100 
101 
102 /*****************************************************************/
118 open_error_t openapiDot1sMgmtStrLenGet(openapiClientHandle_t *client_handle,
119  OPEN_DOT1S_MGMT_STR_t strType,
120  uint32_t *strLen);
121 
122 /*****************************************************************/
135 open_error_t openapiDot1VlanMaxGet(openapiClientHandle_t *client_handle,
136  uint32_t *vlanMax);
137 
138 /*****************************************************************/
154 open_error_t openapiDot1SModeSet(openapiClientHandle_t *client_handle,
155  OPEN_CONTROL_t dot1sMode);
156 
157 /*****************************************************************/
172 open_error_t openapiDot1SModeGet(openapiClientHandle_t *client_handle,
173  OPEN_CONTROL_t *dot1sMode);
174 
175 /*****************************************************************/
192 open_error_t openapiDot1SIntfBPDUFilterModeSet(openapiClientHandle_t *client_handle,
193  uint32_t ifNum,
194  OPEN_CONTROL_t dot1sBPDUFilterMode);
195 
196 /*****************************************************************/
212 open_error_t openapiDot1SIntfBPDUFilterModeGet(openapiClientHandle_t *client_handle,
213  uint32_t ifNum,
214  OPEN_CONTROL_t *dot1sBPDUFilterMode);
215 
216 /*****************************************************************/
233 open_error_t openapiDot1SIntfBPDUFloodModeSet(openapiClientHandle_t *client_handle,
234  uint32_t ifNum,
235  OPEN_CONTROL_t dot1sBPDUFloodMode);
236 
237 /*****************************************************************/
253 open_error_t openapiDot1SIntfBPDUFloodModeGet(openapiClientHandle_t *client_handle,
254  uint32_t ifNum,
255  OPEN_CONTROL_t *dot1sBPDUFloodMode);
256 
257 /*****************************************************************/
272 open_error_t openapiDot1SBPDUGuardModeSet(openapiClientHandle_t *client_handle,
273  OPEN_CONTROL_t dot1sBPDUGuard);
274 
275 /*****************************************************************/
289 open_error_t openapiDot1SBPDUGuardModeGet(openapiClientHandle_t *client_handle,
290  OPEN_CONTROL_t *dot1sBPDUGuard);
291 
292 /*****************************************************************/
307 open_error_t openapiDot1SBPDUFilterModeSet(openapiClientHandle_t *client_handle,
308  OPEN_CONTROL_t dot1sBPDUFilter);
309 
310 /*****************************************************************/
324 open_error_t openapiDot1SBPDUFilterModeGet(openapiClientHandle_t *client_handle,
325  OPEN_CONTROL_t *dot1sBPDUFilter);
326 
327 /*****************************************************************/
345 open_error_t openapiDot1SConfigNameSet(openapiClientHandle_t *client_handle,
346  open_buffdesc *dot1sConfigName);
347 
348 /*****************************************************************/
364 open_error_t openapiDot1SConfigNameGet(openapiClientHandle_t *client_handle,
365  open_buffdesc *dot1sConfigName);
366 
367 /*****************************************************************/
384 open_error_t openapiDot1SConfigRevisionSet(openapiClientHandle_t *client_handle,
385  uint32_t dot1sConfigRev);
386 
387 /*****************************************************************/
401 open_error_t openapiDot1SConfigRevisionGet(openapiClientHandle_t *client_handle,
402  uint32_t *dot1sConfigRev);
403 
404 /*****************************************************************/
419 open_error_t openapiDot1SForceVersionSet(openapiClientHandle_t *client_handle,
420  OPEN_DOT1S_FORCE_VERSION_t dot1sForceVersion);
421 
422 /*****************************************************************/
436 open_error_t openapiDot1SForceVersionGet(openapiClientHandle_t *client_handle,
437  OPEN_DOT1S_FORCE_VERSION_t *dot1sForceVersion);
438 
439 /*****************************************************************/
455 open_error_t openapiDot1SIntfGuardModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum,
456  OPEN_DOT1S_PORT_GUARD_t dot1sGuardMode);
457 
458 /*****************************************************************/
474 open_error_t openapiDot1SIntfGuardModeGet(openapiClientHandle_t *client_handle,
475  uint32_t ifNum,
476  OPEN_DOT1S_PORT_GUARD_t *dot1sGuardMode);
477 
478 /*****************************************************************/
496 open_error_t openapiDot1SMSTInstanceSet(openapiClientHandle_t *client_handle,
497  uint32_t dot1sMSTInstanceId,
498  OPEN_ACTION_t action);
499 
500 /*****************************************************************/
514 open_error_t openapiDot1SMSTInstanceFirstGet(openapiClientHandle_t *client_handle,
515  uint32_t *instanceId);
516 
517 /*****************************************************************/
532 open_error_t openapiDot1SMSTInstanceNextGet(openapiClientHandle_t *client_handle,
533  uint32_t currInstance,
534  uint32_t *nextInstance);
535 
536 /*****************************************************************/
556 open_error_t openapiDot1SMSTInstancePrioritySet(openapiClientHandle_t *client_handle,
557  uint32_t dot1sMSTInstance,
558  uint32_t priority);
559 
560 /*****************************************************************/
575 open_error_t openapiDot1SMSTInstancePriorityGet(openapiClientHandle_t *client_handle,
576  uint32_t dot1sMSTInstance,
577  uint16_t *priority);
578 
579 /*****************************************************************/
600 open_error_t openapiDot1SMSTInstanceVLANSet(openapiClientHandle_t *client_handle,
601  uint32_t dot1sMSTInstance,
602  uint32_t vlan,
603  OPEN_ACTION_t action);
604 /*****************************************************************/
619 open_error_t openapiDot1SMSTInstanceFirstVLANGet(openapiClientHandle_t *client_handle,
620  uint32_t dot1sInstance,
621  uint32_t *VLANId);
622 
623 /*****************************************************************/
639 open_error_t openapiDot1SMSTInstanceNextVLANGet(openapiClientHandle_t *client_handle,
640  uint32_t dot1sInstance,
641  uint32_t currVLANId, uint32_t *nextVLANId);
642 
643 /*****************************************************************/
658 open_error_t openapiDot1SMSTInstanceFirstFIdGet(openapiClientHandle_t *client_handle,
659  uint32_t dot1sInstance,
660  uint32_t *FId);
661 
662 /*****************************************************************/
678 open_error_t openapiDot1SMSTInstanceNextFIdGet(openapiClientHandle_t *client_handle,
679  uint32_t dot1sInstance,
680  uint32_t currFId, uint32_t *nextFId);
681 
682 /*************************************************************************/
701 open_error_t openapiDot1sMSTInstanceBridgeIdentifierGet(openapiClientHandle_t *client_handle,
702  uint32_t dot1sMSTInstance,
703  OPEN_DOT1S_BRIDGEID_t *id);
704 
705 /*************************************************************************/
724 open_error_t openapiDot1sMSTInstanceTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle,
725  uint32_t dot1sMSTInstance,
726  uint32_t *timeVal);
727 
728 /*************************************************************************/
747 open_error_t openapiDot1sMSTInstanceTopologyChangeCountGet(openapiClientHandle_t *client_handle,
748  uint32_t mstId,
749  uint32_t *count);
750 
751 /*************************************************************************/
771 open_error_t openapiDot1sMSTInstanceTopologyChangeStateGet(openapiClientHandle_t *client_handle,
772  uint32_t dot1sMSTInstance,
773  OPEN_BOOL_t *change);
774 
775 /*************************************************************************/
794 open_error_t openapiDot1sMSTInstanceDesignatedRootIDGet(openapiClientHandle_t *client_handle,
795  uint32_t dot1sMSTInstance,
796  OPEN_DOT1S_BRIDGEID_t *rootId);
797 
798 /*************************************************************************/
817 open_error_t openapiDot1sMSTInstanceRootPathCostGet(openapiClientHandle_t *client_handle,
818  uint32_t dot1sMSTInstance,
819  uint32_t *cost);
820 
821 /*************************************************************************/
840 open_error_t openapiDot1sMSTInstanceRootPortIDGet(openapiClientHandle_t *client_handle,
841  uint32_t dot1sMSTInstance,
842  uint32_t *port);
843 
844 /*************************************************************************/
858 open_error_t openapiDot1sCISTMaxAgeGet(openapiClientHandle_t *client_handle,
859  uint32_t *age);
860 
861 /*************************************************************************/
875 open_error_t openapiDot1sBridgeMaxHopGet(openapiClientHandle_t *client_handle,
876  uint32_t *count);
877 
878 /*************************************************************************/
892 open_error_t openapiDot1sBridgeTxHoldCountGet(openapiClientHandle_t *client_handle,
893  uint32_t *count);
894 
895 /*************************************************************************/
909 open_error_t openapiDot1sCISTRootFwdDelayGet(openapiClientHandle_t *client_handle,
910  uint32_t *delay);
911 
912 /*************************************************************************/
927 open_error_t openapiDot1sCISTHelloTimeGet(openapiClientHandle_t *client_handle,
928  uint32_t ifNum,
929  uint32_t *helloTime);
930 
931 /*************************************************************************/
945 open_error_t openapiDot1sCISTBridgeHoldTimeGet(openapiClientHandle_t *client_handle,
946  uint32_t *holdTime);
947 
948 /*************************************************************************/
962 open_error_t openapiDot1sCISTRegionalRootIDGet(openapiClientHandle_t *client_handle,
963  OPEN_DOT1S_BRIDGEID_t *rootId);
964 
965 /*************************************************************************/
979 open_error_t openapiDot1sCISTRegionalRootPathCostGet(openapiClientHandle_t *client_handle,
980  uint32_t *cost);
981 
982 /*****************************************************************/
998 open_error_t openapiDot1SIntfModeSet(openapiClientHandle_t *client_handle,
999  uint32_t ifNum,
1000  OPEN_CONTROL_t dot1sMode);
1001 
1002 /*****************************************************************/
1018 open_error_t openapiDot1SIntfModeGet(openapiClientHandle_t *client_handle,
1019  uint32_t ifNum,
1020  OPEN_CONTROL_t *dot1sMode);
1021 
1022 /*****************************************************************/
1038 open_error_t openapiDot1SIntfPortFwdStateGet(openapiClientHandle_t *client_handle,
1039  uint32_t ifNum,
1040  uint32_t dot1sInstance,
1041  OPEN_DOT1S_PORT_FWD_STATE_t *dot1sPortFwdState);
1042 
1043 /*****************************************************************/
1059 open_error_t openapiDot1SIntfPortRoleGet(openapiClientHandle_t *client_handle,
1060  uint32_t ifNum,
1061  uint32_t dot1sInstance,
1062  OPEN_DOT1S_PORT_ROLE_t *dot1sPortRole);
1063 
1064 /*****************************************************************/
1081 open_error_t openapiDot1SIntfPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1082  uint32_t ifNum,
1083  uint32_t dot1sInstance,
1084  OPEN_BOOL_t *loopInconsistentState);
1085 
1086 /*****************************************************************/
1102 open_error_t openapiDot1SIntfEdgePortModeSet(openapiClientHandle_t *client_handle,
1103  uint32_t ifNum,
1104  OPEN_CONTROL_t dot1sEdgePortMode);
1105 
1106 /*****************************************************************/
1123 open_error_t openapiDot1SIntfEdgePortModeGet(openapiClientHandle_t *client_handle,
1124  uint32_t ifNum,
1125  uint32_t *dot1sEdgePortMode);
1126 
1127 /*****************************************************************/
1143 open_error_t openapiDot1SIntfHelloTimeGet(openapiClientHandle_t *client_handle,
1144  uint32_t ifNum,
1145  uint32_t *helloTime);
1146 
1147 /*****************************************************************/
1163 open_error_t openapiDot1SIntfBPDUGuardEffectGet(openapiClientHandle_t *client_handle,
1164  uint32_t ifNum,
1165  OPEN_CONTROL_t *mode);
1166 
1167 /*****************************************************************/
1186 open_error_t openapiDot1SMSTIntfPortIDGet(openapiClientHandle_t *client_handle,
1187  uint32_t dot1sMSTInstance,
1188  uint32_t ifNum,
1189  open_buffdesc *portID);
1190 
1191 /*****************************************************************/
1209 open_error_t openapiDot1SMstiPortPrioritySet(openapiClientHandle_t *client_handle,
1210  uint32_t dot1sMSTInstance,
1211  uint32_t ifNum,
1212  uint32_t priority);
1213 
1214 /*****************************************************************/
1232 open_error_t openapiDot1SMstiPortPriorityGet(openapiClientHandle_t *client_handle,
1233  uint32_t dot1sMSTInstance,
1234  uint32_t ifNum,
1235  uint32_t *priority);
1236 
1237 /*****************************************************************/
1255 open_error_t openapiDot1SMstiPortPathCostModeGet(openapiClientHandle_t *client_handle,
1256  uint32_t dot1sMSTInstance,
1257  uint32_t ifNum,
1258  OPEN_CONTROL_t *costMode);
1259 
1260 /*****************************************************************/
1278 open_error_t openapiDot1SMstiPortPathCostSet(openapiClientHandle_t *client_handle,
1279  uint32_t dot1sMSTInstance,
1280  uint32_t ifNum,
1281  uint32_t pCost);
1282 
1283 /*****************************************************************/
1301 open_error_t openapiDot1SMstiOperPortPathCostGet(openapiClientHandle_t *client_handle,
1302  uint32_t dot1sMSTInstance,
1303  uint32_t ifNum,
1304  uint32_t *portCost);
1305 
1306 /*****************************************************************/
1321 open_error_t openapiDot1SCistExtPortPathCostModeGet(openapiClientHandle_t *client_handle,
1322  uint32_t ifNum,
1323  OPEN_CONTROL_t *costMode);
1324 
1325 /*****************************************************************/
1340 open_error_t openapiDot1SCistExtPortPathCostGet(openapiClientHandle_t *client_handle,
1341  uint32_t ifNum,
1342  uint32_t *portCost);
1343 
1344 /*****************************************************************/
1359 open_error_t openapiDot1SCistExtPortPathCostSet(openapiClientHandle_t *client_handle,
1360  uint32_t ifNum,
1361  uint32_t portCost);
1362 
1363 /*****************************************************************/
1380 open_error_t openapiDot1SMstiPortDesignatedRootIDGet(openapiClientHandle_t *client_handle,
1381  uint32_t dot1sMSTInstance,
1382  uint32_t ifNum,
1383  open_buffdesc *rootID);
1384 
1385 /*****************************************************************/
1402 open_error_t openapiDot1SMstiDesignatedCostGet(openapiClientHandle_t *client_handle,
1403  uint32_t dot1sMSTInstance,
1404  uint32_t ifNum,
1405  uint32_t *dCost);
1406 
1407 /*****************************************************************/
1424 open_error_t openapiDot1SMstiDesignatedBridgeIDGet(openapiClientHandle_t *client_handle,
1425  uint32_t dot1sMSTInstance,
1426  uint32_t ifNum,
1427  open_buffdesc *bridgeID);
1428 
1429 /*****************************************************************/
1446 open_error_t openapiDot1SMstiDesignatedPortIDGet(openapiClientHandle_t *client_handle,
1447  uint32_t dot1sMSTInstance,
1448  uint32_t ifNum,
1449  open_buffdesc *portID);
1450 
1451 /*****************************************************************/
1467 open_error_t openapiDot1SCistPortTopologyChangeAckGet(openapiClientHandle_t *client_handle,
1468  uint32_t ifNum,
1469  OPEN_BOOL_t *val);
1470 
1471 /*****************************************************************/
1485 open_error_t openapiDot1SCistHelloTimeGet(openapiClientHandle_t *client_handle,
1486  uint32_t *helloTime);
1487 
1488 /*****************************************************************/
1504 open_error_t openapiDot1SCistPortOperEdgeGet(openapiClientHandle_t *client_handle,
1505  uint32_t ifNum,
1506  OPEN_BOOL_t *status);
1507 
1508 /*****************************************************************/
1525 open_error_t openapiDot1SCistPortOperPointToPointGet(openapiClientHandle_t *client_handle,
1526  uint32_t ifNum,
1527  OPEN_BOOL_t *status);
1528 
1529 /*****************************************************************/
1544 open_error_t openapiDot1SCistPortRegionalRootIDGet(openapiClientHandle_t *client_handle,
1545  uint32_t ifNum,
1546  open_buffdesc *bridgeID);
1547 
1548 /*****************************************************************/
1563 open_error_t openapiDot1SCistPortPathCostGet(openapiClientHandle_t *client_handle,
1564  uint32_t ifNum,
1565  uint32_t *portCost);
1566 
1567 /*****************************************************************/
1583 open_error_t openapiDot1SMstiPortLoopInconsistentStateGet(openapiClientHandle_t *client_handle,
1584  uint32_t dot1sMSTInstance,
1585  uint32_t ifNum,
1586  OPEN_BOOL_t *status);
1587 
1588 /*****************************************************************/
1605 open_error_t
1606 openapiDot1SPortStatsTransitionsIntoLoopInconsistentStateGet(
1607  openapiClientHandle_t *client_handle,
1608  uint32_t dot1sMSTInstance,
1609  uint32_t ifNum,
1610  uint32_t *loopCount);
1611 
1612 /*****************************************************************/
1629 open_error_t
1630 openapiDot1SPortStatsTransitionsOutOfLoopInconsistentStateGet(
1631  openapiClientHandle_t *client_handle,
1632  uint32_t dot1sMSTInstance,
1633  uint32_t ifNum,
1634  uint32_t *loopCount);
1635 
1636 /*****************************************************************/
1650 open_error_t openapiDot1SPortStatsClear(openapiClientHandle_t *client_handle,
1651  uint32_t ifNum);
1652 
1653 /*****************************************************************/
1669 open_error_t openapiDot1SPortRestrictedTcnGet(openapiClientHandle_t *client_handle,
1670  uint32_t ifNum,
1671  OPEN_BOOL_t *mode);
1672 
1673 /*****************************************************************/
1689 open_error_t openapiDot1SPortRestrictedTcnSet(openapiClientHandle_t *client_handle,
1690  uint32_t ifNum,
1691  OPEN_BOOL_t val);
1692 
1693 /*****************************************************************/
1709 open_error_t openapiDot1SPortAutoEdgeGet(openapiClientHandle_t *client_handle,
1710  uint32_t ifNum,
1711  OPEN_BOOL_t *mode);
1712 
1713 /*****************************************************************/
1729 open_error_t openapiDot1SPortAutoEdgeSet(openapiClientHandle_t *client_handle,
1730  uint32_t ifNum,
1731  OPEN_BOOL_t mode);
1732 
1733 /*****************************************************************/
1748 open_error_t openapiDot1SPortUpTimeGet(openapiClientHandle_t *client_handle,
1749  uint32_t ifNum,
1750  open_buffdesc *upTime);
1751 
1752 /*****************************************************************/
1767 open_error_t openapiDot1SPortStatsSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1768  uint32_t ifNum,
1769  uint32_t *val);
1770 
1771 /*****************************************************************/
1786 open_error_t openapiDot1SPortStatsSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1787  uint32_t ifNum,
1788  uint32_t *val);
1789 
1790 /*****************************************************************/
1805 open_error_t openapiDot1SPortStatsRSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1806  uint32_t ifNum,
1807  uint32_t *val);
1808 
1809 /*****************************************************************/
1824 open_error_t openapiDot1SPortStatsRSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1825  uint32_t ifNum,
1826  uint32_t *val);
1827 
1828 /*****************************************************************/
1843 open_error_t openapiDot1SPortStatsMSTPBPDUsSentGet(openapiClientHandle_t *client_handle,
1844  uint32_t ifNum,
1845  uint32_t *val);
1846 
1847 /*****************************************************************/
1862 open_error_t openapiDot1SPortStatsMSTPBPDUsReceivedGet(openapiClientHandle_t *client_handle,
1863  uint32_t ifNum,
1864  uint32_t *val);
1865 
1866 #endif /* OPENAPI_DOT1S_H_INCLUDED */
1867