xdptxss_vtc.h File Reference

Overview

This is the header file for Xilinx DisplayPort Transmitter Subsystem sub-core, is Video Timing Controller.

MODIFICATION HISTORY:

Ver  Who Date     Changes



1.00 sha 01/29/15 Initial release.
1.00 sha 07/21/15 Renamed file name with prefix xdptxss_* and function
                  name with prefix XDpTxSs_*
5.0  tu  08/10/17 Modified XDpTxSs_VtcSetup for adjusting BS symbol for
            equal timing

#include "xvtc.h"
#include "xdp.h"

Macros
#define	XDPTXSS_VTC_H_
	Prevent circular inclusions by using protection macros. More...
#define	DIV_ROUND_CLOSEST(n, d)   (((n) + ((d) / 2U)) / (d))
	Divides n by d and rounds to the nearest integer. More...

Functions
u32	XDpTxSs_VtcSetup (XVtc *InstancePtr, XDp_TxMainStreamAttributes *MsaConfig, u8 VtcAdjustBs)
	This function configures Video Timing Controller with video timing parameters from MSA config structure. More...
void	XDpTxSs_VtcAdaptiveSyncSetup (XVtc *InstancePtr, XVtc_AdaptiveSyncMode Mode, u32 StretchLimit)
	This function configures Video Timing Controller with Adaptive-Sync mode to be work on and sets vertical front porch stretch limit. More...
void	XDpTxSs_VtcDisableAdaptiveSync (XVtc *InstancePtr)
	This function disables Adaptive-Sync feature in Video Timing Controller. More...

Macro Definition Documentation

#define DIV_ROUND_CLOSEST	(		n,
			d
	)		(((n) + ((d) / 2U)) / (d))

Divides n by d and rounds to the nearest integer.

This macro performs integer division with rounding to the nearest integer. It adds half the divisor to the numerator before dividing to achieve round-to-nearest behavior.

Parameters

n	Numerator
d	Divisor

Returns

Result of n divided by d, rounded to nearest integer

Referenced by XDpTxSs_VtcSetup().

#define XDPTXSS_VTC_H_

Prevent circular inclusions by using protection macros.

Function Documentation

void XDpTxSs_VtcAdaptiveSyncSetup	(	XVtc *	InstancePtr,
		XVtc_AdaptiveSyncMode	mode,
		u32	StretchLimit
	)

This function configures Video Timing Controller with Adaptive-Sync mode to be work on and sets vertical front porch stretch limit.

Parameters

InstancePtr	is a pointer to the XVtc instance.
mode	is a Adaptive-Sync mechanism to be work on
StretchLimit	is a max limit of vertical front porch stretching

Note

None.

void XDpTxSs_VtcDisableAdaptiveSync

(

XVtc *

InstancePtr

)

This function disables Adaptive-Sync feature in Video Timing Controller.

Parameters

InstancePtr

is a pointer to the XVtc instance.

Note

None.

u32 XDpTxSs_VtcSetup	(	XVtc *	InstancePtr,
		XDp_TxMainStreamAttributes *	MsaConfig,
		u8	VtcAdjustBs
	)

This function configures Video Timing Controller with video timing parameters from MSA config structure.

Parameters

InstancePtr	is a pointer to the XVtc instance.
MsaConfig	is a pointer to main stream attributes structure that will be used to extract timing values.
VtcAdjustBs	is a flag to adjust blanking timing for CVT-RB

Returns

• XST_SUCCESS if video timing parameters set successfully.

Note

None.

References DIV_ROUND_CLOSEST.

Referenced by start_tx(), and XDpTxSs_CfgInitialize().