KonstantinKondrashov
209702d055
esp_ipc: Update documentation and API descriptions
|
4 vuotta sitten | |
|---|---|---|
| .. | ||
| include | 4 vuotta sitten | |
| ld | 4 vuotta sitten | |
| port | 4 vuotta sitten | |
| test | 4 vuotta sitten | |
| test_eh_frame_parser | 4 vuotta sitten | |
| CMakeLists.txt | 4 vuotta sitten | |
| Kconfig | 4 vuotta sitten | |
| README.md | 5 vuotta sitten | |
| app.lf | 5 vuotta sitten | |
| crosscore_int.c | 4 vuotta sitten | |
| debug_stubs.c | 4 vuotta sitten | |
| eh_frame_parser.c | 4 vuotta sitten | |
| esp_err.c | 5 vuotta sitten | |
| esp_ipc.c | 4 vuotta sitten | |
| esp_system.c | 4 vuotta sitten | |
| fpga_overrides.c | 4 vuotta sitten | |
| freertos_hooks.c | 5 vuotta sitten | |
| int_wdt.c | 4 vuotta sitten | |
| linker.lf | 5 vuotta sitten | |
| panic.c | 4 vuotta sitten | |
| sdkconfig.rename | 4 vuotta sitten | |
| stack_check.c | 5 vuotta sitten | |
| startup.c | 4 vuotta sitten | |
| system_time.c | 4 vuotta sitten | |
| task_wdt.c | 4 vuotta sitten | |
| ubsan.c | 5 vuotta sitten | |
| xt_wdt.c | 4 vuotta sitten | |
README.md
System Notes
Timekeeping
The following are the timekeeping mechanisms available and their differences:
- System time (
esp_system_get_time)
Time with the origin at g_startup_time. The implementation is not handled by esp_system,
but it does provide a default implementation using RTC timer. Currently, esp_timer
provides system time, since the hardware timers are under the control of that
component. However, no matter the underlying timer, the system time provider
should maintain the definition of having the origin point at g_startup_time.
esp_timertime (esp_timer_get_time)
This is the time read from an underlying hardware timer, controlled through config. Origin is at the point where the underlying timer starts counting.
newlibtime (gettimeofday)
Timekeeping function in standard library. Can be set (settimeofday) or moved forward/backward (adjtime);
with the possibility of the changes being made persistent through config.
Currently implemented in terms of system time, as the point of origin is fixed.
If persistence is enabled, RTC time is also used in conjuction with system time.
- RTC time (
esp_rtc_get_time_us)
Time read from RTC timer.