Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_sntp.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_sntp.h
28 *
29 * @purpose SNTP Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 28/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_SNTP_H_INCLUDED
39 #define OPENAPI_SNTP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_SNTP_CLIENT_DISABLED = 0,
47  OPEN_SNTP_CLIENT_UNICAST = 1,
48  OPEN_SNTP_CLIENT_BROADCAST = 2
49 } OPEN_SNTP_CLIENT_MODE_t;
50 
51 
53 typedef enum
54 {
55  OPEN_SNTP_SUPPORTED_DISABLED = 0,
56  OPEN_SNTP_SUPPORTED_UNICAST = 1,
57  OPEN_SNTP_SUPPORTED_BROADCAST = 2,
58  OPEN_SNTP_SUPPORTED_UNICAST_AND_BROADCAST = 3
59 }OPEN_SNTP_SUPPORTED_MODE_t;
60 
62 typedef enum
63 {
64  OPEN_SNTP_ADDRESS_UNKNOWN = 0,
65  OPEN_SNTP_ADDRESS_IPV4 = 1,
66  OPEN_SNTP_ADDRESS_IPV6 = 2,
67  OPEN_SNTP_ADDRESS_DNS = 3
68 } OPEN_SNTP_ADDRESS_TYPE_t;
69 
71 typedef enum
72 {
73  OPEN_SNTP_SERVER_MODE_RESERVED = 0,
74  OPEN_SNTP_SERVER_MODE_SYMMETRIC_ACTIVE = 1,
75  OPEN_SNTP_SERVER_MODE_SYMMETRIC_PASSIVE = 2,
76  OPEN_SNTP_SERVER_MODE_CLIENT = 3,
77  OPEN_SNTP_SERVER_MODE_SERVER = 4,
78  OPEN_SNTP_SERVER_MODE_BROADCAST = 5,
79  OPEN_SNTP_SERVER_MODE_RESERVED_CONTROL = 6,
80  OPEN_SNTP_SERVER_MODE_RESERVED_PRIVATE = 7
81 } OPEN_SNTP_SERVER_MODE_t;
82 
83 /*****************************************************************/
106 open_error_t openapiSntpServerAdd(openapiClientHandle_t *client_handle,
107  open_buffdesc *ipAddr);
108 
109 /*****************************************************************/
133 open_error_t openapiSntpServerPrioritySet(openapiClientHandle_t *client_handle,
134  open_buffdesc *ipAddr,
135  uint16_t priority);
136 
137 /*****************************************************************/
151 open_error_t openapiSntpServerPriorityMaxGet(openapiClientHandle_t *client_handle,
152  uint32_t *priorityMax);
153 
154 /*****************************************************************/
178 open_error_t openapiSntpServerPortSet(openapiClientHandle_t *client_handle,
179  open_buffdesc *ipAddr, uint16_t port);
180 
181 /*****************************************************************/
205 open_error_t openapiSntpServerVersionSet(openapiClientHandle_t *client_handle,
206  open_buffdesc *ipAddr, uint16_t version);
207 
208 /*****************************************************************/
224 open_error_t openapiSntpServersMaxSupportedGet(openapiClientHandle_t *client_handle,
225  uint32_t *maxSntpServers);
226 
227 /*****************************************************************/
248 open_error_t openapiSntpServerDelete(openapiClientHandle_t *client_handle,
249  open_buffdesc *ipAddr);
250 
251 /*****************************************************************/
265 open_error_t openapiSntpServerMaxAddrLenGet(openapiClientHandle_t *client_handle,
266  uint32_t *sntpServerAddrLen);
267 
268 /*****************************************************************/
285 open_error_t openapiSntpServerFirstGet(openapiClientHandle_t *client_handle,
286  open_buffdesc *sntpServer);
287 
288 /*****************************************************************/
307 open_error_t openapiSntpServerNextGet(openapiClientHandle_t *client_handle,
308  open_buffdesc *sntpServer,
309  open_buffdesc *nextSntpServer);
310 
311 /*****************************************************************/
327 open_error_t openapiSntpServerAddressTypeGet(openapiClientHandle_t *client_handle,
328  open_buffdesc *sntpServer,
329  OPEN_SNTP_ADDRESS_TYPE_t *sntpServerAddrType);
330 
331 /*****************************************************************/
347 open_error_t openapiSntpServerPriorityGet(openapiClientHandle_t *client_handle,
348  open_buffdesc *sntpServer,
349  uint16_t *serverPriority);
350 
351 /*****************************************************************/
367 open_error_t openapiSntpServerVersionGet(openapiClientHandle_t *client_handle,
368  open_buffdesc *sntpServer,
369  uint16_t *serverVersion);
370 
371 /*****************************************************************/
387 open_error_t openapiSntpServerPortGet(openapiClientHandle_t *client_handle,
388  open_buffdesc *sntpServer,
389  uint16_t *serverPort);
390 
391 /*****************************************************************/
410 open_error_t openapiSntpClientModeSet(openapiClientHandle_t *client_handle,
411  OPEN_SNTP_CLIENT_MODE_t mode);
412 
413 /*****************************************************************/
427 open_error_t openapiSntpClientModeGet(openapiClientHandle_t *client_handle,
428  OPEN_SNTP_CLIENT_MODE_t *sntpClientMode);
429 
430 /*****************************************************************/
444 open_error_t openapiSntpClientSupportedModeGet(openapiClientHandle_t *client_handle,
445  OPEN_SNTP_SUPPORTED_MODE_t *sntpClientSupportedMode);
446 
447 
448 /*****************************************************************/
463 open_error_t openapiActiveSntpServerAddressTypeGet(openapiClientHandle_t *client_handle,
464  OPEN_SNTP_ADDRESS_TYPE_t *type);
465 
466 /*****************************************************************/
485 open_error_t openapiActiveSntpServerIpAddressGet(openapiClientHandle_t *client_handle,
486  open_buffdesc *sntpServer);
487 
488 /*****************************************************************/
503 open_error_t openapiActiveSntpServerStratumGet(openapiClientHandle_t *client_handle,
504  uint32_t *stratum);
505 
506 /*****************************************************************/
521 open_error_t openapiActiveSntpServerReferenceIdGet(openapiClientHandle_t *client_handle,
522  open_buffdesc *reference);
523 
524 /*****************************************************************/
537 open_error_t openapiSntpServerReferenceStringLengthGet(openapiClientHandle_t *client_handle,
538  uint32_t *refStrLen);
539 
540 /*****************************************************************/
554 open_error_t openapiActiveSntpServerModeGet(openapiClientHandle_t *client_handle,
555  OPEN_SNTP_SERVER_MODE_t *serverMode);
556 
557 /*****************************************************************/
571 open_error_t openapiSntpServerCurrentEntriesGet(openapiClientHandle_t *client_handle,
572  uint32_t *currEntries);
573 #endif
574