AXIS Driver API

Complete C API reference for the AXIS stream driver, extracted from include/AxisDriver.h via Doxygen and rendered by Breathe.

Includes the AXIS ioctl command code macros (AXIS_Read_Ack, AXIS_Write_ReqMissed) and the flag-packing helper functions axisSetFlags, axisGetFuser, axisGetLuser, axisGetCont, axisReadAck, and axisWriteReqMissed.

Note

AxisDriver.h includes DmaDriver.h internally. Functions such as dmaWrite and dmaRead are documented in DMA Driver API.

Defines

AXIS_Read_Ack

ioctl command code used to acknowledge a completed AXIS read.

AXIS_Write_ReqMissed

ioctl command code used to signal a missed AXIS write request.

Functions

static inline uint32_t axisSetFlags(uint32_t fuser, uint32_t luser, uint32_t cont)

Packs AXIS first-user, last-user, and continuation bits.

Encodes:

  • fuser in bits [7:0]

  • luser in bits [15:8]

  • cont in bit 16

Parameters:

  • fuser – First user-defined flag ([7:0]).

  • luser – Last user-defined flag ([7:0]).

  • cont – Continuation flag ([0]).

Returns:

The combined flags value.

static inline uint32_t axisGetFuser(uint32_t flags)

Extracts first-user flag from packed AXIS flags.

Parameters:

  • flags – The combined flags value.

Returns:

The first user-defined flag.

static inline uint32_t axisGetLuser(uint32_t flags)

Extracts last-user flag from packed AXIS flags.

Parameters:

  • flags – The combined flags value.

Returns:

The last user-defined flag.

static inline uint32_t axisGetCont(uint32_t flags)

Extracts continuation flag from packed AXIS flags.

Parameters:

  • flags – The combined flags value.

Returns:

The continuation flag.

static inline void axisReadAck(int32_t fd)

Issues AXIS read-acknowledge ioctl command.

Calls ioctl(fd, AXIS_Read_Ack, 0) to notify the driver that a read transaction has been acknowledged/consumed.

Parameters:

  • fd – File descriptor for the AXIS device.

static inline void axisWriteReqMissed(int32_t fd)

Issues AXIS missed-write-request ioctl command.

Calls ioctl(fd, AXIS_Write_ReqMissed, 0) to notify the driver that a write request was missed and recovery/diagnostic handling may be required.

Parameters:

  • fd – File descriptor for the AXIS device.