1# zx_ticks_get
2
3## NAME
4
5<!-- Updated by update-docs-from-abigen, do not edit. -->
6
7ticks_get - Read the number of high-precision timer ticks since boot.
8
9## SYNOPSIS
10
11<!-- Updated by update-docs-from-abigen, do not edit. -->
12
13```
14#include <zircon/syscalls.h>
15
16zx_ticks_t zx_ticks_get(void);
17```
18
19## DESCRIPTION
20
21`zx_ticks_get()` returns the number of high-precision timer ticks since boot.
22
23These ticks may be processor cycles, high speed timer, profiling timer, etc.
24They are not guaranteed to continue advancing when the system is asleep.
25
26## RIGHTS
27
28<!-- Updated by update-docs-from-abigen, do not edit. -->
29
30TODO(ZX-2399)
31
32## RETURN VALUE
33
34`zx_ticks_get()` returns the number of high-precision timer ticks since boot.
35
36## ERRORS
37
38`zx_ticks_get()` does not report any error conditions.
39
40## NOTES
41
42The returned value may be highly variable. Factors that can affect it include:
43- Changes in processor frequency
44- Migration between processors
45- Reset of the processor cycle counter
46- Reordering of instructions (if required, use a memory barrier)
47
48## SEE ALSO
49
50
51[ticks_per_second](ticks_per_second.md)
52