Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | /*
* Copyright (c) 2017 Linaro Limited
* Copyright (c) 2019 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_NET_SNTP_H_
#define ZEPHYR_INCLUDE_NET_SNTP_H_
#ifdef CONFIG_NET_SOCKETS_POSIX_NAMES
#include <net/socket.h>
#else
#include <posix/sys/socket.h>
#include <posix/unistd.h>
#include <posix/poll.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Simple Network Time Protocol API
* @defgroup sntp SNTP
* @ingroup networking
* @{
*/
/** SNTP context */
struct sntp_ctx {
struct {
struct pollfd fds[1];
int nfds;
int fd;
} sock;
/** Timestamp when the request was sent from client to server.
* This is used to check if the originated timestamp in the server
* reply matches the one in client request.
*/
uint32_t expected_orig_ts;
};
/** Time as returned by SNTP API, fractional seconds since 1 Jan 1970 */
struct sntp_time {
uint64_t seconds;
uint32_t fraction;
};
/**
* @brief Initialize SNTP context
*
* @param ctx Address of sntp context.
* @param addr IP address of NTP/SNTP server.
* @param addr_len IP address length of NTP/SNTP server.
*
* @return 0 if ok, <0 if error.
*/
int sntp_init(struct sntp_ctx *ctx, struct sockaddr *addr,
socklen_t addr_len);
/**
* @brief SNTP query with seconds precision (deprecated)
*
* @param ctx Address of sntp context.
* @param timeout Timeout of waiting for sntp response (in milliseconds).
* @param epoch_time Seconds since 1 January 1970 (output).
*
* @return 0 if ok, <0 if error (-ETIMEDOUT if timeout).
*/
__deprecated int sntp_request(struct sntp_ctx *ctx, uint32_t timeout,
uint64_t *epoch_time);
/**
* @brief Perform SNTP query
*
* @param ctx Address of sntp context.
* @param timeout Timeout of waiting for sntp response (in milliseconds).
* @param time Timestamp including integer and fractional seconds since
* 1 Jan 1970 (output).
*
* @return 0 if ok, <0 if error (-ETIMEDOUT if timeout).
*/
int sntp_query(struct sntp_ctx *ctx, uint32_t timeout,
struct sntp_time *time);
/**
* @brief Release SNTP context
*
* @param ctx Address of sntp context.
*/
void sntp_close(struct sntp_ctx *ctx);
/**
* @brief Convenience function to query SNTP in one-shot fashion
*
* Convenience wrapper which calls getaddrinfo(), sntp_init(),
* sntp_query(), and sntp_close().
*
* @param server Address of server in format addr[:port]
* @param timeout Query timeout
* @param time Timestamp including integer and fractional seconds since
* 1 Jan 1970 (output).
*
* @return 0 if ok, <0 if error (-ETIMEDOUT if timeout).
*/
int sntp_simple(const char *server, uint32_t timeout,
struct sntp_time *time);
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif
|