v_frmbuf_rd
Xilinx SDK Drivers API Documentation
Enumerations | Functions
V_frmbuf_rd_v2_0

Enumerations

enum  XVFrmbufRd_HandlerType { XVFRMBUFRD_HANDLER_DONE = 1, XVFRMBUFRD_HANDLER_READY }
 These constants specify different types of handler and used to differentiate interrupt requests from peripheral. More...
 

Functions

XVidC_ColorFormat RdMemory2Live (XVidC_ColorFormat MemFmt)
 This function maps the memory video formats to the live/stream video formats. More...
 
int XVFrmbufRd_Initialize (XV_FrmbufRd_l2 *InstancePtr, u16 DeviceId)
 This function initializes the core instance. More...
 
void XVFrmbufRd_InterruptEnable (XV_FrmbufRd_l2 *InstancePtr, u32 IrqMask)
 This function enables interrupts in the core. More...
 
void XVFrmbufRd_InterruptDisable (XV_FrmbufRd_l2 *InstancePtr, u32 IrqMask)
 This function disables interrupts in the core. More...
 
void XVFrmbufRd_Start (XV_FrmbufRd_l2 *InstancePtr)
 This function starts the core instance. More...
 
int XVFrmbufRd_Stop (XV_FrmbufRd_l2 *InstancePtr)
 This function stops the core instance. More...
 
int XVFrmbufRd_WaitForIdle (XV_FrmbufRd_l2 *InstancePtr)
 This function Waits for the core to reach idle state. More...
 
int XVFrmbufRd_SetMemFormat (XV_FrmbufRd_l2 *InstancePtr, u32 StrideInBytes, XVidC_ColorFormat MemFmt, const XVidC_VideoStream *StrmOut)
 This function configures the frame buffer read memory input. More...
 
XVidC_VideoStream * XVFrmbufRd_GetVideoStream (XV_FrmbufRd_l2 *InstancePtr)
 This function reads the pointer to the output stream configuration. More...
 
int XVFrmbufRd_SetBufferAddr (XV_FrmbufRd_l2 *InstancePtr, UINTPTR Addr)
 This function sets the buffer address. More...
 
UINTPTR XVFrmbufRd_GetBufferAddr (XV_FrmbufRd_l2 *InstancePtr)
 This function reads the buffer address. More...
 
int XVFrmbufRd_SetChromaBufferAddr (XV_FrmbufRd_l2 *InstancePtr, UINTPTR Addr)
 This function sets the buffer address for the UV plane for semi-planar formats. More...
 
UINTPTR XVFrmbufRd_GetChromaBufferAddr (XV_FrmbufRd_l2 *InstancePtr)
 This function reads the buffer address for the UV plane for semi-planar formats. More...
 
int XVFrmbufRd_SetFieldID (XV_FrmbufRd_l2 *InstancePtr, u32 FieldID)
 This function sets the field ID. More...
 
u32 XVFrmbufRd_GetFieldID (XV_FrmbufRd_l2 *InstancePtr)
 This function reads the field ID. More...
 
void XVFrmbufRd_DbgReportStatus (XV_FrmbufRd_l2 *InstancePtr)
 This function reports the frame buffer read status. More...
 

Enumeration Type Documentation

◆ XVFrmbufRd_HandlerType

enum XVFrmbufRd_HandlerType

#include <xv_frmbufrd_l2.h>

These constants specify different types of handler and used to differentiate interrupt requests from peripheral.

Enumerator
XVFRMBUFRD_HANDLER_DONE 

Handler for ap_done.

XVFRMBUFRD_HANDLER_READY 

Handler for ap_ready.

Function Documentation

◆ RdMemory2Live()

XVidC_ColorFormat RdMemory2Live ( XVidC_ColorFormat  MemFmt)

#include <xv_frmbufrd_l2.c>

This function maps the memory video formats to the live/stream video formats.

Parameters
MemFmtis the video format read from memory
Returns
Live/Stream Video Format associated with that memory format

Referenced by XVFrmbufRd_SetMemFormat().

◆ XVFrmbufRd_DbgReportStatus()

void XVFrmbufRd_DbgReportStatus ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function reports the frame buffer read status.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
none
Note
none

References XV_frmbufrd_Config::AXIMMDataWidth, XV_frmbufrd_Config::BaseAddress, XV_frmbufrd_Config::BGR8En, XV_frmbufrd_Config::BGRA8En, XV_frmbufrd_Config::BGRX8En, XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, XV_frmbufrd_Config::Interlaced, XV_frmbufrd_Config::MaxDataWidth, XV_frmbufrd_Config::PixPerClk, XV_frmbufrd_Config::RGB8En, XV_frmbufrd_Config::RGBA8En, XV_frmbufrd_Config::RGBX10En, XV_frmbufrd_Config::RGBX8En, XV_frmbufrd_Config::UYVY8En, XV_frmbufrd_Config::Y10En, XV_frmbufrd_Config::Y8En, XV_frmbufrd_Config::Y_UV10_420En, XV_frmbufrd_Config::Y_UV10En, XV_frmbufrd_Config::Y_UV8_420En, XV_frmbufrd_Config::Y_UV8En, XV_frmbufrd_Config::YUV8En, XV_frmbufrd_Config::YUVA8En, XV_frmbufrd_Config::YUVX10En, XV_frmbufrd_Config::YUVX8En, and XV_frmbufrd_Config::YUYV8En.

