M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

coredevice: Add get_rtio_counter_mu() docstring [nfc]

This commit is contained in:
David Nadlinger 2018-10-26 12:16:57 +01:00 committed by Sébastien Bourdeauducq
parent d6fcc0529f
commit 5d2e3f975f
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
artiq/coredevice/core.py
View File

@ -151,6 +151,15 @@ class Core:
@kernel @kernel
def get_rtio_counter_mu(self): def get_rtio_counter_mu(self):
"""Retrieve the current value of the hardware RTIO timeline counter.
As the timing of kernel code executed on the CPU is inherently
non-deterministic, the return value is by necessity only a lower bound
for the actual value of the hardware register at the instant when
execution resumes in the caller.
For a more detailed description of these concepts, see :doc:`/rtio`.
"""
return rtio_get_counter() return rtio_get_counter()
@kernel @kernel