Overview

Data Structures
struct	XV_frmbufwr_Config
	This typedef contains configuration information for the frame buffer write core Each core instance should have a configuration structure associated. More...

struct	XV_frmbufwr
	Driver instance data. More...

Functions
int	XV_frmbufwr_Initialize (XV_frmbufwr *InstancePtr, u16 DeviceId)
	Initialize the frame buffer write core instance. More...

XV_frmbufwr_Config *	XV_frmbufwr_LookupConfig (u16 DeviceId)
	XV_frmbufwr_LookupConfig - Looks up the configuration for a device instance. More...

int	XV_frmbufwr_CfgInitialize (XV_frmbufwr InstancePtr, XV_frmbufwr_Config ConfigPtr, UINTPTR EffectiveAddr)
	Initialize the XV_frmbufwr instance. More...

void	XV_frmbufwr_Start (XV_frmbufwr *InstancePtr)
	Starts the Frame Buffer Write (frmbufwr) hardware core. More...

u32	XV_frmbufwr_IsDone (XV_frmbufwr *InstancePtr)
	Checks if the Frame Buffer Write (frmbufwr) hardware core has completed its current operation. More...

u32	XV_frmbufwr_IsIdle (XV_frmbufwr *InstancePtr)
	Checks if the Frame Buffer Write (frmbufwr) core is idle. More...

u32	XV_frmbufwr_IsReady (XV_frmbufwr *InstancePtr)
	Checks if the XV_frmbufwr instance is ready to accept new input. More...

void	XV_frmbufwr_EnableAutoRestart (XV_frmbufwr *InstancePtr)
	Enables auto-restart mode for the Frame Buffer Write (frmbufwr) hardware core. More...

void	XV_frmbufwr_DisableAutoRestart (XV_frmbufwr *InstancePtr)
	Disables the auto-restart feature of the frame buffer write core. More...

void	XV_frmbufwr_SetFlushbit (XV_frmbufwr *InstancePtr)
	Sets the flush bit in the Frame Buffer Write (frmbufwr) control register. More...

u32	XV_frmbufwr_Get_FlushDone (XV_frmbufwr *InstancePtr)
	Retrieves the flush done status from the Frame Buffer Write core. More...

void	XV_frmbufwr_Set_HwReg_width (XV_frmbufwr *InstancePtr, u32 Data)
	Sets the hardware register value for the frame buffer writer's width parameter. More...

u32	XV_frmbufwr_Get_HwReg_width (XV_frmbufwr *InstancePtr)
	Retrieves the value of the hardware register that specifies the width configuration for the frame buffer write instance. More...

void	XV_frmbufwr_Set_HwReg_height (XV_frmbufwr *InstancePtr, u32 Data)
	Sets the height hardware register for the frame buffer write instance. More...

u32	XV_frmbufwr_Get_HwReg_height (XV_frmbufwr *InstancePtr)
	Retrieves the value of the HWREG_HEIGHT hardware register for the specified Frame Buffer Write (frmbufwr) instance. More...

void	XV_frmbufwr_Set_HwReg_stride (XV_frmbufwr *InstancePtr, u32 Data)
	Sets the hardware register stride value for the frame buffer write instance. More...

u32	XV_frmbufwr_Get_HwReg_stride (XV_frmbufwr *InstancePtr)
	Retrieves the value of the HWREG_STRIDE register from the frame buffer write hardware. More...

void	XV_frmbufwr_Set_HwReg_video_format (XV_frmbufwr *InstancePtr, u32 Data)
	Sets the hardware register for the video format in the frame buffer write instance. More...

u32	XV_frmbufwr_Get_HwReg_video_format (XV_frmbufwr *InstancePtr)
	Retrieves the current hardware register value for the video format. More...

void	XV_frmbufwr_Set_HwReg_frm_buffer_V (XV_frmbufwr *InstancePtr, u64 Data)
	Sets the hardware register for the frame buffer virtual address. More...

u64	XV_frmbufwr_Get_HwReg_frm_buffer_V (XV_frmbufwr *InstancePtr)
	Retrieves the value of the HWREG_FRM_BUFFER_V hardware register. More...

void	XV_frmbufwr_Set_HwReg_frm_buffer2_V (XV_frmbufwr *InstancePtr, u64 Data)
	Sets the value of the HWREG_FRM_BUFFER2_V hardware register for the frame buffer writer. More...

u64	XV_frmbufwr_Get_HwReg_frm_buffer2_V (XV_frmbufwr *InstancePtr)
	Retrieves the 64-bit value of the HWREG_FRM_BUFFER2_V hardware register. More...

