Outline ![]()
Files ![]()
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
* SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include "freertos/FreeRTOS.h"
#include "freertos/event_groups.h"
#include "esp_event.h"
#include "esp_log.h"
#include "esp_check.h"
#include "esp_netif.h"
#include "esp_netif_sntp.h"
#include "esp_sntp.h"
// Remove compat macro and include lwip API
#undef SNTP_OPMODE_POLL
#include "lwip/apps/sntp.h"
static const char *TAG = "esp_netif_sntp";
typedef struct sntp_storage {
esp_sntp_time_cb_t sync_cb;
SemaphoreHandle_t sync_sem;
ip_event_t ip_event_to_renew;
size_t index_of_first_server;
size_t num_of_servers;
char* servers[];
} sntp_storage_t;
static sntp_storage_t *s_storage = NULL;
static void sync_time_cb(struct timeval *tv)
{
if (s_storage && s_storage->sync_sem) {
xSemaphoreGive(s_storage->sync_sem);
}
if (s_storage && s_storage->sync_cb) {
s_storage->sync_cb(tv);
}
}
static esp_err_t sntp_init_api(void *ctx)
{
esp_err_t ret = ESP_OK;
esp_sntp_config_t * config = ctx;
ESP_GOTO_ON_FALSE(config->num_of_servers <= SNTP_MAX_SERVERS, ESP_ERR_INVALID_ARG, err, TAG, "Tried to configure more servers than enabled in lwip. Please update CONFIG_SNTP_MAX_SERVERS");
sntp_set_time_sync_notification_cb(sync_time_cb);
sntp_setoperatingmode(SNTP_OPMODE_POLL);
for (int i = 0; i < config->num_of_servers; ++i) {
sntp_setservername(i, config->servers[i]);
}
if (config->server_from_dhcp) {
#if LWIP_DHCP_GET_NTP_SRV
sntp_servermode_dhcp(1);
#else
ESP_GOTO_ON_FALSE(false, ESP_ERR_INVALID_ARG, err, TAG, "Tried to configure SNTP server from DHCP, while disabled. Please enable CONFIG_LWIP_DHCP_GET_NTP_SRV");
#endif
}
if (config->smooth_sync) {
sntp_set_sync_mode(SNTP_SYNC_MODE_SMOOTH);
}
if (config->start) {
sntp_init();
}
err:
return ret;
}
static esp_err_t renew_servers_api(void *ctx)
{
if (s_storage && s_storage->num_of_servers) {
for (int i = 0; i < s_storage->num_of_servers; ++i) {
sntp_setservername(i + s_storage->index_of_first_server, s_storage->servers[i]);
}
}
return ESP_OK;
}
void esp_netif_sntp_renew_servers(void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data)
{
esp_netif_tcpip_exec(renew_servers_api, NULL);
}
esp_err_t esp_netif_sntp_init(const esp_sntp_config_t * config)
{
esp_err_t ret = ESP_OK;
ESP_RETURN_ON_FALSE(s_storage == NULL, ESP_ERR_INVALID_STATE, TAG, "esp_netif_sntp already initialized");
s_storage = calloc(1, sizeof(sntp_storage_t) + // allocate space for servers only if we are supposed to refresh the settings
(config->renew_servers_after_new_IP ? config->num_of_servers * sizeof(char*) : 0));
ESP_GOTO_ON_FALSE(s_storage != NULL, ESP_ERR_NO_MEM, err, TAG, "Failed to allocate SNTP storage");
if (config->wait_for_sync) {
s_storage->sync_sem = xSemaphoreCreateBinary();
ESP_GOTO_ON_FALSE(s_storage->sync_sem != NULL, ESP_ERR_NO_MEM, err, TAG, "Failed to SNTP sync semaphore");
}
if (config->renew_servers_after_new_IP && config->num_of_servers > 0) {
s_storage->num_of_servers = config->num_of_servers;
s_storage->index_of_first_server = config->index_of_first_server;
// store the server names, as we'd have to refresh the config after IP event
for (int i = 0; i < config->num_of_servers; ++i) {
s_storage->servers[i] = strdup(config->servers[i]);
}
ESP_GOTO_ON_ERROR(esp_event_handler_register(IP_EVENT, config->ip_event_to_renew, esp_netif_sntp_renew_servers, NULL),
err, TAG, "Failed to register IP event");
s_storage->ip_event_to_renew = config->ip_event_to_renew;
}
if (config->sync_cb) {
s_storage->sync_cb = config->sync_cb;
}
ESP_GOTO_ON_ERROR(esp_netif_tcpip_exec(sntp_init_api, (void*)config), err, TAG, "Failed initialize SNTP service");
return ret;
err:
esp_netif_sntp_deinit();
return ret;
}
static esp_err_t sntp_stop_api(void *ctx)
{
sntp_stop();
return ESP_OK;
}
void esp_netif_sntp_deinit(void)
{
if (s_storage) {
sntp_storage_t *storage = s_storage;
s_storage = NULL;
sntp_set_time_sync_notification_cb(NULL);
esp_netif_tcpip_exec(sntp_stop_api, NULL);
if (storage->num_of_servers) {
for (int i = 0; i < storage->num_of_servers; ++i) {
free(storage->servers[i]);
}
esp_event_handler_unregister(IP_EVENT, storage->ip_event_to_renew, esp_netif_sntp_renew_servers);
}
if (storage->sync_sem) {
vSemaphoreDelete(storage->sync_sem);
}
free(storage);
}
}
esp_err_t esp_netif_sntp_sync_wait(TickType_t tout)
{
if (s_storage == NULL || s_storage->sync_sem == NULL) {
return ESP_ERR_INVALID_STATE;
}
if (xQueueSemaphoreTake(s_storage->sync_sem, tout) != pdTRUE) {
return ESP_ERR_TIMEOUT;
}
if (sntp_get_sync_mode() == SNTP_SYNC_MODE_SMOOTH &&
sntp_get_sync_status() == SNTP_SYNC_STATUS_IN_PROGRESS) {
return ESP_ERR_NOT_FINISHED;
}
return ESP_OK;
}
static esp_err_t sntp_start_api(void* ctx)
{
sntp_stop();
sntp_init();
return ESP_OK;
}
esp_err_t esp_netif_sntp_start(void)
{
return esp_netif_tcpip_exec(sntp_start_api, NULL);
}
esp_err_t esp_netif_sntp_reachability(unsigned int index, unsigned int *reachability)
{
if (index >= SNTP_MAX_SERVERS || reachability == NULL) {
return ESP_ERR_INVALID_ARG;
}
if (s_storage == NULL || sntp_enabled() == 0) {
return ESP_ERR_INVALID_STATE;
}
*reachability = sntp_getreachability(index);
return ESP_OK;
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.