Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
openapi_if.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2023 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 
108 typedef enum
109 {
110  OPEN_PORTCTRL_PORTSPEED_AUTO_NEG = 1,
111  OPEN_PORTCTRL_PORTSPEED_HALF_100TX = 2,
112  OPEN_PORTCTRL_PORTSPEED_FULL_100TX = 3,
113  OPEN_PORTCTRL_PORTSPEED_HALF_10T = 4,
114  OPEN_PORTCTRL_PORTSPEED_FULL_10T = 5,
115  OPEN_PORTCTRL_PORTSPEED_FULL_100FX = 6,
116  OPEN_PORTCTRL_PORTSPEED_FULL_1000SX = 7,
117  OPEN_PORTCTRL_PORTSPEED_FULL_10GSX = 8,
118  OPEN_PORTCTRL_PORTSPEED_FULL_20GSX = 9,
119  OPEN_PORTCTRL_PORTSPEED_FULL_40GSX = 10,
120  OPEN_PORTCTRL_PORTSPEED_FULL_25GSX = 11,
121  OPEN_PORTCTRL_PORTSPEED_FULL_50GSX = 12,
122  OPEN_PORTCTRL_PORTSPEED_FULL_100GSX = 13,
123  OPEN_PORTCTRL_PORTSPEED_AAL5_155 = 14,
124  OPEN_PORTCTRL_PORTSPEED_FULL_5FX = 15,
125  OPEN_PORTCTRL_PORTSPEED_FULL_200GSX = 16,
126  OPEN_PORTCTRL_PORTSPEED_FULL_400GSX = 17,
127  OPEN_PORTCTRL_PORTSPEED_FULL_2P5FX = 128, /* Speed 2.5G FD, Bit 7th set */
128  OPEN_PORTCTRL_PORTSPEED_LAG = 129,
129  OPEN_PORTCTRL_PORTSPEED_UNKNOWN = 130
130 } OPEN_PORT_SPEEDS_t;
131 
134 typedef enum
135 {
136  OPEN_DISABLE_REASON_NONE = 1,
137  OPEN_DISABLE_REASON_UDLD = 2,
138  OPEN_DISABLE_REASON_STP = 3,
139  OPEN_DISABLE_REASON_BPDUGUARD = 4,
140  OPEN_DISABLE_REASON_BPDUSTORM = 5,
141  OPEN_DISABLE_REASON_DHCPSNOOPING = 6,
142  OPEN_DISABLE_REASON_ARPINSPECTION = 7,
143  OPEN_DISABLE_REASON_STORMCONTROL_BCAST = 8,
144  OPEN_DISABLE_REASON_STORMCONTROL_MCAST = 9,
145  OPEN_DISABLE_REASON_STORMCONTROL_UCAST = 10,
146  OPEN_DISABLE_REASON_XCEIVER = 11,
147  OPEN_DISABLE_REASON_XCEIVERPLUS = 12,
148  OPEN_DISABLE_REASON_LOOPPROTECT = 13,
149  OPEN_DISABLE_REASON_PML = 14,
150  OPEN_DISABLE_REASON_DOS = 15,
151  OPEN_DISABLE_REASON_LINK_FLAP = 16,
152  OPEN_DISABLE_REASON_AUTHMGR_AUTH_VIOLATION = 17,
153  OPEN_DISABLE_REASON_COA = 18
154 } OPEN_DISABLE_REASON_t;
155 
158 typedef enum
159 {
160  OPEN_PORT_CABLE_MEDIA_TYPE_NONE = 0,
161  OPEN_PORT_CABLE_MEDIA_TYPE_COPPER = 1,
162  OPEN_PORT_CABLE_MEDIA_TYPE_FIBER = 2,
163 } OPEN_PORT_CABLE_MEDIA_TYPE_t;
164 
168 typedef enum
169 {
170  OPEN_SPECIAL_PORT_TYPE_NORMAL = 1,
171  OPEN_SPECIAL_PORT_TYPE_TRUNK_MEMBER = 2,
172  OPEN_SPECIAL_PORT_TYPE_MIRRORED_PORT = 3,
173  OPEN_SPECIAL_PORT_TYPE_PROBE_PORT = 4,
174  OPEN_SPECIAL_PORT_TYPE_L2TUNNEL_PORT = 5,
175  OPEN_SPECIAL_PORT_TYPE_SERVICE_PORT = 6
176 } OPEN_SPECIAL_PORT_TYPE_t;
177 
178 typedef enum
179 {
180  OPEN_PORT_DUPLEX_HALF = 0,
181  OPEN_PORT_DUPLEX_FULL = 1,
182  OPEN_PORT_DUPLEX_UNKNOWN = 0xffff
183 
184 } OPEN_PORT_DUPLEX_t;
185 
186 typedef enum
187 {
188  OPEN_PORT_AUTO_NEG_ENABLE = 0,
189  OPEN_PORT_AUTO_NEG_DISABLE = 1,
190  OPEN_PORT_AUTO_NEG_UNKNOWN = 0xffff
191 
192 } OPEN_PORT_AUTO_NEG_t;
193 
195 typedef enum
196 {
197  OPEN_INTF_STATUS_NONE = 0,
198  OPEN_INTF_STATUS_ATTACHED = 1,
199 } OPEN_INTF_STATUS_t;
200 
201 typedef enum
202 {
203  OPEN_EXPANDABLE_PORTMODE_NONE,
204  OPEN_EXPANDABLE_PORTMODE_SINGLE_10G,
205  OPEN_EXPANDABLE_PORTMODE_SINGLE_25G,
206  OPEN_EXPANDABLE_PORTMODE_DUAL_50G,
207  OPEN_EXPANDABLE_PORTMODE_QUAD_40G,
208  OPEN_EXPANDABLE_PORTMODE_QUAD_100G,
209  OPEN_EXPANDABLE_PORTMODE_ROOT_DUAL_50G,
210  OPEN_EXPANDABLE_PORTMODE_DUAL_25G,
211  OPEN_EXPANDABLE_PORTMODE_8x10G,
212  OPEN_EXPANDABLE_PORTMODE_8x25G,
213  OPEN_EXPANDABLE_PORTMODE_8x50G,
214  OPEN_EXPANDABLE_PORTMODE_4x100G,
215  OPEN_EXPANDABLE_PORTMODE_2x100G,
216  OPEN_EXPANDABLE_PORTMODE_2x200G,
217  OPEN_EXPANDABLE_PORTMODE_1x400G,
218  OPEN_EXPANDABLE_PORTMODE_LAST,
219  OPEN_EXPANDABLE_PORTMODE_INVALID
220 } OPEN_EXPANDABLE_PORTMODE_t;
221 
223 typedef enum
224 {
225  OPEN_PORT_FEC_DISABLE ,
226  OPEN_PORT_FEC_ENABLE ,
227  OPEN_PORT_FEC_AUTO ,
228  OPEN_PORT_FEC_BASE_R ,
229  OPEN_PORT_FEC_RS_FEC ,
230  OPEN_PORT_FEC_RS_544 ,
231  OPEN_PORT_FEC_RS_272 ,
232  OPEN_PORT_FEC_RS_206 ,
233  OPEN_PORT_FEC_RS_108 ,
234  OPEN_PORT_FEC_RS_545 ,
235  OPEN_PORT_FEC_RS_304 ,
236  OPEN_PORT_FEC_RS_544_2xN ,
237  OPEN_PORT_FEC_RS_272_2xN ,
238  OPEN_PORT_FEC_NOFEC_50G ,
239  OPEN_PORT_FEC_NOT_AVAILABLE,
240  OPEN_PORT_FEC_LAST
241 } OPEN_PORT_FEC_MODE_t;
242 
243 #define OPENAPI_INTERFACE_NAME_LENGTH 60
244 #define OPENAPI_INTERFACE_LIST_MAX_LENGTH 256
245 
246 /******************************************************************************/
261 open_error_t openapiIfSpeedGet (openapiClientHandle_t * client_handle,
262  uint32_t ifNum, OPEN_PORT_SPEEDS_t * speed);
263 
264 /*****************************************************************/
280 open_error_t openapiIfSpeedSet (openapiClientHandle_t * client_handle,
281  uint32_t ifNum, OPEN_PORT_SPEEDS_t speed);
282 
283 
284 /*****************************************************************/
301 open_error_t openapiIfDuplexModeGet (openapiClientHandle_t * client_handle,
302  uint32_t ifNum, OPEN_PORT_DUPLEX_t * duplex_mode);
303 
304 /*****************************************************************/
318 open_error_t openapiIfAutoNegGet (openapiClientHandle_t * client_handle,
319  uint32_t ifNum, OPEN_PORT_AUTO_NEG_t * autoneg);
320 
321 /*****************************************************************/
338 open_error_t openapiIfAutoNegSet (openapiClientHandle_t * client_handle,
339  uint32_t ifNum, uint32_t autoneg);
340 
341 /*****************************************************************/
355 open_error_t openapiIfEthernetHeaderSizeGet(openapiClientHandle_t *client_handle,
356  uint32_t ifNum, uint32_t *headerSize);
357 
358 /*****************************************************************/
372 open_error_t openapiIfMtuSizeGet (openapiClientHandle_t * client_handle,
373  uint32_t ifNum, uint32_t * mtu_size);
374 
375 /*****************************************************************/
396 open_error_t openapiIfMtuSizeSet (openapiClientHandle_t * client_handle,
397  uint32_t ifNum, uint32_t mtu_size);
398 
399 /*****************************************************************/
420 open_error_t openapiIfMtuSizeSetV2(openapiClientHandle_t *client_handle,
421  uint32_t ifNum,
422  uint32_t mtu_size);
423 
424 /*****************************************************************/
444 open_error_t openapiIfMaxFrameSizeSet(openapiClientHandle_t *client_handle,
445  uint32_t ifNum, uint32_t maxFrameSize);
446 
447 /*****************************************************************/
461 open_error_t openapiIfMaxFrameSizeGet(openapiClientHandle_t *client_handle,
462  uint32_t ifNum, uint32_t *maxFrameSize);
463 
464 /*****************************************************************************************/
484 open_error_t openapiIfSoftShutdownStateGet (openapiClientHandle_t *
485  client_handle, uint32_t ifNum,
486  OPEN_CONTROL_t * soft_shut);
487 
488 /************************************************************************************/
509 open_error_t openapiIfSoftShutdownStateSet (openapiClientHandle_t *
510  client_handle, uint32_t ifNum,
511  OPEN_CONTROL_t soft_shut);
512 
513 /*****************************************************************/
527 open_error_t openapiIfMacAddrSizeGet (openapiClientHandle_t * client_handle,
528  uint32_t ifNum, uint32_t * size);
529 
530 
531 /*****************************************************************/
547 open_error_t openapiIfMacAddrGet (openapiClientHandle_t * client_handle,
548  uint32_t ifNum, open_buffdesc * mac_addr);
549 
550 /*****************************************************************/
564 open_error_t openapiIfDescrSizeGet (openapiClientHandle_t * client_handle,
565  uint32_t ifNum, uint32_t* size);
566 
567 
568 /*****************************************************************/
583 open_error_t openapiIfDescrGet (openapiClientHandle_t * client_handle,
584  uint32_t ifNum, open_buffdesc * descrip);
585 
586 /*****************************************************************/
603 open_error_t openapiIfDescrSet (openapiClientHandle_t * client_handle,
604  uint32_t ifNum, open_buffdesc * descrip);
605 
606 /*****************************************************************/
622 open_error_t openapiIfAdminStateSet(openapiClientHandle_t *client_handle,
623  uint32_t ifNum,
624  OPEN_CONTROL_t adminState);
625 
626 /*****************************************************************/
641 open_error_t openapiIfFirstGet(openapiClientHandle_t *client_handle,
642  OPEN_INTF_TYPE_t ifType,
643  uint32_t *firstIfNum);
644 
645 /*****************************************************************/
664 open_error_t openapiIfNextGet(openapiClientHandle_t *client_handle,
665  OPEN_INTF_TYPE_t ifType,
666  uint32_t ifNum,
667  uint32_t *nextIfNum);
668 
669 /*****************************************************************/
686 open_error_t openapiIfStatusGet(openapiClientHandle_t *client_handle,
687  uint32_t ifNum,
688  OPEN_INTF_STATUS_t *ifStatus);
689 
690 /*****************************************************************/
704 open_error_t openapiIfLinkStateGet(openapiClientHandle_t *client_handle,
705  uint32_t ifNum,
706  OPEN_LINK_STATE_t *linkState);
707 
708 /*****************************************************************/
722 open_error_t openapiIfAdminStateGet(openapiClientHandle_t *client_handle,
723  uint32_t ifNum,
724  OPEN_CONTROL_t *adminState);
725 
726 /*****************************************************************/
742 open_error_t openapiIfNameGet(openapiClientHandle_t *client_handle,
743  uint32_t intf,
744  open_buffdesc *intfName);
745 
746 /*****************************************************************/
761 open_error_t openapiIfNumGet (openapiClientHandle_t * client_handle,
762  open_buffdesc *intfName, uint32_t *ifNum );
763 
764 /*****************************************************************/
781 open_error_t openapiIfNextChangedGet(openapiClientHandle_t *client_handle,
782  uint32_t ifNum,
783  uint32_t *nextIfNum,
784  uint32_t *delete_pending);
785 
786 /*****************************************************************/
801 open_error_t openapiIfTypeGet(openapiClientHandle_t * client_handle,
802  uint32_t ifNum,
803  OPEN_INTF_TYPE_t *ifType);
804 
805 /*****************************************************************/
819 open_error_t openapiIfLastChangeGet(openapiClientHandle_t *client_handle,
820  uint32_t interface, uint32_t *value);
821 
822 /*****************************************************************/
837 open_error_t openapiIfInOctetsGet(openapiClientHandle_t *client_handle,
838  uint32_t interface, uint32_t *value);
839 
840 /*****************************************************************/
858 open_error_t openapiIfInUcastPktsGet(openapiClientHandle_t *client_handle,
859  uint32_t interface, uint32_t *value);
860 
861 /*****************************************************************/
878 open_error_t openapiIfInDiscardsGet(openapiClientHandle_t *client_handle,
879  uint32_t interface, uint32_t *value);
880 
881 /*****************************************************************/
895 open_error_t openapiIfInErrorsGet(openapiClientHandle_t *client_handle,
896  uint32_t interface, uint32_t *value);
897 
898 /*****************************************************************/
913 open_error_t openapiIfInUnknownProtosGet(openapiClientHandle_t *client_handle,
914  uint32_t interface, uint32_t *value);
915 
916 /*****************************************************************/
931 open_error_t openapiIfOutOctetsGet(openapiClientHandle_t *client_handle,
932  uint32_t interface, uint32_t *value);
933 
934 /*****************************************************************/
955 open_error_t openapiIfOutUcastPktsGet(openapiClientHandle_t *client_handle,
956  uint32_t interface, uint32_t *value);
957 
958 /*****************************************************************/
976 open_error_t openapiIfOutDiscardsGet(openapiClientHandle_t *client_handle,
977  uint32_t interface, uint32_t *value);
978 
979 /*****************************************************************/
994 open_error_t openapiIfOutErrorsGet(openapiClientHandle_t *client_handle,
995  uint32_t interface, uint32_t *value);
996 
997 /******************************************************************************/
1013 open_error_t openapiIfSpeedModeGet(openapiClientHandle_t *client_handle,
1014  uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed);
1015 
1016 
1017 /*****************************************************************/
1034 open_error_t openapiIfDuplexGet(openapiClientHandle_t *client_handle,
1035  uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode);
1036 
1037 /*****************************************************************/
1054 open_error_t openapiIfCapabilitiesGet(openapiClientHandle_t * client_handle,
1055  uint32_t ifNum, uint64_t *portCapability);
1056 
1057 /*****************************************************************/
1073 open_error_t openapiIfDisableReasonGet(openapiClientHandle_t *client_handle,
1074  uint32_t ifNum,
1075  OPEN_DISABLE_REASON_t *reason);
1076 
1077 /*****************************************************************/
1096 open_error_t openapiIfExpPortRootPortGet(openapiClientHandle_t *client_handle,
1097  uint32_t ifNum,
1098  uint32_t *rootSlot,
1099  uint32_t *rootPort);
1100 
1101 /*****************************************************************/
1118 open_error_t openapiIfExpPortOperModeLaneCountGet(openapiClientHandle_t *client_handle,
1119  uint32_t ifNum,
1120  uint32_t *laneCount);
1121 
1122 /*****************************************************************/
1139 open_error_t openapiIfExpPortFirstPeerGet(openapiClientHandle_t *client_handle,
1140  uint32_t ifNum,
1141  uint32_t *peerIfNum);
1142 
1143 /*****************************************************************/
1160 open_error_t openapiIfPortSpeedLaneCountGet(openapiClientHandle_t *client_handle,
1161  uint32_t ifNum,
1162  uint32_t *laneCount);
1163 
1164 /*****************************************************************/
1191 open_error_t openapiIfActiveMediaTypeGet(openapiClientHandle_t *client_handle,
1192  uint32_t ifNum,
1193  OPEN_PORT_CABLE_MEDIA_TYPE_t *mediaType);
1194 
1195 /*****************************************************************/
1221 open_error_t openapiIfPauseStatusGet(openapiClientHandle_t *client_handle,
1222  uint32_t ifNum,
1223  OPEN_BOOL_t *rxPauseAllowed,
1224  OPEN_BOOL_t *txPauseAllowed);
1225 
1226 /*****************************************************************/
1248 open_error_t openapiIfSpecialPortTypeGet(openapiClientHandle_t *client_handle,
1249  uint32_t ifNum,
1250  OPEN_SPECIAL_PORT_TYPE_t *specialType);
1251 
1252 /*****************************************************************/
1269 open_error_t openapiIfOprStateGet(openapiClientHandle_t *client_handle,
1270  uint32_t ifNum,
1271  OPEN_PORT_STATE_t *val);
1272 
1273 /*************************************************************************/
1288 open_error_t openapiConfigIdMaskOffsetGet(openapiClientHandle_t *client_handle,
1289  uint32_t interface,
1290  uint32_t *maskOffset);
1291 
1292 /*************************************************************************/
1308 open_error_t openapiusmDbIfIndexGet(openapiClientHandle_t *client_handle,
1309  uint32_t interface, uint32_t *ifIndex);
1310 
1311 /*************************************************************************/
1328 open_error_t openapiIfActiveStateGet(openapiClientHandle_t *client_handle,
1329  uint32_t interface,
1330  uint32_t *intfActiveState);
1331 
1332 /*************************************************************************/
1350 open_error_t openapiIfLinkTrapGet(openapiClientHandle_t *client_handle,
1351  uint32_t ifNum,
1352  OPEN_CONTROL_t *mode);
1353 
1354 /*************************************************************************/
1374 open_error_t openapiIfLinkTrapSet(openapiClientHandle_t *client_handle,
1375  uint32_t ifNum,
1376  OPEN_CONTROL_t mode);
1377 
1378 /*************************************************************************/
1397 open_error_t openapiIntfExpandablePortNextGet(openapiClientHandle_t *client_handle,
1398  uint32_t prevIfNum,
1399  uint32_t *nextIfNum);
1400 
1401 /*****************************************************************/
1419 open_error_t openapiIntfExpandablePortModeSupportedGet(openapiClientHandle_t *client_handle,
1420  OPEN_EXPANDABLE_PORTMODE_t expandPortMode,
1421  OPEN_BOOL_t *isExpandedModeSupported);
1422 
1423 /*****************************************************************/
1443 open_error_t openapiIntfExpandablePortModeSet(openapiClientHandle_t *client_handle,
1444  uint32_t ifNum,
1445  OPEN_EXPANDABLE_PORTMODE_t expandPortMode);
1446 
1447 /*****************************************************************/
1466 open_error_t openapiIntfExpandablePortConfigModeGet(openapiClientHandle_t *client_handle,
1467  uint32_t ifNum,
1468  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode);
1469 
1470 /*****************************************************************/
1489 open_error_t openapiIntfExpandablePortOperModeGet(openapiClientHandle_t *client_handle,
1490  uint32_t ifNum,
1491  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode);
1492 
1493 /*****************************************************************/
1515 open_error_t openapiIntfExpandableModePeersGetByModeGet(openapiClientHandle_t *client_handle,
1516  uint32_t ifNum,
1517  OPEN_EXPANDABLE_PORTMODE_t *expandPortMode,
1518  open_buffdesc *peerIntfs,
1519  uint32_t *peerCount);
1520 
1521 /*****************************************************************/
1541 open_error_t openapiIntfFECModeSet(openapiClientHandle_t *client_handle,
1542  uint32_t ifNum,
1543  OPEN_PORT_FEC_MODE_t fecMode);
1544 
1545 /*****************************************************************/
1566 open_error_t openapiIntfFECModeGet(openapiClientHandle_t *client_handle,
1567  uint32_t ifNum,
1568  OPEN_PORT_FEC_MODE_t *fecConfigMode,
1569  OPEN_PORT_FEC_MODE_t *fecOperMode);
1570 #endif /* OPENAPI_IF_H_INCLUDED */
1571 
OPEN_PORT_FEC_RS_544_2xN
Rs544, using 2xN RS FEC architecture.
Definition: openapi_if.h:236
OPEN_EXPANDABLE_PORTMODE_QUAD_100G
Quad lane 100g ports.
Definition: openapi_if.h:208
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:195
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:168
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:227
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:216
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:201
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:239
OPEN_PORT_FEC_RS_108
Rs108.
Definition: openapi_if.h:233
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:158
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:197
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:237
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:230
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:213
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:134
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:226
OPEN_EXPANDABLE_PORTMODE_SINGLE_25G
Single lane ports 25G.
Definition: openapi_if.h:205
OPEN_EXPANDABLE_PORTMODE_ROOT_DUAL_50G
Single 50GB port with dual lane.
Definition: openapi_if.h:209
OPEN_EXPANDABLE_PORTMODE_DUAL_50G
Dual lane ports 50G.
Definition: openapi_if.h:206
OPEN_PORT_FEC_RS_272
Rs272, using 1xN RS FEC architecture.
Definition: openapi_if.h:231
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:210
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:207
OPEN_EXPANDABLE_PORTMODE_1x400G
Octalane 400g ports.
Definition: openapi_if.h:217
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_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:211
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:198
OPEN_PORT_FEC_BASE_R
CL74/Base-R.
Definition: openapi_if.h:228
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:223
OPEN_EXPANDABLE_PORTMODE_NONE
None.
Definition: openapi_if.h:203
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:238
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:225
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:219
OPEN_EXPANDABLE_PORTMODE_4x100G
Quad lane 100g ports.
Definition: openapi_if.h:214
OPEN_EXPANDABLE_PORTMODE_2x100G
Dual lane 100g ports.
Definition: openapi_if.h:215
OPEN_EXPANDABLE_PORTMODE_SINGLE_10G
Single lane ports 10G.
Definition: openapi_if.h:204
OPEN_PORT_FEC_RS_545
Rs545.
Definition: openapi_if.h:234
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:212
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:229
OPEN_PORT_FEC_RS_304
Rs304.
Definition: openapi_if.h:235
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:232
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.