v_voip_framer: xframer_hw.h File Reference

| v_voip_framer Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Macros
xframer_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 Framer core.

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

    MODIFICATION HISTORY:

    Ver   Who    Date     Changes

    1.00   mmo   02/12/16 Initial release.

## Macros
#define | XFRAMER_HW_H_
| Prevent circular inclusions by using protection macros. More...
Register access macro definition
#define | XFramer_In32 Xil_In32
| Input Operations. More...
#define | XFramer_Out32 Xil_Out32
| Output Operations. More...
#define | XFramer_ReadReg(BaseAddress, RegOffset) XFramer_In32((BaseAddress) + ((u32)RegOffset))
| This macro reads a value from a VoIP Framer register. More...
#define | XFramer_WriteReg(BaseAddress, RegOffset, Data) XFramer_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
| This macro writes a value to a VoIP Framer register. More...

## Macro Definition Documentation

#define XFRAMER_HW_H_

Prevent circular inclusions by using protection macros.

#define XFramer_In32 Xil_In32

Input Operations.

#define XFramer_Out32 Xil_Out32

Output Operations.

#define XFramer_ReadReg | ( |  | BaseAddress,
|  |  | RegOffset
| ) |  | XFramer_In32((BaseAddress) + ((u32)RegOffset))

This macro reads a value from a VoIP Framer 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 Framer 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 XFramer_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XFramer_ChannelUpdate(), XFramer_ChStatus(), XFramer_CoreInfo(), XFramer_EthDestAddr1(), XFramer_FECTOS(), XFramer_FECTTL(), XFramer_GetDropPcktCnt(), XFramer_GetEthSrcAddr0(), XFramer_GetEthSrcAddr1(), XFramer_GetPeakBufferLevel(), XFramer_GetRXPcktCnt(), XFramer_GetTransmitEnable(), XFramer_GetTXPcktCnt(), XFramer_MediaTOS(), XFramer_MediaTTL(), XFramer_SetVLAN(), XFramer_SoftReset(), XFramer_UDPDest(), XFramer_UDPSrc(), and XFramer_VLANID().

#define XFramer_WriteReg | ( |  | BaseAddress,
|  |  | RegOffset,
|  |  | Data
| ) |  | XFramer_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

This macro writes a value to a VoIP Framer 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 Framer 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 XFramer_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XFramer_ChannelAccess(), XFramer_ChannelUpdate(), XFramer_ClearDropPcktCnt(), XFramer_ClearPeakBufferLevel(), XFramer_ClearRXPcktCnt(), XFramer_ClearTXPcktCnt(), XFramer_EthDestAddr0(), XFramer_EthDestAddr1(), XFramer_EthSrcAddr0(), XFramer_EthSrcAddr1(), XFramer_FECTOS(), XFramer_FECTTL(), XFramer_IP0Dest(), XFramer_IP0Src(), XFramer_MediaTOS(), XFramer_MediaTTL(), XFramer_SetVLAN(), XFramer_SoftReset(), XFramer_TransmitEnable(), XFramer_UDPDest(), XFramer_UDPSrc(), and XFramer_VLANID().