Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_bridge.h
Go to the documentation of this file.
1 
9 /**************************************************************************************
10 *
11 * Copyright Broadcom Corporation 2012-2018
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_bridge.h
28 *
29 * @purpose BRIDGE support
30 *
31 * @component OPEN
32 *
33 * @create 06/02/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_BRIDGE_H_INCLUDED
39 #define OPENAPI_BRIDGE_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_STP_PROTOCOL_SPEC_UNKNOWN 1
44 #define OPEN_STP_PROTOCOL_SPEC_IEEE8021D 3
45 
46 /* string representation of MAC in "XX:XX:XX:XX:XX:XX" format including EOL symbol */
47 #define OPEN_STP_DOT1D_DESIGNATED_ROOT_LEN 18
48 
49 #define OPEN_FDB_ADDR_LEN 8
50 #define OPEN_FDB_ADDR_STR_LEN ((OPEN_FDB_ADDR_LEN * 2) + (OPEN_FDB_ADDR_LEN - 1))
51 
52 /* Spanning Tree Port States */
53 #define OPEN_DOT1D_BLOCKING 1
54 #define OPEN_DOT1D_LISTENING 2
55 #define OPEN_DOT1D_LEARNING 3
56 #define OPEN_DOT1D_FORWARDING 4
57 #define OPEN_DOT1D_DISABLED 5
58 #define OPEN_DOT1D_MANUAL_FWD 6
59 #define OPEN_DOT1D_NOT_PARTICIPATE 7
60 #define OPEN_NULLPTR ((void *)0)
61 
62 /**********************************************************************************/
77 open_error_t openapiDot1dBasePortEntryNextGet(openapiClientHandle_t *client_handle,
78  uint32_t intIfNum,
79  uint32_t *nextIntIfNum);
80 
81 /***********************************************************************************************/
98 open_error_t openapiDot1dBaseBridgeAddressGet(openapiClientHandle_t *client_handle,
99  open_buffdesc *bridgeAddress);
100 
101 /**********************************************************************************/
115 open_error_t openapiDot1dBaseNumPortsGet(openapiClientHandle_t *client_handle,
116  uint32_t *numPorts);
117 
118 /**********************************************************************************/
133 open_error_t openapiDot1dBaseTypeGet(openapiClientHandle_t *client_handle, uint32_t *type);
134 
135 /**********************************************************************************/
150 open_error_t openapiDot1dBasePortEntryGet(openapiClientHandle_t *client_handle,
151  uint32_t port);
152 
153 /**********************************************************************************/
173 open_error_t openapiDot1dBasePortCircuitGet(openapiClientHandle_t *client_handle,
174  uint32_t port, open_buffdesc *buffer);
175 
176 /**********************************************************************************/
196 open_error_t openapiDot1dBasePortIfIndexGet(openapiClientHandle_t *client_handle,
197  uint32_t port, uint32_t *ifIndex);
198 
199 /**********************************************************************************/
213 open_error_t openapiDot1dIsValidIntf(openapiClientHandle_t *client_handle, uint32_t intIfNum);
214 
215 /**********************************************************************************/
232 open_error_t
233 openapiDot1dBasePortDelayExceededDiscardsGet(openapiClientHandle_t *client_handle,
234  uint32_t port,
235  uint32_t *delayExceededDiscardsValue);
236 
237 /**********************************************************************************/
254 open_error_t openapiDot1dBasePortMtuExceededDiscardsGet(openapiClientHandle_t *client_handle,
255  uint32_t port,
256  uint32_t *mtuExceededDiscardsValue);
257 
258 /**********************************************************************************/
272 open_error_t openapiDot1dStpProtocolSpecificationGet(openapiClientHandle_t *client_handle,
273  uint32_t *value);
274 
275 /**********************************************************************************/
289 open_error_t openapiDot1dStpPriorityGet(openapiClientHandle_t *client_handle,
290  uint32_t *value);
291 
292 /**********************************************************************************/
306 open_error_t openapiDot1dStpTimeSinceTopologyChangeGet(openapiClientHandle_t *client_handle,
307  uint64_t *value);
308 
309 /**********************************************************************************/
323 open_error_t openapiDot1dStpTopChangesGet(openapiClientHandle_t *client_handle,
324  uint32_t *value);
325 
326 /**********************************************************************************/
343 open_error_t openapiDot1dStpDesignatedRootGet(openapiClientHandle_t *client_handle,
344  open_buffdesc *buffer);
345 
346 /**********************************************************************************/
360 open_error_t openapiDot1dStpRootCostGet(openapiClientHandle_t *client_handle,
361  uint32_t *value);
362 
363 /**********************************************************************************/
377 open_error_t openapiDot1dStpRootPortGet(openapiClientHandle_t *client_handle,
378  uint32_t *value);
379 
380 /**********************************************************************************/
396 open_error_t openapiDot1dStpMaxAgeGet(openapiClientHandle_t *client_handle,
397  uint32_t *value);
398 
399 /**********************************************************************************/
415 open_error_t openapiDot1dStpHelloTimeGet(openapiClientHandle_t *client_handle,
416  uint32_t *value);
417 
418 /**********************************************************************************/
434 open_error_t openapiDot1dStpHoldTimeGet(openapiClientHandle_t *client_handle,
435  uint32_t *value);
436 
437 /**********************************************************************************/
451 open_error_t openapiDot1dStpForwardDelayGet(openapiClientHandle_t *client_handle,
452  uint32_t *value);
453 
454 /**********************************************************************************/
470 open_error_t openapiDot1dStpBridgeMaxAgeGet(openapiClientHandle_t *client_handle,
471  uint32_t *value);
472 
473 /**********************************************************************************/
487 open_error_t openapiDot1dStpBridgeHelloTimeGet(openapiClientHandle_t *client_handle,
488  uint32_t *value);
489 
490 /**********************************************************************************/
504 open_error_t openapiDot1dStpBridgeForwardDelayGet(openapiClientHandle_t *client_handle,
505  uint32_t *value);
506 
507 /**********************************************************************************/
522 open_error_t openapiDot1dStpPortPriorityGet(openapiClientHandle_t *client_handle,
523  uint32_t port, uint32_t *value);
524 
525 /**********************************************************************************/
540 open_error_t openapiDot1dIsInterfaceInCurrentInstance(openapiClientHandle_t *client_handle,
541  uint32_t intIfNum,
542  uint32_t *isInInstance);
543 
544 /**********************************************************************************/
559 open_error_t openapiDot1dInstanceMemberGetNext(openapiClientHandle_t *client_handle,
560  uint32_t intIfNum,
561  uint32_t *nextIntIfNum);
562 
563 /**********************************************************************************/
578 open_error_t openapiDot1dStpPortStateGet(openapiClientHandle_t *client_handle,
579  uint32_t port, uint32_t *value);
580 
581 /**********************************************************************************/
596 open_error_t openapiDot1dStpPortPathCostGet(openapiClientHandle_t *client_handle,
597  uint32_t port, uint32_t *value);
598 
599 /**********************************************************************************/
614 open_error_t openapiDot1dStpPortDesignatedRootGet(openapiClientHandle_t *client_handle,
615  uint32_t port, open_buffdesc *buffer);
616 
617 /**********************************************************************************/
632 open_error_t openapiDot1dStpPortDesignatedCostGet(openapiClientHandle_t *client_handle,
633  uint32_t port, uint32_t *value);
634 
635 /**********************************************************************************/
650 open_error_t openapiDot1dStpPortDesignatedBridgeGet(openapiClientHandle_t *client_handle,
651  uint32_t port, open_buffdesc *buffer);
652 
653 /**********************************************************************************/
668 open_error_t openapiDot1dStpPortDesignatedPortGet(openapiClientHandle_t *client_handle,
669  uint32_t port, uint16_t *value);
670 
671 /**********************************************************************************/
686 open_error_t openapiDot1dStpPortForwardTransitionsGet(openapiClientHandle_t *client_handle,
687  uint32_t port, uint32_t *value);
688 
689 /**********************************************************************************/
704 open_error_t openapiDot1dTpLearnedEntryDiscardsGet(openapiClientHandle_t *client_handle,
705  uint32_t *value);
706 
707 /**********************************************************************************/
723 open_error_t openapiDbDot1dTpAgingTimeGet(openapiClientHandle_t *client_handle,
724  uint32_t *value);
725 
726 /**********************************************************************************/
742 open_error_t openapiDbDot1dTpAgingTimeSet(openapiClientHandle_t *client_handle,
743  uint32_t value);
744 
745 /**********************************************************************************/
760 open_error_t openapiDot1dTpFdbEntryNextGet(openapiClientHandle_t *client_handle,
761  open_buffdesc *address);
762 
763 /**********************************************************************************/
778 open_error_t openapiDot1dTpFdbEntryGet(openapiClientHandle_t *client_handle,
779  open_buffdesc *address);
780 
781 /**********************************************************************************/
808 open_error_t openapiDot1dTpFdbPortGet(openapiClientHandle_t *client_handle,
809  open_buffdesc *address, uint32_t *value);
810 
811 /**********************************************************************************/
861 open_error_t openapiDot1dTpFdbStatusGet(openapiClientHandle_t *client_handle,
862  open_buffdesc *address, uint32_t *value);
863 
864 /**********************************************************************************/
879 open_error_t openapiDot1dTpPortMaxInfoGet(openapiClientHandle_t *client_handle,
880  uint32_t port, uint32_t *value);
881 
882 /**********************************************************************************/
897 open_error_t openapiDot1dTpPortInFramesGet(openapiClientHandle_t *client_handle,
898  uint32_t port, uint32_t *value);
899 
900 /**********************************************************************************/
915 open_error_t openapiDot1dTpPortOutFramesGet(openapiClientHandle_t *client_handle,
916  uint32_t port, uint32_t *value);
917 
918 /**********************************************************************************/
934 open_error_t openapiDot1dTpPortInDiscardsGet(openapiClientHandle_t *client_handle,
935  uint32_t port, uint32_t *value);
936 
937 #endif /* OPENAPI_BRIDGE_H_INCLUDED */
938