aboutsummaryrefslogtreecommitdiff
path: root/py/mphal.h
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2020-09-14 12:15:03 +1000
committerDamien George <damien@micropython.org>2020-09-18 17:20:34 +1000
commit8f20cdc353a9d1c1e5d43484b58e1eaf81ec52e0 (patch)
tree5889824fb3b3aec00d69e63220b3ad9e0ef77dda /py/mphal.h
parentbd7af6151d605d3fc8f70cb9ddf45b2fd7881f08 (diff)
all: Rename absolute time-based functions to include "epoch".
For time-based functions that work with absolute time there is the need for an Epoch, to set the zero-point at which the absolute time starts counting. Such functions include time.time() and filesystem stat return values. And different ports may use a different Epoch. To make it clearer what functions use the Epoch (whatever it may be), and make the ports more consistent with their use of the Epoch, this commit renames all Epoch related functions to include the word "epoch" in their name (and remove references to "2000"). Along with this rename, the following things have changed: - mp_hal_time_ns() is now specified to return the number of nanoseconds since the Epoch, rather than since 1970 (but since this is an internal function it doesn't change anything for the user). - littlefs timestamps on the esp8266 have been fixed (they were previously off by 30 years in nanoseconds). Otherwise, there is no functional change made by this commit. Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'py/mphal.h')
-rw-r--r--py/mphal.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/py/mphal.h b/py/mphal.h
index 6d11f6ddc..0d4b1224e 100644
--- a/py/mphal.h
+++ b/py/mphal.h
@@ -76,7 +76,7 @@ mp_uint_t mp_hal_ticks_cpu(void);
#endif
#ifndef mp_hal_time_ns
-// Nanoseconds since 1970/1/1.
+// Nanoseconds since the Epoch.
uint64_t mp_hal_time_ns(void);
#endif