Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_dot1ad.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_dot1ad.h
28 *
29 * @purpose QinQ Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 06/02/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DOT1AD_H_INCLUDED
39 #define OPENAPI_DOT1AD_H_INCLUDED
40 
41 #include <stdio.h>
42 #include <stddef.h>
43 #include <stdbool.h>
44 #include <sys/un.h>
45 
46 #include "openapi_common.h"
47 
48 #define OPEN_DOT1AD_SVID_MIN 1
49 #define OPEN_DOT1AD_SVID_MAX 4092
50 #define OPEN_DOT1AD_SERVICES_MAX 4096
51 #define OPEN_DOT1AD_SERVICE_NAME_LEN_MIN 1
52 #define OPEN_DOT1AD_SERVICE_NAME_LEN_MAX 31
53 #define OPEN_DOT1AD_MIN_VLAN_ID 1
54 #define OPEN_DOT1AD_MAX_VLAN_ID 4095
55 #define OPEN_DOT1AD_SUBSCRIPTIONS_MAX 4096
56 #define OPEN_DOT1AD_CVID_MIN 1
57 #define OPEN_DOT1AD_CVID_MAX 4092
61 typedef enum
62 {
63  OPEN_DOT1AD_SVCTYPE_ELINE = 1,
64  OPEN_DOT1AD_SVCTYPE_ELAN = 2,
65  OPEN_DOT1AD_SVCTYPE_ETREE = 3,
66  OPEN_DOT1AD_SVCTYPE_TLS = 4,
67  OPEN_DOT1AD_SVCTYPE_TOTAL
68 }OPEN_DOT1AD_SVCTYPE_t;
69 
72 typedef enum
73 {
74  OPEN_DOT1AD_PKTTYPE_NONE = 0,
75  OPEN_DOT1AD_PKTTYPE_UNTAGGED = 1,
76  OPEN_DOT1AD_PKTTYPE_PRIOTAGGED = 2,
77  OPEN_DOT1AD_PKTTYPE_TAGGED = 3,
78  OPEN_DOT1AD_PKTTYPE_NO_STAG = 4,
79  OPEN_DOT1AD_PKTTYPE_NO_CTAG = 5,
80  OPEN_DOT1AD_PKTTYPE_TOTAL
81 }OPEN_DOT1AD_PKTTYPE_t;
82 
85 typedef enum
86 {
87  OPEN_DOT1AD_INTERFACE_TYPE_UNI = 0,
88  OPEN_DOT1AD_INTERFACE_TYPE_UNI_P = 1,
89  OPEN_DOT1AD_INTERFACE_TYPE_UNI_S = 2,
90  OPEN_DOT1AD_INTERFACE_TYPE_NNI = 3,
91  OPEN_DOT1AD_INTERFACE_TYPE_SWITCHPORT = 4,
92  OPEN_DOT1AD_INTERFACE_TYPE_TOTAL
93 }OPEN_DOT1AD_INTERFACE_TYPE_t;
94 
95 /*****************************************************************/
116 open_error_t openapiDot1adServiceCreate(openapiClientHandle_t *client_handle,
117  uint32_t svid);
118 
119 /*****************************************************************/
137 open_error_t openapiDot1adServiceDelete(openapiClientHandle_t *client_handle,
138  uint32_t svid);
139 
140 /*****************************************************************/
156 open_error_t openapiDot1adServiceIndexGetFirst(openapiClientHandle_t *client_handle,
157  uint32_t *serviceIndex);
158 
159 /*****************************************************************/
177 open_error_t openapiDot1adServiceIndexGetNext(openapiClientHandle_t *client_handle,
178  uint32_t serviceIndex,
179  uint32_t *next);
180 
181 /*****************************************************************/
203 open_error_t openapiDot1adServiceNameAdd(openapiClientHandle_t *client_handle,
204  uint32_t svid, open_buffdesc *name);
205 
206 /*****************************************************************/
228 open_error_t openapiDot1adServiceNameGet(openapiClientHandle_t *client_handle,
229  uint32_t svid, open_buffdesc *name);
230 
231 /*****************************************************************/
251 open_error_t openapiDot1adServiceNameStringCheck(openapiClientHandle_t *client_handle,
252  open_buffdesc *name);
253 
254 /*****************************************************************/
273 open_error_t openapiDot1adServiceNameToSvid(openapiClientHandle_t *client_handle,
274  open_buffdesc *name, uint32_t *svid);
275 
276 /*****************************************************************/
295 open_error_t openapiDot1adServiceVidIsConfigured(openapiClientHandle_t *client_handle,
296  uint32_t vlanId, OPEN_BOOL_t *flag);
297 /*****************************************************************/
316 open_error_t openapiDot1adServiceIsolateVidIsConfigured(openapiClientHandle_t *client_handle,
317  uint32_t vlanId,
318  OPEN_BOOL_t *flag);
319 
320 /*****************************************************************/
341 open_error_t openapiDot1adServiceTypeSet(openapiClientHandle_t *client_handle,
342  uint32_t svid,
343  OPEN_DOT1AD_SVCTYPE_t serviceType);
344 
345 /*****************************************************************/
367 open_error_t openapiDot1adIsolateVidSet(openapiClientHandle_t *client_handle,
368  uint32_t svid, uint32_t isolateVid);
369 
370 /*****************************************************************/
390 open_error_t openapiDot1adServiceTypeGet(openapiClientHandle_t *client_handle,
391  uint32_t svid,
392  OPEN_DOT1AD_SVCTYPE_t *serviceType);
393 
394 /*****************************************************************/
418 open_error_t openapiDot1adNniIntfListSet(openapiClientHandle_t *client_handle,
419  uint32_t svid, open_buffdesc *nniIntfList);
420 
421 /*****************************************************************/
448 open_error_t openapiDot1adNniIntfListGet(openapiClientHandle_t *client_handle,
449  uint32_t svid, open_buffdesc *nniIntfList);
450 
451 /*****************************************************************/
480 open_error_t openapiDot1adSubscriptionAdd(openapiClientHandle_t *client_handle,
481  uint32_t intIfNum, uint32_t svid);
482 
483 /*****************************************************************/
507 open_error_t openapiDot1adSubscriptionDelete(openapiClientHandle_t *client_handle,
508  uint32_t intIfNum, uint32_t svid,
509  open_buffdesc *subscrName);
510 
511 /*****************************************************************/
530 open_error_t openapiDot1adReserveCurrentSubscription(openapiClientHandle_t *client_handle,
531  uint32_t intIfNum,
532  uint32_t svid);
533 
534 /*****************************************************************/
553 open_error_t openapiDot1adReleaseCurrentSubscription(openapiClientHandle_t *client_handle,
554  uint32_t intIfNum,
555  uint32_t svid);
556 
557 /*****************************************************************/
578 open_error_t openapiDot1adSubscriptionNameSet(openapiClientHandle_t *client_handle,
579  uint32_t intIfNum,
580  uint32_t svid, open_buffdesc *name);
581 
582 /*****************************************************************/
604 open_error_t openapiDot1adSubscriptionNameGet(openapiClientHandle_t *client_handle,
605  uint32_t intIfNum, uint32_t svid,
606  uint32_t cvid, open_buffdesc *name);
607 
608 /*****************************************************************/
627 open_error_t openapiDot1adSubscriptionPktTypeSet(openapiClientHandle_t *client_handle,
628  uint32_t intIfNum,
629  uint32_t svid,
630  OPEN_DOT1AD_PKTTYPE_t pktType);
631 
632 /*****************************************************************/
654 open_error_t openapiDot1adSubscriptionPktTypeGet(openapiClientHandle_t *client_handle,
655  uint32_t intIfNum, uint32_t svid,
656  uint32_t cvid,
657  OPEN_DOT1AD_PKTTYPE_t *pktType);
658 
659 /*****************************************************************/
677 open_error_t openapiDot1adSubscriptionSvidSet(openapiClientHandle_t *client_handle,
678  uint32_t intIfNum, uint32_t svid);
679 
680 /*****************************************************************/
701 open_error_t openapiDot1adSubscriptionMatchCvidSet(openapiClientHandle_t *client_handle,
702  uint32_t intIfNum, uint32_t svid,
703  uint32_t matchCvid);
704 
705 /*****************************************************************/
724 open_error_t openapiDot1adSubscriptionMatchSvidSet(openapiClientHandle_t *client_handle,
725  uint32_t intIfNum,
726  uint32_t svid, uint32_t matchSvid);
727 
728 /*****************************************************************/
746 open_error_t openapiDot1adServiceIntfMatchCvidGet(openapiClientHandle_t *client_handle,
747  uint32_t subscrIndex,
748  uint32_t intIfNum,
749  uint32_t *matchCvid);
750 
751 /*****************************************************************/
770 open_error_t openapiDot1adServiceIntfMatchSvidGet(openapiClientHandle_t *client_handle,
771  uint32_t subscrIndex,
772  uint32_t intIfNum,
773  uint32_t *matchSvid);
774 
775 /*****************************************************************/
794 open_error_t openapiDot1adSubscriptionMatchPrioritySet(openapiClientHandle_t *client_handle,
795  uint32_t intIfNum,
796  uint32_t svid,
797  uint32_t priority);
798 
799 /*****************************************************************/
817 open_error_t openapiDot1adSubscriptionFirstIntfEntryGet(openapiClientHandle_t *client_handle,
818  uint32_t intfIn, uint32_t *intfOut,
819  uint32_t *svid, uint32_t *cvid);
820 
821 /*****************************************************************/
841 open_error_t openapiDot1adSubscriptionNextIntfEntryGet(openapiClientHandle_t *client_handle,
842  uint32_t intfIn, uint32_t svidIn,
843  uint32_t cvidIn, uint32_t *intfOut,
844  uint32_t *svidOut, uint32_t *cvidOut);
845 
846 /*****************************************************************/
867 open_error_t openapiDot1adSpecificSubscriptionNextIntfEntryGet(openapiClientHandle_t *client_handle,
868  uint32_t intfIn, uint32_t svidIn,
869  uint32_t cvidIn, uint32_t *intfOut,
870  uint32_t *svidOut, uint32_t *cvidOut);
871 
872 /*****************************************************************/
890 open_error_t openapiDot1adServiceIntfMatchPriorityGet(openapiClientHandle_t *client_handle,
891  uint32_t subscrIndex,
892  uint32_t intIfNum,
893  uint32_t *priority);
894 
895 /*****************************************************************/
918 open_error_t openapiDot1adSubscriptionCvidSet(openapiClientHandle_t *client_handle,
919  uint32_t intIfNum, uint32_t svid,
920  uint32_t cvid);
921 
922 /*****************************************************************/
942 open_error_t openapiDot1adSubscriptionRemoveCtagSet(openapiClientHandle_t *client_handle,
943  uint32_t intIfNum,
944  uint32_t svid,
945  OPEN_BOOL_t removeCtag);
946 
947 /*****************************************************************/
964 open_error_t openapiDot1adServiceRemoveCtagGet(openapiClientHandle_t *client_handle,
965  uint32_t subscrIndex,
966  uint32_t intIfNum,
967  OPEN_BOOL_t *removeCtag);
968 
969 /*****************************************************************/
993 open_error_t openapiDot1adSubscriptionNNIIntfListSet(openapiClientHandle_t *client_handle,
994  uint32_t intIfNum, uint32_t svid,
995  open_buffdesc *nniIntfList);
996 
997 /*****************************************************************/
1017 open_error_t openapiDot1adSubscriptionNNIIntfListGet(openapiClientHandle_t *client_handle,
1018  uint32_t subscrIndex,
1019  uint32_t intIfNum,
1020  open_buffdesc *nniIntfList);
1021 
1022 /************************************************************************/
1037 open_error_t openapiDot1adInterfaceTypeSet(openapiClientHandle_t *client_handle,
1038  uint32_t basePort,
1039  OPEN_DOT1AD_INTERFACE_TYPE_t intfType);
1040 
1041 /************************************************************************/
1057 open_error_t openapiDot1adInterfaceTypeGet(openapiClientHandle_t *client_handle,
1058  uint32_t BasePort,
1059  OPEN_DOT1AD_INTERFACE_TYPE_t *intfType);
1060 
1061 /*****************************************************************/
1080 open_error_t openapiDot1adIntfNextGet(openapiClientHandle_t *client_handle,
1081  uint32_t intIfNum, uint32_t *nextIntIfNum);
1082 
1083 /**********************************************************************/
1098 open_error_t openapiDot1adInterfacePreserveCvlanDot1pGet(openapiClientHandle_t *client_handle,
1099  uint32_t intIfNum,
1100  OPEN_BOOL_t *enable);
1101 
1102 /**********************************************************************/
1117 open_error_t openapiDot1adInterfacePreserveCvlanDot1pSet(openapiClientHandle_t *client_handle,
1118  uint32_t intIfNum,
1119  OPEN_BOOL_t enable);
1120 
1121 #endif /* OPENAPI_DOT1AD_H_INCLUDED */
1122