Skip to content

Commit 1f39e9e

Browse files
Yuval Peressnashif
authored andcommitted
rtio: Update documentation
Revise the documentation around canceling pending SQEs. Signed-off-by: Yuval Peress <[email protected]>
1 parent 9f6d6a0 commit 1f39e9e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/services/rtio/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,14 @@ does this work is up to the author of the iodev, perhaps the entire queue of
122122
operations can be converted to a set of DMA transfer descriptors, meaning the
123123
hardware does almost all of the real work.
124124

125+
Cancellation
126+
************
127+
128+
Canceling an already queued operation is possible but not guaranteed. If the
129+
SQE has not yet started, it's likely that a call to :c:func:`rtio_sqe_cancel`
130+
will remove the SQE and never run it. If, however, the SQE already started
131+
running, the cancel request will be ignored.
132+
125133
Memory pools
126134
************
127135

0 commit comments

Comments
 (0)