Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_ptp_tc.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2019 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_ptp_tc.h
28 *
29 * @purpose PTP TC Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @note This code must not include any ICOS header files.
34 *
35 * @create 03/13/2019
36 *
37 * @end
38 *
39 **********************************************************************/
40 #ifndef OPENAPI_PTP_TC_H_INCLUDED
41 #define OPENAPI_PTP_TC_H_INCLUDED
42 
43 #include "openapi_common.h"
44 
45 /*****************************************************************/
60 open_error_t openapiPtpTcAdminModeSet(openapiClientHandle_t *client_handle,
61  OPEN_CONTROL_t mode);
62 
63 /*****************************************************************/
76 open_error_t openapiPtpTcAdminModeGet(openapiClientHandle_t *client_handle,
77  OPEN_CONTROL_t *mode);
78 
79 /*************************************************************************/
92 open_error_t openapiPtpTcIsSupportedGet(openapiClientHandle_t *client_handle,
93  OPEN_BOOL_t *isSupported);
94 
95 /*************************************************************************/
109 open_error_t openapiPtpTcIsValidUnitGet(openapiClientHandle_t *client_handle,
110  uint32_t unit, OPEN_BOOL_t *isValid);
111 
112 /*************************************************************************/
128 open_error_t openapiPtpTcIntfHwConfigAllowedGet(openapiClientHandle_t *client_handle, uint32_t intfNum,
129  OPEN_BOOL_t *isAllowed);
130 
131 /*************************************************************************/
146 open_error_t openapiPtpTcIntfAdminModeGet(openapiClientHandle_t *client_handle,
147  uint32_t intfNum, OPEN_CONTROL_t *adminMode);
148 
149 /*************************************************************************/
164 open_error_t openapiPtpTcIntfAdminModeSet(openapiClientHandle_t *client_handle,
165  uint32_t intfNum, OPEN_CONTROL_t adminMode);
166 
167 /*************************************************************************/
182 open_error_t openapiPtpTcIntfOperAdminModeGet(openapiClientHandle_t *client_handle,
183  uint32_t intfNum, OPEN_CONTROL_t *mode);
184 
185 /*************************************************************************/
201 open_error_t openapiPtpTcIsValidIntfGet(openapiClientHandle_t *client_handle,
202  uint32_t intfNum, OPEN_BOOL_t *isValid);
203 
204 
205 #endif /* OPENAPI_PTPTC_H_INCLUDED */
206