Enumerations

This section documents the enumeration types provided by the dma-utils

enum mdb5_dma_chan_dir {
    MDB5_CHAN_DIR_TO_DEV = 1,
    MDB5_CHAN_DIR_FROM_DEV
};

mdb5_dma_chan_dir - Transfer direction enumeration

MDB5_CHAN_DIR_TO_DEV = 1, Host-to-Card (write) transfer direction
MDB5_CHAN_DIR_FROM_DEV = Card-to-Host (read) transfer direction

enum mdb5_dma_transfer_mode {
    MDB5_MODE_SG = 0x100,
    MDB5_MODE_SIMPLE = 0x300
};

mdb5_dma_transfer_mode - DMA transfer mode enumeration

MDB5_MODE_SG = Scatter-Gather (Linked-list) DMA mode
MDB5_MODE_SIMPLE = Simple (Non Linked-list) DMA mode

enum mdb5_dma_chan_mode {
    MDB5_CHAN_MODE_MM = 1
};

mdb5_dma_chan_mode - Channel operation mode enumeration

MDB5_CHAN_MODE_MM = Memory-mapped channel mode

enum mdb5_dma_io_type {
    MDB5_IO_SYNC = 1,
    MDB5_IO_ASYNC
};

mdb5_dma_io_type - I/O operation type enumeration

MDB5_IO_SYNC = Synchronous I/O operation
MDB5_IO_ASYNC = Asynchronous I/O operation

enum operation {
    CMD_REG_READ = 0,
    CMD_REG_WRITE,
    CMD_STATS,
    CMD_SET_TRANSFER_MODE,
    CMD_GET_TRANSFER_MODE,
    CMD_SET_APERTURE_MODE,
    CMD_GET_APERTURE_MODE,
    CMD_MAX
};

operation - MDB5-DMA control operation enumeration

This enumeration defines the various operations that can be performed from user space.

CMD_REG_READ = Register read operation
CMD_REG_WRITE = Register write operation
CMD_STATS = Statistics retrieval operation
CMD_SET_TRANSFER_MODE = Set transfer mode operation
CMD_GET_TRANSFER_MODE = Get transfer mode operation
CMD_SET_APERTURE_MODE = Set aperture mode operation
CMD_GET_APERTURE_MODE = Get aperture mode operation
CMD_MAX = Maximum operation value

enum operation_arg {
    ARG_CHAN_IDX = 0,
    ARG_PCI_BDF,
    ARG_CHAN_DIR,
    ARG_MAX
};

operation_arg - MDB5-DMA operation argument enumeration

This enumeration defines the various arguments that can be used with enum operation.

ARG_CHAN_IDX = Channel index argument
ARG_PCI_BDF = PCI Bus:Device.Function argument
ARG_CHAN_DIR = Channel direction argument
ARG_MAX = Maximum argument value