Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_if.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2019 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 * 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 #define OPENAPI_INTERFACE_NAME_LENGTH 60
202 
203 /******************************************************************************/
218 open_error_t openapiIfSpeedGet (openapiClientHandle_t * client_handle,
219  uint32_t ifNum, OPEN_PORT_SPEEDS_t * speed);
220 
221 /*****************************************************************/
237 open_error_t openapiIfSpeedSet (openapiClientHandle_t * client_handle,
238  uint32_t ifNum, OPEN_PORT_SPEEDS_t speed);
239 
240 
241 /*****************************************************************/
258 open_error_t openapiIfDuplexModeGet (openapiClientHandle_t * client_handle,
259  uint32_t ifNum, OPEN_PORT_DUPLEX_t * duplex_mode);
260 
261 /*****************************************************************/
275 open_error_t openapiIfAutoNegGet (openapiClientHandle_t * client_handle,
276  uint32_t ifNum, OPEN_PORT_AUTO_NEG_t * autoneg);
277 
278 /*****************************************************************/
295 open_error_t openapiIfAutoNegSet (openapiClientHandle_t * client_handle,
296  uint32_t ifNum, uint32_t autoneg);
297 
298 /*****************************************************************/
312 open_error_t openapiIfEthernetHeaderSizeGet(openapiClientHandle_t *client_handle,
313  uint32_t ifNum, uint32_t *headerSize);
314 
315 /*****************************************************************/
329 open_error_t openapiIfMtuSizeGet (openapiClientHandle_t * client_handle,
330  uint32_t ifNum, uint32_t * mtu_size);
331 
332 /*****************************************************************/
353 open_error_t openapiIfMtuSizeSet (openapiClientHandle_t * client_handle,
354  uint32_t ifNum, uint32_t mtu_size);
355 
356 /*****************************************************************/
377 open_error_t openapiIfMtuSizeSetV2(openapiClientHandle_t *client_handle,
378  uint32_t ifNum,
379  uint32_t mtu_size);
380 
381 /*****************************************************************/
401 open_error_t openapiIfMaxFrameSizeSet(openapiClientHandle_t *client_handle,
402  uint32_t ifNum, uint32_t maxFrameSize);
403 
404 /*****************************************************************/
418 open_error_t openapiIfMaxFrameSizeGet(openapiClientHandle_t *client_handle,
419  uint32_t ifNum, uint32_t *maxFrameSize);
420 
421 /*****************************************************************************************/
441 open_error_t openapiIfSoftShutdownStateGet (openapiClientHandle_t *
442  client_handle, uint32_t ifNum,
443  OPEN_CONTROL_t * soft_shut);
444 
445 /************************************************************************************/
466 open_error_t openapiIfSoftShutdownStateSet (openapiClientHandle_t *
467  client_handle, uint32_t ifNum,
468  OPEN_CONTROL_t soft_shut);
469 
470 /*****************************************************************/
484 open_error_t openapiIfMacAddrSizeGet (openapiClientHandle_t * client_handle,
485  uint32_t ifNum, uint32_t * size);
486 
487 
488 /*****************************************************************/
504 open_error_t openapiIfMacAddrGet (openapiClientHandle_t * client_handle,
505  uint32_t ifNum, open_buffdesc * mac_addr);
506 
507 /*****************************************************************/
521 open_error_t openapiIfDescrSizeGet (openapiClientHandle_t * client_handle,
522  uint32_t ifNum, uint32_t* size);
523 
524 
525 /*****************************************************************/
540 open_error_t openapiIfDescrGet (openapiClientHandle_t * client_handle,
541  uint32_t ifNum, open_buffdesc * descrip);
542 
543 /*****************************************************************/
560 open_error_t openapiIfDescrSet (openapiClientHandle_t * client_handle,
561  uint32_t ifNum, open_buffdesc * descrip);
562 
563 /*****************************************************************/
579 open_error_t openapiIfAdminStateSet(openapiClientHandle_t *client_handle,
580  uint32_t ifNum,
581  OPEN_CONTROL_t adminState);
582 
583 /*****************************************************************/
598 open_error_t openapiIfFirstGet(openapiClientHandle_t *client_handle,
599  OPEN_INTF_TYPE_t ifType,
600  uint32_t *firstIfNum);
601 
602 /*****************************************************************/
621 open_error_t openapiIfNextGet(openapiClientHandle_t *client_handle,
622  OPEN_INTF_TYPE_t ifType,
623  uint32_t ifNum,
624  uint32_t *nextIfNum);
625 
626 /*****************************************************************/
643 open_error_t openapiIfStatusGet(openapiClientHandle_t *client_handle,
644  uint32_t ifNum,
645  OPEN_INTF_STATUS_t *ifStatus);
646 
647 /*****************************************************************/
661 open_error_t openapiIfLinkStateGet(openapiClientHandle_t *client_handle,
662  uint32_t ifNum,
663  OPEN_LINK_STATE_t *linkState);
664 
665 /*****************************************************************/
679 open_error_t openapiIfAdminStateGet(openapiClientHandle_t *client_handle,
680  uint32_t ifNum,
681  OPEN_CONTROL_t *adminState);
682 
683 /*****************************************************************/
699 open_error_t openapiIfNameGet(openapiClientHandle_t *client_handle,
700  uint32_t intf,
701  open_buffdesc *intfName);
702 
703 /*****************************************************************/
718 open_error_t openapiIfNumGet (openapiClientHandle_t * client_handle,
719  open_buffdesc *intfName, uint32_t *ifNum );
720 
721 /*****************************************************************/
738 open_error_t openapiIfNextChangedGet(openapiClientHandle_t *client_handle,
739  uint32_t ifNum,
740  uint32_t *nextIfNum,
741  uint32_t *delete_pending);
742 
743 /*****************************************************************/
758 open_error_t openapiIfTypeGet(openapiClientHandle_t * client_handle,
759  uint32_t ifNum,
760  OPEN_INTF_TYPE_t *ifType);
761 
762 /*****************************************************************/
776 open_error_t openapiIfLastChangeGet(openapiClientHandle_t *client_handle,
777  uint32_t interface, uint32_t *value);
778 
779 /*****************************************************************/
794 open_error_t openapiIfInOctetsGet(openapiClientHandle_t *client_handle,
795  uint32_t interface, uint32_t *value);
796 
797 /*****************************************************************/
815 open_error_t openapiIfInUcastPktsGet(openapiClientHandle_t *client_handle,
816  uint32_t interface, uint32_t *value);
817 
818 /*****************************************************************/
835 open_error_t openapiIfInDiscardsGet(openapiClientHandle_t *client_handle,
836  uint32_t interface, uint32_t *value);
837 
838 /*****************************************************************/
852 open_error_t openapiIfInErrorsGet(openapiClientHandle_t *client_handle,
853  uint32_t interface, uint32_t *value);
854 
855 /*****************************************************************/
870 open_error_t openapiIfInUnknownProtosGet(openapiClientHandle_t *client_handle,
871  uint32_t interface, uint32_t *value);
872 
873 /*****************************************************************/
888 open_error_t openapiIfOutOctetsGet(openapiClientHandle_t *client_handle,
889  uint32_t interface, uint32_t *value);
890 
891 /*****************************************************************/
912 open_error_t openapiIfOutUcastPktsGet(openapiClientHandle_t *client_handle,
913  uint32_t interface, uint32_t *value);
914 
915 /*****************************************************************/
933 open_error_t openapiIfOutDiscardsGet(openapiClientHandle_t *client_handle,
934  uint32_t interface, uint32_t *value);
935 
936 /*****************************************************************/
951 open_error_t openapiIfOutErrorsGet(openapiClientHandle_t *client_handle,
952  uint32_t interface, uint32_t *value);
953 
954 /******************************************************************************/
970 open_error_t openapiIfSpeedModeGet(openapiClientHandle_t *client_handle,
971  uint32_t ifNum, OPEN_PORT_SPEEDS_t *speed);
972 
973 
974 /*****************************************************************/
991 open_error_t openapiIfDuplexGet(openapiClientHandle_t *client_handle,
992  uint32_t ifNum, OPEN_PORT_DUPLEX_t *duplex_mode);
993 
994 /*****************************************************************/
1011 open_error_t openapiIfCapabilitiesGet(openapiClientHandle_t * client_handle,
1012  uint32_t ifNum, uint64_t *portCapability);
1013 
1014 /*****************************************************************/
1030 open_error_t openapiIfDisableReasonGet(openapiClientHandle_t *client_handle,
1031  uint32_t ifNum,
1032  OPEN_DISABLE_REASON_t *reason);
1033 
1034 /*****************************************************************/
1053 open_error_t openapiIfExpPortRootPortGet(openapiClientHandle_t *client_handle,
1054  uint32_t ifNum,
1055  uint32_t *rootSlot,
1056  uint32_t *rootPort);
1057 
1058 /*****************************************************************/
1075 open_error_t openapiIfExpPortOperModeLaneCountGet(openapiClientHandle_t *client_handle,
1076  uint32_t ifNum,
1077  uint32_t *laneCount);
1078 
1079 /*****************************************************************/
1096 open_error_t openapiIfExpPortFirstPeerGet(openapiClientHandle_t *client_handle,
1097  uint32_t ifNum,
1098  uint32_t *peerIfNum);
1099 
1100 /*****************************************************************/
1117 open_error_t openapiIfPortSpeedLaneCountGet(openapiClientHandle_t *client_handle,
1118  uint32_t ifNum,
1119  uint32_t *laneCount);
1120 
1121 /*****************************************************************/
1148 open_error_t openapiIfActiveMediaTypeGet(openapiClientHandle_t *client_handle,
1149  uint32_t ifNum,
1150  OPEN_PORT_CABLE_MEDIA_TYPE_t *mediaType);
1151 
1152 /*****************************************************************/
1178 open_error_t openapiIfPauseStatusGet(openapiClientHandle_t *client_handle,
1179  uint32_t ifNum,
1180  OPEN_BOOL_t *rxPauseAllowed,
1181  OPEN_BOOL_t *txPauseAllowed);
1182 
1183 /*****************************************************************/
1205 open_error_t openapiIfSpecialPortTypeGet(openapiClientHandle_t *client_handle,
1206  uint32_t ifNum,
1207  OPEN_SPECIAL_PORT_TYPE_t *specialType);
1208 
1209 /*****************************************************************/
1226 open_error_t openapiIfOprStateGet(openapiClientHandle_t *client_handle,
1227  uint32_t ifNum,
1228  OPEN_PORT_STATE_t *val);
1229 
1230 #endif /* OPENAPI_IF_H_INCLUDED */
1231