void	XV_frmbufwr_Set_HwReg_frm_buffer3_V (XV_frmbufwr *InstancePtr, u64 Data)
	Sets the hardware register for frame buffer 3 (vertical) in the XV_frmbufwr instance. More...

u64	XV_frmbufwr_Get_HwReg_frm_buffer3_V (XV_frmbufwr *InstancePtr)
	Retrieves the 64-bit value of the HWREG_FRM_BUFFER3_V hardware register. More...

u32	XV_frmbufwr_Get_HwReg_field_id (XV_frmbufwr *InstancePtr)
	Retrieves the value of the HWREG_FIELD_ID register from the frame buffer write hardware. More...

void	XV_frmbufwr_InterruptGlobalEnable (XV_frmbufwr *InstancePtr)
	Enables the global interrupt for the Frame Buffer Write (frmbufwr) core. More...

void	XV_frmbufwr_InterruptGlobalDisable (XV_frmbufwr *InstancePtr)
	XV_frmbufwr_InterruptGlobalDisable - Disables the global interrupt for the frame buffer write core. More...

void	XV_frmbufwr_InterruptEnable (XV_frmbufwr *InstancePtr, u32 Mask)
	Enables specific interrupts for the Frame Buffer Write core. More...

void	XV_frmbufwr_InterruptDisable (XV_frmbufwr *InstancePtr, u32 Mask)
	Disable specific interrupts for the Frame Buffer Write core. More...

void	XV_frmbufwr_InterruptClear (XV_frmbufwr *InstancePtr, u32 Mask)
	Clears specific interrupt(s) for the Frame Buffer Write (frmbufwr) instance. More...

u32	XV_frmbufwr_InterruptGetEnabled (XV_frmbufwr *InstancePtr)
	Retrieves the interrupt enable register value for the XV_frmbufwr instance. More...

u32	XV_frmbufwr_InterruptGetStatus (XV_frmbufwr *InstancePtr)
	Retrieves the interrupt status register value for the XV_frmbufwr instance. More...

Function Documentation

int XV_frmbufwr_CfgInitialize	(	XV_frmbufwr *	InstancePtr,
		XV_frmbufwr_Config *	ConfigPtr,
		UINTPTR	EffectiveAddr
	)

Initialize the XV_frmbufwr instance.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance to be initialized.
ConfigPtr	Pointer to the configuration structure.
EffectiveAddr	Physical base address of the device.

This function initializes an XV_frmbufwr instance using the provided configuration structure and base address. It sets up the instance configuration, updates the base address, and marks the instance as ready.

Returns: : XST_SUCCESS on successful initialization.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XV_frmbufwr_Initialize().

void XV_frmbufwr_DisableAutoRestart ( XV_frmbufwr * InstancePtr )

Disables the auto-restart feature of the frame buffer write core.

Parameters

InstancePtr,: Pointer to the XV_frmbufwr instance.

This function disables the auto-restart functionality by writing 0 to the AP_CTRL register of the frame buffer write hardware. It asserts that the instance pointer is not NULL and that the core is ready before performing the operation.

Returns: None.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptEnable(), and XVFrmbufWr_Stop().

void XV_frmbufwr_EnableAutoRestart ( XV_frmbufwr * InstancePtr )

Enables auto-restart mode for the Frame Buffer Write (frmbufwr) hardware core.

This function sets the auto-restart bit in the control register, allowing the core to automatically restart its operation after completion without requiring software intervention.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: None.

Note: The hardware core must be properly initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptDisable().

u32 XV_frmbufwr_Get_FlushDone ( XV_frmbufwr * InstancePtr )

Retrieves the flush done status from the Frame Buffer Write core.

This function reads the status register of the Frame Buffer Write hardware instance to determine if the flush operation has completed. It asserts that the provided instance pointer is not NULL and that the instance is ready.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The value of the flush done status bit (non-zero if flush is done, zero otherwise).

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_Stop().

u32 XV_frmbufwr_Get_HwReg_field_id ( XV_frmbufwr * InstancePtr )

Retrieves the value of the HWREG_FIELD_ID register from the frame buffer write hardware.

This function reads the HWREG_FIELD_ID register from the hardware instance specified by InstancePtr. It asserts that the instance pointer is valid, the instance is ready, and the configuration is set to interlaced mode before performing the register read.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The value read from the HWREG_FIELD_ID register.

Note: The function asserts that the instance is configured for interlaced mode.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, XV_frmbufwr_Config::Interlaced, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_GetFieldID().

