IRU:StartRecvTransfer - Revision history

Made: /* Description */ fix formatting

2025-08-18T00:19:57Z

Description: fix formatting

← Older revision		Revision as of 04:19, 18 August 2025
Line 41:		Line 41:
	Before another receive transfer can be started, [[IRU:WaitRecvTransfer]] needs to be called, otherwise error 0xE0210CCA is returned.		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.

Made: /* Description */ document error when starting new transfer before ending old one

2025-08-18T00:18:23Z

Description: document error when starting new transfer before ending old one

← Older revision		Revision as of 04:18, 18 August 2025
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.

Made: Document variable length flag and signalling, as well as correct note on errors.

2025-08-11T19:17:30Z

Document variable length flag and signalling, as well as correct note on errors.

← Older revision		Revision as of 23:17, 11 August 2025
Line 15:		Line 15:
	\|-		\|-
	\| 3		\| 3
	\| u8 flag		\| u8 Variable length flag
	\|-		\|-
	\| 4		\| 4
Line 38:		Line 38:

	=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 ~~newly~~ received transfer-count can be obtained via [[IRU:WaitRecvTransfer]]. The input size ~~must~~ be ~~<=0x800~~, otherwise error 0xE0E10FEC is returned.		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]].
			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.

			If the variable length flag is set, the command instead continuously reads a variable amount of bytes.
			This treats the shared memory as a ring buffer with its length given by the receive size, overwriting bytes at the start of memory if more data is received.
			The length returned by [[IRU:GetRecvTransferCount]] gives the total amount of bytes received, so determining the location of the most recently received bytes requires taking this wrapping behaviour into account.
			Each time the IR module times out (it has not received any new signals for the time it would take to receive a number of bytes), the receive event is signalled.
			The transfer only stops once it encounters a transfer error or it is cancelled using [[IRU:WaitRecvTransfer]].

			Both cases also signal the receive event if they stop because a transfer error has been encountered, but not when cancelled or [[IRU:Shutdown\|shut down]]. The presence and type of a transfer error can be queried using [[IRU::GetErrorStatus]].

Yellows8: /* Description */

2014-02-21T23:17:33Z

Description

← Older revision		Revision as of 02:17, 22 February 2014
Line 38:		Line 38:

	=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 newly received transfer-count can be obtained via [[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 newly received transfer-count can be obtained via [[IRU:WaitRecvTransfer]]. The input size must be <=0x800, otherwise error 0xE0E10FEC is returned.

Yellows8: /* Description */

2014-02-21T22:45:49Z

Description

← Older revision		Revision as of 01:45, 22 February 2014
Line 38:		Line 38:

	=Description=		=Description=
	This starts an IR data-receive transfer, this command is non-blocking. The received data to is written to sharedmemaddr + 0. ~~Note that the output data from this will~~ be ~~the same each time this is used, until new valid IR data is received~~.		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 newly received transfer-count can be obtained via [[IRU:WaitRecvTransfer]].

Yellows8: Created page with "=Request= {| class="wikitable" border="1" |- ! Index Word ! Description |- | 0 | Header code [0x000500C2] |- | 1 | Total shared memory size |- | 2 | Size of data to receive |- ..."

2014-02-21T21:01:43Z

Created page with "=Request= {| class="wikitable" border="1" |- ! Index Word ! Description |- | 0 | Header code [0x000500C2] |- | 1 | Total shared memory size |- | 2 | Size of data to receive |- ..."

New page

=Request=
{| class="wikitable" border="1"
|-
! Index Word
! Description
|-
| 0
| Header code [0x000500C2]
|-
| 1
| Total shared memory size
|-
| 2
| Size of data to receive
|-
| 3
| u8 flag
|-
| 4
| Value zero
|-
| 5
| Shared memory handle
|}

=Response=
{| class="wikitable" border="1"
|-
! Index Word
! Description
|-
| 0
| Header code
|-
| 1
| Result code
|}

=Description=
This starts an IR data-receive transfer, this command is non-blocking. The received data to is written to sharedmemaddr + 0. Note that the output data from this will be the same each time this is used, until new valid IR data is received.