From 5d2e3f975f0e9018fcdd75ca2f6505bc249ba574 Mon Sep 17 00:00:00 2001 From: David Nadlinger Date: Fri, 26 Oct 2018 12:16:57 +0100 Subject: [PATCH] coredevice: Add get_rtio_counter_mu() docstring [nfc] --- artiq/coredevice/core.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/artiq/coredevice/core.py b/artiq/coredevice/core.py index 60abcf96b..5144b6010 100644 --- a/artiq/coredevice/core.py +++ b/artiq/coredevice/core.py @@ -151,6 +151,15 @@ class Core: @kernel 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() @kernel