MODIFICATION HISTORY:
Ver Who Date Changes ----- ------ -------- -------------------------------------------------- 1.00a xd 08/05/08 First release. 1.01a xd 07/23/10 Added GIER; Added more h/w generic info into xparameters.h; Feed callbacks with pending interrupt info. Added Doxygen & Version support. 3.00a cjm 08/01/12 Converted from xio.h to xil_io.h, translating basic types, MB cache functions, exceptions and assertions to xil_io format. Replaced the following: "XExc_Init" -> "Xil_ExceptionInit" "XExc_RegisterHandler" -> "Xil_ExceptionRegisterHandler" "XEXC_ID_NON_CRITICAL_INT" -> "XIL_EXCEPTION_ID_INT" "XExceptionHandler" -> "Xil_ExceptionHandler" "XExc_mEnableExceptions" -> "Xil_ExceptionEnable" "XEXC_NON_CRITICAL" -> "XIL_EXCEPTION_NON_CRITICAL" "XExc_DisableExceptions" -> "Xil_ExceptionDisable" "XExc_RemoveHandler" -> "Xil_ExceptionRemoveHandler" "microblaze_enable_interrupts" -> "Xil_ExceptionEnable" "microblaze_disable_interrupts" -> Xil_ExceptionDisable" "XCOMPONENT_IS_STARTED" -> "XIL_COMPONENT_IS_STARTED" "XCOMPONENT_IS_READY" -> "(XIL_COMPONENT_IS_READY)"
"XASSERT_NONVOID" -> "Xil_AssertNonvoid" "XASSERT_VOID_ALWAYS" -> "Xil_AssertVoidAlways" "XASSERT_VOID" -> "Xil_AssertVoid" "Xil_AssertVoid_ALWAYS" -> "Xil_AssertVoidAlways" "XAssertStatus" -> "Xil_AssertStatus" "XAssertSetCallback" -> "Xil_AssertCallback"
"XASSERT_OCCURRED" -> "XIL_ASSERT_OCCURRED" "XASSERT_NONE" -> "XIL_ASSERT_NONE"
"microblaze_disable_dcache" -> "Xil_DCacheDisable" "microblaze_enable_dcache" -> "Xil_DCacheEnable" "microblaze_enable_icache" -> "Xil_ICacheEnable" "microblaze_disable_icache" -> "Xil_ICacheDisable" "microblaze_init_dcache_range" -> "Xil_DCacheInvalidateRange" "XCache_DisableDCache" -> "Xil_DCacheDisable" "XCache_DisableICache" -> "Xil_ICacheDisable" "XCache_EnableDCache" -> "Xil_DCacheEnableRegion" "XCache_EnableICache" -> "Xil_ICacheEnableRegion" "XCache_InvalidateDCacheLine" -> "Xil_DCacheInvalidateRange"
"XUtil_MemoryTest32" -> "Xil_TestMem32" "XUtil_MemoryTest16" -> "Xil_TestMem16" "XUtil_MemoryTest8" -> "Xil_TestMem8"
"xutil.h" -> "xil_testmem.h"
"xbasic_types.h" -> "xil_types.h" "xio.h" -> "xil_io.h"
"XIo_In32" -> "Xil_In32" "XIo_Out32" -> "Xil_Out32"
"XTRUE" -> "TRUE" "XFALSE" -> "FALSE" "XNULL" -> "NULL"
"Xuint8" -> "u8" "Xuint16" -> "u16" "Xuint32" -> "u32" "Xint8" -> "char" "Xint16" -> "short" "Xint32" -> "long" "Xfloat32" -> "float" "Xfloat64" -> "double" "Xboolean" -> "int" "XTEST_FAILED" -> "XST_FAILURE" "XTEST_PASSED" -> "XST_SUCCESS" 4.00a cjm 02/08/13 Removed XVTC_CTL_HASS_MASK 5.00a cjm 08/07/13 Replaced CTL in Polarity and Encoding register definition with "POL" and "ENC" 5.00a cjm 10/30/13 Removed type parameter from XVtc_Enable which now enables both generator and detector. Added XVtc_EnableGenerator to enable only the Generator Added XVtc_EnableDetector to enable only the Detector 5.00a cjm 11/01/13 Added Timing, VideoMode and Signal Conversion Functions XVtc_ConvVideoMode2Timing XVtc_ConvTiming2Signal XVtc_ConvSignal2Timing XVtc_ConvTiming2VideoMode Added Timing and Video Mode Set/Get Functions XVtc_SetGeneratorTiming XVtc_SetGeneratorVideoMode XVtc_GetGeneratorTiming XVtc_GetGeneratorVideoMode XVtc_GetDetectorTiming XVtc_GetDetectorVideoMode Updated XVtc_GetGeneratorHoriOffset and XVtc_SetGeneratorHoriOffset. For adding interlaced or field-1 registers setting/getting updated XVtc_SetGenerator to align vsync to hsync horizontally by default. Added Field 1 set/get to XVtc_SetGenerator, XVtc_GetGenerator and XVtc_GetDetector. 5.00a cjm 11/03/13 Added Chroma/field parity bit masks. Replaced old timing bit masks/shifts with Start/End Bit masks/shifts. 6.1 adk 08/23/14 Modified HActiveVideo value to 1920 for XVTC_VMODE_1080I mode. Removed Major, Minor and Revision parameters from XVtc_GetVersion. Modified return type of XVtc_GetVersion from void to u32.
#include "xvtc.h"
#include "xenv.h"
Functions | |
int | XVtc_CfgInitialize (XVtc *InstancePtr, XVtc_Config *CfgPtr, u32 EffectiveAddr) |
void | XVtc_EnableGenerator (XVtc *InstancePtr) |
void | XVtc_EnableDetector (XVtc *InstancePtr) |
void | XVtc_Enable (XVtc *InstancePtr) |
void | XVtc_DisableGenerator (XVtc *InstancePtr) |
void | XVtc_DisableDetector (XVtc *InstancePtr) |
void | XVtc_Disable (XVtc *InstancePtr) |
void | XVtc_SetPolarity (XVtc *InstancePtr, XVtc_Polarity *PolarityPtr) |
void | XVtc_GetPolarity (XVtc *InstancePtr, XVtc_Polarity *PolarityPtr) |
void | XVtc_GetDetectorPolarity (XVtc *InstancePtr, XVtc_Polarity *PolarityPtr) |
void | XVtc_SetSource (XVtc *InstancePtr, XVtc_SourceSelect *SourcePtr) |
void | XVtc_GetSource (XVtc *InstancePtr, XVtc_SourceSelect *SourcePtr) |
void | XVtc_SetSkipLine (XVtc *InstancePtr, int GeneratorChromaSkip) |
void | XVtc_GetSkipLine (XVtc *InstancePtr, int *GeneratorChromaSkipPtr) |
void | XVtc_SetSkipPixel (XVtc *InstancePtr, int GeneratorChromaSkip) |
void | XVtc_GetSkipPixel (XVtc *InstancePtr, int *GeneratorChromaSkipPtr) |
void | XVtc_SetDelay (XVtc *InstancePtr, int VertDelay, int HoriDelay) |
void | XVtc_GetDelay (XVtc *InstancePtr, int *VertDelayPtr, int *HoriDelayPtr) |
void | XVtc_SetFSync (XVtc *InstancePtr, u16 FrameSyncIndex, u16 VertStart, u16 HoriStart) |
void | XVtc_GetFSync (XVtc *InstancePtr, u16 FrameSyncIndex, u16 *VertStartPtr, u16 *HoriStartPtr) |
void | XVtc_SetGeneratorHoriOffset (XVtc *InstancePtr, XVtc_HoriOffsets *HoriOffsets) |
void | XVtc_GetGeneratorHoriOffset (XVtc *InstancePtr, XVtc_HoriOffsets *HoriOffsets) |
void | XVtc_GetDetectorHoriOffset (XVtc *InstancePtr, XVtc_HoriOffsets *HoriOffsets) |
void | XVtc_SetGenerator (XVtc *InstancePtr, XVtc_Signal *SignalCfgPtr) |
void | XVtc_GetGenerator (XVtc *InstancePtr, XVtc_Signal *SignalCfgPtr) |
void | XVtc_GetDetector (XVtc *InstancePtr, XVtc_Signal *SignalCfgPtr) |
u32 | XVtc_GetVersion (XVtc *InstancePtr) |
void | XVtc_ConvVideoMode2Timing (XVtc *InstancePtr, u16 Mode, XVtc_Timing *TimingPtr) |
void | XVtc_ConvTiming2Signal (XVtc *InstancePtr, XVtc_Timing *TimingPtr, XVtc_Signal *SignalCfgPtr, XVtc_HoriOffsets *HOffPtr, XVtc_Polarity *PolarityPtr) |
void | XVtc_ConvSignal2Timing (XVtc *InstancePtr, XVtc_Signal *SignalCfgPtr, XVtc_HoriOffsets *HOffPtr, XVtc_Polarity *PolarityPtr, XVtc_Timing *TimingPtr) |
u16 | XVtc_ConvTiming2VideoMode (XVtc *InstancePtr, XVtc_Timing *TimingPtr) |
void | XVtc_SetGeneratorTiming (XVtc *InstancePtr, XVtc_Timing *TimingPtr) |
void | XVtc_SetGeneratorVideoMode (XVtc *InstancePtr, u16 Mode) |
void | XVtc_GetGeneratorTiming (XVtc *InstancePtr, XVtc_Timing *TimingPtr) |
u16 | XVtc_GetGeneratorVideoMode (XVtc *InstancePtr) |
void | XVtc_GetDetectorTiming (XVtc *InstancePtr, XVtc_Timing *TimingPtr) |
u16 | XVtc_GetDetectorVideoMode (XVtc *InstancePtr) |
int XVtc_CfgInitialize | ( | XVtc * | InstancePtr, | |
XVtc_Config * | CfgPtr, | |||
u32 | EffectiveAddr | |||
) |
This function initializes the VTC core. This function must be called prior to using the VTC core. Initialization of the VTC includes setting up the instance data, and ensuring the hardware is in a quiescent state.
InstancePtr | is a pointer to the VTC core instance to be worked on. | |
CfgPtr | points to the configuration structure associated with the VTC core. | |
EffectiveAddr | is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used. |
void XVtc_ConvSignal2Timing | ( | XVtc * | InstancePtr, | |
XVtc_Signal * | SignalCfgPtr, | |||
XVtc_HoriOffsets * | HOffPtr, | |||
XVtc_Polarity * | PolarityPtr, | |||
XVtc_Timing * | TimingPtr | |||
) |
This function converts the VTC signal structure, horizontal offsets structure and the polarity structure into the Video Timing structure.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
SignalCfgPtr | is a pointer to a VTC signal configuration to be read | |
HOffPtr | is a pointer to a VTC horizontal offsets structure to be read | |
PolarityPtr | is a pointer to a VTC polarity structure to be read. | |
TimingPtr | is a pointer to a Video Timing structure to be set. |
void XVtc_ConvTiming2Signal | ( | XVtc * | InstancePtr, | |
XVtc_Timing * | TimingPtr, | |||
XVtc_Signal * | SignalCfgPtr, | |||
XVtc_HoriOffsets * | HOffPtr, | |||
XVtc_Polarity * | PolarityPtr | |||
) |
This function converts the video timing structure into the VTC signal configuration structure, horizontal offsets structure and the polarity structure.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
TimingPtr | is a pointer to a Video Timing structure to be read. | |
SignalCfgPtr | is a pointer to a VTC signal configuration to be set. | |
HOffPtr | is a pointer to a VTC horizontal offsets structure to be set. | |
PolarityPtr | is a pointer to a VTC polarity structure to be set. |
u16 XVtc_ConvTiming2VideoMode | ( | XVtc * | InstancePtr, | |
XVtc_Timing * | TimingPtr | |||
) |
This function converts the video timing structure into predefined video mode values returned as a short integer.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
TimingPtr | is a pointer to a Video Timing structure to be read. |
void XVtc_ConvVideoMode2Timing | ( | XVtc * | InstancePtr, | |
u16 | Mode, | |||
XVtc_Timing * | TimingPtr | |||
) |
This function converts the video mode integer into the video timing information stored within the XVtc_Timing pointer.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
Mode | is a u16 int defined as macro to one of the predefined Video Modes. | |
TimingPtr | is a pointer to a VTC Video Timing Structure. |
void XVtc_Disable | ( | XVtc * | InstancePtr | ) |
This function disables the Detector and Generator at same time of the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_DisableDetector | ( | XVtc * | InstancePtr | ) |
This function disables the VTC Detector core.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_DisableGenerator | ( | XVtc * | InstancePtr | ) |
This function disables the VTC Generator core.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_Enable | ( | XVtc * | InstancePtr | ) |
This function enables the Detector and Generator at same time of the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_EnableDetector | ( | XVtc * | InstancePtr | ) |
This function enables the VTC Detector core
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_EnableGenerator | ( | XVtc * | InstancePtr | ) |
This function enables the VTC Generator core.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_GetDelay | ( | XVtc * | InstancePtr, | |
int * | VertDelayPtr, | |||
int * | HoriDelayPtr | |||
) |
This function gets the Generator delay setting used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
VertDelayPtr | will point to a value indicating the number of total lines per frame to delay the generator output after this function returns. | |
HoriDelayPtr | will point to a value indicating the number of total clock cycles per line to delay the generator output after this function returns. |
void XVtc_GetDetector | ( | XVtc * | InstancePtr, | |
XVtc_Signal * | SignalCfgPtr | |||
) |
This function gets the VTC signal setting used by the Detector module in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
SignalCfgPtr | is a pointer to a VTC signal configuration which will be populated with the setting used by the Detector module in the VTC core once this function returns. |
void XVtc_GetDetectorHoriOffset | ( | XVtc * | InstancePtr, | |
XVtc_HoriOffsets * | HoriOffsets | |||
) |
This function gets the VBlank/VSync Horizontal Offsets detected by the Detector in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
HoriOffsets | points to a VBlank/VSync Horizontal Offset configuration structure that will be populated with the setting detected on the Detector in the given VTC device after this function returns. |
void XVtc_GetDetectorPolarity | ( | XVtc * | InstancePtr, | |
XVtc_Polarity * | PolarityPtr | |||
) |
This function gets the input polarity setting used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
PolarityPtr | points to a Polarity configuration structure that will be populated with the setting used on the VTC core after this function returns. |
void XVtc_GetDetectorTiming | ( | XVtc * | InstancePtr, | |
XVtc_Timing * | TimingPtr | |||
) |
This function gets the video timing structure settings currently reported by the detector in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
TimingPtr | is a pointer to a Video Timing structure to be set. |
u16 XVtc_GetDetectorVideoMode | ( | XVtc * | InstancePtr | ) |
This function gets the video mode currently reported by the detector in the VTC core. If the video mode is unknown or not recognized, then 0 will be returned.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_GetFSync | ( | XVtc * | InstancePtr, | |
u16 | FrameSyncIndex, | |||
u16 * | VertStartPtr, | |||
u16 * | HoriStartPtr | |||
) |
This function gets the SYNC setting of a frame sync used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
FrameSyncIndex | indicates the index number of the frame sync. The valid range is from 0 to 15. | |
VertStartPtr | will point to the value that indicates the vertical line count during which the frame sync is active once this function returns. | |
HoriStartPtr | will point to the value that indicates the horizontal cycle count during which the frame sync is active once this function returns. |
void XVtc_GetGenerator | ( | XVtc * | InstancePtr, | |
XVtc_Signal * | SignalCfgPtr | |||
) |
This function gets the VTC signal setting used by the Generator module in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
SignalCfgPtr | is a pointer to a VTC signal configuration which will be populated with the setting used by the Generator module in the VTC core once this function returns. |
void XVtc_GetGeneratorHoriOffset | ( | XVtc * | InstancePtr, | |
XVtc_HoriOffsets * | HoriOffsets | |||
) |
This function gets the VBlank/VSync Horizontal Offsets currently used by the Generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
HoriOffsets | points to a VBlank/VSync Horizontal Offset configuration structure that will be populated with the setting currently used on the Generator in the given VTC device after this function returns. |
void XVtc_GetGeneratorTiming | ( | XVtc * | InstancePtr, | |
XVtc_Timing * | TimingPtr | |||
) |
This function gets the video timing structure settings currently used by generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
TimingPtr | is a pointer to a Video Timing Structure to be set. |
u16 XVtc_GetGeneratorVideoMode | ( | XVtc * | InstancePtr | ) |
This function gets the video mode currently used by the generator in the VTC core. If the video mode is unknown or not recognized, then 0 will be returned.
InstancePtr | is a pointer to the VTC instance to be worked on. |
void XVtc_GetPolarity | ( | XVtc * | InstancePtr, | |
XVtc_Polarity * | PolarityPtr | |||
) |
This function gets the output polarity setting used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
PolarityPtr | points to a Polarity configuration structure that will be populated with the setting used on the VTC core after this function returns. |
void XVtc_GetSkipLine | ( | XVtc * | InstancePtr, | |
int * | GeneratorChromaSkipPtr | |||
) |
This function gets the line skip setting used by the Generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
GeneratorChromaSkipPtr | will point to the value indicating whether one line is skipped between active chroma for the Generator module after this function returns. Value 1 means that 1 line is skipped and zero means that no lines are skipped. |
void XVtc_GetSkipPixel | ( | XVtc * | InstancePtr, | |
int * | GeneratorChromaSkipPtr | |||
) |
This function gets the pixel skip setting used by the Generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
GeneratorChromaSkipPtr | will point to the value indicating whether one pixel is skipped between active chroma for the Generator module after this function returns. Value 1 means that 1 pixel is skipped and zero means that no pixels are skipped. |
void XVtc_GetSource | ( | XVtc * | InstancePtr, | |
XVtc_SourceSelect * | SourcePtr | |||
) |
This function gets the source select setting used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
SourcePtr | points to a source select configuration structure that will be populated with the setting used on the VTC core after this function returns. |
u32 XVtc_GetVersion | ( | XVtc * | InstancePtr | ) |
This function facilitates software identification of exact version of the VTC hardware (h/w).
InstancePtr | is a pointer to the XVtc instance. |
void XVtc_SetDelay | ( | XVtc * | InstancePtr, | |
int | VertDelay, | |||
int | HoriDelay | |||
) |
This function sets up the Generator delay setting of the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
VertDelay | indicates the number of total lines per frame to delay the generator output. The valid range is from 0 to 4095. | |
HoriDelay | indicates the number of total clock cycles per line to delay the generator output. The valid range is from 0 to 4095. |
void XVtc_SetFSync | ( | XVtc * | InstancePtr, | |
u16 | FrameSyncIndex, | |||
u16 | VertStart, | |||
u16 | HoriStart | |||
) |
This function sets up the SYNC setting of a frame sync used by the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
FrameSyncIndex | indicates the index number of the frame sync. The valid range is from 0 to 15. | |
VertStart | indicates the vertical line count during which the frame sync is active. The valid range is from 0 to 4095. | |
HoriStart | indicates the horizontal cycle count during which the frame sync is active. The valid range is from 0 to 4095. |
void XVtc_SetGenerator | ( | XVtc * | InstancePtr, | |
XVtc_Signal * | SignalCfgPtr | |||
) |
This function sets up VTC signal to be used by the Generator module in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
SignalCfgPtr | is a pointer to the VTC signal configuration to be used by the Generator module in the VTC core. |
void XVtc_SetGeneratorHoriOffset | ( | XVtc * | InstancePtr, | |
XVtc_HoriOffsets * | HoriOffsets | |||
) |
This function sets the VBlank/VSync Horizontal Offsets for the Generator in a VTC device.
InstancePtr | is a pointer to the VTC device instance to be worked on. | |
HoriOffsets | points to a VBlank/VSync Horizontal Offset configuration with the setting to use on the VTC device. |
void XVtc_SetGeneratorTiming | ( | XVtc * | InstancePtr, | |
XVtc_Timing * | TimingPtr | |||
) |
This function sets up the generator (Polarity, H/V values and horizontal offsets) by reading the configuration from a video timing structure.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
TimingPtr | is a pointer to a Video Timing Structure to be read. |
void XVtc_SetGeneratorVideoMode | ( | XVtc * | InstancePtr, | |
u16 | Mode | |||
) |
This function sets up the generator (Polarity, H/V values and horizontal offsets) by reading the configuration from a video mode short integer.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
Mode | is a short integer predefined video mode. |
void XVtc_SetPolarity | ( | XVtc * | InstancePtr, | |
XVtc_Polarity * | PolarityPtr | |||
) |
This function sets up the output polarity of the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
PolarityPtr | points to a Polarity configuration structure with the setting to use on the VTC core. |
void XVtc_SetSkipLine | ( | XVtc * | InstancePtr, | |
int | GeneratorChromaSkip | |||
) |
This function sets up the line skip setting of the Generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
GeneratorChromaSkip | indicates whether to skip 1 line between active chroma for the Generator module. Use Non-0 value for this parameter to skip 1 line, and 0 to not skip lines. |
void XVtc_SetSkipPixel | ( | XVtc * | InstancePtr, | |
int | GeneratorChromaSkip | |||
) |
This function sets up the pixel skip setting of the Generator in the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on. | |
GeneratorChromaSkip | indicates whether to skip 1 pixel between active chroma for the Generator module. Use Non-0 value for this parameter to skip 1 pixel, and 0 to not skip pixels |
void XVtc_SetSource | ( | XVtc * | InstancePtr, | |
XVtc_SourceSelect * | SourcePtr | |||
) |
This function sets up the source selecting of the VTC core.
InstancePtr | is a pointer to the VTC instance to be worked on | |
SourcePtr | points to a Source Selecting configuration structure with the setting to use on the VTC device. |
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.