IRU:StartRecvTransfer: Difference between revisions
Document variable length flag and signalling, as well as correct note on errors. |
→Description: document error when starting new transfer before ending old one |
||
| Line 39: | Line 39: | ||
=Description= | =Description= | ||
This starts an IR data-receive transfer, this command is non-blocking. The received data (when the receive transfer-count is non-zero) is written to sharedmemaddr + 0. The currently received transfer-count can be obtained via [[IRU:GetRecvTransferCount]], unless cancelled using [[IRU:WaitRecvTransfer]]. | This starts an IR data-receive transfer, this command is non-blocking. The received data (when the receive transfer-count is non-zero) is written to sharedmemaddr + 0. The currently received transfer-count can be obtained via [[IRU:GetRecvTransferCount]], unless cancelled using [[IRU:WaitRecvTransfer]]. | ||
Before another receive transfer can be started, [[IRU:WaitRecvTransfer]] needs to be called, otherwise error 0xE0210CCA is returned. | |||
The shared memory size must be larger or equal to the input size and both have to be non-zero, otherwise error 0xE0E10FEC is returned. | The shared memory size must be larger or equal to the input size and both have to be non-zero, otherwise error 0xE0E10FEC is returned. | ||
The event handle returned by [[IRU:GetRecvFinishedEvent]] is signalled when the given amount of bytes has been received. | The event handle returned by [[IRU:GetRecvFinishedEvent]] is signalled when the given amount of bytes has been received. | ||