v_hdmirxss: audiogen_drv.h File Reference

| v_hdmirxss Xilinx SDK Drivers API Documentation

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

Macros
audiogen_drv.h File Reference

## Overview

This file contains .

    MODIFICATION HISTORY:

    Ver   Who  Date        Changes

    X.XX  XX  YYYY/MM/DD   ...
    1.00  RHe 2014/12/00   First release
    1.1   RHe 2015/07/30   Updated ACR GetNVal to be dependent of the
                           TMDS character rate instead of the video mode.
    1.2   NA  2017/04/28   Updated the XhdmiAudioGen_PLL_t struct to be able to
                           set fractional multipliers and dividers.
    1.3   RHe 2017/07/31   Updated ACR CTS generation for HDMI 2.0 formats.
    1.4   MMO 2017/09/05   Replace U32 with UINTPTR for 64 Bit Addressing Support

## Macros
#define | XAudGen_In32 Xil_In32
| Input Operations. More...
#define | XAudGen_Out32 Xil_Out32
| Output Operations. More...
#define | XAudGen_ReadReg(BaseAddress, RegOffset) XAudGen_In32((BaseAddress) + ((u32)RegOffset))
| This function macro reads the given register. More...
#define | XAudGen_WriteReg(BaseAddress, RegOffset, Data) XAudGen_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
| Write the given register. More...

## Macro Definition Documentation

#define XAudGen_In32 Xil_In32

Input Operations.

#define XAudGen_Out32 Xil_Out32

Output Operations.

#define XAudGen_ReadReg | ( |  | BaseAddress,
|  |  | RegOffset
| ) |  | XAudGen_In32((BaseAddress) + ((u32)RegOffset))

This function macro reads the given register.

Parameters

  BaseAddress | is the base address of the Audio Generator core.
  RegOffset | is the register offset of the register

Returns
  The 32-bit value of the register.

Note
  C-style signature: u32 XAudGen_ReadReg(u32 BaseAddress, u32 RegOffset)

#define XAudGen_WriteReg | ( |  | BaseAddress,
|  |  | RegOffset,
|  |  | Data
| ) |  | XAudGen_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

Write the given register.

Parameters

  BaseAddress | is the base address of the Audio Generator core.
  RegOffset | is the register offset of the register
  Data | is the 32-bit value to write to the register.

Returns
  None.

Note
  C-style signature: void XAudGen_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)