| v_hdmitxss1 Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Macros | Functions
IDT_8T49N24x

## Macros
#define | IDT_8T49N24X_REVID 0x0
| Device Revision. More...
#define | IDT_8T49N24X_DEVID 0x0607
| Device ID Code. More...
#define | IDT_8T49N24X_XTAL_FREQ 40000000
| The freq of the crystal in Hz. More...
#define | IDT_8T49N24X_FVCO_MAX 4000000000
| Max VCO Operating Freq in Hz. More...
#define | IDT_8T49N24X_FVCO_MIN 3000000000
| Min VCO Operating Freq in Hz. More...
#define | IDT_8T49N24X_FOUT_MAX 400000000
| Max Output Freq in Hz. More...
#define | IDT_8T49N24X_FOUT_MIN 8000
| Min Output Freq in Hz. More...
#define | IDT_8T49N24X_FIN_MAX 875000000
| Max Input Freq in Hz. More...
#define | IDT_8T49N24X_FIN_MIN 8000
| Min Input Freq in Hz. More...
#define | IDT_8T49N24X_FPD_MAX 128000
| Max Phase Detector Freq in Hz. More...
#define | IDT_8T49N24X_FPD_MIN 8000
| Min Phase Detector Freq in Hz. More...
#define | IDT_8T49N24X_P_MAX 4194304 /* pow(2,22) */
| Max P div value. More...
#define | IDT_8T49N24X_M_MAX 16777216 /* pow(2,24) */
| Max M mult value. More...
#define | IDT_8T49N24X_REVID 0x0
| Device Revision. More...
#define | IDT_8T49N24X_DEVID 0x0607
| Device ID Code. More...
#define | IDT_8T49N24X_XTAL_FREQ 40000000
| The freq of the crystal in Hz. More...
#define | IDT_8T49N24X_FVCO_MAX 4000000000
| Max VCO Operating Freq in Hz. More...
#define | IDT_8T49N24X_FVCO_MIN 3000000000
| Min VCO Operating Freq in Hz. More...
#define | IDT_8T49N24X_FOUT_MAX 400000000
| Max Output Freq in Hz. More...
#define | IDT_8T49N24X_FOUT_MIN 8000
| Min Output Freq in Hz. More...
#define | IDT_8T49N24X_FIN_MAX 875000000
| Max Input Freq in Hz. More...
#define | IDT_8T49N24X_FIN_MIN 8000
| Min Input Freq in Hz. More...
#define | IDT_8T49N24X_FPD_MAX 128000
| Max Phase Detector Freq in Hz. More...
#define | IDT_8T49N24X_FPD_MIN 8000
| Min Phase Detector Freq in Hz. More...
#define | IDT_8T49N24X_P_MAX 4194304 /* pow(2,22) */
| Max P div value. More...
#define | IDT_8T49N24X_M_MAX 16777216 /* pow(2,24) */
| Max M mult value. More...

## Functions
int | IDT_8T49N24x_SetClock (void *IicPtr, u8 I2CSlaveAddress, int FIn, int FOut, u8 FreeRun)
| This function calculates and sets the IDT 8TN49N24x device with the given clock configuration. More...
int | IDT_8T49N24x_Init (void *IicPtr, u8 I2CSlaveAddress)
| This function initializes the IDT 8TN49N24x with default values for use with the Video FMC. More...
void | IDT_8T49N24x_RegisterDump (void *IicPtr, u8 I2CSlaveAddress)
| This function displays a registerdump of the IDT 8TN49N24x device. More...
int | IDT_8T49N24x_I2cClk (void *IicPtr, u8 IICAddress, u32 InFreq, u32 OutFreq)
| This function setup IDT 8T49N24x clock generator either in free or locked mode. More...
int | IDT_8T49N24x_GpioLolEnable (void *IicPtr, u8 IICAddress)
| This function setup IDT 8T49N24x clock generator to enable GPIO[3] to be used as LoL indicator. More...

## Macro Definition Documentation

#define IDT_8T49N24X_DEVID 0x0607

Device ID Code.

#define IDT_8T49N24X_DEVID 0x0607

Device ID Code.

#define IDT_8T49N24X_FIN_MAX 875000000

Max Input Freq in Hz.

Referenced by IDT_8T49N24x_SetClock().

#define IDT_8T49N24X_FIN_MAX 875000000

Max Input Freq in Hz.

#define IDT_8T49N24X_FIN_MIN 8000

Min Input Freq in Hz.

Referenced by IDT_8T49N24x_SetClock().

#define IDT_8T49N24X_FIN_MIN 8000

Min Input Freq in Hz.

#define IDT_8T49N24X_FOUT_MAX 400000000

Max Output Freq in Hz.

Referenced by IDT_8T49N24x_SetClock().

#define IDT_8T49N24X_FOUT_MAX 400000000

Max Output Freq in Hz.

#define IDT_8T49N24X_FOUT_MIN 8000

Min Output Freq in Hz.

