docs/library/rp2.StateMachine: Expand put() documentation.

Document that put() can also accept arrays/bytearrays as values.

Fixes issue #10465.

Signed-off-by: Paul Warren <pdw@ex-parrot.com>
pull/10468/head
Paul Warren 2023-01-11 14:08:08 +00:00 zatwierdzone przez Damien George
rodzic 209a6bb6b7
commit a322ebafc0
1 zmienionych plików z 9 dodań i 5 usunięć

Wyświetl plik

@ -99,13 +99,17 @@ Methods
.. method:: StateMachine.put(value, shift=0) .. method:: StateMachine.put(value, shift=0)
Push a word onto the state machine's TX FIFO. Push words onto the state machine's TX FIFO.
If the FIFO is full, it blocks until there is space (i.e. the state machine *value* can be an integer, an array of type ``B``, ``H`` or ``I``, or a
pulls a word). `bytearray`.
The value is first shifted left by *shift* bits, i.e. the state machine This method will block until all words have been written to the FIFO. If
receives ``value << shift``. the FIFO is, or becomes, full, the method will block until the state machine
pulls enough words to complete the write.
Each word is first shifted left by *shift* bits, i.e. the state machine
receives ``word << shift``.
.. method:: StateMachine.rx_fifo() .. method:: StateMachine.rx_fifo()