v_frmbuf_wr
Vitis Drivers API Documentation
xv_frmbufwr_l2.h File Reference

Data Structures

struct  XV_FrmbufWr_l2
 Frame Buffer Write driver Layer 2 data. More...
 

Macros

#define XVFrmbufWr_IsRGBX8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.RGBX8En)
 This macro returns if Video Format RGBX8 is available. More...
 
#define XVFrmbufWr_IsYUVX8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUVX8En)
 This macro returns if Video Format YUVX8 is available. More...
 
#define XVFrmbufWr_IsY_U_V8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_U_V8En)
 This macro returns if Video Format Y_U_V8 is available. More...
 
#define XVFrmbufWr_IsY_U_V10Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_U_V10En)
 This macro returns if Video Format Y_U_V10 is available. More...
 
#define XVFrmbufWr_IsY_U_V8_420Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_U_V8_420En)
 This macro returns if Video Format Y_U_V8_420 is available. More...
 
#define XVFrmbufWr_IsYUYV8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUYV8En)
 This macro returns if Video Format YUYV8 is available. More...
 
#define XVFrmbufWr_IsRGBX10Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.RGBX10En)
 This macro returns if Video Format RGBX10 is available. More...
 
#define XVFrmbufWr_IsYUVX10Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUVX10En)
 This macro returns if Video Format YUVX10 is available. More...
 
#define XVFrmbufWr_IsY_UV8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV8En)
 This macro returns if Video Format Y_UV8 is available. More...
 
#define XVFrmbufWr_IsY_UV8_420Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV8_420En)
 This macro returns if Video Format Y_UV8_420 is available. More...
 
#define XVFrmbufWr_IsRGB8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.RGB8En)
 This macro returns if Video Format RGB8 is available. More...
 
#define XVFrmbufWr_IsYUV8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUV8En)
 This macro returns if Video Format YUV8 is available. More...
 
#define XVFrmbufWr_IsY_UV10Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV10En)
 This macro returns if Video Format Y_UV10 is available. More...
 
#define XVFrmbufWr_IsY_UV10_420Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV10_420En)
 This macro returns if Video Format Y_UV10_420 is available. More...
 
#define XVFrmbufWr_IsY8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y8En)
 This macro returns if Video Format Y8 is available. More...
 
#define XVFrmbufWr_IsY10Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y10En)
 This macro returns if Video Format Y10 is available. More...
 
#define XVFrmbufWr_IsBGRX8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.BGRX8En)
 This macro returns if Video Format BGRX8 is available. More...
 
#define XVFrmbufWr_IsUYVY8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.UYVY8En)
 This macro returns if Video Format UYVY8 is available. More...
 
#define XVFrmbufWr_IsBGR8Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.BGR8En)
 This macro returns if Video Format BGR8 is available. More...
 
#define XVFrmbufWr_IsRGBX12Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.RGBX12En)
 This macro returns if Video Format RGBX12 is available. More...
 
#define XVFrmbufWr_IsRGB16Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.RGB16En)
 This macro returns if Video Format RGB16 is available. More...
 
#define XVFrmbufWr_IsYUVX12Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUVX12En)
 This macro returns if Video Format YUVX12 is available. More...
 
#define XVFrmbufWr_IsYUV16Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.YUV16En)
 This macro returns if Video Format YUV16 is available. More...
 
#define XVFrmbufWr_IsY_UV12Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV12En)
 This macro returns if Video Format Y_UV12 is available. More...
 
#define XVFrmbufWr_IsY_UV16Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV16En)
 This macro returns if Video Format Y_UV16 is available. More...
 
#define XVFrmbufWr_IsY_UV12_420Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV12_420En)
 This macro returns if Video Format Y_UV12_420 is available. More...
 
#define XVFrmbufWr_IsY_UV16_420Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y_UV16_420En)
 This macro returns if Video Format Y_UV16_420 is available. More...
 
#define XVFrmbufWr_IsY12Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y12En)
 This macro returns if Video Format Y12 is available. More...
 
#define XVFrmbufWr_IsY16Enabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Y16En)
 This macro returns if Video Format Y16 is available. More...
 
#define XVFrmbufWr_InterlacedEnabled(InstancePtr)   ((InstancePtr)->FrmbufWr.Config.Interlaced)
 This macro returns if interlaced support is available. More...
 

Typedefs

typedef void(* XVFrmbufWr_Callback )(void *CallbackRef)
 Callback type for interrupt. More...
 

Enumerations

enum  XVFrmbufWr_HandlerType { XVFRMBUFWR_HANDLER_DONE = 1, XVFRMBUFWR_HANDLER_READY }
 These constants specify different types of handler and used to differentiate interrupt requests from peripheral. More...
 

Functions

int XVFrmbufWr_Initialize (XV_FrmbufWr_l2 *InstancePtr, u16 DeviceId)
 This function initializes the core instance. More...
 
void XVFrmbufWr_Start (XV_FrmbufWr_l2 *InstancePtr)
 This function starts the core instance. More...
 
int XVFrmbufWr_Stop (XV_FrmbufWr_l2 *InstancePtr)
 This function stops the core instance. More...
 
int XVFrmbufWr_WaitForIdle (XV_FrmbufWr_l2 *InstancePtr)
 This function Waits for the core to reach idle state. More...
 
