v_voip_fec_rx
Xilinx SDK Drivers API Documentation
xvoipfec_rx_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 Receiver core.

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

MODIFICATION HISTORY:
Ver   Who    Date     Changes


1.00 mmo 02/12/16 Initial release.

 

Macros

Register access macro definition
#define XVoipFEC_RX_In32   Xil_In32
 Input Operations. More...
 
#define XVoipFEC_RX_Out32   Xil_Out32
 Output Operations. More...
 
#define XVoipFEC_RX_ReadReg(BaseAddress, RegOffset)   XVoipFEC_RX_In32((BaseAddress) + ((u32)RegOffset))
 This macro reads a value from a VoIP FEC Receiver register. More...
 
#define XVoipFEC_RX_WriteReg(BaseAddress, RegOffset, Data)   XVoipFEC_RX_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
 This macro writes a value to a VoIP FEC Receiver register. More...
 

Macro Definition Documentation

#define XVoipFEC_RX_In32   Xil_In32

Input Operations.

#define XVoipFEC_RX_Out32   Xil_Out32

Output Operations.

#define XVoipFEC_RX_ReadReg (   BaseAddress,
  RegOffset 
)    XVoipFEC_RX_In32((BaseAddress) + ((u32)RegOffset))

This macro reads a value from a VoIP FEC Receiver 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
BaseAddressis the base address of the VoIP FEC Receiver core instance.
RegOffsetis 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_RX_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XVoipFEC_HitlessStatusRegValue(), XVoipFEC_RX_ChannelClear(), XVoipFEC_RX_ChannelEnable(), XVoipFEC_RX_ChannelUpdate(), XVoipFEC_RX_CoreInfo(), XVoipFEC_RX_FECParamsRegValue(), XVoipFEC_RX_FECRecoveryDisable(), XVoipFEC_RX_FECStatisticsRegValue(), XVoipFEC_RX_FECStatusRegValue(), XVoipFEC_RX_GetFECBufferPeakDataCnt(), XVoipFEC_RX_GetFECPacketDropCnt(), XVoipFEC_RX_GetFECProcessingDelay(), XVoipFEC_RX_MediaPacketBypass(), XVoipFEC_RX_OORCfg(), and XVoipFEC_RX_SoftReset().

#define XVoipFEC_RX_WriteReg (   BaseAddress,
  RegOffset,
  Data 
)    XVoipFEC_RX_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

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

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

Parameters
BaseAddressis the base address of the VoIP FEC Receiver core instance.
RegOffsetis the register offset of the register (defined at the top of this file) to be written.
Datais the 32-bit value to write into the register.
Returns
None.
Note
C-style signature: void XVoipFEC_RX_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XVoipFEC_RX_ChannelAccess(), XVoipFEC_RX_ChannelClear(), XVoipFEC_RX_ChannelEnable(), XVoipFEC_RX_ChannelUpdate(), XVoipFEC_RX_FECRecoveryDisable(), XVoipFEC_RX_MediaPacketBypass(), XVoipFEC_RX_OORCfg(), XVoipFEC_RX_SetFECProcessingDelay(), and XVoipFEC_RX_SoftReset().