mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-11 00:43:01 +00:00
f65727a193
Existing sntp_request() function has a coarse integer seconds precision, discarding fractional part as returned by SNTP. Deprecate it, and instead introduce sntp_query() function which returns both integer and fractional seconds as a newly introduced structure sntp_tstamp. Fixes: #15596 Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
90 lines
2.0 KiB
C
90 lines
2.0 KiB
C
/*
|
|
* 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_
|
|
|
|
#include <net/socket.h>
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
u32_t expected_orig_ts;
|
|
};
|
|
|
|
/** Time as returned by SNTP API, fractional seconds since 1 Jan 1970 */
|
|
struct sntp_time {
|
|
u64_t seconds;
|
|
u32_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, u32_t timeout,
|
|
u64_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, u32_t timeout,
|
|
struct sntp_time *time);
|
|
|
|
/**
|
|
* @brief Release SNTP context
|
|
*
|
|
* @param ctx Address of sntp context.
|
|
*/
|
|
void sntp_close(struct sntp_ctx *ctx);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif
|