FPGA Interface C API Reference

Table of Contents

Read FIFO Functions

Read FIFO Functions

The FPGA Interface C API includes the following Read FIFO functions, which share similar parameters.

NiFpga_ReadFifoBool

NiFpga_Status NiFpga_ReadFifoBool(NiFpga_Session session, uint32_t fifo, NiFpga_Bool* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of Booleans.

NiFpga_ReadFifoI8

NiFpga_Status NiFpga_ReadFifoI8(NiFpga_Session session, uint32_t fifo, int8_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of signed 8-bit integers.

NiFpga_ReadFifoU8

NiFpga_Status NiFpga_ReadFifoU8(NiFpga_Session session, uint32_t fifo, uint8_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of unsigned 8-bit integers.

NiFpga_ReadFifoI16

NiFpga_Status NiFpga_ReadFifoI16(NiFpga_Session session, uint32_t fifo, int16_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of signed 16-bit integers.

NiFpga_ReadFifoU16

NiFpga_Status NiFpga_ReadFifoU16(NiFpga_Session session, uint32_t fifo, uint16_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of unsigned 16-bit integers.

NiFpga_ReadFifoI32

NiFpga_Status NiFpga_ReadFifoI32(NiFpga_Session session, uint32_t fifo, int32_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of signed 32-bit integers.

NiFpga_ReadFifoU32

NiFpga_Status NiFpga_ReadFifoU32(NiFpga_Session session, uint32_t fifo, uint32_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of unsigned 32-bit integers.

NiFpga_ReadFifoI64

NiFpga_Status NiFpga_ReadFifoI64(NiFpga_Session session, uint32_t fifo, int64_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of signed 64-bit integers.

NiFpga_ReadFifoU64

NiFpga_Status NiFpga_ReadFifoU64(NiFpga_Session session, uint32_t fifo, uint64_t* data, size_t numberOfElements, uint32_t timeout, size_t* elementsRemaining)

Reads from a target-to-host FIFO of unsigned 64-bit integers.

Parameters for All Read FIFO Functions

Name Type Description
session NiFpga_Session handle to a currently open session
fifo uint32_t target-to-host FIFO from which to read
data Varies by ReadFifo function outputs the data that was read
numberOfElements size_t number of elements to read
timeout uint32_t timeout in milliseconds, or NiFpga_InfiniteTimeout
elementsRemaining size_t* if non-NULL, outputs the number of elements remaining in the host memory part of the DMA FIFO

Return Value for All Read FIFO Functions

result of the call

Log in to get a better experience