spe_mfcio_get

NAME

spe_mfcio_get - Place a get DMA command on the proxy command queue of the SPE context.

SYNOPSIS

include <libspe2.h>

int spe_mfcio_get (spe_context_ptr_t spe, unsigned int lsa, void *ea, unsigned int size, unsigned int tag, unsigned int tid, unsigned int rid)

Parameters  
spe Specifies the SPE context of the proxy command queue into which the get command is to be placed.
lsa Specifies the starting local store destination address.
ea Specifies the starting effective address source address.
size Specifies the size, in bytes, to be transferred.
tag Specifies the tag ID used to identify the DMA command. The range for valid tag IDs is 0:31. Based on the needs of the underlying operating system implementations of this API can restrict the range.
Note: (Linux) In the Linux implementation of libspe2, the range for the valid tags is 0:15.

See Cell Broadband Engine Architecture, MFC Command Tag Register.

tid Specifies the transfer class identifier of the DMA command.
rid Specifies the replacement class identifier of the DMA command.

DESCRIPTION

Places a get DMA command on the proxy command queue of the SPE context specified by spe

The spe_mfcio_get command transfers size bytes of data starting at the effective address specified by ea to the local store address specified by lsa. The DMA is identified by the tag id specified by tag and performed according transfer class and replacement class specified by tid and rid respectively.

The caller of this function must ensure that the address alignment and transfer size is in accordance with the limitation and restrictions of the Cell Broadband Engine Architecture.

RETURN VALUE

On success, 0 (zero) is returned.

EXIT STATUS

On error, -1 is returned and errno is set to indicate the error.

Possible errors include:

ESRCH The specified SPE context is invalid.