Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_pml.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 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 * 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_pml.h
40 *
41 * @purpose Port MAC Locking (PML) Configuration and Status
42 *
43 * @component OPEN
44 *
45 * @create 09/10/2018
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_PML_H_INCLUDED
51 #define OPENAPI_PML_H_INCLUDED
52 
53 #include "openapi_common.h"
54 
55 /*****************************************************************/
70 
71 /*****************************************************************/
87 open_error_t openapiPmlIntfIsValid(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_BOOL_t *isValid);
88 
89 /*****************************************************************/
105 open_error_t openapiPmlIntfModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode);
106 
107 /*****************************************************************/
123 open_error_t openapiPmlIntfDynamicLimitGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit);
124 
125 /*****************************************************************/
141 open_error_t openapiPmlIntfStaticLimitGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit);
142 
143 /*****************************************************************/
160 
161 /*****************************************************************/
178 
179 /*****************************************************************/
195 open_error_t openapiPmlIntfStickyModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *stickyMode);
196 
197 #endif /* OPENAPI_PML_H_INCLUDED */
198 
open_error_t openapiPmlIntfIsValid(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_BOOL_t *isValid)
Get whether an interface is a valid PML interface or not.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiPmlIntfStaticLimitGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
Get the Port MAC Locking static limit for the specified interface.
open_error_t openapiPmlIntfViolationTrapModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *trapMode)
Get the Port MAC Locking violation trap mode for the specified interface.
open_error_t openapiPmlIntfViolationDDisableModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Get the Port MAC Locking violation D-Disable mode for the specified interface.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
open_error_t openapiPmlIntfModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode)
Get the Port MAC Locking mode for the specified interface.
open_error_t openapiPmlGlobalAdminModeGet(openapiClientHandle_t *clientHandle, OPEN_CONTROL_t *adminMode)
Get the Port MAC Locking Global Admin mode.
open_error_t openapiPmlIntfStickyModeGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *stickyMode)
Get the Port MAC Locking sticky mode for the specified interface.
open_error_t openapiPmlIntfDynamicLimitGet(openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
Get the Port MAC Locking dynamic limit for the specified interface.