u64 XV_frmbufwr_Get_HwReg_frm_buffer2_V ( XV_frmbufwr * InstancePtr )

Retrieves the 64-bit value of the HWREG_FRM_BUFFER2_V hardware register.

This function reads two 32-bit registers from the hardware, combines them into a 64-bit value, and returns the result. It asserts that the provided instance pointer is not NULL and that the instance is ready before performing the read operations.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance.

Returns: The 64-bit value read from the HWREG_FRM_BUFFER2_V register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus(), and XVFrmbufWr_GetChromaBufferAddr().

u64 XV_frmbufwr_Get_HwReg_frm_buffer3_V ( XV_frmbufwr * InstancePtr )

Retrieves the 64-bit value of the HWREG_FRM_BUFFER3_V hardware register.

This function reads two 32-bit registers from the hardware to construct a 64-bit value representing the contents of the HWREG_FRM_BUFFER3_V register. It asserts that the provided instance pointer is not NULL and that the instance is ready before performing the read operations.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance.

Returns: 64-bit value read from the HWREG_FRM_BUFFER3_V register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus(), and XVFrmbufWr_GetVChromaBufferAddr().

u64 XV_frmbufwr_Get_HwReg_frm_buffer_V ( XV_frmbufwr * InstancePtr )

Retrieves the value of the HWREG_FRM_BUFFER_V hardware register.

This function reads a 64-bit value from the hardware register associated with frame buffer V. It reads two 32-bit values from consecutive register addresses, combines them into a single 64-bit value, and returns the result.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance. Must not be NULL and must be initialized.

Returns: The 64-bit value read from the HWREG_FRM_BUFFER_V register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus(), and XVFrmbufWr_GetBufferAddr().

u32 XV_frmbufwr_Get_HwReg_height ( XV_frmbufwr * InstancePtr )

Retrieves the value of the HWREG_HEIGHT hardware register for the specified Frame Buffer Write (frmbufwr) instance.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance.

Returns: The current value of the HWREG_HEIGHT register.

Note: The InstancePtr must be initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus().

u32 XV_frmbufwr_Get_HwReg_stride ( XV_frmbufwr * InstancePtr )

Retrieves the value of the HWREG_STRIDE register from the frame buffer write hardware.

This function reads the stride value (in bytes) from the hardware register, which typically represents the number of bytes between the start of one line of pixels and the start of the next line in memory.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance. It must be a valid pointer to an initialized XV_frmbufwr structure.

Returns: The current value of the HWREG_STRIDE register.

Note: The function asserts that InstancePtr is not NULL and that the instance is ready before accessing the hardware register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus().

u32 XV_frmbufwr_Get_HwReg_video_format ( XV_frmbufwr * InstancePtr )

Retrieves the current hardware register value for the video format.

This function reads the value of the HWREG_VIDEO_FORMAT register from the frame buffer write hardware instance specified by InstancePtr.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The value of the HWREG_VIDEO_FORMAT register.

Note: The function asserts that InstancePtr is not NULL and that the instance is ready before accessing the hardware register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus().

u32 XV_frmbufwr_Get_HwReg_width ( XV_frmbufwr * InstancePtr )

Retrieves the value of the hardware register that specifies the width configuration for the frame buffer write instance.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The width value read from the hardware register.

Note: The function asserts that the instance pointer is not NULL and that the instance is ready before accessing the hardware register.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_DbgReportStatus().

int XV_frmbufwr_Initialize	(	XV_frmbufwr *	InstancePtr,
		u16	DeviceId
	)

Initialize the frame buffer write core instance.

This function initializes an XV_frmbufwr instance using the configuration corresponding to the specified DeviceId. It looks up the configuration, checks for validity, and then calls the core's configuration initialization function. If the configuration is not found, the instance is marked as not ready and an error code is returned.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance to be initialized.
DeviceId	Unique device ID of the frame buffer write core.

Returns

XST_SUCCESS if initialization was successful.
XST_DEVICE_NOT_FOUND if the configuration for the given DeviceId was not found.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::IsReady, XV_frmbufwr_CfgInitialize(), and XV_frmbufwr_LookupConfig().

Referenced by XVFrmbufWr_Initialize().

void XV_frmbufwr_InterruptClear	(	XV_frmbufwr *	InstancePtr,
		u32	Mask
	)

Clears specific interrupt(s) for the Frame Buffer Write (frmbufwr) instance.

This function writes the specified interrupt mask to the Interrupt Status Register (ISR) to clear the corresponding interrupt(s).

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Mask	Bitmask indicating which interrupt(s) to clear.