Referenced by IDT_8T49N24x_SetClock().

#define IDT_8T49N24X_FOUT_MIN 8000

Min Output Freq in Hz.

#define IDT_8T49N24X_FPD_MAX 128000

Max Phase Detector Freq in Hz.

#define IDT_8T49N24X_FPD_MAX 128000

Max Phase Detector Freq in Hz.

#define IDT_8T49N24X_FPD_MIN 8000

Min Phase Detector Freq in Hz.

#define IDT_8T49N24X_FPD_MIN 8000

Min Phase Detector Freq in Hz.

#define IDT_8T49N24X_FVCO_MAX 4000000000

Max VCO Operating Freq in Hz.

#define IDT_8T49N24X_FVCO_MAX 4000000000

Max VCO Operating Freq in Hz.

#define IDT_8T49N24X_FVCO_MIN 3000000000

Min VCO Operating Freq in Hz.

#define IDT_8T49N24X_FVCO_MIN 3000000000

Min VCO Operating Freq in Hz.

#define IDT_8T49N24X_M_MAX 16777216 /* pow(2,24) */

Max M mult value.

#define IDT_8T49N24X_M_MAX 16777216 /* pow(2,24) */

Max M mult value.

#define IDT_8T49N24X_P_MAX 4194304 /* pow(2,22) */

Max P div value.

#define IDT_8T49N24X_P_MAX 4194304 /* pow(2,22) */

Max P div value.

#define IDT_8T49N24X_REVID 0x0

Device Revision.

#define IDT_8T49N24X_REVID 0x0

Device Revision.

#define IDT_8T49N24X_XTAL_FREQ 40000000

The freq of the crystal in Hz.

Referenced by IDT_8T49N24x_I2cClk().

#define IDT_8T49N24X_XTAL_FREQ 40000000

The freq of the crystal in Hz.

## Function Documentation

int IDT_8T49N24x_GpioLolEnable | ( | void * | IicPtr,
|  | u8 | IICAddress
| ) |  |

This function setup IDT 8T49N24x clock generator to enable GPIO[3] to be used as LoL indicator.

Parameters

  IicBaseAddr | IIC controller base address.
  IICAddress | device's IIC bus address.

Returns
  - 0 XST_SUCCESS.
  - 1 XST_FAILURE.

Note
  None.

int IDT_8T49N24x_I2cClk | ( | void * | IicPtr,
|  | u8 | IICAddress,
|  | u32 | InFreq,
|  | u32 | OutFreq
| ) |  |

This function setup IDT 8T49N24x clock generator either in free or locked mode.

Parameters

  IicPtr | IIC instance pointer.
  IICAddress | device's IIC bus address.
  InFreq | input frequency 0-free running mode.
  OutFreq | requested output frequency.

Returns
  - 0 XST_SUCCESS.
  - 1 XST_FAILURE.

Note
  None.

References IDT_8T49N24x_SetClock(), and IDT_8T49N24X_XTAL_FREQ.

Referenced by I2cClk().

int IDT_8T49N24x_Init | ( | void * | IicPtr,
|  | u8 | I2CSlaveAddress
| ) |  |

This function initializes the IDT 8TN49N24x with default values for use with the Video FMC.

Parameters

  I2CBaseAddress | is the baseaddress of the I2C core.
  I2CSlaveAddress | is the 7-bit I2C slave address.

Returns
  - XST_SUCCESS Initialization was successful.
  - XST_FAILURE I2C write error.

Note
  None.

void IDT_8T49N24x_RegisterDump | ( | void * | IicPtr,
|  | u8 | I2CSlaveAddress
| ) |  |

This function displays a registerdump of the IDT 8TN49N24x device.

Parameters

  I2CBaseAddress | is the baseaddress of the I2C core.
  I2CSlaveAddress | is the 7-bit I2C slave address.

Returns
  None

Note
  None.

int IDT_8T49N24x_SetClock | ( | void * | IicPtr,
|  | u8 | I2CSlaveAddress,
|  | int | FIn,
|  | int | FOut,
|  | u8 | FreeRun
| ) |  |

This function calculates and sets the IDT 8TN49N24x device with the given clock configuration.

Parameters

  I2CBaseAddress | is the baseaddress of the I2C core.
  I2CSlaveAddress | is the 7-bit I2C slave address.
  FIn | specifies the input frequency.
  FOut | specifies the output frequency.
  FreeRun | specifies if the operation mode is locked/synthesizer mode. TRUE Synthesizer mode (Fout only) FALSE Locked mode (Fout locked to Fin)

Returns
  - XST_SUCCESS Initialization was successful.
  - XST_FAILURE I2C write error or incorrect parameters detected.

Note

References IDT_8T49N24X_FIN_MAX, IDT_8T49N24X_FIN_MIN, IDT_8T49N24X_FOUT_MAX, and IDT_8T49N24X_FOUT_MIN.

Referenced by IDT_8T49N24x_I2cClk().