xstreamer.h File Reference

#include "xenv.h"
#include "xdebug.h"
#include "xil_types.h"

Classes
union	XStrm_AlignedBufferType
struct	XStrm_RxFifoStreamer
struct	XStrm_TxFifoStreamer
Defines
#define	XSTREAMER_H
#define	LARGEST_FIFO_KEYHOLE_SIZE_WORDS   4
#define	XStrm_TxVacancy(InstancePtr)
#define	XStrm_RxOccupancy(InstancePtr)
#define	XStrm_IsRxInternalEmpty(InstancePtr)   (((InstancePtr)->FrmByteCnt == 0) ? TRUE : FALSE)
Typedefs
typedef int(*	XStrm_XferFnType )(void *FifoInstance, void *BufPtr, unsigned WordCount)
typedef u32(*	XStrm_GetLenFnType )(void *FifoInstance)
typedef void(*	XStrm_SetLenFnType )(void *FifoInstance, u32 ByteCount)
typedef u32(*	XStrm_GetOccupancyFnType )(void *FifoInstance)
typedef u32(*	XStrm_GetVacancyFnType )(void *FifoInstance)
Functions
void	XStrm_RxInitialize (XStrm_RxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType ReadFn, XStrm_GetLenFnType GetLenFn, XStrm_GetOccupancyFnType GetOccupancyFn)
void	XStrm_TxInitialize (XStrm_TxFifoStreamer *InstancePtr, unsigned FifoWidth, void *FifoInstance, XStrm_XferFnType WriteFn, XStrm_SetLenFnType SetLenFn, XStrm_GetVacancyFnType GetVacancyFn)
void	XStrm_TxSetLen (XStrm_TxFifoStreamer *InstancePtr, u32 Bytes)
void	XStrm_Write (XStrm_TxFifoStreamer *InstancePtr, void *BufPtr, unsigned bytes)
u32	XStrm_RxGetLen (XStrm_RxFifoStreamer *InstancePtr)
void	XStrm_Read (XStrm_RxFifoStreamer *InstancePtr, void *BufPtr, unsigned bytes)

---

Define Documentation

#define LARGEST_FIFO_KEYHOLE_SIZE_WORDS   4

#define XSTREAMER_H

#define XStrm_IsRxInternalEmpty

(

InstancePtr

)

(((InstancePtr)->FrmByteCnt == 0) ? TRUE : FALSE)

#define XStrm_RxOccupancy

(

InstancePtr

)

Value:

( \
          ((*(InstancePtr)->GetOccupancyFn)((InstancePtr)->FifoInstance)) + \
          ( \
            ((InstancePtr)->FrmByteCnt) ? \
              ((InstancePtr)->FifoWidth - (InstancePtr)->HeadIndex) : \
              0 \
          ) \
        )

#define XStrm_TxVacancy

(

InstancePtr

)

Value:

(((*(InstancePtr)->GetVacancyFn)((InstancePtr)->FifoInstance)) - \
                        (((InstancePtr)->TailIndex + 3) / 4))

---

Typedef Documentation

typedef u32(* XStrm_GetLenFnType)(void *FifoInstance)

typedef u32(* XStrm_GetOccupancyFnType)(void *FifoInstance)

typedef u32(* XStrm_GetVacancyFnType)(void *FifoInstance)

typedef void(* XStrm_SetLenFnType)(void *FifoInstance, u32 ByteCount)

typedef int(* XStrm_XferFnType)(void *FifoInstance, void *BufPtr, unsigned WordCount)

---

Function Documentation

void XStrm_Read	(	XStrm_RxFifoStreamer *	InstancePtr,
		void *	BufPtr,
		unsigned	bytes
	)

u32 XStrm_RxGetLen

(

XStrm_RxFifoStreamer *

InstancePtr

)

void XStrm_RxInitialize	(	XStrm_RxFifoStreamer *	InstancePtr,
		unsigned	FifoWidth,
		void *	FifoInstance,
		XStrm_XferFnType	ReadFn,
		XStrm_GetLenFnType	GetLenFn,
		XStrm_GetOccupancyFnType	GetOccupancyFn
	)

void XStrm_TxInitialize	(	XStrm_TxFifoStreamer *	InstancePtr,
		unsigned	FifoWidth,
		void *	FifoInstance,
		XStrm_XferFnType	WriteFn,
		XStrm_SetLenFnType	SetLenFn,
		XStrm_GetVacancyFnType	GetVacancyFn
	)

void XStrm_TxSetLen	(	XStrm_TxFifoStreamer *	InstancePtr,
		u32	Bytes
	)

void XStrm_Write	(	XStrm_TxFifoStreamer *	InstancePtr,
		void *	BufPtr,
		unsigned	bytes
	)