summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/rp2.StateMachine.rst
diff options
context:
space:
mode:
authorNicko van Someren <nicko@nicko.org>2023-12-28 14:22:40 -0700
committerDamien George <damien@micropython.org>2024-03-19 17:10:54 +1100
commit77f08b72caeb26c7e3be5975d976e77d44099d43 (patch)
tree3fcf77675a4cc8c5783fa73051e2a9a8252c44b8 /docs/library/rp2.StateMachine.rst
parent1c6012b0b5c62f18130217f30e73ad3ce4c8c9e6 (diff)
downloadmicropython-77f08b72caeb26c7e3be5975d976e77d44099d43.tar.gz
micropython-77f08b72caeb26c7e3be5975d976e77d44099d43.zip
docs/library/rp2.DMA: Add documentation for rp2 DMA support.
Signed-off-by: Nicko van Someren <nicko@nicko.org>
Diffstat (limited to 'docs/library/rp2.StateMachine.rst')
-rw-r--r--docs/library/rp2.StateMachine.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/library/rp2.StateMachine.rst b/docs/library/rp2.StateMachine.rst
index e8c167c09f..1cb87e90b6 100644
--- a/docs/library/rp2.StateMachine.rst
+++ b/docs/library/rp2.StateMachine.rst
@@ -140,3 +140,10 @@ Methods
Optionally configure it.
+Buffer protocol
+---------------
+
+The StateMachine class supports the `buffer protocol`, allowing direct access to the transmit
+and receive FIFOs for each state machine. This is primarily in order to allow StateMachine
+objects to be passed directly as the read or write parameters when configuring a `rp2.DMA()`
+channel.