avbuf
Vitis Drivers API Documentation
xavbuf_clk.h File Reference

Overview

This header file contains the identifiers and low-level driver functions (or macros) that can be used to configure PLL to generate required frequency.

Note
None.
MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.0 mh 06/24/17 Initial release. 2.1 tu 12/29/17 LPD and FPD offsets adjusted

Data Structures

struct  XAVBuf_Pll
 This typedef enumerates various variables used to configure Pll. More...
 

Enumerations

enum  PLL
 This enum enumerates various PLL. More...
 

Functions

int XAVBuf_SetPixelClock (u64 FreqHz)
 This function calls API to calculate and configure PLL with desired frequency for Video. More...
 
int XAVBuf_SetAudioClock (u64 FreqHz)
 This function calls API to calculate and configure PLL with desired frequency for Audio. More...
 

Enumeration Type Documentation

enum PLL

This enum enumerates various PLL.

Function Documentation

int XAVBuf_SetAudioClock ( u64  FreqHz)

This function calls API to calculate and configure PLL with desired frequency for Audio.

Parameters
FreqHzis the desired frequency in Hz.
Returns
XST_SUCCESS if PLL is configured without an error. XST_FAILURE otherwise.
Note
The Pll used is design specific.

References XAVBUF_AUDIO_REF_CTRL, XAVBUF_CLK_FPD_BASEADDR, XAVBuf_ReadReg, and XAVBUF_VPLL_SRC_SEL.

int XAVBuf_SetPixelClock ( u64  FreqHz)

This function calls API to calculate and configure PLL with desired frequency for Video.

Parameters
FreqHzis the desired frequency in Hz.
Returns
XST_SUCCESS if PLL is configured without an error. XST_FAILURE otherwise.
Note
The Pll used is design specific.

References XAVBUF_CLK_FPD_BASEADDR, XAVBuf_ReadReg, XAVBUF_VIDEO_REF_CTRL, and XAVBUF_VPLL_SRC_SEL.