Note: The InstancePtr must be initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptHandler().

void XV_frmbufwr_InterruptDisable	(	XV_frmbufwr *	InstancePtr,
		u32	Mask
	)

Disable specific interrupts for the Frame Buffer Write core.

This function disables the interrupts specified by the Mask parameter in the Interrupt Enable Register (IER) of the Frame Buffer Write core.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Mask	Bitmask of interrupts to disable. Each bit corresponds to a specific interrupt source.

Note: The function asserts that the InstancePtr is not NULL and that the core is ready before proceeding.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptDisable().

void XV_frmbufwr_InterruptEnable	(	XV_frmbufwr *	InstancePtr,
		u32	Mask
	)

Enables specific interrupts for the Frame Buffer Write core.

This function sets the bits specified by the Mask parameter in the Interrupt Enable Register (IER) of the Frame Buffer Write hardware instance. Only the interrupts corresponding to the set bits in the Mask will be enabled.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Mask	Bitmask of interrupts to enable. Each bit corresponds to a specific interrupt.

Note: The InstancePtr must be initialized and ready before calling this function.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptEnable().

u32 XV_frmbufwr_InterruptGetEnabled ( XV_frmbufwr * InstancePtr )

Retrieves the interrupt enable register value for the XV_frmbufwr instance.

This function checks that the provided instance pointer is valid and that the instance is ready. It then reads and returns the value of the Interrupt Enable Register (IER) for the frame buffer write hardware.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The current value of the Interrupt Enable Register (IER).

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

u32 XV_frmbufwr_InterruptGetStatus ( XV_frmbufwr * InstancePtr )

Retrieves the interrupt status register value for the XV_frmbufwr instance.

This function checks that the provided instance pointer is valid and that the instance is ready. It then reads and returns the value of the Interrupt Status Register (ISR) for the frame buffer write hardware.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: The current value of the Interrupt Status Register (ISR).

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptHandler().

void XV_frmbufwr_InterruptGlobalDisable ( XV_frmbufwr * InstancePtr )

XV_frmbufwr_InterruptGlobalDisable - Disables the global interrupt for the frame buffer write core.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance.

This function disables the global interrupt enable (GIE) bit in the control register of the frame buffer write hardware. It asserts that the provided instance pointer is not NULL and that the instance is ready before performing the operation.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptDisable().

void XV_frmbufwr_InterruptGlobalEnable ( XV_frmbufwr * InstancePtr )

Enables the global interrupt for the Frame Buffer Write (frmbufwr) core.

This function sets the Global Interrupt Enable (GIE) bit in the control register, allowing the core to generate interrupts. It asserts that the provided instance pointer is not NULL and that the core is ready before enabling the interrupt.

Parameters

InstancePtr Pointer to the XV_frmbufwr instance.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_InterruptEnable().

u32 XV_frmbufwr_IsDone ( XV_frmbufwr * InstancePtr )

Checks if the Frame Buffer Write (frmbufwr) hardware core has completed its current operation.

This function reads the status register of the frmbufwr core and returns the "done" status bit.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: 1 if the operation is done, 0 otherwise.

Note: The function asserts that the InstancePtr is not NULL and that the core is ready.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

u32 XV_frmbufwr_IsIdle ( XV_frmbufwr * InstancePtr )

Checks if the Frame Buffer Write (frmbufwr) core is idle.

This function reads the control register of the Frame Buffer Write core and returns the status of the idle bit. The core is considered idle if the bit is set.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: 1 if the core is idle, 0 otherwise.

Note: None.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_WaitForIdle().

u32 XV_frmbufwr_IsReady ( XV_frmbufwr * InstancePtr )

Checks if the XV_frmbufwr instance is ready to accept new input.

This function reads the control register of the frame buffer write core to determine if it is ready for the next operation. It asserts that the provided instance pointer is not NULL and that the instance is marked as ready. The function returns a non-zero value if the core is ready for the next input, and zero otherwise.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: 1 if the core is ready for the next input, 0 otherwise.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

XV_frmbufwr_Config* XV_frmbufwr_LookupConfig ( u16 DeviceId )

XV_frmbufwr_LookupConfig - Looks up the configuration for a device instance.

Parameters

DeviceId The unique device ID of the XV_frmbufwr instance to look up.

Returns: Pointer to the configuration structure if found, NULL otherwise.

This function searches the configuration table for an entry matching the specified DeviceId and returns a pointer to its configuration structure.

