v_voip_packetizer56: xpacketizer56_hw.h File Reference

| v_voip_packetizer56 Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

xpacketizer56_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 ST2022-6 Packetizer core.

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

    MODIFICATION HISTORY:

    Ver   Who    Date     Changes

    1.00   mmo   02/12/16 Initial release.

## Macros
Register access macro definition
#define | XPacketizer56_In32 Xil_In32
| Input Operations. More...
#define | XPacketizer56_Out32 Xil_Out32
| Output Operations. More...
#define | XPacketizer56_ReadReg(BaseAddress, RegOffset) XPacketizer56_In32((BaseAddress) + ((u32)RegOffset))
| This macro reads a value from a VoIP ST2022-6 Packetizer register. More...
#define | XPacketizer56_WriteReg(BaseAddress, RegOffset, Data) XPacketizer56_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))
| This macro reads a value from a VoIP ST2022-6 Packetizer register. More...

## Macro Definition Documentation

#define XPacketizer56_In32 Xil_In32

Input Operations.

#define XPacketizer56_Out32 Xil_Out32

Output Operations.

#define XPacketizer56_ReadReg | ( |  | BaseAddress,
|  |  | RegOffset
| ) |  | XPacketizer56_In32((BaseAddress) + ((u32)RegOffset))

This macro reads a value from a VoIP ST2022-6 Packetizer 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 ST2022-6 Packetizer 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 XPacketizer56_ReadReg(u32 BaseAddress, u32 RegOffset)

Referenced by XPacketizer56_IntrHandler(), XPacketizer56_LosslessEnable(), XPacketizer56_ModEnable(), XPacketizer56_RegClear(), XPacketizer56_RTPMediaHeader(), XPacketizer56_SetChannel(), and XPacketizer56_VidFormat().

#define XPacketizer56_WriteReg | ( |  | BaseAddress,
|  |  | RegOffset,
|  |  | Data
| ) |  | XPacketizer56_Out32((BaseAddress) + ((u32)RegOffset), (u32)(Data))

This macro reads a value from a VoIP ST2022-6 Packetizer 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 ST2022-6 Packetizer 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 XPacketizer56_WriteReg(u32 BaseAddress, u32 RegOffset, u32 Data)

Referenced by XPacketizer56_LosslessEnable(), XPacketizer56_ModEnable(), XPacketizer56_RegClear(), XPacketizer56_RTPMediaHeader(), XPacketizer56_SetChannel(), XPacketizer56_SetSSRC(), and XPacketizer56_VidFormat().