◆ XVFrmbufRd_GetBufferAddr()

UINTPTR XVFrmbufRd_GetBufferAddr ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function reads the buffer address.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
Address of buffer in memory

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_GetChromaBufferAddr()

UINTPTR XVFrmbufRd_GetChromaBufferAddr ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function reads the buffer address for the UV plane for semi-planar formats.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
Address of buffer in memory

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_GetFieldID()

u32 XVFrmbufRd_GetFieldID ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function reads the field ID.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
Field ID

References XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, and XV_frmbufrd_Config::Interlaced.

◆ XVFrmbufRd_GetVideoStream()

XVidC_VideoStream* XVFrmbufRd_GetVideoStream ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function reads the pointer to the output stream configuration.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
Pointer to output stream configuration

References XV_FrmbufRd_l2::Stream.

◆ XVFrmbufRd_Initialize()

int XVFrmbufRd_Initialize ( XV_FrmbufRd_l2 *  InstancePtr,
u16  DeviceId 
)

#include <xv_frmbufrd_l2.c>

This function initializes the core instance.

Parameters
InstancePtris a pointer to core instance to be worked upon
DeviceIdis instance id of the core
Returns
XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_InterruptDisable()

void XVFrmbufRd_InterruptDisable ( XV_FrmbufRd_l2 *  InstancePtr,
u32  IrqMask 
)

#include <xv_frmbufrd_l2.c>

This function disables interrupts in the core.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
none

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_InterruptEnable()

void XVFrmbufRd_InterruptEnable ( XV_FrmbufRd_l2 *  InstancePtr,
u32  IrqMask 
)

#include <xv_frmbufrd_l2.c>

This function enables interrupts in the core.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
none

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_SetBufferAddr()

int XVFrmbufRd_SetBufferAddr ( XV_FrmbufRd_l2 *  InstancePtr,
UINTPTR  Addr 
)

#include <xv_frmbufrd_l2.c>

This function sets the buffer address.

Parameters
InstancePtris a pointer to core instance to be worked upon
Addris the absolute address of buffer in memory
Returns
XST_SUCCESS or XST_FAILURE

References XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, and XV_frmbufrd_Config::PixPerClk.

◆ XVFrmbufRd_SetChromaBufferAddr()

int XVFrmbufRd_SetChromaBufferAddr ( XV_FrmbufRd_l2 *  InstancePtr,
UINTPTR  Addr 
)

#include <xv_frmbufrd_l2.c>

This function sets the buffer address for the UV plane for semi-planar formats.

Parameters
InstancePtris a pointer to core instance to be worked upon
Addris the absolute address of buffer in memory
Returns
XST_SUCCESS or XST_FAILURE

References XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, and XV_frmbufrd_Config::PixPerClk.

◆ XVFrmbufRd_SetFieldID()

int XVFrmbufRd_SetFieldID ( XV_FrmbufRd_l2 *  InstancePtr,
u32  FieldID 
)

#include <xv_frmbufrd_l2.c>

This function sets the field ID.

Parameters
InstancePtris a pointer to core instance to be worked upon
FieldID
Returns
XST_SUCCESS or XST_FAILURE

References XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, and XV_frmbufrd_Config::Interlaced.

◆ XVFrmbufRd_SetMemFormat()

int XVFrmbufRd_SetMemFormat ( XV_FrmbufRd_l2 *  InstancePtr,
u32  StrideInBytes,
XVidC_ColorFormat  MemFmt,
const XVidC_VideoStream *  StrmOut 
)

#include <xv_frmbufrd_l2.c>

This function configures the frame buffer read memory input.

Parameters
InstancePtris a pointer to the core instance to be worked on.
StrideInBytesis the memory stride in bytes
MemFormatis the video format to be read from memory
StrmOutis the pointer to output stream configuration
Returns
none

References XV_frmbufrd::Config, XV_FrmbufRd_l2::FrmbufRd, XV_frmbufrd_Config::PixPerClk, RdMemory2Live(), and XV_FrmbufRd_l2::Stream.

◆ XVFrmbufRd_Start()

void XVFrmbufRd_Start ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function starts the core instance.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
none

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_Stop()

int XVFrmbufRd_Stop ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function stops the core instance.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
XST_SUCCESS if the core in stop state XST_FAILURE if the core is not in stop state

References XV_FrmbufRd_l2::FrmbufRd.

◆ XVFrmbufRd_WaitForIdle()

int XVFrmbufRd_WaitForIdle ( XV_FrmbufRd_l2 *  InstancePtr)

#include <xv_frmbufrd_l2.c>

This function Waits for the core to reach idle state.

Parameters
InstancePtris a pointer to core instance to be worked upon
Returns
XST_SUCCESS if the core is in idle state XST_FAILURE if the core is not in idle state

References XV_FrmbufRd_l2::FrmbufRd.