Nios® V Processor Software Developer Handbook

ID 743810
Date 2/14/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

12.1.1.22. alt_dma_txchan_ioctl()

Prototype

int alt_dma_txchan_ioctl (alt_dma_txchan dma, 
 int req, 
 void* arg)

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_txchan_ioctl() function performs device specific I/O operations on the DMA transmit channel, dma. For example, some drivers support options to control the width of the transfer operations. The input argument, req, is an enumeration of the requested operation; arg is an additional argument for the request. The interpretation of arg is request dependent.

For more information, refer to the Generic Requests DMA Might Support table for the generic requests a device might support.

Whether a call to alt_dma_txchan_ioctl() is thread-safe, or can be called from an ISR, is device dependent. In general it safest to assume that it is not thread-safe.

Do not call the alt_dma_txchan_ioctl() function while DMA transfers are pending or can result in unpredictable behavior.

Return

A negative return value indicates failure; otherwise the interpretation of the return value is request specific.