Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_garp.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2022-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 ***********************************************************************
26 *
27 * @filename openapi_garp.h
28 *
29 * @purpose This code implements the OpEN APIs for GARP
30 *
31 * @component OPEN
32 *
33 * @create 11/16/2022
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_GARP_H_INCLUDED
39 #define OPENAPI_GARP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /* join timer */
44 #define OPEN_GARP_MIN_JOIN_TIME 10 /* centiseconds */
45 #define OPEN_GARP_MAX_JOIN_TIME 100 /* centiseconds */
46 #define OPEN_GARP_DEF_JOIN_TIME 20 /* centiseconds */
47 
48 /* leave timer */
49 #define OPEN_GARP_MIN_LEAVE_TIME 20 /* centiseconds */
50 #define OPEN_GARP_MAX_LEAVE_TIME 600 /* centiseconds */
51 #define OPEN_GARP_DEF_LEAVE_TIME 60 /* centiseconds */
52 
53 /* leave all timer */
54 #define OPEN_GARP_MIN_LEAVE_ALL_TIME 200 /* centiseconds */
55 #define OPEN_GARP_MAX_LEAVE_ALL_TIME 6000 /* centiseconds */
56 #define OPEN_GARP_DEF_LEAVE_ALL_TIME 1000 /* centiseconds */
57 
58 
59 /*************************************************************************/
74 open_error_t openapiGarpGmrpEnableGet(openapiClientHandle_t *client_handle,
75  OPEN_CONTROL_t *globalGmrpStatus);
76 
77 /*************************************************************************/
93 open_error_t openapiGarpGmrpEnableSet(openapiClientHandle_t *client_handle,
94  OPEN_CONTROL_t globalGmrpStatus);
95 
96 /*************************************************************************/
112 open_error_t openapiGarpGmrpPortEnableGet(openapiClientHandle_t *client_handle,
113  uint32_t ifNum,
114  OPEN_CONTROL_t *intfGmrpStatus);
115 
116 /*************************************************************************/
133 open_error_t openapiGarpGmrpPortEnableSet(openapiClientHandle_t *client_handle,
134  uint32_t ifNum,
135  OPEN_CONTROL_t intfGmrpStatus);
136 
137 /*************************************************************************/
152 open_error_t openapiGarpGvrpEnableGet(openapiClientHandle_t *client_handle,
153  OPEN_CONTROL_t *globalGvrpStatus);
154 
155 /*************************************************************************/
171 open_error_t openapiGarpGvrpEnableSet(openapiClientHandle_t *client_handle,
172  OPEN_CONTROL_t globalGvrpStatus);
173 
174 /*************************************************************************/
190 open_error_t openapiGarpGvrpPortEnableGet(openapiClientHandle_t *client_handle,
191  uint32_t ifNum,
192  OPEN_CONTROL_t *intfGvrpStatus);
193 
194 /*************************************************************************/
211 open_error_t openapiGarpGvrpPortEnableSet(openapiClientHandle_t *client_handle,
212  uint32_t ifNum,
213  OPEN_CONTROL_t intfGvrpStatus);
214 
215 /*************************************************************************/
231 open_error_t openapiGarpJoinTimeGet(openapiClientHandle_t *client_handle,
232  uint32_t ifNum, uint32_t *joinTime);
233 
234 /*************************************************************************/
253 open_error_t openapiGarpJoinTimeSet(openapiClientHandle_t *client_handle,
254  uint32_t ifNum, uint32_t joinTime);
255 
256 /*************************************************************************/
272 open_error_t openapiGarpLeaveTimeGet(openapiClientHandle_t *client_handle,
273  uint32_t ifNum, uint32_t *leaveTime);
274 
275 /*************************************************************************/
294 open_error_t openapiGarpLeaveTimeSet(openapiClientHandle_t *client_handle,
295  uint32_t ifNum, uint32_t leaveTime);
296 
297 /*************************************************************************/
313 open_error_t openapiGarpLeaveAllTimeGet(openapiClientHandle_t *client_handle,
314  uint32_t ifNum, uint32_t *leaveAllTime);
315 
316 /*************************************************************************/
335 open_error_t openapiGarpLeaveAllTimeSet(openapiClientHandle_t *client_handle,
336  uint32_t ifNum, uint32_t leaveAllTime);
337 
338 /*************************************************************************/
357 open_error_t openapiGarpGmrpFailedRegistrationsGet(openapiClientHandle_t *client_handle,
358  uint32_t ifNum,
359  uint32_t *gmrpFailedRegistrations);
360 
361 /*************************************************************************/
379 open_error_t openapiGarpGmrpReceivePDUCountGet(openapiClientHandle_t *client_handle,
380  uint32_t ifNum,
381  uint32_t *gmrpPduRxCount);
382 
383 /*************************************************************************/
401 open_error_t openapiGarpGmrpTransmitPDUCountGet(openapiClientHandle_t *client_handle,
402  uint32_t ifNum,
403  uint32_t *gmrpPduTxCount);
404 
405 /*************************************************************************/
424 open_error_t openapiGarpGvrpFailedRegistrationsGet(openapiClientHandle_t *client_handle,
425  uint32_t ifNum,
426  uint32_t *gvrpFailedRegistrations);
427 
428 /*************************************************************************/
446 open_error_t openapiGarpGvrpReceivePDUCountGet(openapiClientHandle_t *client_handle,
447  uint32_t ifNum,
448  uint32_t *gvrpPduRxCount);
449 
450 /*************************************************************************/
468 open_error_t openapiGarpGvrpTransmitPDUCountGet(openapiClientHandle_t *client_handle,
469  uint32_t ifNum,
470  uint32_t *gvrpPduTxCount);
471 #endif /* OPENAPI_GARP_H_INCLUDED */
472 
openapiGarpLeaveAllTimeGet
open_error_t openapiGarpLeaveAllTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *leaveAllTime)
Get the GARP Leave All Time.
openapiGarpGvrpPortEnableGet
open_error_t openapiGarpGvrpPortEnableGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *intfGvrpStatus)
Get the GVRP interface status.
openapiGarpGmrpTransmitPDUCountGet
open_error_t openapiGarpGmrpTransmitPDUCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gmrpPduTxCount)
Get the number of GMRP PDUs transmitted from an interface.
openapiGarpGvrpReceivePDUCountGet
open_error_t openapiGarpGvrpReceivePDUCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gvrpPduRxCount)
Get the number of GVRP PDUs received on an interface.
openapiGarpJoinTimeGet
open_error_t openapiGarpJoinTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *joinTime)
Get the GARP Join Time.
openapiGarpJoinTimeSet
open_error_t openapiGarpJoinTimeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t joinTime)
Set the GARP Join Time.
openapiGarpGmrpPortEnableGet
open_error_t openapiGarpGmrpPortEnableGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *intfGmrpStatus)
Get the GMRP interface status.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiGarpGvrpPortEnableSet
open_error_t openapiGarpGvrpPortEnableSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGvrpStatus)
Set the GVRP interface status.
openapiGarpGvrpEnableGet
open_error_t openapiGarpGvrpEnableGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *globalGvrpStatus)
Get the GVRP global status.
openapiClientHandle_s
Definition: openapi_common.h:131
openapiGarpGmrpFailedRegistrationsGet
open_error_t openapiGarpGmrpFailedRegistrationsGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gmrpFailedRegistrations)
Get the number of failed GMRP registrations of the interface.
openapiGarpGvrpTransmitPDUCountGet
open_error_t openapiGarpGvrpTransmitPDUCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gvrpPduTxCount)
Get the number of GVRP PDUs transmitted from an interface.
openapiGarpGmrpEnableSet
open_error_t openapiGarpGmrpEnableSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t globalGmrpStatus)
Set the GMRP global status.
openapiGarpGmrpReceivePDUCountGet
open_error_t openapiGarpGmrpReceivePDUCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gmrpPduRxCount)
Get the number of GMRP PDUs received on an interface.
openapiGarpLeaveAllTimeSet
open_error_t openapiGarpLeaveAllTimeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t leaveAllTime)
Set the GARP Leave All Time.
openapiGarpLeaveTimeGet
open_error_t openapiGarpLeaveTimeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *leaveTime)
Get the GARP Leave Time.
openapiGarpGmrpEnableGet
open_error_t openapiGarpGmrpEnableGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *globalGmrpStatus)
Get the GMRP global status.
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
openapiGarpLeaveTimeSet
open_error_t openapiGarpLeaveTimeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t leaveTime)
Set the GARP Leave Time.
openapiGarpGvrpEnableSet
open_error_t openapiGarpGvrpEnableSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t globalGvrpStatus)
Set the GVRP global status.
openapiGarpGvrpFailedRegistrationsGet
open_error_t openapiGarpGvrpFailedRegistrationsGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *gvrpFailedRegistrations)
Get the number of failed GVRP registrations of the interface.
openapi_common.h
openapiGarpGmrpPortEnableSet
open_error_t openapiGarpGmrpPortEnableSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfGmrpStatus)
Set the GMRP interface status.