Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_if.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2024 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 * Licensed under the Apache License, Version 2.0 (the "License");
26 * you may not use this file except in compliance with the License.
27 * You may obtain a copy of the License at
28 *
29 * http://www.apache.org/licenses/LICENSE-2.0
30 *
31 * Unless required by applicable law or agreed to in writing, software
32 * distributed under the License is distributed on an "AS IS" BASIS,
33 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 * See the License for the specific language governing permissions and
35 * limitations under the License.
36 *
37 **********************************************************************
38 *
39 * @filename openapi_if.h
40 *
41 * @purpose Interface Configuration and Status
42 *
43 * @component OPEN
44 *
45 * @create 10/23/2012
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_IF_H_INCLUDED
51 #define OPENAPI_IF_H_INCLUDED
52 
53 #include "openapi_common.h"
54 
55 typedef enum
56 {
57  OPEN_PHY_CAP_PORTSPEED_HALF_10 = 0x000000001,
58  OPEN_PHY_CAP_PORTSPEED_FULL_10 = 0x000000002,
59  OPEN_PHY_CAP_PORTSPEED_HALF_100 = 0x000000004,
60  OPEN_PHY_CAP_PORTSPEED_FULL_100 = 0x000000008,
61  OPEN_PHY_CAP_PORTSPEED_HALF_1000 = 0x000000010,
62  OPEN_PHY_CAP_PORTSPEED_FULL_1000 = 0x000000020,
63  OPEN_PHY_CAP_PORTSPEED_FULL_2P5G = 0x000000040,
64  OPEN_PHY_CAP_PORTSPEED_FULL_5G = 0x000000080,
65  OPEN_PHY_CAP_PORTSPEED_FULL_10G = 0x000000100,
66  OPEN_PHY_CAP_PORTSPEED_AUTO_NEG = 0x000000400,
67  OPEN_PHY_CAP_PORTSPEED_SFP = 0x000000800,
68  OPEN_PHY_CAP_PORTSPEED_SFP_DETECT = 0x000001000,
69  OPEN_PHY_CAP_POE_PSE = 0x000002000,
70  OPEN_PHY_CAP_POE_PD = 0x000004000,
71  OPEN_PHY_CAP_INTERNAL = 0x000008000, /* Indicates a blade switch internal port */
72  OPEN_PHY_CAP_NATIVE_EEE = 0x000010000,
73  OPEN_PHY_CAP_AUTO_EEE = 0x000020000,
74  OPEN_PHY_CAP_DUAL_MODE_SUPPORT = 0x000040000, /* Used represent PHYs where phy/port capabilities change
75  dynamically(ex: SFP support in 10G fiber port, Combo port where two phys
76  are used one for fiber, one for copper)*/
77  OPEN_PHY_CAP_POE_PSE_PLUS = 0x000080000,
78  OPEN_PHY_CAP_POE_PD_PLUS = 0x000100000,
79  OPEN_PHY_CAP_ENERGY_DETECT = 0x000200000,
80  OPEN_PHY_CAP_COMBO_PREFERENCE = 0x000400000, /* If the port is a combo port *and* the preferred media can be configured. */
81  OPEN_PHY_CAP_EXPANDABLE_PORT = 0x000800000,
82  OPEN_PHY_CAP_AUTO_CONFIG = 0x001000000,
83  OPEN_PHY_CAP_SHORT_REACH = 0x002000000,
84  OPEN_PHY_CAP_UPOE_PSE = 0x004000000, /* UPOE capability bits */
85  OPEN_PHY_CAP_UPOE_PD = 0x008000000,
86  OPEN_PHY_CAP_DYNAMIC_PORT = 0x010000000, /* This should be used instead of DUAL_MODE */
87  OPEN_PHY_CAP_FIXED_STACK_PORT = 0x020000000,
88 
89  OPEN_PHY_CAP_FEC_SUPPORT = 0x040000000,
90  OPEN_PHY_CAP_PORTSPEED_FULL_20G = 0x080000000,
91  OPEN_PHY_CAP_PORTSPEED_FULL_25G = 0x081000000,
92  OPEN_PHY_CAP_PORTSPEED_FULL_40G = 0x082000000,
93  OPEN_PHY_CAP_PORTSPEED_FULL_50G = 0x084000000,
94  OPEN_PHY_CAP_PORTSPEED_FULL_100G = 0x088000000,
95 /* Add support for 64-Bit. Commenting for now, to be fixed by UI team. overlapping values need to removed
96  pls check commdefs.h
97  OPEN_PHY_CAP_PORTSPEED_FULL_25G = 0x100000000ULL,
98  OPEN_PHY_CAP_PORTSPEED_FULL_40G = 0x200000000ULL,
99  OPEN_PHY_CAP_PORTSPEED_FULL_50G = 0x400000000ULL,
100  OPEN_PHY_CAP_PORTSPEED_FULL_100G = 0x800000000ULL,
101  OPEN_PHY_CAP_PORTSPEED_FULL_200G = 0x1000000000ULL,
102  OPEN_PHY_CAP_PORTSPEED_FULL_400G = 0x2000000000ULL,
103 */
104  /* Add new caps below */
105 
106 } OPEN_PHY_CAPABILITIES_t;
107 
109 typedef enum
110 {
111  OPEN_PORTCTRL_PORTSPEED_AUTO_NEG = 1,
112  OPEN_PORTCTRL_PORTSPEED_HALF_100TX = 2,
113  OPEN_PORTCTRL_PORTSPEED_FULL_100TX = 3,
114  OPEN_PORTCTRL_PORTSPEED_HALF_10T = 4,
115  OPEN_PORTCTRL_PORTSPEED_FULL_10T = 5,
116  OPEN_PORTCTRL_PORTSPEED_FULL_100FX = 6,
117  OPEN_PORTCTRL_PORTSPEED_FULL_1000SX = 7,
118  OPEN_PORTCTRL_PORTSPEED_FULL_10GSX = 8,
119  OPEN_PORTCTRL_PORTSPEED_FULL_20GSX = 9,
120  OPEN_PORTCTRL_PORTSPEED_FULL_40GSX = 10,
121  OPEN_PORTCTRL_PORTSPEED_FULL_25GSX = 11,
122  OPEN_PORTCTRL_PORTSPEED_FULL_50GSX = 12,
123  OPEN_PORTCTRL_PORTSPEED_FULL_100GSX = 13,
124  OPEN_PORTCTRL_PORTSPEED_AAL5_155 = 14,
125  OPEN_PORTCTRL_PORTSPEED_FULL_5FX = 15,
126  OPEN_PORTCTRL_PORTSPEED_FULL_200GSX = 16,
127  OPEN_PORTCTRL_PORTSPEED_FULL_400GSX = 17,
128  OPEN_PORTCTRL_PORTSPEED_FULL_2P5FX = 128, /* Speed 2.5G FD, Bit 7th set */
129  OPEN_PORTCTRL_PORTSPEED_LAG = 129,
130  OPEN_PORTCTRL_PORTSPEED_UNKNOWN = 130
131 } OPEN_PORT_SPEEDS_t;
132 
135 typedef enum
136 {
137  OPEN_DISABLE_REASON_NONE = 1,
138  OPEN_DISABLE_REASON_UDLD = 2,
139  OPEN_DISABLE_REASON_STP = 3,
140  OPEN_DISABLE_REASON_BPDUGUARD = 4,
141  OPEN_DISABLE_REASON_BPDUSTORM = 5,
142  OPEN_DISABLE_REASON_DHCPSNOOPING = 6,
143  OPEN_DISABLE_REASON_ARPINSPECTION = 7,
144  OPEN_DISABLE_REASON_STORMCONTROL_BCAST = 8,
145  OPEN_DISABLE_REASON_STORMCONTROL_MCAST = 9,
146  OPEN_DISABLE_REASON_STORMCONTROL_UCAST = 10,
147  OPEN_DISABLE_REASON_XCEIVER = 11,
148  OPEN_DISABLE_REASON_XCEIVERPLUS = 12,
149  OPEN_DISABLE_REASON_LOOPPROTECT = 13,
150  OPEN_DISABLE_REASON_PML = 14,
151  OPEN_DISABLE_REASON_DOS = 15,
152  OPEN_DISABLE_REASON_LINK_FLAP = 16,
153  OPEN_DISABLE_REASON_AUTHMGR_AUTH_VIOLATION = 17,
154  OPEN_DISABLE_REASON_COA = 18
155 } OPEN_DISABLE_REASON_t;
156 
159 typedef enum
160 {
161  OPEN_PORT_CABLE_MEDIA_TYPE_NONE = 0,
162  OPEN_PORT_CABLE_MEDIA_TYPE_COPPER = 1,
163  OPEN_PORT_CABLE_MEDIA_TYPE_FIBER = 2,
164 } OPEN_PORT_CABLE_MEDIA_TYPE_t;
165 
169 typedef enum
170 {
171  OPEN_SPECIAL_PORT_TYPE_NORMAL = 1,
172  OPEN_SPECIAL_PORT_TYPE_TRUNK_MEMBER = 2,
173  OPEN_SPECIAL_PORT_TYPE_MIRRORED_PORT = 3,
174  OPEN_SPECIAL_PORT_TYPE_PROBE_PORT = 4,
175  OPEN_SPECIAL_PORT_TYPE_L2TUNNEL_PORT = 5,
176  OPEN_SPECIAL_PORT_TYPE_SERVICE_PORT = 6
177 } OPEN_SPECIAL_PORT_TYPE_t;
178 
180 typedef enum
181 {
182  OPEN_PORT_DUPLEX_HALF = 0,
183  OPEN_PORT_DUPLEX_FULL = 1,
184  OPEN_PORT_DUPLEX_UNKNOWN = 0xffff
185 
186 } OPEN_PORT_DUPLEX_t;
187 
189 typedef enum
190 {
191  OPEN_PORT_AUTO_NEG_ENABLE = 0,
192  OPEN_PORT_AUTO_NEG_DISABLE = 1,
193  OPEN_PORT_AUTO_NEG_UNKNOWN = 0xffff
194 
195 } OPEN_PORT_AUTO_NEG_t;
196 
198 typedef enum
199 {
200  OPEN_INTF_STATUS_NONE = 0,
201  OPEN_INTF_STATUS_ATTACHED = 1,
202 } OPEN_INTF_STATUS_t;
203 
204 typedef enum
205 {
206  OPEN_EXPANDABLE_PORTMODE_NONE,
207  OPEN_EXPANDABLE_PORTMODE_SINGLE_10G,
208  OPEN_EXPANDABLE_PORTMODE_SINGLE_25G,
209  OPEN_EXPANDABLE_PORTMODE_DUAL_50G,
210  OPEN_EXPANDABLE_PORTMODE_QUAD_40G,
211  OPEN_EXPANDABLE_PORTMODE_QUAD_100G,
212  OPEN_EXPANDABLE_PORTMODE_ROOT_DUAL_50G,
213  OPEN_EXPANDABLE_PORTMODE_DUAL_25G,
214  OPEN_EXPANDABLE_PORTMODE_8x10G,
215  OPEN_EXPANDABLE_PORTMODE_8x25G,
216  OPEN_EXPANDABLE_PORTMODE_8x50G,
217  OPEN_EXPANDABLE_PORTMODE_4x100G,
218  OPEN_EXPANDABLE_PORTMODE_2x100G,
219  OPEN_EXPANDABLE_PORTMODE_2x200G,
220  OPEN_EXPANDABLE_PORTMODE_1x400G,
221  OPEN_EXPANDABLE_PORTMODE_LAST,
222  OPEN_EXPANDABLE_PORTMODE_INVALID
223 } OPEN_EXPANDABLE_PORTMODE_t;
224 
226 typedef enum
227 {
228  OPEN_PORT_FEC_DISABLE ,
229  OPEN_PORT_FEC_ENABLE ,
230  OPEN_PORT_FEC_AUTO ,
231  OPEN_PORT_FEC_BASE_R ,
232  OPEN_PORT_FEC_RS_FEC ,
233  OPEN_PORT_FEC_RS_544 ,
234  OPEN_PORT_FEC_RS_272 ,
235  OPEN_PORT_FEC_RS_206 ,
236  OPEN_PORT_FEC_RS_108 ,
237  OPEN_PORT_FEC_RS_545 ,
238  OPEN_PORT_FEC_RS_304 ,
239  OPEN_PORT_FEC_RS_544_2xN ,
240  OPEN_PORT_FEC_RS_272_2xN ,
241  OPEN_PORT_FEC_NOFEC_50G ,
242  OPEN_PORT_FEC_NOT_AVAILABLE,
243  OPEN_PORT_FEC_LAST
244 } OPEN_PORT_FEC_MODE_t;
245 
246 #define OPENAPI_INTERFACE_NAME_LENGTH 60
247 #define OPENAPI_INTERFACE_LIST_MAX_LENGTH 256
248 
249 /******************************************************************************/
264 open_error_t openapiIfSpeedGet (openapiClientHandle_t * client_handle,
265  uint32_t ifNum, OPEN_PORT_SPEEDS_t * speed);
266 
267 /*****************************************************************/
283 open_error_t openapiIfSpeedSet (openapiClientHandle_t * client_handle,
284  uint32_t ifNum, OPEN_PORT_SPEEDS_t speed);
285 
286 
287 /*****************************************************************/
304 open_error_t openapiIfDuplexModeGet (openapiClientHandle_t * client_handle,
305  uint32_t ifNum, OPEN_PORT_DUPLEX_t * duplex_mode);
306 
307 /*****************************************************************/
321 open_error_t openapiIfAutoNegGet (openapiClientHandle_t * client_handle,
322  uint32_t ifNum, OPEN_PORT_AUTO_NEG_t * autoneg);
323 
324 /*****************************************************************/
341 open_error_t openapiIfAutoNegSet (openapiClientHandle_t * client_handle,
342  uint32_t ifNum, uint32_t autoneg);
343 
344 /*****************************************************************/
358 open_error_t openapiIfEthernetHeaderSizeGet(openapiClientHandle_t *client_handle,
359  uint32_t ifNum, uint32_t *headerSize);
360 
361 /*****************************************************************/
375 open_error_t openapiIfMtuSizeGet (openapiClientHandle_t * client_handle,
376  uint32_t ifNum, uint32_t * mtu_size);
377 
378 /*****************************************************************/
399 open_error_t openapiIfMtuSizeSet (openapiClientHandle_t * client_handle,
400  uint32_t ifNum, uint32_t mtu_size);
401 
402 /*****************************************************************/
423 open_error_t openapiIfMtuSizeSetV2(openapiClientHandle_t *client_handle,
424  uint32_t ifNum,
425  uint32_t mtu_size);
426 
427 /*****************************************************************/
447 open_error_t openapiIfMaxFrameSizeSet(openapiClientHandle_t *client_handle,
448  uint32_t ifNum, uint32_t maxFrameSize);
449 
450 /*****************************************************************/
464 open_error_t openapiIfMaxFrameSizeGet(openapiClientHandle_t *client_handle,
465  uint32_t ifNum, uint32_t *maxFrameSize);
466 
467 /*****************************************************************************************/
487 open_error_t openapiIfSoftShutdownStateGet (openapiClientHandle_t *
488  client_handle, uint32_t ifNum,
489  OPEN_CONTROL_t * soft_shut);
490 
491 /************************************************************************************/
512 open_error_t openapiIfSoftShutdownStateSet (openapiClientHandle_t *
513  client_handle, uint32_t ifNum,
514  OPEN_CONTROL_t soft_shut);
515 
516 /*****************************************************************/
530 open_error_t openapiIfMacAddrSizeGet (openapiClientHandle_t * client_handle,
531  uint32_t ifNum, uint32_t * size);
532 
533 
534 /*****************************************************************/
550 open_error_t openapiIfMacAddrGet (openapiClientHandle_t * client_handle,
551  uint32_t ifNum, open_buffdesc * mac_addr);
552 
553 /*****************************************************************/
567 open_error_t openapiIfDescrSizeGet (openapiClientHandle_t * client_handle,
568  uint32_t ifNum, uint32_t* size);
569 
570 
571 /*****************************************************************/
586 open_error_t openapiIfDescrGet (openapiClientHandle_t * client_handle,
587  uint32_t ifNum, open_buffdesc * descrip);
588 
589 /*****************************************************************/
606 open_error_t openapiIfDescrSet (openapiClientHandle_t * client_handle,
607  uint32_t ifNum, open_buffdesc * descrip);
608 
609 /*****************************************************************/
625 open_error_t openapiIfAdminStateSet(openapiClientHandle_t *client_handle,
626  uint32_t ifNum,
627  OPEN_CONTROL_t adminState);
628 
629 /*****************************************************************/
644 open_error_t openapiIfFirstGet(openapiClientHandle_t *client_handle,
645  OPEN_INTF_TYPE_t ifType,
646  uint32_t *firstIfNum);
647 
648 /*****************************************************************/
667 open_error_t openapiIfNextGet(openapiClientHandle_t *client_handle,
668  OPEN_INTF_TYPE_t ifType,
669  uint32_t ifNum,
670  uint32_t *nextIfNum);
671 
672 /*****************************************************************/
689 open_error_t openapiIfStatusGet(openapiClientHandle_t *client_handle,
690  uint32_t ifNum,
691  OPEN_INTF_STATUS_t *ifStatus);
692 
693 /*****************************************************************/
707 open_error_t openapiIfLinkStateGet(openapiClientHandle_t *client_handle,
708  uint32_t ifNum,
709  OPEN_LINK_STATE_t *linkState);
710 
711 /*****************************************************************/
725 open_error_t openapiIfAdminStateGet(openapiClientHandle_t *client_handle,
726  uint32_t ifNum,
727  OPEN_CONTROL_t *adminState);
728 
729 /*****************************************************************/
745 open_error_t openapiIfNameGet(openapiClientHandle_t *client_handle,
746  uint32_t intf,
747  open_buffdesc *intfName);
748 
749 /*****************************************************************/
764 open_error_t openapiIfNumGet (openapiClientHandle_t * client_handle,
765  open_buffdesc *intfName, uint32_t *ifNum );
766 
767 /*****************************************************************/
784 open_error_t openapiIfNextChangedGet(openapiClientHandle_t *client_handle,
785  uint32_t ifNum,
786  uint32_t *nextIfNum,
787  uint32_t *delete_pending);
788 
789 /*****************************************************************/
804 open_error_t openapiIfTypeGet(openapiClientHandle_t * client_handle,
805  uint32_t ifNum,
806  OPEN_INTF_TYPE_t *ifType);
807 
808 /*****************************************************************/
822 open_error_t openapiIfLastChangeGet(openapiClientHandle_t *client_handle,
823  uint32_t interface, uint32_t *value);
824 
825 /*****************************************************************/
840 open_error_t openapiIfInOctetsGet(openapiClientHandle_t *client_handle,
841  uint32_t interface, uint32_t *value);
842 
843 /*****************************************************************/
861 open_error_t openapiIfInUcastPktsGet(openapiClientHandle_t *client_handle,
862  uint32_t interface, uint32_t *value);
863 
864 /*****************************************************************/
881 open_error_t openapiIfInDiscardsGet(openapiClientHandle_t *client_handle,
882  uint32_t interface, uint32_t *value);
883 
884 /*****************************************************************/
898 open_error_t openapiIfInErrorsGet(openapiClientHandle_t *client_handle,
899  uint32_t interface, uint32_t *value);
900 
901 /*****************************************************************/
916 open_error_t openapiIfInUnknownProtosGet(openapiClientHandle_t *client_handle,
917  uint32_t interface, uint32_t *value);
918 
919 /*****************************************************************/
934 open_error_t openapiIfOutOctetsGet(openapiClientHandle_t *client_handle,
935  uint32_t interface, uint32_t *value);
936 
937 /*****************************************************************/
958 open_error_t openapiIfOutUcastPktsGet(openapiClientHandle_t *client_handle,
959  uint32_t interface, uint32_t *value);
960 
961 /*****************************************************************/
979 open_error_t openapiIfOutDiscardsGet(openapiClientHandle_t *client_handle,
980  uint32_t interface, uint32_t *value);
981 
982 /*****************************************************************/
997 open_error_t openapiIfOutErrorsGet(openapiClientHandle_t *client_handle,
998  uint32_t interface, uint32_t *value);
999 
1000 /******************************************************************************/
1016 open_error_t openapiIfSpeedModeGet(openapiClientHandle_t *client_handle,
1017  uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed);
1018 
1019 
1020 /*****************************************************************/
1037 open_error_t openapiIfDuplexGet(openapiClientHandle_t *client_handle,
1038  uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode);
1039 
1040 /*****************************************************************/
1057 open_error_t openapiIfCapabilitiesGet(openapiClientHandle_t * client_handle,
1058  uint32_t ifNum, uint64_t *portCapability);
1059 
1060 /*****************************************************************/
1076 open_error_t openapiIfDisableReasonGet(openapiClientHandle_t *client_handle,
1077  uint32_t ifNum,
1078  OPEN_DISABLE_REASON_t *reason);
1079 
1080 /*****************************************************************/
1099 open_error_t openapiIfExpPortRootPortGet(openapiClientHandle_t *client_handle,
1100  uint32_t ifNum,
1101  uint32_t *rootSlot,
1102  uint32_t *rootPort);
1103 
1104 /*****************************************************************/
1121 open_error_t openapiIfExpPortOperModeLaneCountGet(openapiClientHandle_t *client_handle,
1122  uint32_t ifNum,
1123  uint32_t *laneCount);
1124 
1125 /*****************************************************************/
1142 open_error_t openapiIfExpPortFirstPeerGet(openapiClientHandle_t *client_handle,
1143  uint32_t ifNum,
1144  uint32_t *peerIfNum);
1145 
1146 /*****************************************************************/
1163 open_error_t openapiIfPortSpeedLaneCountGet(openapiClientHandle_t *client_handle,
1164  uint32_t ifNum,
1165  uint32_t *laneCount);
1166 
1167 /*****************************************************************/
1194 open_error_t openapiIfActiveMediaTypeGet(openapiClientHandle_t *client_handle,
1195  uint32_t ifNum,
1196  OPEN_PORT_CABLE_MEDIA_TYPE_t *mediaType);
1197 
1198 /*****************************************************************/
1224 open_error_t openapiIfPauseStatusGet(openapiClientHandle_t *client_handle,
1225  uint32_t ifNum,
1226  OPEN_BOOL_t *rxPauseAllowed,
1227  OPEN_BOOL_t *txPauseAllowed);
1228 
1229 /*****************************************************************/
1251 open_error_t openapiIfSpecialPortTypeGet(openapiClientHandle_t *client_handle,
1252  uint32_t ifNum,
1253  OPEN_SPECIAL_PORT_TYPE_t *specialType);
1254 
1255 /*****************************************************************/
1272 open_error_t openapiIfOprStateGet(openapiClientHandle_t *client_handle,
1273  uint32_t ifNum,
1274  OPEN_PORT_STATE_t *val);
1275 
1276 /*************************************************************************/
1291 open_error_t openapiConfigIdMaskOffsetGet(openapiClientHandle_t *client_handle,
1292  uint32_t interface,
1293  uint32_t *maskOffset);
1294 
1295 /*************************************************************************/
1311 open_error_t openapiusmDbIfIndexGet(openapiClientHandle_t *client_handle,
1312  uint32_t interface, uint32_t *ifIndex);
1313 
1314 /*************************************************************************/
1331 open_error_t openapiIfActiveStateGet(openapiClientHandle_t *client_handle,
1332  uint32_t interface,
1333  uint32_t *intfActiveState);
1334 
1335 /*************************************************************************/
1353 open_error_t openapiIfLinkTrapGet(openapiClientHandle_t *client_handle,
1354  uint32_t ifNum,
1355  OPEN_CONTROL_t *mode);
1356 
1357 /*************************************************************************/
1377 open_error_t openapiIfLinkTrapSet(openapiClientHandle_t *client_handle,
1378  uint32_t ifNum,
1379  OPEN_CONTROL_t mode);
1380 
1381 /*************************************************************************/
1400 open_error_t openapiIntfExpandablePortNextGet(openapiClientHandle_t *client_handle,
1401  uint32_t prevIfNum,
1402  uint32_t *nextIfNum);
1403 
1404 /*****************************************************************/
1422 open_error_t openapiIntfExpandablePortModeSupportedGet(openapiClientHandle_t *client_handle,
1423  OPEN_EXPANDABLE_PORTMODE_t expandPortMode,
1424  OPEN_BOOL_t *isExpandedModeSupported);
1425 
1426 /*****************************************************************/
1446 open_error_t openapiIntfExpandablePortModeSet(openapiClientHandle_t *client_handle,
1447  uint32_t ifNum,
1448  OPEN_EXPANDABLE_PORTMODE_t expandPortMode);
1449 
1450 /*****************************************************************/
1469 open_error_t openapiIntfExpandablePortConfigModeGet(openapiClientHandle_t *client_handle,
1470  uint32_t ifNum,
1471  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode);
1472 
1473 /*****************************************************************/
1492 open_error_t openapiIntfExpandablePortOperModeGet(openapiClientHandle_t *client_handle,
1493  uint32_t ifNum,
1494  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode);
1495 
1496 /*****************************************************************/
1518 open_error_t openapiIntfExpandableModePeersGetByModeGet(openapiClientHandle_t *client_handle,
1519  uint32_t ifNum,
1520  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode,
1521  open_buffdesc *peerIntfs,
1522  uint32_t *peerCount);
1523 
1524 /*****************************************************************/
1544 open_error_t openapiIntfFECModeSet(openapiClientHandle_t *client_handle,
1545  uint32_t ifNum,
1546  OPEN_PORT_FEC_MODE_t fecMode);
1547 
1548 /*****************************************************************/
1569 open_error_t openapiIntfFECModeGet(openapiClientHandle_t *client_handle,
1570  uint32_t ifNum,
1571  OPEN_PORT_FEC_MODE_t *fecConfigMode,
1572  OPEN_PORT_FEC_MODE_t *fecOperMode);
1573 #endif /* OPENAPI_IF_H_INCLUDED */
1574 
OPEN_PORT_FEC_RS_544_2xN
Rs544, using 2xN RS FEC architecture.
Definition: openapi_if.h:239
OPEN_PORT_SPEEDS_t
OPEN_PORT_SPEEDS_t
OpEN port speed enum values.
Definition: openapi_if.h:109
OPEN_EXPANDABLE_PORTMODE_QUAD_100G
Quad lane 100g ports.
Definition: openapi_if.h:211
openapiIfAdminStateSet
open_error_t openapiIfAdminStateSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t adminState)
Sets the administrative state for the specified interface.
openapiIfOutOctetsGet
open_error_t openapiIfOutOctetsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The total number of octets transmitted out of the interface, including framing characters.
openapiIntfExpandablePortNextGet
open_error_t openapiIntfExpandablePortNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *nextIfNum)
Get the next valid expandable interface.
OPEN_INTF_STATUS_t
OPEN_INTF_STATUS_t
OPEN uses these enumerators to indicate the interface status.
Definition: openapi_if.h:198
OPEN_SPECIAL_PORT_TYPE_t
OPEN_SPECIAL_PORT_TYPE_t
OPEN uses these enumerators to indicate a port that is currently being used for a special purpose...
Definition: openapi_if.h:169
openapiIfPauseStatusGet
open_error_t openapiIfPauseStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *rxPauseAllowed, OPEN_BOOL_t *txPauseAllowed)
Get the negotiated Rx and Tx pause status of a given interface.
openapiIfInOctetsGet
open_error_t openapiIfInOctetsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
Gets the total number of octets received on the interface including framing characters.
OPEN_PORT_FEC_AUTO
For AN cases.
Definition: openapi_if.h:230
openapiIfSpeedGet
open_error_t openapiIfSpeedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed)
Gets the speed status of a given interface.
openapiIfSoftShutdownStateGet
open_error_t openapiIfSoftShutdownStateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *soft_shut)
Gets the Soft-shutdown status of a given interface.
openapiIfNumGet
open_error_t openapiIfNumGet(openapiClientHandle_t *client_handle, open_buffdesc *intfName, uint32_t *ifNum)
Gets the interface number given the displayable name for the interface.
openapiIfInUcastPktsGet
open_error_t openapiIfInUcastPktsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The number of packets, delivered by this sub-layer to a higher sub-layer.
openapiIfMtuSizeSet
open_error_t openapiIfMtuSizeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t mtu_size)
Sets the MTU size of a given interface.
openapiIfLinkTrapSet
open_error_t openapiIfLinkTrapSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
Sets the link trap configuration of specified interface.
OPEN_EXPANDABLE_PORTMODE_2x200G
Quad lane 200g ports.
Definition: openapi_if.h:219
openapiIfOutErrorsGet
open_error_t openapiIfOutErrorsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
For packet-oriented interfaces, the number of outbound packets that could not be transmitted because ...
OPEN_EXPANDABLE_PORTMODE_t
OPEN_EXPANDABLE_PORTMODE_t
Definition: openapi_if.h:204
openapiIfMacAddrSizeGet
open_error_t openapiIfMacAddrSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *size)
Gets the MAC address size of a given interface.
OPEN_PORT_FEC_NOT_AVAILABLE
FEC is supported but not status is not available.
Definition: openapi_if.h:242
OPEN_PORT_FEC_RS_108
Rs108.
Definition: openapi_if.h:236
openapiIntfFECModeSet
open_error_t openapiIntfFECModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_FEC_MODE_t fecMode)
Set the FEC mode on the specifed interface number.
OPEN_PORT_CABLE_MEDIA_TYPE_t
OPEN_PORT_CABLE_MEDIA_TYPE_t
OPEN uses these enumerators to indicate the interface active media type.
Definition: openapi_if.h:159
openapiIntfExpandablePortOperModeGet
open_error_t openapiIntfExpandablePortOperModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_EXPANDABLE_PORTMODE_t *expandPortMode)
Get the running expandable port blocks based on interface number.
openapiIntfFECModeGet
open_error_t openapiIntfFECModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_FEC_MODE_t *fecConfigMode, OPEN_PORT_FEC_MODE_t *fecOperMode)
Get the FEC configured and operational modes on the specifed interface number.
openapiIntfExpandablePortModeSet
open_error_t openapiIntfExpandablePortModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_EXPANDABLE_PORTMODE_t expandPortMode)
Set the configured expandable port mode on the specifed interface number.
OPEN_INTF_STATUS_NONE
Interface not attached.
Definition: openapi_if.h:200
openapiIfAutoNegSet
open_error_t openapiIfAutoNegSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t autoneg)
Sets the auto-negotiation mode of a given interface.
openapiIfEthernetHeaderSizeGet
open_error_t openapiIfEthernetHeaderSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *headerSize)
Gets the ethernet header size of a given interface.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiIfAutoNegGet
open_error_t openapiIfAutoNegGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_AUTO_NEG_t *autoneg)
Gets the auto-negotiation mode of a given interface.
openapiIfDescrGet
open_error_t openapiIfDescrGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *descrip)
Gets the Description of a given interface.
openapiIfPortSpeedLaneCountGet
open_error_t openapiIfPortSpeedLaneCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *laneCount)
Determine the number of lanes running under this port based on the running speed of this port...
openapiIfDuplexModeGet
open_error_t openapiIfDuplexModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode)
Gets the duplex mode of a given interface.
OPEN_PORT_FEC_RS_272_2xN
Rs272, using 2xN RS FEC architecture.
Definition: openapi_if.h:240
openapiusmDbIfIndexGet
open_error_t openapiusmDbIfIndexGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *ifIndex)
Returns the interface index associated with the internal interface number.
OPEN_PORT_FEC_RS_544
Rs544, using 1xN RS FEC architecture.
Definition: openapi_if.h:233
openapiIfOutDiscardsGet
open_error_t openapiIfOutDiscardsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The number of outbound packets which were chosen to be discarded.
openapiIfNextChangedGet
open_error_t openapiIfNextChangedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum, uint32_t *delete_pending)
Gets the next interface which has a pending change or a pending deletion.
OPEN_INTF_TYPE_t
OPEN_INTF_TYPE_t
Definition: openapi_common.h:201
openapiIfDescrSizeGet
open_error_t openapiIfDescrSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *size)
Gets the Description size of a given interface.
openapiIfDisableReasonGet
open_error_t openapiIfDisableReasonGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DISABLE_REASON_t *reason)
Gets the disable reason code for an interface.
open_buffdesc
Definition: openapi_common.h:138
OPEN_EXPANDABLE_PORTMODE_8x50G
Single lane 50G ports.
Definition: openapi_if.h:216
OPEN_DISABLE_REASON_t
OPEN_DISABLE_REASON_t
OPEN uses these enumerators to indicate the reason a port is diagnostically disabled.
Definition: openapi_if.h:135
openapiClientHandle_s
Definition: openapi_common.h:131
openapiIfInDiscardsGet
open_error_t openapiIfInDiscardsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The number of inbound packets which were chosen to be discarded.
openapiIfLinkTrapGet
open_error_t openapiIfLinkTrapGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Gets the link trap configuration of specified interface.
OPEN_PORT_FEC_ENABLE
FEC enabled.
Definition: openapi_if.h:229
OPEN_EXPANDABLE_PORTMODE_SINGLE_25G
Single lane ports 25G.
Definition: openapi_if.h:208
OPEN_EXPANDABLE_PORTMODE_ROOT_DUAL_50G
Single 50GB port with dual lane.
Definition: openapi_if.h:212
OPEN_EXPANDABLE_PORTMODE_DUAL_50G
Dual lane ports 50G.
Definition: openapi_if.h:209
OPEN_PORT_FEC_RS_272
Rs272, using 1xN RS FEC architecture.
Definition: openapi_if.h:234
openapiIfExpPortFirstPeerGet
open_error_t openapiIfExpPortFirstPeerGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *peerIfNum)
Get the interface number of the port's first and presumably the smallest peer interface.
openapiIfInUnknownProtosGet
open_error_t openapiIfInUnknownProtosGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The number of packets received via the interface which were discarded because of an unknown or unsupp...
OPEN_PORT_STATE_t
OPEN_PORT_STATE_t
OPEN uses these enumerators to indicate port admin mode enable, disable or diag_disable.
Definition: openapi_common.h:170
openapiIfMaxFrameSizeGet
open_error_t openapiIfMaxFrameSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *maxFrameSize)
Gets the Maximum frame size of a given interface.
OPEN_EXPANDABLE_PORTMODE_DUAL_25G
Dual 25GB ports.
Definition: openapi_if.h:213
openapiIfDescrSet
open_error_t openapiIfDescrSet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *descrip)
Sets the Description of a given interface.
openapiIfSpeedModeGet
open_error_t openapiIfSpeedModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed)
Gets the speed mode of a given interface.
openapiIfNextGet
open_error_t openapiIfNextGet(openapiClientHandle_t *client_handle, OPEN_INTF_TYPE_t ifType, uint32_t ifNum, uint32_t *nextIfNum)
Gets the interface identifier for the first interface of the specified interface type that has the ne...
OPEN_EXPANDABLE_PORTMODE_QUAD_40G
Quad lane 40g ports.
Definition: openapi_if.h:210
OPEN_EXPANDABLE_PORTMODE_1x400G
Octalane 400g ports.
Definition: openapi_if.h:220
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:163
openapiIntfExpandablePortModeSupportedGet
open_error_t openapiIntfExpandablePortModeSupportedGet(openapiClientHandle_t *client_handle, OPEN_EXPANDABLE_PORTMODE_t expandPortMode, OPEN_BOOL_t *isExpandedModeSupported)
Check if the expandable port mode is supported.
openapiIfMtuSizeGet
open_error_t openapiIfMtuSizeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *mtu_size)
Gets the MTU size of a given interface.
openapiIfSoftShutdownStateSet
open_error_t openapiIfSoftShutdownStateSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t soft_shut)
Sets the Soft-shutdown status of a given interface.
OPEN_PORT_AUTO_NEG_t
OPEN_PORT_AUTO_NEG_t
OpEN port auto neg enum values.
Definition: openapi_if.h:189
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
OPEN_EXPANDABLE_PORTMODE_8x10G
Single lane 10G ports.
Definition: openapi_if.h:214
openapiConfigIdMaskOffsetGet
open_error_t openapiConfigIdMaskOffsetGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *maskOffset)
Get the Configuration Mask Offset.
openapiIfActiveStateGet
open_error_t openapiIfActiveStateGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *intfActiveState)
Gets the active state of the specified interface.
OPEN_INTF_STATUS_ATTACHED
Interface in attached state.
Definition: openapi_if.h:201
OPEN_PORT_FEC_BASE_R
CL74/Base-R.
Definition: openapi_if.h:231
openapiIfAdminStateGet
open_error_t openapiIfAdminStateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminState)
Gets the administrative state for the specified interface.
openapiIfNameGet
open_error_t openapiIfNameGet(openapiClientHandle_t *client_handle, uint32_t intf, open_buffdesc *intfName)
Gets the displayable name for the specified interface.
OPEN_PORT_FEC_MODE_t
OPEN_PORT_FEC_MODE_t
Definition: openapi_if.h:226
OPEN_EXPANDABLE_PORTMODE_NONE
None.
Definition: openapi_if.h:206
openapiIntfExpandablePortConfigModeGet
open_error_t openapiIntfExpandablePortConfigModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_EXPANDABLE_PORTMODE_t *expandPortMode)
Get the configured expandable port mode on the specifed interface number.
openapiIfMtuSizeSetV2
open_error_t openapiIfMtuSizeSetV2(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t mtu_size)
Sets the MTU size of a given interface.
OPEN_PORT_FEC_NOFEC_50G
support FEC disable on 50G port.
Definition: openapi_if.h:241
openapiIfInErrorsGet
open_error_t openapiIfInErrorsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
Returns the current value of the errors counter.
openapiIfTypeGet
open_error_t openapiIfTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_TYPE_t *ifType)
Gets the interface type associated with the internal interface number.
openapi_common.h
openapiIfCapabilitiesGet
open_error_t openapiIfCapabilitiesGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint64_t *portCapability)
Gets the capabilities of a given interface.
openapiIfOprStateGet
open_error_t openapiIfOprStateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_STATE_t *val)
Gets the operational status of a given interface.
openapiIfActiveMediaTypeGet
open_error_t openapiIfActiveMediaTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_CABLE_MEDIA_TYPE_t *mediaType)
Get the active media type for a given interface.
openapiIfLinkStateGet
open_error_t openapiIfLinkStateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *linkState)
Gets the link state for the specified interface.
openapiIfLastChangeGet
open_error_t openapiIfLastChangeGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
Gets the time of last link state change in seconds.
openapiIfSpecialPortTypeGet
open_error_t openapiIfSpecialPortTypeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_SPECIAL_PORT_TYPE_t *specialType)
Get the special port type designation of a given interface.
OPEN_PORT_FEC_DISABLE
FEC disabled.
Definition: openapi_if.h:228
openapiIfDuplexGet
open_error_t openapiIfDuplexGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode)
Gets the duplex status of a given interface.
OPEN_EXPANDABLE_PORTMODE_INVALID
Invalid port mode.
Definition: openapi_if.h:222
OPEN_EXPANDABLE_PORTMODE_4x100G
Quad lane 100g ports.
Definition: openapi_if.h:217
OPEN_EXPANDABLE_PORTMODE_2x100G
Dual lane 100g ports.
Definition: openapi_if.h:218
OPEN_EXPANDABLE_PORTMODE_SINGLE_10G
Single lane ports 10G.
Definition: openapi_if.h:207
OPEN_PORT_DUPLEX_t
OPEN_PORT_DUPLEX_t
OpEN port duplex enum values.
Definition: openapi_if.h:180
OPEN_PORT_FEC_RS_545
Rs545.
Definition: openapi_if.h:237
openapiIntfExpandableModePeersGetByModeGet
open_error_t openapiIntfExpandableModePeersGetByModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_EXPANDABLE_PORTMODE_t *expandPortMode, open_buffdesc *peerIntfs, uint32_t *peerCount)
Get the peer ports and peer port count for a given interface.
OPEN_LINK_STATE_t
OPEN_LINK_STATE_t
OPEN uses these enumerators to indicate the link status.
Definition: openapi_common.h:186
openapiIfStatusGet
open_error_t openapiIfStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_STATUS_t *ifStatus)
Gets the status of the specified interface.
OPEN_EXPANDABLE_PORTMODE_8x25G
Single lane 25G ports.
Definition: openapi_if.h:215
openapiIfOutUcastPktsGet
open_error_t openapiIfOutUcastPktsGet(openapiClientHandle_t *client_handle, uint32_t interface, uint32_t *value)
The total number of packets that higher-level protocols requested be transmitted. ...
openapiIfFirstGet
open_error_t openapiIfFirstGet(openapiClientHandle_t *client_handle, OPEN_INTF_TYPE_t ifType, uint32_t *firstIfNum)
Gets the interface identifier for the first interface of the specified interface type.
openapiIfMacAddrGet
open_error_t openapiIfMacAddrGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *mac_addr)
Gets the MAC address of a given interface.
OPEN_PORT_FEC_RS_FEC
CL91/RS-FEC.
Definition: openapi_if.h:232
OPEN_PORT_FEC_RS_304
Rs304.
Definition: openapi_if.h:238
openapiIfExpPortOperModeLaneCountGet
open_error_t openapiIfExpPortOperModeLaneCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *laneCount)
Determine the number of lanes running under this port based on the operating mode of this port...
OPEN_PORT_FEC_RS_206
Rs206.
Definition: openapi_if.h:235
openapiIfMaxFrameSizeSet
open_error_t openapiIfMaxFrameSizeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t maxFrameSize)
Sets the Maximum frame size of a given interface.
openapiIfExpPortRootPortGet
open_error_t openapiIfExpPortRootPortGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rootSlot, uint32_t *rootPort)
Translate internal interface number into root slot and port.
openapiIfSpeedSet
open_error_t openapiIfSpeedSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PORT_SPEEDS_t speed)
Sets the speed of a given interface.