Skip to content

Commit d114f54

Browse files
kjbraceykjbracey
committed
ESP8266: Convert to Chrono
1 parent d1ae0d5 commit d114f54

File tree

4 files changed

+68
-49
lines changed

4 files changed

+68
-49
lines changed

‎components/wifi/esp8266-driver/ESP8266/ESP8266.cpp‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@
4040

4141

4242
using namespace mbed;
43+
using namespace std::chrono;
44+
using std::milli;
4345

4446
ESP8266::ESP8266(PinName tx, PinName rx, bool debug, PinName rts, PinName cts)
4547
: _sdk_v(-1, -1, -1),
@@ -275,12 +277,12 @@ bool ESP8266::startup(int mode)
275277

276278
bool ESP8266::reset(void)
277279
{
278-
static const int ESP8266_BOOTTIME = 10000; // [ms]
280+
static const auto ESP8266_BOOTTIME = 10s;
279281
bool done = false;
280282

281283
_smutex.lock();
282284

283-
unsigned long int start_time = rtos::Kernel::get_ms_count();
285+
auto start_time = rtos::Kernel::Clock::now();
284286
_reset_done = false;
285287
set_timeout(ESP8266_RECV_TIMEOUT);
286288
for (int i = 0; i < 2; i++) {
@@ -291,10 +293,10 @@ bool ESP8266::reset(void)
291293

292294
while (!_reset_done) {
293295
_process_oob(ESP8266_RECV_TIMEOUT, true); // UART mutex claimed -> need to check for OOBs ourselves
294-
if (_reset_done || (rtos::Kernel::get_ms_count() - start_time >= ESP8266_BOOTTIME)) {
296+
if (_reset_done || rtos::Kernel::Clock::now() - start_time >= ESP8266_BOOTTIME) {
295297
break;
296298
}
297-
rtos::ThisThread::sleep_for(100);
299+
rtos::ThisThread::sleep_for(100ms);
298300
}
299301

300302
done = _reset_done;
@@ -494,12 +496,12 @@ int8_t ESP8266::rssi()
494496
return rssi;
495497
}
496498

497-
int ESP8266::scan(WiFiAccessPoint *res, unsigned limit, scan_mode mode, unsigned t_max, unsigned t_min)
499+
int ESP8266::scan(WiFiAccessPoint *res, unsigned limit, scan_mode mode, duration<unsigned, milli> t_max, duration<unsigned, milli> t_min)
498500
{
499501
_smutex.lock();
500502

501503
// Default timeout plus time spend scanning each channel
502-
set_timeout(ESP8266_MISC_TIMEOUT + 13 * (t_max ? t_max : ESP8266_SCAN_TIME_MAX_DEFAULT));
504+
set_timeout(ESP8266_MISC_TIMEOUT + 13 * (t_max != t_max.zero() ? t_max : duration<unsigned, milli>(ESP8266_SCAN_TIME_MAX_DEFAULT)));
503505

504506
_scan_r.res = res;
505507
_scan_r.limit = limit;
@@ -508,7 +510,7 @@ int ESP8266::scan(WiFiAccessPoint *res, unsigned limit, scan_mode mode, unsigned
508510
bool ret_parse_send = true;
509511

510512
if (FW_AT_LEAST_VERSION(_at_v.major, _at_v.minor, _at_v.patch, 0, ESP8266_AT_VERSION_WIFI_SCAN_CHANGE)) {
511-
ret_parse_send = _parser.send("AT+CWLAP=,,,%u,%u,%u", (mode == SCANMODE_ACTIVE ? 0 : 1), t_min, t_max);
513+
ret_parse_send = _parser.send("AT+CWLAP=,,,%u,%u,%u", (mode == SCANMODE_ACTIVE ? 0 : 1), t_min.count(), t_max.count());
512514
} else {
513515
ret_parse_send = _parser.send("AT+CWLAP");
514516
}
@@ -844,7 +846,7 @@ void ESP8266::_oob_packet_hdlr()
844846
_packets_end = &packet->next;
845847
}
846848

847-
void ESP8266::_process_oob(uint32_t timeout, bool all)
849+
void ESP8266::_process_oob(duration<uint32_t, milli> timeout, bool all)
848850
{
849851
set_timeout(timeout);
850852
// Poll for inbound packets
@@ -853,14 +855,14 @@ void ESP8266::_process_oob(uint32_t timeout, bool all)
853855
set_timeout();
854856
}
855857

856-
void ESP8266::bg_process_oob(uint32_t timeout, bool all)
858+
void ESP8266::bg_process_oob(duration<uint32_t, milli> timeout, bool all)
857859
{
858860
_smutex.lock();
859861
_process_oob(timeout, all);
860862
_smutex.unlock();
861863
}
862864

863-
int32_t ESP8266::_recv_tcp_passive(int id, void *data, uint32_t amount, uint32_t timeout)
865+
int32_t ESP8266::_recv_tcp_passive(int id, void *data, uint32_t amount, duration<uint32_t, milli> timeout)
864866
{
865867
int32_t ret = NSAPI_ERROR_WOULD_BLOCK;
866868

@@ -923,7 +925,7 @@ int32_t ESP8266::_recv_tcp_passive(int id, void *data, uint32_t amount, uint32_t
923925
return ret;
924926
}
925927

926-
int32_t ESP8266::recv_tcp(int id, void *data, uint32_t amount, uint32_t timeout)
928+
int32_t ESP8266::recv_tcp(int id, void *data, uint32_t amount, duration<uint32_t, milli> timeout)
927929
{
928930
if (_tcp_passive) {
929931
return _recv_tcp_passive(id, data, amount, timeout);
@@ -981,7 +983,7 @@ int32_t ESP8266::recv_tcp(int id, void *data, uint32_t amount, uint32_t timeout)
981983
return NSAPI_ERROR_WOULD_BLOCK;
982984
}
983985

984-
int32_t ESP8266::recv_udp(struct esp8266_socket *socket, void *data, uint32_t amount, uint32_t timeout)
986+
int32_t ESP8266::recv_udp(struct esp8266_socket *socket, void *data, uint32_t amount, duration<uint32_t, milli> timeout)
985987
{
986988
_smutex.lock();
987989
set_timeout(timeout);
@@ -1099,9 +1101,9 @@ bool ESP8266::close(int id)
10991101
return false;
11001102
}
11011103

1102-
void ESP8266::set_timeout(uint32_t timeout_ms)
1104+
void ESP8266::set_timeout(duration<uint32_t, milli> timeout)
11031105
{
1104-
_parser.set_timeout(timeout_ms);
1106+
_parser.set_timeout(timeout.count());
11051107
}
11061108

11071109
bool ESP8266::readable()
@@ -1172,7 +1174,7 @@ bool ESP8266::get_sntp_time(std::tm *t)
11721174
memset(buf, 0, 25);
11731175

11741176
bool done = _parser.send("AT+CIPSNTPTIME?")
1175-
&& _parser.scanf("+CIPSNTPTIME:%24c", &buf)
1177+
&& _parser.scanf("+CIPSNTPTIME:%24c", buf)
11761178
&& _parser.recv("OK\n");
11771179
_smutex.unlock();
11781180

‎components/wifi/esp8266-driver/ESP8266/ESP8266.h‎

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,35 @@
2828
#include "PinNames.h"
2929
#include "platform/ATCmdParser.h"
3030
#include "platform/Callback.h"
31+
#include "platform/mbed_chrono.h"
3132
#include "platform/mbed_error.h"
3233
#include "rtos/Mutex.h"
3334
#include "rtos/ThisThread.h"
3435
#include "features/netsocket/SocketAddress.h"
3536

3637
// Various timeouts for different ESP8266 operations
38+
// (some of these can't use literal form as they're needed for defaults in this header, where
39+
// we shouldn't add a using directive for them. Defines only used in the C++ file can use literals).
3740
#ifndef ESP8266_CONNECT_TIMEOUT
38-
#define ESP8266_CONNECT_TIMEOUT 15000
41+
#define ESP8266_CONNECT_TIMEOUT 15s
3942
#endif
4043
#ifndef ESP8266_SEND_TIMEOUT
41-
#define ESP8266_SEND_TIMEOUT 2000
44+
#define ESP8266_SEND_TIMEOUT 2s
4245
#endif
4346
#ifndef ESP8266_RECV_TIMEOUT
44-
#define ESP8266_RECV_TIMEOUT 2000
47+
#define ESP8266_RECV_TIMEOUT std::chrono::seconds(2)
4548
#endif
4649
#ifndef ESP8266_MISC_TIMEOUT
47-
#define ESP8266_MISC_TIMEOUT 2000
50+
#define ESP8266_MISC_TIMEOUT std::chrono::seconds(2)
4851
#endif
4952
#ifndef ESP8266_DNS_TIMEOUT
50-
#define ESP8266_DNS_TIMEOUT 15000
53+
#define ESP8266_DNS_TIMEOUT 15s
5154
#endif
5255

53-
#define ESP8266_SCAN_TIME_MIN 0 // [ms]
54-
#define ESP8266_SCAN_TIME_MAX 1500 // [ms]
55-
#define ESP8266_SCAN_TIME_MIN_DEFAULT 120 // [ms]
56-
#define ESP8266_SCAN_TIME_MAX_DEFAULT 360 // [ms]
56+
#define ESP8266_SCAN_TIME_MIN 0ms
57+
#define ESP8266_SCAN_TIME_MAX 1500ms
58+
#define ESP8266_SCAN_TIME_MIN_DEFAULT 120ms
59+
#define ESP8266_SCAN_TIME_MAX_DEFAULT 360ms
5760

5861
// Firmware version
5962
#define ESP8266_SDK_VERSION 2000000
@@ -237,7 +240,9 @@ class ESP8266 {
237240
* @return Number of entries in @a res, or if @a count was 0 number of available networks, negative on error
238241
* see @a nsapi_error
239242
*/
240-
int scan(WiFiAccessPoint *res, unsigned limit, scan_mode mode, unsigned t_max, unsigned t_min);
243+
int scan(WiFiAccessPoint *res, unsigned limit, scan_mode mode,
244+
std::chrono::duration<unsigned, std::milli> t_max,
245+
std::chrono::duration<unsigned, std::milli> t_min);
241246

242247
/**Perform a dns query
243248
*
@@ -292,7 +297,7 @@ class ESP8266 {
292297
* @param amount number of bytes to be received
293298
* @return the number of bytes received
294299
*/
295-
int32_t recv_udp(struct esp8266_socket *socket, void *data, uint32_t amount, uint32_t timeout = ESP8266_RECV_TIMEOUT);
300+
int32_t recv_udp(struct esp8266_socket *socket, void *data, uint32_t amount, mbed::chrono::milliseconds_u32 timeout = ESP8266_RECV_TIMEOUT);
296301

297302
/**
298303
* Receives stream data from an open TCP socket
@@ -302,7 +307,7 @@ class ESP8266 {
302307
* @param amount number of bytes to be received
303308
* @return the number of bytes received
304309
*/
305-
int32_t recv_tcp(int id, void *data, uint32_t amount, uint32_t timeout = ESP8266_RECV_TIMEOUT);
310+
int32_t recv_tcp(int id, void *data, uint32_t amount, mbed::chrono::milliseconds_u32 timeout = ESP8266_RECV_TIMEOUT);
306311

307312
/**
308313
* Closes a socket
@@ -317,7 +322,7 @@ class ESP8266 {
317322
*
318323
* @param timeout_ms timeout of the connection
319324
*/
320-
void set_timeout(uint32_t timeout_ms = ESP8266_MISC_TIMEOUT);
325+
void set_timeout(mbed::chrono::milliseconds_u32 timeout = ESP8266_MISC_TIMEOUT);
321326

322327
/**
323328
* Checks if data is available
@@ -454,7 +459,7 @@ class ESP8266 {
454459
* @param timeout AT parser receive timeout
455460
* @param if TRUE, process all OOBs instead of only one
456461
*/
457-
void bg_process_oob(uint32_t timeout, bool all);
462+
void bg_process_oob(std::chrono::duration<uint32_t, std::milli> timeout, bool all);
458463

459464
/**
460465
* Flush the serial port input buffers.
@@ -485,7 +490,7 @@ class ESP8266 {
485490

486491
// FW version specific settings and functionalities
487492
bool _tcp_passive;
488-
int32_t _recv_tcp_passive(int id, void *data, uint32_t amount, uint32_t timeout);
493+
int32_t _recv_tcp_passive(int id, void *data, uint32_t amount, std::chrono::duration<uint32_t, std::milli> timeout);
489494
mbed::Callback<void()> _callback;
490495

491496
// UART settings
@@ -518,7 +523,7 @@ class ESP8266 {
518523
size_t _heap_usage; // (Socket data buffer usage)
519524

520525
// OOB processing
521-
void _process_oob(uint32_t timeout, bool all);
526+
void _process_oob(std::chrono::duration<uint32_t, std::milli> timeout, bool all);
522527

523528
// OOB message handlers
524529
void _oob_packet_hdlr();

‎components/wifi/esp8266-driver/ESP8266Interface.cpp‎

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
#include "platform/mbed_debug.h"
3232
#include "rtos/ThisThread.h"
3333

34+
using namespace std::chrono;
35+
3436
#ifndef MBED_CONF_ESP8266_DEBUG
3537
#define MBED_CONF_ESP8266_DEBUG false
3638
#endif
@@ -196,7 +198,7 @@ void ESP8266Interface::PowerPin::power_on()
196198
if (_pwr_pin.is_connected()) {
197199
_pwr_pin = MBED_CONF_ESP8266_POWER_ON_POLARITY;
198200
tr_debug("power_on(): HW power-on.");
199-
ThisThread::sleep_for(MBED_CONF_ESP8266_POWER_ON_TIME_MS);
201+
ThisThread::sleep_for(milliseconds(MBED_CONF_ESP8266_POWER_ON_TIME_MS));
200202
}
201203
}
202204

@@ -205,7 +207,7 @@ void ESP8266Interface::PowerPin::power_off()
205207
if (_pwr_pin.is_connected()) {
206208
_pwr_pin = !MBED_CONF_ESP8266_POWER_ON_POLARITY;
207209
tr_debug("power_off(): HW power-off.");
208-
ThisThread::sleep_for(MBED_CONF_ESP8266_POWER_OFF_TIME_MS);
210+
ThisThread::sleep_for(milliseconds(MBED_CONF_ESP8266_POWER_OFF_TIME_MS));
209211
}
210212
}
211213

@@ -260,14 +262,14 @@ void ESP8266Interface::_connect_async()
260262
return;
261263
}
262264
_connect_retval = _esp.connect(ap_ssid, ap_pass);
263-
int timeleft_ms = ESP8266_INTERFACE_CONNECT_TIMEOUT_MS - _conn_timer.read_ms();
265+
auto timepassed = _conn_timer.elapsed_time();
264266
if (_connect_retval == NSAPI_ERROR_OK
265267
|| _connect_retval == NSAPI_ERROR_AUTH_FAILURE
266268
|| _connect_retval == NSAPI_ERROR_NO_SSID
267-
|| ((_if_blocking == true) && (timeleft_ms <= 0))) {
269+
|| ((_if_blocking == true) && (timepassed >= ESP8266_INTERFACE_CONNECT_TIMEOUT))) {
268270
_connect_event_id = 0;
269271
_conn_timer.stop();
270-
if (timeleft_ms <= 0 && _connect_retval != NSAPI_ERROR_OK) {
272+
if (timepassed >= ESP8266_INTERFACE_CONNECT_TIMEOUT && _connect_retval != NSAPI_ERROR_OK) {
271273
_connect_retval = NSAPI_ERROR_CONNECTION_TIMEOUT;
272274
}
273275
if (_connect_retval != NSAPI_ERROR_OK) {
@@ -279,7 +281,7 @@ void ESP8266Interface::_connect_async()
279281
#endif
280282
} else {
281283
// Postpone to give other stuff time to run
282-
_connect_event_id = _global_event_queue->call_in(ESP8266_INTERFACE_CONNECT_INTERVAL_MS,
284+
_connect_event_id = _global_event_queue->call_in(ESP8266_INTERFACE_CONNECT_INTERVAL,
283285
callback(this, &ESP8266Interface::_connect_async));
284286
if (!_connect_event_id) {
285287
MBED_ERROR(MBED_MAKE_ERROR(MBED_MODULE_DRIVER, MBED_ERROR_CODE_ENOMEM), \
@@ -411,11 +413,11 @@ void ESP8266Interface::_disconnect_async()
411413
{
412414
_cmutex.lock();
413415
_disconnect_retval = _esp.disconnect() ? NSAPI_ERROR_OK : NSAPI_ERROR_DEVICE_ERROR;
414-
int timeleft_ms = ESP8266_INTERFACE_CONNECT_TIMEOUT_MS - _conn_timer.read_ms();
416+
auto timepassed = _conn_timer.elapsed_time();
415417

416-
if (_disconnect_retval == NSAPI_ERROR_OK || ((_if_blocking == true) && (timeleft_ms <= 0))) {
418+
if (_disconnect_retval == NSAPI_ERROR_OK || ((_if_blocking == true) && (timepassed >= ESP8266_INTERFACE_CONNECT_TIMEOUT))) {
417419

418-
if (timeleft_ms <= 0 && _connect_retval != NSAPI_ERROR_OK) {
420+
if (timepassed >= ESP8266_INTERFACE_CONNECT_TIMEOUT && _connect_retval != NSAPI_ERROR_OK) {
419421
_disconnect_retval = NSAPI_ERROR_CONNECTION_TIMEOUT;
420422
} else {
421423
if (_conn_stat != NSAPI_STATUS_DISCONNECTED) {
@@ -436,7 +438,7 @@ void ESP8266Interface::_disconnect_async()
436438
} else {
437439
// Postpone to give other stuff time to run
438440
_disconnect_event_id = _global_event_queue->call_in(
439-
ESP8266_INTERFACE_CONNECT_INTERVAL_MS,
441+
ESP8266_INTERFACE_CONNECT_INTERVAL,
440442
callback(this, &ESP8266Interface::_disconnect_async));
441443
if (!_disconnect_event_id) {
442444
MBED_ERROR(
@@ -612,10 +614,10 @@ int8_t ESP8266Interface::get_rssi()
612614

613615
int ESP8266Interface::scan(WiFiAccessPoint *res, unsigned count)
614616
{
615-
return scan(res, count, SCANMODE_ACTIVE, 0, 0);
617+
return scan(res, count, SCANMODE_ACTIVE);
616618
}
617619

618-
int ESP8266Interface::scan(WiFiAccessPoint *res, unsigned count, scan_mode mode, unsigned t_max, unsigned t_min)
620+
int ESP8266Interface::scan(WiFiAccessPoint *res, unsigned count, scan_mode mode, mbed::chrono::milliseconds_u32 t_max, mbed::chrono::milliseconds_u32 t_min)
619621
{
620622
if (t_max > ESP8266_SCAN_TIME_MAX) {
621623
return NSAPI_ERROR_PARAMETER;
@@ -735,7 +737,15 @@ nsapi_error_t ESP8266Interface::_reset()
735737
_rst_pin.rst_assert();
736738
// If you happen to use Pin7 CH_EN as reset pin, not needed otherwise
737739
// https://www.espressif.com/sites/default/files/documentation/esp8266_hardware_design_guidelines_en.pdf
738-
ThisThread::sleep_for(2); // Documentation says 200 us; need 2 ticks to get minimum 1 ms.
740+
// First need to round up when converting to kernel ticks (eg 200us -> 1ms).
741+
auto delay = duration_cast<Kernel::Clock::duration_u32>(200us);
742+
if (delay < 200us) {
743+
delay++;
744+
}
745+
// Then need to round the clock-resolution duration up; if we were at the end of a tick
746+
// period, it might flip immediately.
747+
delay++;
748+
ThisThread::sleep_for(delay);
739749
_esp.flush();
740750
_rst_pin.rst_deassert();
741751
} else {
@@ -898,7 +908,7 @@ int ESP8266Interface::socket_send(void *handle, const void *data, unsigned size)
898908
&& socket->proto == NSAPI_TCP
899909
&& core_util_atomic_cas_u8(&_cbs[socket->id].deferred, &expect_false, true)) {
900910
tr_debug("socket_send(...): Postponing SIGIO from the device.");
901-
if (!_global_event_queue->call_in(50, callback(this, &ESP8266Interface::event_deferred))) {
911+
if (!_global_event_queue->call_in(50ms, callback(this, &ESP8266Interface::event_deferred))) {
902912
MBED_ERROR(MBED_MAKE_ERROR(MBED_MODULE_DRIVER, MBED_ERROR_CODE_ENOMEM), \
903913
"socket_send(): unable to add event to queue. Increase \"events.shared-eventsize\"\n");
904914
}
@@ -1055,7 +1065,7 @@ void ESP8266Interface::event()
10551065
{
10561066
if (!_oob_event_id) {
10571067
// Throttles event creation by using arbitrary small delay
1058-
_oob_event_id = _global_event_queue->call_in(50, callback(this, &ESP8266Interface::proc_oob_evnt));
1068+
_oob_event_id = _global_event_queue->call_in(50ms, callback(this, &ESP8266Interface::proc_oob_evnt));
10591069
if (!_oob_event_id) {
10601070
MBED_ERROR(MBED_MAKE_ERROR(MBED_MODULE_DRIVER, MBED_ERROR_CODE_ENOMEM), \
10611071
"ESP8266Interface::event(): unable to add event to queue. Increase \"events.shared-eventsize\"\n");

‎components/wifi/esp8266-driver/ESP8266Interface.h‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,16 @@
3131
#include "features/netsocket/WiFiAccessPoint.h"
3232
#include "features/netsocket/WiFiInterface.h"
3333
#include "platform/Callback.h"
34+
#include "platform/mbed_chrono.h"
3435
#if MBED_CONF_RTOS_PRESENT
3536
#include "rtos/ConditionVariable.h"
3637
#endif
3738
#include "rtos/Mutex.h"
3839

3940
#define ESP8266_SOCKET_COUNT 5
4041

41-
#define ESP8266_INTERFACE_CONNECT_INTERVAL_MS (5000)
42-
#define ESP8266_INTERFACE_CONNECT_TIMEOUT_MS (2 * ESP8266_CONNECT_TIMEOUT + ESP8266_INTERFACE_CONNECT_INTERVAL_MS)
42+
#define ESP8266_INTERFACE_CONNECT_INTERVAL 5s
43+
#define ESP8266_INTERFACE_CONNECT_TIMEOUT (2 * ESP8266_CONNECT_TIMEOUT + ESP8266_INTERFACE_CONNECT_INTERVAL)
4344

4445
#ifdef TARGET_FF_ARDUINO
4546
#ifndef MBED_CONF_ESP8266_TX
@@ -219,7 +220,8 @@ class ESP8266Interface : public NetworkStack, public WiFiInterface {
219220
* see @a nsapi_error
220221
*/
221222
virtual int scan(WiFiAccessPoint *res, unsigned count, scan_mode mode = SCANMODE_PASSIVE,
222-
unsigned t_max = 0, unsigned t_min = 0);
223+
mbed::chrono::milliseconds_u32 t_max = mbed::chrono::milliseconds_u32(0),
224+
mbed::chrono::milliseconds_u32 t_min = mbed::chrono::milliseconds_u32(0));
223225

224226
/** Translates a hostname to an IP address with specific version
225227
*

0 commit comments

Comments
 (0)