Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
timing.h File Reference
Portable interface to timeouts and to the CPU cycle counter. More...
Go to the source code of this file.
Data Structures | |
struct | mbedtls_timing_hr_time |
timer structure More... | |
struct | mbedtls_timing_delay_context |
Context for mbedtls_timing_set/get_delay() More... | |
Functions | |
unsigned long | mbedtls_timing_hardclock (void) |
Return the CPU cycle counter value. | |
unsigned long | mbedtls_timing_get_timer (struct mbedtls_timing_hr_time *val, int reset) |
Return the elapsed time in milliseconds. | |
void | mbedtls_set_alarm (int seconds) |
Setup an alarm clock. | |
void | mbedtls_timing_set_delay (void *data, uint32_t int_ms, uint32_t fin_ms) |
Set a pair of delays to watch (See mbedtls_timing_get_delay() .) | |
int | mbedtls_timing_get_delay (void *data) |
Get the status of delays (Memory helper: number of delays passed.) | |
int | mbedtls_timing_self_test (int verbose) |
Checkup routine. |
Detailed Description
Portable interface to timeouts and to the CPU cycle counter.
Definition in file timing.h.
Function Documentation
void mbedtls_set_alarm | ( | int | seconds ) |
int mbedtls_timing_get_delay | ( | void * | data ) |
Get the status of delays (Memory helper: number of delays passed.)
- Parameters:
-
data Pointer to timing data Must point to a valid mbedtls_timing_delay_context
struct.
- Returns:
- -1 if cancelled (fin_ms = 0), 0 if none of the delays are passed, 1 if only the intermediate delay is passed, 2 if the final delay is passed.
unsigned long mbedtls_timing_get_timer | ( | struct mbedtls_timing_hr_time * | val, |
int | reset | ||
) |
Return the elapsed time in milliseconds.
- Parameters:
-
val points to a timer structure reset If 0, query the elapsed time. Otherwise (re)start the timer.
- Returns:
- Elapsed time since the previous reset in ms. When restarting, this is always 0.
- Note:
- To initialize a timer, call this function with reset=1.
Determining the elapsed time and resetting the timer is not atomic on all platforms, so after the sequence `{ get_timer(1); ...; time1 = get_timer(1); ...; time2 = get_timer(0) }` the value time1+time2 is only approximately the delay since the first reset.
unsigned long mbedtls_timing_hardclock | ( | void | ) |
int mbedtls_timing_self_test | ( | int | verbose ) |
void mbedtls_timing_set_delay | ( | void * | data, |
uint32_t | int_ms, | ||
uint32_t | fin_ms | ||
) |
Set a pair of delays to watch (See mbedtls_timing_get_delay()
.)
- Parameters:
-
data Pointer to timing data. Must point to a valid mbedtls_timing_delay_context
struct.int_ms First (intermediate) delay in milliseconds. The effect if int_ms > fin_ms is unspecified. fin_ms Second (final) delay in milliseconds. Pass 0 to cancel the current delay.
- Note:
- To set a single delay, either use
mbedtls_timing_set_timer
directly or use this function with int_ms == fin_ms.
Generated on Tue Jul 12 2022 18:18:59 by
