forked from M-Labs/artiq
1
0
Fork 0

doc: add precisions on RTIO error handling

This commit is contained in:
Sebastien Bourdeauducq 2014-10-21 23:46:14 +08:00
parent 5105b88302
commit 97f9c9c34f
1 changed files with 7 additions and 0 deletions

View File

@ -16,6 +16,8 @@ class RTIOUnderflow(RuntimeException):
"""Raised when the CPU fails to submit a RTIO event early enough """Raised when the CPU fails to submit a RTIO event early enough
(with respect to the event's timestamp). (with respect to the event's timestamp).
Causes a reset of the RTIO core, except its time counter.
""" """
eid = 1 eid = 1
@ -25,6 +27,9 @@ class RTIOUnderflow(RuntimeException):
class RTIOSequenceError(RuntimeException): class RTIOSequenceError(RuntimeException):
"""Raised when an event was not submitted with an increasing timestamp. """Raised when an event was not submitted with an increasing timestamp.
The offending event is discarded and RTIO operation is not affected
further.
""" """
eid = 2 eid = 2
@ -33,6 +38,8 @@ class RTIOOverflow(RuntimeException):
"""Raised when at least one event could not be registered into the RTIO """Raised when at least one event could not be registered into the RTIO
input FIFO because it was full (CPU not reading fast enough). input FIFO because it was full (CPU not reading fast enough).
Causes a reset of the RTIO core, except its time counter.
""" """
eid = 3 eid = 3