Nios II Classic Software Developer’s Handbook

ID 683282
Date 5/14/2015
Public
Document Table of Contents

14.1.18. alt_dma_rxchan_prepare()

Prototype

int alt_dma_rxchan_prepare (alt_dma_rxchan dma, 
 void* data, 
 alt_u32 length, 
 alt_rxchan_done* done, 
 void* handle)

Commonly Called By

C/C++ programs

Device drivers

Thread-safe

See description.

Available from ISR

See description.

Include

<sys/alt_dma.h>

Description

The alt_dma_rxchan_prepare() posts a receive request to a DMA receive channel. The input arguments are: dma, the channel to use; data, a pointer to the location that data is to be received to; length, the maximum length of the data to receive in bytes; done, callback function that is called after the data is received; handle, an opaque value passed to done.

Whether this function is thread-safe, or can be called from an ISR, depends on the underlying device driver. In general it safest to assume that it is not thread-safe.

Return

The return value is zero upon success. A negative return value indicates that the request cannot be posted.