Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_vlan.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_vlan.h
28 *
29 * @purpose VLAN Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 08/29/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_VLAN_H_INCLUDED
39 #define OPENAPI_VLAN_H_INCLUDED
40 
41 #include <stdio.h>
42 #include <stddef.h>
43 #include <sys/un.h>
44 
45 #include "openapi_common.h"
46 
47 typedef enum
48 {
49  OPEN_DOT1Q_SWPORT_MODE_NONE = 0,
50  OPEN_DOT1Q_SWPORT_MODE_GENERAL = 1,
51  OPEN_DOT1Q_SWPORT_MODE_ACCESS = 2,
52  OPEN_DOT1Q_SWPORT_MODE_TRUNK = 3,
53  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_HOST = 4,
54  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC = 5,
55  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_PROMISC_TRUNK = 6,
56  OPEN_DOT1Q_SWPORT_MODE_PRIVATE_ISOLATED_TRUNK = 7,
57 } OPEN_DOT1Q_SWPORT_MODE_t;
58 
60 #define OPEN_VLAN_LIST_MAX_ENTRIES 4096
61 
62 typedef struct
63 {
64  uint32_t numEntries;
65  uint16_t ids[OPEN_VLAN_LIST_MAX_ENTRIES];
66 } OPEN_VLAN_LIST_t;
67 
68 typedef enum
69 {
70  OPEN_PRIVATE_VLAN_UNCONFIGURED = 0,
71  OPEN_PRIVATE_VLAN_PRIMARY,
72  OPEN_PRIVATE_VLAN_SECONDARY_ISOLATED,
73  OPEN_PRIVATE_VLAN_SECONDARY_COMMUNITY
74 } OPEN_DOT1Q_PVLAN_TYPE_t;
75 
76 
77 typedef enum
78 {
79  OPEN_PRIVATE_VLAN_UNCONFIGURED_PORT,
80  OPEN_PRIVATE_VLAN_HOST_PORT,
81  OPEN_PRIVATE_VLAN_COMMUNITY_PORT,
82  OPEN_PRIVATE_VLAN_PROMISCOUS_PORT
83 } OPEN_DOT1Q_PVLAN_PORT_TYPE_t;
84 
85 /*****************************************************************/
103 open_error_t openapiVlanNextGet(openapiClientHandle_t *client_handle,
104  uint32_t vlanNum,
105  uint32_t *nextVlanNum);
106 
107 /*****************************************************************/
120 open_error_t openapiVlanCreatedCheck(openapiClientHandle_t *client_handle,
121  uint32_t vlanNum);
122 
123 /*****************************************************************/
135 int openapiVlanIsStatic(openapiClientHandle_t *client_handle,
136  uint32_t vlanNum);
137 
138 /*****************************************************************/
154 open_error_t openapiVlanCreate(openapiClientHandle_t *client_handle,
155  uint32_t vlanNum);
156 
157 /*****************************************************************/
173 open_error_t openapiVlanDelete(openapiClientHandle_t *client_handle,
174  uint32_t vlanNum);
175 
176 /*****************************************************************/
192 open_error_t openapiVlanIfAcceptFrameTypeGet(openapiClientHandle_t *client_handle,
193  uint32_t ifNum,
194  OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t *type);
195 
196 /*****************************************************************/
212 open_error_t openapiVlanIfAcceptFrameTypeSet(openapiClientHandle_t *client_handle,
213  uint32_t ifNum,
214  OPEN_DOT1Q_ACCEPT_FRAME_TYPE_t type);
215 
216 /*****************************************************************/
232 open_error_t openapiVlanIfPvidGet(openapiClientHandle_t *client_handle,
233  uint32_t ifNum,
234  uint32_t *vlanNum);
235 
236 /*****************************************************************/
254 open_error_t openapiVlanIfTaggingGet(openapiClientHandle_t *client_handle,
255  uint32_t ifNum,
256  uint32_t vlanNum,
257  OPEN_CONTROL_t *tagging);
258 
259 /*****************************************************************/
277 open_error_t openapiVlanIfParticipationStatusGet(openapiClientHandle_t *client_handle,
278  uint32_t vlanNum,
279  uint32_t ifNum,
280  uint32_t *participating);
281 
282 /*****************************************************************/
299 open_error_t openapiVlanNextChangedGet(openapiClientHandle_t *client_handle,
300  uint32_t vlanNum,
301  uint32_t *nextVlanNum,
302  uint32_t *delete_pending);
303 
304 /*****************************************************************/
327 open_error_t openapiVlanIfParticipationSet(openapiClientHandle_t *client_handle,
328  uint32_t vlanNum,
329  uint32_t ifNum,
330  OPEN_VLAN_PARTICIPATION_MODE_t participationMode);
331 
332 /*****************************************************************/
353 open_error_t openapiVlanIfParticipationGet(openapiClientHandle_t *client_handle,
354  uint32_t vlanNum,
355  uint32_t ifNum,
356  OPEN_VLAN_PARTICIPATION_MODE_t *participationMode);
357 
358 /*****************************************************************/
378 open_error_t openapiVlanIfPvidSet(openapiClientHandle_t *client_handle,
379  uint32_t ifNum,
380  uint32_t vlanNum);
381 
382 /*****************************************************************/
403 open_error_t openapiVlanIfTaggingSet(openapiClientHandle_t *client_handle,
404  uint32_t ifNum,
405  uint32_t vlanNum,
406  OPEN_CONTROL_t tagging);
407 
408 /*****************************************************************/
422 open_error_t openapiVlanIfNumTrafficClassesGet(openapiClientHandle_t *client_handle,
423  uint32_t ifNum,
424  uint32_t *numTrafficClasses);
425 
426 /*****************************************************************/
445 open_error_t openapiVlanIfDefaultUserPrioritySet(openapiClientHandle_t *client_handle,
446  uint32_t ifNum,
447  uint32_t priority);
448 
449 /*****************************************************************/
464 open_error_t openapiVlanIfDefaultUserPriorityGet(openapiClientHandle_t *client_handle,
465  uint32_t ifNum,
466  uint32_t *priority);
467 
468 /*****************************************************************/
482 open_error_t openapiVlanNameLenGet(openapiClientHandle_t *client_handle,
483  uint32_t *strLen);
484 
485 /*****************************************************************/
506 open_error_t openapiVlanNameSet(openapiClientHandle_t *client_handle,
507  uint32_t vlanNum,
508  open_buffdesc *vlanName);
509 
510 /*****************************************************************/
527 open_error_t openapiVlanNameGet(openapiClientHandle_t *client_handle,
528  uint32_t vlanNum,
529  open_buffdesc *vlanName);
530 
531 /*****************************************************************/
548 open_error_t openapiDot1qSwPortModeSet(openapiClientHandle_t *client_handle,
549  uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t mode);
550 
551 /*****************************************************************/
568 open_error_t openapiDot1qSwPortModeGet(openapiClientHandle_t *client_handle,
569  uint32_t intf, OPEN_DOT1Q_SWPORT_MODE_t *mode);
570 
571 /*****************************************************************/
588 open_error_t openapiDot1qSwPortAccessVlanSet(openapiClientHandle_t *client_handle,
589  uint32_t intf, uint32_t vlanId);
590 
591 /*****************************************************************/
608 open_error_t openapiDot1qSwPortAccessVlanGet(openapiClientHandle_t *client_handle,
609  uint32_t intf, uint32_t *vlanId);
610 
611 /*****************************************************************/
629 open_error_t openapiDot1qSwPortTrunkNativeVlanSet(openapiClientHandle_t *client_handle,
630  uint32_t intf, uint32_t vlanId);
631 
632 /*****************************************************************/
649 open_error_t openapiDot1qSwPortTrunkNativeVlanGet(openapiClientHandle_t *client_handle,
650  uint32_t intf, uint32_t *vlanId);
651 
652 /*****************************************************************/
668 open_error_t openapiDot1qSwPortTrunkAllowedVlanListSet(openapiClientHandle_t *client_handle,
669  uint32_t intf,
670  OPEN_VLAN_LIST_t *vidList);
671 
672 /*****************************************************************/
687 open_error_t openapiDot1qSwPortTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle,
688  uint32_t intf,
689  OPEN_VLAN_LIST_t *vidList);
690 
691 /*****************************************************************/
706 open_error_t openapiDot1qSwPortForbiddenVlanListGet(openapiClientHandle_t *client_handle,
707  uint32_t intf,
708  OPEN_VLAN_LIST_t *vidList);
709 
710 /*****************************************************************/
725 open_error_t openapiDot1qSwPortUntaggedVlanListGet(openapiClientHandle_t *client_handle,
726  uint32_t intf,
727  OPEN_VLAN_LIST_t *vidList);
728 
729 /*****************************************************************/
744 open_error_t openapiDot1qSwPortTaggedVlanListGet(openapiClientHandle_t *client_handle,
745  uint32_t intf,
746  OPEN_VLAN_LIST_t *vidList);
747 
748 /*****************************************************************/
763 open_error_t openapiDot1qSwPortDynamicallyAddedVlanListGet(openapiClientHandle_t *client_handle,
764  uint32_t intf,
765  OPEN_VLAN_LIST_t *vidList);
766 
767 /*****************************************************************/
788 open_error_t openapiPvlanIntfModeGet(openapiClientHandle_t *client_handle,
789  uint32_t intf,
790  OPEN_DOT1Q_SWPORT_MODE_t *mode);
791 
792 /*****************************************************************/
812 open_error_t openapiPvlanIntfHostAssocGet(openapiClientHandle_t *client_handle,
813  uint32_t intf,
814  uint32_t *primaryVid,
815  uint32_t *secondaryVid);
816 
817 /*****************************************************************/
837 open_error_t openapiPvlanIntfPromiscAssocGet(openapiClientHandle_t *client_handle,
838  uint32_t intf,
839  uint32_t *primaryVid,
840  OPEN_VLAN_LIST_t *secondaryVidList);
841 
842 /*****************************************************************/
859 open_error_t openapiPvlanIntfOperAssocGet(openapiClientHandle_t *client_handle,
860  uint32_t intf,
861  OPEN_VLAN_LIST_t *operationalVidList);
862 
863 /*****************************************************************/
886 open_error_t openapiPvlanIntfPromiscTrunkAssocNextGet(openapiClientHandle_t *client_handle,
887  uint32_t intf,
888  uint32_t primaryVid,
889  uint32_t *nextPrimaryVid,
890  OPEN_VLAN_LIST_t *secondaryVidList);
891 
892 /*****************************************************************/
915 open_error_t openapiPvlanIntfIsolatedTrunkAssocNextGet(openapiClientHandle_t *client_handle,
916  uint32_t intf,
917  uint32_t primaryVid,
918  uint32_t *nextPrimaryVid,
919  uint32_t *secondaryVid);
920 
921 /*****************************************************************/
943 open_error_t openapiPvlanIntfTrunkNativeVlanGet(openapiClientHandle_t *client_handle,
944  uint32_t intf,
945  uint32_t *nativeVid);
946 
947 /*****************************************************************/
965 open_error_t openapiPvlanIntfTrunkAllowedVlanListGet(openapiClientHandle_t *client_handle,
966  uint32_t intf,
967  OPEN_VLAN_LIST_t *normalVidList);
968 
969 /*****************************************************************/
985 open_error_t openapiDot1qPrivateVlanEnable(openapiClientHandle_t *client_handle,
986  uint32_t vlanId,
987  OPEN_DOT1Q_PVLAN_TYPE_t pvlanType);
988 
989 /*****************************************************************/
1005 open_error_t openapiDot1qPrivateVlanGet(openapiClientHandle_t *client_handle,
1006  uint32_t vlanId,
1007  OPEN_DOT1Q_PVLAN_TYPE_t *pvlanType);
1008 
1009 /*****************************************************************/
1025 open_error_t openapiDot1qApiPrivateVlanAssocAdd(openapiClientHandle_t *client_handle,
1026  uint32_t vlanId,
1027  OPEN_VLAN_LIST_t vidList);
1028 
1029 /*****************************************************************/
1045 open_error_t openapiDot1qApiPrivateVlanAssocRemove(openapiClientHandle_t *client_handle,
1046  uint32_t vlanId,
1047  OPEN_VLAN_LIST_t vidList);
1048 
1049 /*****************************************************************/
1065 open_error_t openapiDot1qPrivateVlanAssociationGet(openapiClientHandle_t *client_handle,
1066  uint32_t vlanId,
1067  OPEN_VLAN_LIST_t *vidList);
1068 
1069 /*****************************************************************/
1086 open_error_t openapiDot1qIntfPVlanHostAssocSet(openapiClientHandle_t *client_handle,
1087  uint32_t ifNum,
1088  uint32_t primary_vlan,
1089  uint32_t sec_vlan);
1090 
1091 /*****************************************************************/
1106 open_error_t openapiDot1qPVlanIntfHostAssocRemove(openapiClientHandle_t *client_handle,
1107  uint32_t ifNum);
1108 
1109 /*****************************************************************/
1126 open_error_t openapiDot1qIntfPVlanPromiscAssocSet(openapiClientHandle_t *client_handle,
1127  uint32_t ifNum,
1128  uint32_t primary_vlan,
1129  OPEN_VLAN_LIST_t vidList);
1130 
1131 /*****************************************************************/
1146 open_error_t openapiDot1qPVlanIntfPromiscAssocRemove(openapiClientHandle_t *client_handle,
1147  uint32_t ifNum);
1148 
1149 #endif /* OPENAPI_VLAN_H_INCLUDED */
1150