Data Structures
struct	XV_letterbox_Config
	This typedef contains configuration information for the letterbox core Each core instance should have a configuration structure associated. More...

struct	XV_letterbox
	Driver instance data. More...

Functions
int	XV_letterbox_Initialize (XV_letterbox *InstancePtr, u16 DeviceId)
	XV_letterbox_Initialize - Initializes an XV_letterbox instance. More...

XV_letterbox_Config *	XV_letterbox_LookupConfig (u16 DeviceId)
	XV_letterbox_LookupConfig - Looks up the configuration for a specific XV_letterbox device. More...

int	XV_letterbox_CfgInitialize (XV_letterbox InstancePtr, XV_letterbox_Config ConfigPtr, UINTPTR EffectiveAddr)
	XV_letterbox_CfgInitialize - Initializes a specific XV_letterbox instance. More...

void	XV_letterbox_Start (XV_letterbox *InstancePtr)
	XV_letterbox_Start - Starts the XV_letterbox hardware core. More...

u32	XV_letterbox_IsDone (XV_letterbox *InstancePtr)
	XV_letterbox_IsDone - Checks if the XV_letterbox hardware core has finished processing. More...

u32	XV_letterbox_IsIdle (XV_letterbox *InstancePtr)
	Checks if the XV_letterbox hardware core is idle. More...

u32	XV_letterbox_IsReady (XV_letterbox *InstancePtr)
	Checks if the XV_letterbox hardware core is ready to accept new input. More...

void	XV_letterbox_EnableAutoRestart (XV_letterbox *InstancePtr)
	XV_letterbox_EnableAutoRestart - Enables auto-restart for the XV_letterbox hardware core. More...

void	XV_letterbox_DisableAutoRestart (XV_letterbox *InstancePtr)
	XV_letterbox_DisableAutoRestart - Disables auto-restart for the XV_letterbox hardware core. More...