int XVFrmbufWr_SetMemFormat (XV_FrmbufWr_l2 *InstancePtr, u32 StrideInBytes, XVidC_ColorFormat MemFmt, const XVidC_VideoStream *StrmIn)
 This function configures the frame buffer write memory output. More...
 
XVidC_VideoStream * XVFrmbufWr_GetVideoStream (XV_FrmbufWr_l2 *InstancePtr)
 This function reads the pointer to the output stream configuration. More...
 
int XVFrmbufWr_SetBufferAddr (XV_FrmbufWr_l2 *InstancePtr, UINTPTR Addr)
 This function sets the buffer address. More...
 
UINTPTR XVFrmbufWr_GetBufferAddr (XV_FrmbufWr_l2 *InstancePtr)
 This function reads the buffer address. More...
 
int XVFrmbufWr_SetChromaBufferAddr (XV_FrmbufWr_l2 *InstancePtr, UINTPTR Addr)
 This function sets the buffer address for the UV plane for semi-planar formats or Only U Plane for 3 planar formats. More...
 
UINTPTR XVFrmbufWr_GetChromaBufferAddr (XV_FrmbufWr_l2 *InstancePtr)
 This function reads the buffer address for the UV plane for semi-planar formats or Only U plane for 3 planar formats. More...
 
int XVFrmbufWr_SetVChromaBufferAddr (XV_FrmbufWr_l2 *InstancePtr, UINTPTR Addr)
 This function sets the buffer address for the V plane for 3 planar formats. More...
 
UINTPTR XVFrmbufWr_GetVChromaBufferAddr (XV_FrmbufWr_l2 *InstancePtr)
 This function reads the buffer address for the V plane for 3 planar formats. More...
 
u32 XVFrmbufWr_GetFieldID (XV_FrmbufWr_l2 *InstancePtr)
 This function reads the field ID. More...
 
void XVFrmbufWr_DbgReportStatus (XV_FrmbufWr_l2 *InstancePtr)
 This function reports the frame buffer write status. More...
 
void XVFrmbufWr_InterruptHandler (void *InstancePtr)
 This function is the interrupt handler for the frame buffer write core driver. More...
 
int XVFrmbufWr_SetCallback (XV_FrmbufWr_l2 *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)
 This function installs an asynchronous callback function for the given HandlerType: More...
 
void XVFrmbufWr_InterruptEnable (XV_FrmbufWr_l2 *InstancePtr, u32 IrqMask)
 This function enables interrupts in the core. More...
 
void XVFrmbufWr_InterruptDisable (XV_FrmbufWr_l2 *InstancePtr, u32 IrqMask)
 This function disables interrupts in the core. More...
 

Macro Definition Documentation

#define XVFrmbufWr_InterlacedEnabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Interlaced)

This macro returns if interlaced support is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.
#define XVFrmbufWr_IsBGR8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.BGR8En)

This macro returns if Video Format BGR8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsBGRX8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.BGRX8En)

This macro returns if Video Format BGRX8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsRGB16Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.RGB16En)

This macro returns if Video Format RGB16 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsRGB8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.RGB8En)

This macro returns if Video Format RGB8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsRGBX10Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.RGBX10En)

This macro returns if Video Format RGBX10 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsRGBX12Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.RGBX12En)

This macro returns if Video Format RGBX12 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsRGBX8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.RGBX8En)

This macro returns if Video Format RGBX8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsUYVY8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.UYVY8En)

This macro returns if Video Format UYVY8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY10Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y10En)

This macro returns if Video Format Y10 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY12Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y12En)

This macro returns if Video Format Y12 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY16Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y16En)

This macro returns if Video Format Y16 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y8En)

This macro returns if Video Format Y8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_U_V10Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_U_V10En)

This macro returns if Video Format Y_U_V10 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_U_V8_420Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_U_V8_420En)

This macro returns if Video Format Y_U_V8_420 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_U_V8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_U_V8En)

This macro returns if Video Format Y_U_V8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV10_420Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV10_420En)

This macro returns if Video Format Y_UV10_420 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV10Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV10En)

This macro returns if Video Format Y_UV10 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV12_420Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV12_420En)

This macro returns if Video Format Y_UV12_420 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV12Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV12En)

This macro returns if Video Format Y_UV12 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV16_420Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV16_420En)

This macro returns if Video Format Y_UV16_420 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV16Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV16En)

This macro returns if Video Format Y_UV16 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV8_420Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV8_420En)

This macro returns if Video Format Y_UV8_420 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsY_UV8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.Y_UV8En)

This macro returns if Video Format Y_UV8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUV16Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUV16En)

This macro returns if Video Format YUV16 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUV8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUV8En)

This macro returns if Video Format YUV8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUVX10Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUVX10En)

This macro returns if Video Format YUVX10 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUVX12Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUVX12En)

This macro returns if Video Format YUVX12 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUVX8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUVX8En)

This macro returns if Video Format YUVX8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

#define XVFrmbufWr_IsYUYV8Enabled (   InstancePtr)    ((InstancePtr)->FrmbufWr.Config.YUYV8En)

This macro returns if Video Format YUYV8 is available.

Parameters
InstancePtris a pointer to the core instance.
Returns
Enabled(1)/Disabled(0)
Note
None.

Referenced by XVFrmbufWr_SetMemFormat().

Typedef Documentation

typedef void(* XVFrmbufWr_Callback)(void *CallbackRef)

Callback type for interrupt.

Parameters
CallbackRefis a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.
Returns
None.
Note
None.