mirror of https://github.com/m-labs/artiq.git
coredevice/runtime_exceptions: update RTIO exception behaviour doc
This commit is contained in:
parent
7166ca82d1
commit
d50dbc0e73
|
@ -16,7 +16,7 @@ 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.
|
The offending event is discarded and the RTIO core keeps operating.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
eid = 1
|
eid = 1
|
||||||
|
@ -28,8 +28,7 @@ class RTIOSequenceError(RuntimeException):
|
||||||
"""Raised when an event is submitted on a given channel with a timestamp
|
"""Raised when an event is submitted on a given channel with a timestamp
|
||||||
not larger than the previous one.
|
not larger than the previous one.
|
||||||
|
|
||||||
The offending event is discarded and RTIO operation is not affected
|
The offending event is discarded and the RTIO core keeps operating.
|
||||||
further.
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
eid = 2
|
eid = 2
|
||||||
|
@ -39,7 +38,9 @@ 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.
|
This does not interrupt operations further than cancelling the current
|
||||||
|
read attempt and discarding some events. Reading can be reattempted after
|
||||||
|
the exception is caught, and events will be partially retrieved.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
eid = 3
|
eid = 3
|
||||||
|
|
Loading…
Reference in New Issue