Project directory/component name, Component name/doc | Xilinx UG492

Directory and File Contents

<project directory>/<component name>

The <component name> directory contains the release notes file provided with the core, which may include last-minute changes and updates.

Table 15-2:Component Name Directory

Name	Description

<project_dir>/<component_name>

eth_avb_endpoint_readme.txt	Core release notes file

Back to Top

<component name>/doc

The doc directory contains the PDF documentation provided with the core.

Table 15-3:Doc Directory

Name	Description

<project_dir>/<component_name>/doc

eth_avb_endpoint_ds677.pdf	Ethernet AVB Endpoint Data Sheet

eth_avb_endpoint_ug492.pdf	Ethernet AVB Endpoint User Guide

Back to Top

<component name>/example design

The example design directory contains the example design files provided with the core. For more information, see “Example Design,” page 152.

Table 15-4:Example Design Directory

Name	Description

<project_dir>/<component_name>/example_design/

<component_name>_example_design.ucf	Example User Constraints File (UCF)
	provided for the example design.

<component_name>_example_design.v[hd]	Top-level file that allows the example
	design to be implemented in a device as a
	standalone design.

tx_frame_stimulus.v[hd]	An HDL file which is capable of
	producing Ethernet frames at maximum
	line-rate and containing a predictable
	pattern in the data field.

temac_loopback_shim.v[hd]	An HDL file which sits in the place of an
	Ethernet MAC (an Ethernet MAC is
	required in a real system). This file loops
	back the data from the transmitter client
	to the receiver client.

Ethernet AVB Endpoint User Guide

www.xilinx.com

145

UG492 July 23, 2010

Image 145

Xilinx UG492 manual Project directory/component name, Component name/doc, Component name/example design

Contents