void	XV_letterbox_Set_HwReg_width (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register value for the width parameter of the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_width (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_WIDTH hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_height (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register value for the height parameter of the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_height (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_HEIGHT hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_video_format (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register for the video format in the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_video_format (XV_letterbox *InstancePtr)
	Retrieves the current hardware register value for the video format from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_col_start (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register value for the column start parameter of the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_col_start (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_COL_START hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_col_end (XV_letterbox *InstancePtr, u32 Data)
	XV_letterbox_Set_HwReg_col_end - Sets the hardware register value for the column end parameter in the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_col_end (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_COL_END hardware register for the specified XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_row_start (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register value for the row start parameter of the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_row_start (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_ROW_START hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_row_end (XV_letterbox *InstancePtr, u32 Data)
	Sets the hardware register value for the row end parameter of the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_row_end (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_ROW_END hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_Y_R_value (XV_letterbox *InstancePtr, u32 Data)
	XV_letterbox_Set_HwReg_Y_R_value - Sets the Y register value for the hardware register in the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_Y_R_value (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_Y_R hardware register from the XV_letterbox instance. More...

void	XV_letterbox_Set_HwReg_Cb_G_value (XV_letterbox *InstancePtr, u32 Data)
	XV_letterbox_Set_HwReg_Cb_G_value - Sets the Cb/G register value for the hardware register in the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_Cb_G_value (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_CB_G register from the XV_letterbox hardware instance. More...

void	XV_letterbox_Set_HwReg_Cr_B_value (XV_letterbox *InstancePtr, u32 Data)
	XV_letterbox_Set_HwReg_Cr_B_value - Set the value of the HWREG_CR_B register for the XV_letterbox instance. More...

u32	XV_letterbox_Get_HwReg_Cr_B_value (XV_letterbox *InstancePtr)
	Retrieves the value of the HWREG_CR_B register from the XV_letterbox instance. More...

void	XV_letterbox_InterruptGlobalEnable (XV_letterbox *InstancePtr)
	XV_letterbox_InterruptGlobalEnable - Enables global interrupts for the XV_letterbox hardware core. More...

void	XV_letterbox_InterruptGlobalDisable (XV_letterbox *InstancePtr)
	XV_letterbox_InterruptGlobalDisable - Disables global interrupts for the XV_letterbox hardware core. More...

void	XV_letterbox_InterruptEnable (XV_letterbox *InstancePtr, u32 Mask)
	Enables the specified interrupts for the XV_letterbox instance. More...

void	XV_letterbox_InterruptDisable (XV_letterbox *InstancePtr, u32 Mask)
	XV_letterbox_InterruptDisable - Disables specific interrupts for the XV_letterbox instance. More...

void	XV_letterbox_InterruptClear (XV_letterbox *InstancePtr, u32 Mask)
	XV_letterbox_InterruptClear - Clears specific interrupts for the XV_letterbox instance. More...

u32	XV_letterbox_InterruptGetEnabled (XV_letterbox *InstancePtr)
	XV_letterbox_InterruptGetEnabled - Retrieves the currently enabled interrupts for the XV_letterbox instance. More...

u32	XV_letterbox_InterruptGetStatus (XV_letterbox *InstancePtr)
	XV_letterbox_InterruptGetStatus - Retrieves the current interrupt status for the XV_letterbox instance. More...

Function Documentation

int XV_letterbox_CfgInitialize	(	XV_letterbox *	InstancePtr,
		XV_letterbox_Config *	ConfigPtr,
		UINTPTR	EffectiveAddr
	)

XV_letterbox_CfgInitialize - Initializes a specific XV_letterbox instance.

This function sets up the XV_letterbox instance pointed to by InstancePtr using the configuration provided in ConfigPtr and the specified base address EffectiveAddr. It asserts that all input pointers are valid, copies the configuration, updates the base address, and marks the instance as ready.

Parameters

InstancePtr	Pointer to the XV_letterbox instance to be initialized.
ConfigPtr	Pointer to the configuration structure for the instance.
EffectiveAddr	Base address to be used for the hardware instance.

Returns: XST_SUCCESS if initialization is successful.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_letterbox_Initialize().

void XV_letterbox_DisableAutoRestart ( XV_letterbox * InstancePtr )

XV_letterbox_DisableAutoRestart - Disables auto-restart for the XV_letterbox hardware core.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It writes to the control register to disable the auto-restart feature, so the hardware will not automatically restart after completion.

Parameters

InstancePtr,: Pointer to the XV_letterbox instance.

Returns: This function does not return a value.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxStop().

void XV_letterbox_EnableAutoRestart ( XV_letterbox * InstancePtr )

XV_letterbox_EnableAutoRestart - Enables auto-restart for the XV_letterbox hardware core.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It writes to the control register to enable the auto-restart feature, allowing the hardware to automatically restart processing after completion without software intervention.

Parameters

InstancePtr,: Pointer to the XV_letterbox instance.

Returns: This function does not return a value.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxStart().

u32 XV_letterbox_Get_HwReg_Cb_G_value ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_CB_G register from the XV_letterbox hardware instance.

This function reads the register value from the hardware using the base address specified in the configuration structure of the provided XV_letterbox instance pointer.

Parameters

InstancePtr is a pointer to the XV_letterbox instance. It must be initialized and ready before calling this function.

Returns: The 32-bit value read from the HWREG_CB_G register.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_col_end ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_COL_END hardware register for the specified XV_letterbox instance.

This function asserts that the provided instance pointer is not NULL and that the instance is ready before reading the register value from the hardware. The value read from the HWREG_COL_END register is then returned to the caller.

Parameters

InstancePtr is a pointer to the XV_letterbox instance for which the HWREG_COL_END register value is to be retrieved.

Returns: The value of the HWREG_COL_END hardware register.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_col_start ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_COL_START hardware register from the XV_letterbox instance.

This function reads the current column start configuration from the hardware register associated with the XV_letterbox peripheral.

Parameters

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

Returns: The value of the HWREG_COL_START register as a 32-bit unsigned integer.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_Cr_B_value ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_CR_B register from the XV_letterbox instance.

This function reads the current value of the HWREG_CR_B hardware register associated with the XV_letterbox peripheral. It asserts that the instance pointer is not NULL and that the instance is ready before accessing the hardware register.

Parameters

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

Returns: The value of the HWREG_CR_B register as a 32-bit unsigned integer.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_height ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_HEIGHT hardware register from the XV_letterbox instance.

This function reads the current height configuration from the hardware register associated with the XV_letterbox peripheral.

Parameters

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

Returns: The value of the HWREG_HEIGHT register as a 32-bit unsigned integer.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_row_end ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_ROW_END hardware register from the XV_letterbox instance.

This function reads the current row end configuration from the hardware register associated with the XV_letterbox peripheral.

Parameters

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

Returns: The value of the HWREG_ROW_END register as a 32-bit unsigned integer.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_row_start ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_ROW_START hardware register from the XV_letterbox instance.

This function reads the current row start configuration from the hardware register associated with the XV_letterbox peripheral.

Parameters

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

Returns: The value of the HWREG_ROW_START register as a 32-bit unsigned integer.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_video_format ( XV_letterbox * InstancePtr )

Retrieves the current hardware register value for the video format from the XV_letterbox instance.

Parameters

InstancePtr is a pointer to the XV_letterbox instance.

Returns: The value of the HWREG_VIDEO_FORMAT register.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_width ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_WIDTH hardware register from the XV_letterbox instance.

This function reads the current width configuration from the hardware register associated with the XV_letterbox peripheral.

Parameters

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

Returns: The value of the HWREG_WIDTH register as a 32-bit unsigned integer.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_Get_HwReg_Y_R_value ( XV_letterbox * InstancePtr )

Retrieves the value of the HWREG_Y_R hardware register from the XV_letterbox instance.

This function reads the current Y (or R) value from the hardware register associated with the XV_letterbox peripheral. It asserts that the instance pointer is not NULL and that the instance is ready before accessing the hardware register.

Parameters

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

Returns: The value of the HWREG_Y_R register as a 32-bit unsigned integer.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxDbgReportStatus().

int XV_letterbox_Initialize	(	XV_letterbox *	InstancePtr,
		u16	DeviceId
	)

XV_letterbox_Initialize - Initializes an XV_letterbox instance.

This function initializes the specified XV_letterbox instance using the configuration data corresponding to the provided DeviceId. It first looks up the configuration for the given DeviceId. If the configuration is found, it initializes the instance with the configuration data and base address. If the configuration is not found, the function sets the instance's IsReady flag to 0 and returns XST_DEVICE_NOT_FOUND.

Parameters

InstancePtr	is a pointer to the XV_letterbox instance to be initialized.
DeviceId	is the unique identifier for the XV_letterbox device.

Returns: XST_SUCCESS if initialization is successful, or XST_DEVICE_NOT_FOUND if the device configuration is not found.

References XV_letterbox_Config::BaseAddress, XV_letterbox::IsReady, XV_letterbox_CfgInitialize(), and XV_letterbox_LookupConfig().

Referenced by XV_LBoxInitialize().

void XV_letterbox_InterruptClear	(	XV_letterbox *	InstancePtr,
		u32	Mask
	)

XV_letterbox_InterruptClear - Clears specific interrupts for the XV_letterbox instance.

This function writes the specified Mask to the interrupt status register to clear the corresponding interrupt sources for the given XV_letterbox instance. It asserts that the InstancePtr is not NULL and that the instance is ready before performing the operation.

Parameters

InstancePtr	Pointer to the XV_letterbox instance.
Mask	Bitmask of interrupts to clear.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

void XV_letterbox_InterruptDisable	(	XV_letterbox *	InstancePtr,
		u32	Mask
	)

XV_letterbox_InterruptDisable - Disables specific interrupts for the XV_letterbox instance.

This function disables the interrupts specified by the Mask parameter for the given XV_letterbox instance. It reads the current interrupt enable register, clears the bits corresponding to the Mask, and writes the updated value back to the register. The function asserts that the InstancePtr is not NULL and that the instance is ready before performing the operation.

Parameters

InstancePtr	Pointer to the XV_letterbox instance.
Mask	Bitmask of interrupts to disable.

Returns: None

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

void XV_letterbox_InterruptEnable	(	XV_letterbox *	InstancePtr,
		u32	Mask
	)

Enables the specified interrupts for the XV_letterbox instance.

This function reads the current interrupt enable register, applies the given mask to enable the specified interrupts, and writes the updated value back to the register. It asserts that the instance pointer is not NULL and that the instance is ready before performing any operations.

Parameters

InstancePtr	is a pointer to the XV_letterbox instance.
Mask	is the bitmask of interrupts to enable. Each bit in the mask corresponds to a specific interrupt source.

Returns: None

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

u32 XV_letterbox_InterruptGetEnabled ( XV_letterbox * InstancePtr )

XV_letterbox_InterruptGetEnabled - Retrieves the currently enabled interrupts for the XV_letterbox instance.

This function asserts that the provided InstancePtr is not NULL and that the instance is ready. It reads the interrupt enable register and returns its value, indicating which interrupts are currently enabled for the hardware core.

Parameters

InstancePtr Pointer to the XV_letterbox instance.

Returns: The value of the interrupt enable register as a 32-bit unsigned integer.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

u32 XV_letterbox_InterruptGetStatus ( XV_letterbox * InstancePtr )

XV_letterbox_InterruptGetStatus - Retrieves the current interrupt status for the XV_letterbox instance.

This function asserts that the provided InstancePtr is not NULL and that the instance is ready. It reads the interrupt status register and returns its value, indicating which interrupts are currently active for the hardware core.

Parameters

InstancePtr Pointer to the XV_letterbox instance.

Returns: The value of the interrupt status register as a 32-bit unsigned integer.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

void XV_letterbox_InterruptGlobalDisable ( XV_letterbox * InstancePtr )

XV_letterbox_InterruptGlobalDisable - Disables global interrupts for the XV_letterbox hardware core.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It writes to the global interrupt enable register to disable interrupt generation by the hardware.

Parameters

InstancePtr Pointer to the XV_letterbox instance.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

void XV_letterbox_InterruptGlobalEnable ( XV_letterbox * InstancePtr )

XV_letterbox_InterruptGlobalEnable - Enables global interrupts for the XV_letterbox hardware core.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It writes to the global interrupt enable register to allow interrupt generation by the hardware.

Parameters

InstancePtr Pointer to the XV_letterbox instance.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

u32 XV_letterbox_IsDone ( XV_letterbox * InstancePtr )

XV_letterbox_IsDone - Checks if the XV_letterbox hardware core has finished processing.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It reads the control register and checks the 'done' bit to determine if the hardware operation is complete.

Parameters

InstancePtr,: Pointer to the XV_letterbox instance to be checked.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_IsIdle ( XV_letterbox * InstancePtr )

Checks if the XV_letterbox hardware core is idle.

This function reads the control register of the XV_letterbox instance to determine if the hardware is currently idle. It asserts that the instance pointer is not NULL and that the instance is ready before accessing the hardware register.

Parameters

InstancePtr is a pointer to the XV_letterbox instance.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxDbgReportStatus().

u32 XV_letterbox_IsReady ( XV_letterbox * InstancePtr )

Checks if the XV_letterbox hardware core is ready to accept new input.

This function reads the control register of the XV_letterbox instance to determine if the hardware core is ready for the next operation. It asserts that the 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, and zero otherwise.

Parameters

InstancePtr is a pointer to the XV_letterbox instance.

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

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxDbgReportStatus().

XV_letterbox_Config* XV_letterbox_LookupConfig ( u16 DeviceId )

XV_letterbox_LookupConfig - Looks up the configuration for a specific XV_letterbox device.

This function searches the configuration table for an entry that matches the provided DeviceId. If a matching configuration is found, a pointer to the configuration structure is returned. If no match is found, NULL is returned.

Parameters

DeviceId is the unique identifier for the XV_letterbox device.

Returns: A pointer to the configuration structure corresponding to the given DeviceId, or NULL if no matching device is found.

Referenced by XV_letterbox_Initialize().

void XV_letterbox_Set_HwReg_Cb_G_value	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

XV_letterbox_Set_HwReg_Cb_G_value - Sets the Cb/G register value for the hardware register in the XV_letterbox instance.

This function writes the specified data value to the HWREG_CB_G register of the XV_letterbox hardware. It asserts that the provided instance pointer is not NULL and that the instance is ready before performing the register write operation.

Parameters

InstancePtr	Pointer to the XV_letterbox instance. Must not be NULL and must be initialized.
Data	The 32-bit value to be written to the HWREG_CB_G register.

Returns: None

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LboxSetBackgroundColor().

void XV_letterbox_Set_HwReg_col_end	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

XV_letterbox_Set_HwReg_col_end - Sets the hardware register value for the column end parameter in the XV_letterbox instance.

This function writes the specified data value to the HWREG_COL_END register of the letterbox hardware, using the base address from the instance configuration. It first asserts that the instance pointer is not NULL and that the instance is ready before performing the register write operation.

Parameters

InstancePtr,:	Pointer to the XV_letterbox instance.
Data,:	Value to be written to the HWREG_COL_END register.

Returns: None

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_col_start	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the column start parameter of the XV_letterbox instance.

This function writes the specified column start value to the hardware register associated with the XV_letterbox core. 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_letterbox instance.
Data	The column start value to be written to the hardware register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_Cr_B_value	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

XV_letterbox_Set_HwReg_Cr_B_value - Set the value of the HWREG_CR_B register for the XV_letterbox instance.

This function writes the specified data value to the HWREG_CR_B register of the XV_letterbox hardware. It first asserts that the provided instance pointer is not NULL and that the instance is ready for use. The function then writes the data to the hardware register using the base address from the configuration structure.

Parameters

InstancePtr,:	Pointer to the XV_letterbox instance.
Data,:	Value to be written to the HWREG_CR_B register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LboxSetBackgroundColor().

void XV_letterbox_Set_HwReg_height	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the height parameter of the XV_letterbox instance.

This function writes the specified height value to the hardware register associated with the XV_letterbox core. 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_letterbox instance.
Data	The height value to be written to the hardware register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_row_end	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the row end parameter of the XV_letterbox instance.

This function writes the specified row end value to the hardware register associated with the XV_letterbox core. 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_letterbox instance.
Data	The row end value to be written to the hardware register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_row_start	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the row start parameter of the XV_letterbox instance.

This function writes the specified row start value to the hardware register associated with the XV_letterbox core. 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_letterbox instance.
Data	The row start value to be written to the hardware register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_video_format	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register for the video format in the XV_letterbox instance.

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

Parameters

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

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LboxSetBackgroundColor().

void XV_letterbox_Set_HwReg_width	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

Sets the hardware register value for the width parameter of the XV_letterbox instance.

This function writes the specified width value to the hardware register associated with the XV_letterbox core. 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_letterbox instance.
Data	The width value to be written to the hardware register.

Returns: None.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LBoxSetActiveWin().

void XV_letterbox_Set_HwReg_Y_R_value	(	XV_letterbox *	InstancePtr,
		u32	Data
	)

XV_letterbox_Set_HwReg_Y_R_value - Sets the Y register value for the hardware register in the XV_letterbox instance.

This function asserts that the provided instance pointer is not NULL and that the instance is ready before writing the specified data value to the HWREG_Y_R register using the XV_letterbox_WriteReg function.

Parameters

InstancePtr,:	Pointer to the XV_letterbox instance. Must not be NULL and must be initialized.
Data,:	The 32-bit value to be written to the HWREG_Y_R register.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, and XV_letterbox::IsReady.

Referenced by XV_LboxSetBackgroundColor().

void XV_letterbox_Start ( XV_letterbox * InstancePtr )

XV_letterbox_Start - Starts the XV_letterbox hardware core.

This function asserts that the provided InstancePtr is not NULL and that the hardware component is ready. It then reads the current control register value, preserves the auto-restart bit, and sets the start bit to initiate the hardware operation.

Parameters

InstancePtr,: Pointer to the XV_letterbox instance to be started.

Returns: This function does not return a value.

References XV_letterbox_Config::BaseAddress, XV_letterbox::Config, XV_letterbox::IsReady, and XV_LETTERBOX_CTRL_ADDR_AP_CTRL.

Referenced by XV_LBoxStart().

Data Structures

Functions

Function Documentation