v_voip_fec_tx: xvoipfec_tx_hw.h File Reference

| v_voip_fec_tx Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

xvoipfec_tx_hw.h File Reference

## Overview

This header file contains identifiers and register-level core functions (or macros) that can be used to access the Xilinx VoIP FEC Transmitter core.

For more information about the operation of this core see the hardware specification and documentation in the higher level driver xvoipfec_tx.h file.

    MODIFICATION HISTORY:

    Ver   Who    Date     Changes

    1.00   mmo   02/12/16 Initial release.

## Macros
Register access macro definition
#define | XVoipFEC_TX_In32 Xil_In32
| Input Operations. More...
#define | XVoipFEC_TX_Out32 Xil_Out32
| Output Operations. More...
#define | XVoipFEC_TX_ReadReg(BaseAddress, RegOffset) XVoipFEC_TX_In32((BaseAddress) + ((u32)RegOffset))
| This macro reads a value from a VoIP FEC Transmitter register. More...
#define | XVoipFEC_TX_WriteReg(BaseAddress, RegOffset, Data) XVoipFEC_TX_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
| This macro writes a value to a VoIP FEC Transmitter register. More...

## Macro Definition Documentation

#define XVoipFEC_TX_In32 Xil_In32

Input Operations.

#define XVoipFEC_TX_Out32 Xil_Out32

Output Operations.

#define XVoipFEC_TX_ReadReg | ( |  | BaseAddress,
|  |  | RegOffset
| ) |  | XVoipFEC_TX_In32((BaseAddress) + ((u32)RegOffset))

This macro reads a value from a VoIP FEC Transmitter register.

A 32 bit read is performed. If the component is implemented in a smaller width, only the least significant data is read from the register. The most significant data will be read as 0.

Parameters

  BaseAddress | is the base address of the VoIP FEC Transmitter core instance.
  RegOffset | is the register offset of the register (defined at the top of this file).

Returns
  The 32-bit value of the register.

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

Referenced by XVoipFEC_TX_ChannelUpdate(), XVoipFEC_TX_CoreStatisics(), XVoipFEC_TX_CoreStatusRegValue(), XVoipFEC_TX_FECParamsRegValue(), XVoipFEC_TX_SetFEC_D(), XVoipFEC_TX_SetFEC_L(), XVoipFEC_TX_SetFECMode(), XVoipFEC_TX_SetFECNonBlockAllign(), and XVoipFEC_TX_SoftReset().

#define XVoipFEC_TX_WriteReg | ( |  | BaseAddress,
|  |  | RegOffset,
|  |  | Data
| ) |  | XVoipFEC_TX_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

This macro writes a value to a VoIP FEC Transmitter register.

A 32 bit write is performed. If the component is implemented in a smaller width, only the least significant data is written.

Parameters

  BaseAddress | is the base address of the VoIP FEC Transmitter core instance.
  RegOffset | is the register offset of the register (defined at the top of this file) to be written.
  Data | is the 32-bit value to write into the register.

Returns
  None.

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

Referenced by XVoipFEC_ChannelAccess(), XVoipFEC_TX_ChannelUpdate(), XVoipFEC_TX_SetFEC_D(), XVoipFEC_TX_SetFEC_L(), XVoipFEC_TX_SetFECMode(), XVoipFEC_TX_SetFECNonBlockAllign(), and XVoipFEC_TX_SoftReset().