Referenced by XV_frmbufwr_Initialize().

void XV_frmbufwr_Set_HwReg_frm_buffer2_V	(	XV_frmbufwr *	InstancePtr,
		u64	Data
	)

Sets the value of the HWREG_FRM_BUFFER2_V hardware register for the frame buffer writer.

This function writes a 64-bit value to the hardware register associated with frame buffer 2. The value is split into two 32-bit parts and written to consecutive register addresses.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	64-bit value to be written to the hardware register.

Preconditions:

InstancePtr must not be NULL.
InstancePtr->IsReady must be set to XIL_COMPONENT_IS_READY.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetChromaBufferAddr().

void XV_frmbufwr_Set_HwReg_frm_buffer3_V	(	XV_frmbufwr *	InstancePtr,
		u64	Data
	)

Sets the hardware register for frame buffer 3 (vertical) in the XV_frmbufwr instance.

This function writes a 64-bit value to the hardware register associated with frame buffer 3's vertical parameter. The value is split into two 32-bit parts and written to consecutive register addresses.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	64-bit value to be written to the hardware register.

Preconditions:

InstancePtr must not be NULL.
InstancePtr->IsReady must be set to XIL_COMPONENT_IS_READY.
Returns
none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetVChromaBufferAddr().

void XV_frmbufwr_Set_HwReg_frm_buffer_V	(	XV_frmbufwr *	InstancePtr,
		u64	Data
	)

Sets the hardware register for the frame buffer virtual address.

This function writes a 64-bit address (Data) to the hardware register associated with the frame buffer. The address is split into two 32-bit values and written to consecutive register addresses.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	64-bit virtual address to be written to the hardware register.

Preconditions:

InstancePtr must not be NULL.
InstancePtr->IsReady must be set to XIL_COMPONENT_IS_READY.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetBufferAddr().

void XV_frmbufwr_Set_HwReg_height	(	XV_frmbufwr *	InstancePtr,
		u32	Data
	)

Sets the height hardware register for the frame buffer write instance.

This function writes the specified height value to the hardware register responsible for configuring the frame buffer's height. It first asserts that the provided instance pointer is not NULL and that the instance is ready for operation.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	The height value to be written to the hardware register.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetMemFormat().

void XV_frmbufwr_Set_HwReg_stride	(	XV_frmbufwr *	InstancePtr,
		u32	Data
	)

Sets the hardware register stride value for the frame buffer write instance.

This function writes the specified stride value to the hardware register associated with the frame buffer writer. The stride typically represents the number of bytes between the start of one line of pixels and the next in memory.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	The stride value to be written to the hardware register.

Note: The InstancePtr must be initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetMemFormat().

void XV_frmbufwr_Set_HwReg_video_format	(	XV_frmbufwr *	InstancePtr,
		u32	Data
	)

Sets the hardware register for the video format in the frame buffer write instance.

This function writes the specified video format data to the hardware register associated with the frame buffer writer. It first asserts that the instance pointer is not NULL and that the instance is ready before performing the register write.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	The video format data to be written to the hardware register.

Returns: none

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetMemFormat().

void XV_frmbufwr_Set_HwReg_width	(	XV_frmbufwr *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the frame buffer writer's width parameter.

This function writes the specified width value to the hardware register associated with the frame buffer writer instance. It first asserts that the provided instance pointer is not NULL and that the instance is ready.

Parameters

InstancePtr	Pointer to the XV_frmbufwr instance.
Data	The width value to be written to the hardware register.

Returns: none.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_SetMemFormat().

void XV_frmbufwr_SetFlushbit ( XV_frmbufwr * InstancePtr )

Sets the flush bit in the Frame Buffer Write (frmbufwr) control register.

This function sets the flush bit in the AP_CTRL register to trigger a flush operation in the hardware. It reads the current value of the control register, sets the flush bit, and writes the updated value back.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: None.

Note: The hardware core must be properly initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_Stop().

void XV_frmbufwr_Start ( XV_frmbufwr * InstancePtr )

Starts the Frame Buffer Write (frmbufwr) hardware core.

This function asserts the start signal of the frmbufwr core by writing to the control register. It preserves the auto-restart bit if it is set.

Parameters

InstancePtr is a pointer to the XV_frmbufwr instance.

Returns: None.

Note: The hardware core must be properly initialized and ready before calling this function.

References XV_frmbufwr_Config::BaseAddress, XV_frmbufwr::Config, and XV_frmbufwr::IsReady.

Referenced by XVFrmbufWr_Start().

Overview

Data Structures

Functions

Function Documentation