UG492 July 23 LogiCORETM IP Ethernet AVB Endpoint Date Version Revision Revision History Table of Contents Generating the Core Precise Timing Protocol Packet Buffers Quick Start Example Design Detailed Example Design EDK format Ethernet AVB Endpoint User Guide 1Example AVB Home Network Schedule of Figures Constraining the Core System Integration Figure A-1RTC Periodic Error Ethernet AVB Endpoint User Guide Schedule of Tables 17Tri-Mode Ethernet MAC and Ethernet Statistics Detailed Example Design EDK format Ethernet AVB Endpoint User Guide About This Guide Guide Contents Typographical Conventions Conventions Online DocumentConvention Meaning or Use Example Acronym Spelled Out List of Abbreviations Vhdl Conventions Acronym Spelled Out Preface About This Guide System Requirements IntroductionAbout the Core Windows Additional Core Resources Recommended Design ExperienceTechnical Support Feedback Feedback Document Introduction Before you Begin License Options Licensing the CoreSimulation Only Full System Hardware Evaluation Obtaining Your License Key Installing the License File 1Example AVB Home Network Overview of Ethernet Audio Video Bridging P802.1AS AVB SpecificationsOverview of Ethernet Audio Video Bridging P802.1Qav AVB SpecificationsTalker Assumptions Listener Assumptions P802.1Qat Typical Implementation Typical Implementation UG492 July 23 Ethernet AVB GUI Generating the Core Core Delivery Format Component NameGenerating the Core PLB Base Address Number of PLB MastersEthernet AVB GUI Output Generation Parameter Values in the XCO File Core Architecture Core Architecture Standard Core Generator Format EDK pcore Format EDK pcore Format PLB Interface Functional Block DescriptionAV Traffic Interface Legacy Traffic Interface Rx Splitter Tx ArbiterMAC Header Filters Functional Block Description Tx PTP Packet Buffers Precise Timing Protocol BlocksTx Time Stamp Rx PTP Packet Buffers RTC Tri-Mode Ethernet MACs Software Drivers 1Clocks and Resets Signal Direction Description Clocks and ResetCore Interfaces Core Interfaces Legacy Traffic Receiver Path Signals Legacy Traffic Transmitter Path Signals3Legacy Traffic Signals Receiver Path Direction Description 3Legacy Traffic Signals Receiver Path AV Traffic Transmitter Path Signals4AV Traffic Signals Transmitter Path Direction Description 5AV Traffic Signals Receiver Path Direction Description AV Traffic Receiver Path SignalsTri-Mode Ethernet MAC Client Interface MAC Transmitter Interface MAC Management Interface MAC Receiver Interface Processor Local Bus PLB Interface PIN Name Direction Description PLB Interface Ethernet AVB Endpoint User Guide 10Interrupt Signals Direction Description Interrupt Signals Signal Direction Description PTP Signals Tx Legacy Traffic I/F Ethernet AVB Endpoint Transmission Ethernet AVB Endpoint Transmission Error Free Legacy Frame Transmission Tx AV Traffic I/F Errored Legacy Frame TransmissionTx AV Traffic I/F 3Normal Frame Transmission across the AV Traffic Interface Overview Tx ArbiterCredit Based Traffic Shaping Algorithm Tx Arbiter 4Credit-based Shaper Operation IdleSlope Tx Arbiter Bandwidth ControlSendSlope LoLimit HiLimit Rx Splitter Ethernet AVB Endpoint ReceptionRx Legacy Traffic I/F Ethernet AVB Endpoint Reception Error Free Legacy Frame Reception Legacy MAC Header Filters Errored Legacy Frame ReceptionOverview of Operation Rx Legacy Traffic I/F 3Normal Frame Reception Address Filter Match MAC Header Filter Configuration Full Destination Address DA Match Single MAC Header Filter Usage Examples 5Filtering of Frames with a Partial DA Match Partial Destination Address DA Match Any Other Combinations Vlan Priority Match Rx AV Traffic I/F Error Free AV Traffic ReceptionRx AV Traffic I/F 8Errored Frame Reception across the AV Traffic Interface Errored AV Traffic Reception Real Time Clock Real Time Clock and Time Stamping Real Time Clock and Time Stamping Increment of Nanoseconds Field RTC ImplementationReal Time Clock Controlled Frequency RTC Increment of the Seconds FieldSynchronized RTC Time Stamping Logic Time Stamping Logic 3Time Stamping Position Time Stamp Sampling Position of MAC Frames IEEE1722 Real Time Clock Format IEEE1722 Real Time Clock Format Real Time Clock and Time Stamping Tx PTP Packet Buffer Precise Timing Protocol Packet Buffers 1Tx PTP Packet Buffer Structure Precise Timing Protocol Packet Buffers Rx PTP Packet Buffer Rx PTP Packet Buffer 2Rx PTP Packet Buffer Processor Local Bus Interface Configuration and StatusSingle Read Transaction 1Single Read Transaction Configuration and Status Processor Local Bus Interface Single Write Transaction PLB Address Map and Register Definitions Ethernet AVB Endpoint Address Space PLB Address Map and Register Definitions Ethernet AVB Endpoint Address Space Ethernet Audio Video End Point Configuration RegistersRx PTP Packet Buffer Address Space Tx PTP Packet Buffer Address Space Rx Filtering Control Register Rx PTP Packet Control Register Tx Arbiter Idle Slope Control Register Tx Arbiter Send Slope Control RegisterRTC Offset Control Registers Current RTC Value Registers RTC Increment Value Control Register RTC Interrupt Clear Register Phase Adjustment Register Software Reset Register PTP Receiver logic reset. When written with a Address Default Access Description 16MAC Header Filter Configuration Registers Cont’d Tri-Mode Ethernet MAC Address Space MAC Configuration and StatisticsMAC Address Filter Registers MAC Mdio Registers 102 Required Constraints Constraining the Core PLBclk Period Constraints for Clock NetsHostclk Txclk Rtcclk Timespecs for Critical Logic within the CoreRequired Constraints Inst Ethernet AVB Endpoint User Guide 107 108 Ethernet AVB Endpoint User Guide 109 110 System Integration Using the Xilinx LogiCORE IP Tri-Mode Ethernet MACs Tri-Mode Ethernet MAC Core Generation LogiCORE IP Tri-Mode Ethernet MAC Soft CoreSystem Integration Connections Without Ethernet Statistics Using the Xilinx LogiCORE IP Tri-Mode Ethernet MACs 114 GND Connections Including Ethernet Statistics LogiCORE IP Embedded Tri-Mode Ethernet MACs Ethernet AVB Endpoint User Guide 117 118 Virtex-6 Fpga Embedded Tri-Mode Ethernet MAC 120 PLB Using an EDK Project Top Level PLB Using an ISE Software Top-Level Project Ethernet AVB Endpoint User Guide 123 Xpslltemac configuration Using the Xilinx XPS LocalLink Tri-Mode Ethernet MACIntroduction System Overview AVB capable xpslltemac Using the Xilinx XPS LocalLink Tri-Mode Ethernet MAC Ethernet AVB Endpoint Connections 9Connection to the XPS LocalLink Tri-Mode Ethernet MAC MHS File Syntax END Ethernet AVB Endpoint User Guide 129 130 Clock Master Software Drivers Software System Integration Clock SlaveDriver Instantiation Software Drivers Software System Integration Interrupt Service Routine Connections When Using a LogiCORE IP Tri-Mode Ethernet MAC Ethernet AVB Endpoint SetupCore Initialization System-Specific Defines in xavbhw.h Setting up GrandMaster Discontinuity Callback Handler Setting up SourcePortIdentity and Default TX PTP Messages Starting and Stopping the AVB Drivers Overview Quick Start Example Design 1Ethernet AVB Endpoint Example Design and Test Bench Quick Start Example Design Generating the Core 2Ethernet AVB Endpoint Core Customization Screen Implementing the Example Design Setting up for Simulation Functional SimulationSimulating the Example Design Implementing the Example Design Timing Simulation What’s Next? Project directory Detailed Example Design Standard Format Directory and File Contents Component name/doc Project directory/component nameComponent name/example design 5Implement Directory Name Description Component name/implement Component name/simulation Implement/resultsSimulation/functional 6Results Directory Name Description Name Description Simulation/timing Drivers/avbv204a/data Componentname/drivers/v204aDrivers/avbv204a/examples 11Driver Example Directory Name Description Drivers/avbv204a/src Simulation Scripts Implementation ScriptsImplementation Scripts Example Design HDL for the Ethernet AVB Endpoint Example Design Ethernet Frame Stimulus Top-Level Example Design HDLExample Design Loopback Module Ethernet Frame Checker PLB Module 2Ethernet AVB Endpoint Demonstration Test Bench Demonstration Test Bench Simulation Run Time Customizing the Test BenchChanging Frame Data Viewing the Simulation Wave Form 3Simulator Wave Window Contents Detailed Example Design EDK format Detailed Example Design EDK format MyProcessorIPLib/pcores/ethavbendpointv204a Component name/MyProcessorIPLibPcores/ethavbendpointv204a/data Pcores/ethavbendpointv204a/netlist Pcores/ethavbendpointv204a/hdl/vhdlMyProcessorIPLib/drivers/avbv204a 5Driver Data Directory Name Description 8Driver Example Directory Name Description 164 Ethernet AVB Endpoint User Guide 165 166 RTC Time Stamp Accuracy RTC Real Time Instantaneous ErrorTime Stamp Accuracy Appendix a RTC Time Stamp Accuracy Figure A-1RTC Periodic Error Time Stamp Accuracy RTC Sampling Error Figure A-3Sampling Position Uncertainty Figure A-4Overall Time Stamp Accuracy Accuracy Resulting from the Combined Errors 172