8B10B Encoder/Decoder MegaCore Function User Guide 101 Innovation Drive San Jose, CA 95134 www.altera.com MegaCore Version: Document Date: 7.2 October 2007 Copyright © 2007 Altera Corporation. All rights reserved. Altera, The Programmable Solutions Company, the stylized Altera logo, specific device designations, and all other words and logos that are identified as trademarks and/or service marks are, unless noted otherwise, the trademarks and service marks of Altera Corporation in the U.S. and other countries. All other product or service names are the property of their respective holders. Altera products are protected under numerous U.S. and foreign patents and pending applications, maskwork rights, and copyrights. Altera warrants performance of its semiconductor products to current specifications in accordance with Altera's standard warranty, but reserves the right to make changes to any products and services at any time without notice. Altera assumes no responsibility or liability arising out of the application or use of any information, product, or service described herein except as expressly agreed to in writing by Altera Corporation. Altera customers are advised to obtain the latest version of device specifications before relying on any published information and before placing orders for products or services. UG-IPED8B10B-1.10 ii MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation Contents About This User Guide ............................................................................. v Revision History ........................................................................................................................................ v How to Contact Altera ............................................................................................................................ vi Typographic Conventions ................................................................................................................. 1–vii Chapter 1. About This MegaCore Function Release Information ............................................................................................................................... Device Family Support ......................................................................................................................... Features ................................................................................................................................................... General Description ............................................................................................................................... OpenCore Plus Evaluation .............................................................................................................. Performance ............................................................................................................................................ 1–1 1–1 1–2 1–2 1–2 1–3 Chapter 2. Getting Started Design Flow ............................................................................................................................................ 2–1 8B10B Encoder /Decoder Walkthrough ............................................................................................ 2–2 Create a New Quartus II Project .................................................................................................... 2–2 Launch MegaWizard Plug-in Manager ......................................................................................... 2–4 Parameterize ..................................................................................................................................... 2–6 Set Up Simulation ............................................................................................................................. 2–7 Generate Files .................................................................................................................................... 2–8 Set Constraints ................................................................................................................................ 2–10 Simulate the Design ............................................................................................................................. 2–12 IP Functional Simulation Model .................................................................................................. 2–12 Compile the Design ............................................................................................................................. 2–13 Program a Device ................................................................................................................................ 2–13 Set Up Licensing .................................................................................................................................. 2–13 Chapter 3. Specifications Functional Description .......................................................................................................................... 3–1 Disparity ............................................................................................................................................ 3–1 Generic Framing Procedure ............................................................................................................ 3–2 Character Codes ............................................................................................................................... 3–3 Encoder .............................................................................................................................................. 3–4 Decoder .............................................................................................................................................. 3–8 OpenCore Plus Time-Out Behavior ............................................................................................... 3–9 Parameters ............................................................................................................................................ 3–10 Signals ................................................................................................................................................... 3–10 Altera Corporation MegaCore Version 7.2 iii Contents iv MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation About This User Guide Revision History The table below displays the revision history for the chapters in this user guide. Chapter Date Version All October 2007 7.2 Changes Made ● ● All 1 May 2007 7.1 ● Added support for Arria™ GX device family Maintenance release; updated product release information ● December 2006 7.0 ● Added support for Cyclone III devices. April 2006 1.6.1 ● Updated release information and device family support tables. October 2005 1.6.0 ● Updated release information and device family support tables. June 2004 1.5.0 ● Updated release information and device family support tables. Updated performance information. ● February 2004 1.4.0 ● Updated release information and device family support tables. Added OpenCore Plus description. Updated performance information. ● ● 2 Corrected error in text: the decoder (not the encoder) asserts kerr upon receiving an invalid code. Updated discussion of Encoder in the Specifications chapter and timing diagrams Figure 3–5 and Figure 3–6. December 2006 6.1 ● Updated screen shots to match new version. April 2006 1.6.1 ● Updated walkthrough instructions. October 2005 1.6.0 ● Updated system requirements June 2004 1.5.0 ● Update system requirements Updated the instructions to obtain the 8B10B Encoder/Decoder MegaCore® function. ● February 2004 1.4.0 ● ● ● Altera Corporation Added Linux instructions. Added IP Toolbench instructions. Added IP functional simulation models information. MegaCore Version 7.2 v 8B10B Encoder/Decoder MegaCore Function User Guide How to Contact Altera Chapter Date Version 3 April 2006 1.6.1 Changes Made ● ● ● ● Added text to Encoded Latency description. Added “Encoder Timing Diagram—One Cycle Latency” on page 3–7. Made corrections to clk signal description. Removed Device family parameter and added Registered inputs/outputs parameter. October 2005 1.6.0 ● Removed Mercury™ devices from the Device family parameter options, and added the HardCopy® II and Stratix® II GX families. June 2004 1.5.0 ● No changes. February 2004 1.4.0 ● Added running disparity error output (rderr) description. Added 10B_ERR special code description. Added OpenCore Plus time-out behavior description. Added Parameters description (table). Updated Signals tables. ● ● ● ● How to Contact Altera For the most up-to-date information about Altera® products, go to the Altera world-wide website at www.altera.com. For technical support on this product, go to www.altera.com/mysupport. For additional information about Altera products, consult the sources shown below. Information Type Contact (1) Technical support www.altera.com/mysupport/ Technical training www.altera.com/training/ Technical training services [email protected] Product literature www.altera.com/literature Product literature services [email protected] FTP site ftp.altera.com Note: (1) You can also contact your local Altera sales office or sales representative. vi MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation About This User Guide Typographic Conventions Visual Cue This document uses the typographic conventions shown below. Meaning Bold Type with Initial Capital Letters Command names, dialog box titles, checkbox options, and dialog box options are shown in bold, initial capital letters. Example: Save As dialog box. bold type External timing parameters, directory names, project names, disk drive names, filenames, filename extensions, and software utility names are shown in bold type. Examples: fMAX, \qdesigns directory, d: drive, chiptrip.gdf file. Italic Type with Initial Capital Letters Document titles are shown in italic type with initial capital letters. Example: AN 75: High-Speed Board Design. Italic type Internal timing parameters and variables are shown in italic type. Examples: tPIA, n + 1. Variable names are enclosed in angle brackets (< >) and shown in italic type. Example: <file name>, <project name>.pof file. Initial Capital Letters Keyboard keys and menu names are shown with initial capital letters. Examples: Delete key, the Options menu. “Subheading Title” References to sections within a document and titles of on-line help topics are shown in quotation marks. Example: “Typographic Conventions.” Courier type Signal and port names are shown in lowercase Courier type. Examples: data1, tdi, input. Active-low signals are denoted by suffix n, for example, resetn. Anything that must be typed exactly as it appears is shown in Courier type. For example: c:\qdesigns\tutorial\chiptrip.gdf. Also, sections of an actual file, such as a Report File, references to parts of files (for example, the VHDL keyword BEGIN), as well as logic function names (for example, TRI) are shown in Courier. 1., 2., 3., and a., b., c., etc. Numbered steps are used in a list of items when the sequence of the items is important, such as the steps listed in a procedure. ■ Bullets are used in a list of items when the sequence of the items is not important. ● • v The checkmark indicates a procedure that consists of one step only. 1 The hand points to information that requires special attention. c A caution calls attention to a condition or possible situation that can damage or destroy the product or the user’s work. w A warning calls attention to a condition or possible situation that can cause injury to the user. r The angled arrow indicates you should press the Enter key. f The feet direct you to more information on a particular topic. Altera Corporation MegaCore Version 7.2 vii 8B10B Encoder/Decoder MegaCore Function User Guide Typographic Conventions viii MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation 1. About This MegaCore Function Release Information Table 1–1 provides information about this release of the Altera® 8B10B Encoder/Decoder MegaCore® function. Table 1–1. 8B10B Encoder/Decoder MegaCore Function Release Information Item Description Version Device Family Support 7.2 Release Date October 2007 Ordering Code IP-ED8B10B Product ID 0079 Vendor ID 6AF7 MegaCore functions provide either full or preliminary support for target Altera device families: ■ ■ Full support means the MegaCore function meets all functional and timing requirements for the device family and may be used in production designs. Preliminary support means the MegaCore function meets all functional requirements, but may still be undergoing timing analysis for the device family; it may be used in production designs with caution. Table 1–2 shows the level of support offered by the 8B10B Encoder/Decoder MegaCore function to each Altera device family. Table 1–2. Device Family Support (Part 1 of 2) Device Family Altera Corporation October 2007 Support Arria™ GX Preliminary Cyclone® Full Cyclone II Full Cyclone III Preliminary HardCopy® II Full MegaCore Version 7.2 1–1 8B10B Encoder/Decoder MegaCore Function User Guide Features Table 1–2. Device Family Support (Part 2 of 2) Device Family Support HardCopy Stratix® Full Stratix Full Stratix II Full Stratix II GX Full Stratix III Preliminary Stratix GX Full Other device families No support Features ■ ■ ■ ■ ■ ■ ■ General Description Encoders and decoders are used for physical layer coding for Gigabit Ethernet, Fibre Channel, and other applications. The 8b/10b encoder takes byte inputs, and generates a direct current (DC) balanced stream (equal number of 1s and 0s) with a maximum run length of 5. Some of the individual 10-bit codes will have an equal number of 1s and 0s, while others will have either four 1s and six 0s, or, six 1s and four 0s. In the latter case, the disparity between 1s and 0s is used as an input to the next 10-bit code generation, so that the disparity can be reversed, and maintain an overall balanced stream. For this reason, some 8-bit inputs have two valid 10-bit codes, depending on the input disparity. Support for Arria™ GX device family 8b/10b encoding and decoding Cascaded encoding and decoding Industry compatible special character coding Easy-to-use IP MegaWizard® interface Support for OpenCore Plus evaluation IP functional simulation models for use in Altera-supported VHDL and Verilog HDL simulators The Altera 8B10B Encoder/Decoder is a compact, high performance MegaCore function capable of encoding and decoding in multi-gigabit applications. OpenCore Plus Evaluation With Altera’s free OpenCore Plus evaluation feature, you can perform the following actions: ■ Simulate the behavior of a megafunction within your system 1–2 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 About This MegaCore Function ■ ■ ■ Verify the functionality of your design, as well as evaluate its size and speed quickly and easily Generate time-limited device programming files for designs that include megafunctions Program a device and verify your design in hardware You only need to purchase a license for the megafunction when you are completely satisfied with its functionality and performance, and want to take your design to production. f Performance For more information on OpenCore Plus hardware evaluation using the 8B10B Encoder/Decoder see “OpenCore Plus Time-Out Behavior” on page 3–9 and AN 320: OpenCore Plus Evaluation of Megafunctions. Table 1–3, Table 1–4, and Table 1–5 show the resource utilization and performance of some 8B10B Encoder/Decoder MegaCore functions. These results were obtained using the Quartus® II software version7.1 for the following devices: ■ ■ ■ ■ Altera Corporation October 2007 Cyclone II (EP2C35F484C6) Cyclone III (EP3C80F780C6) Stratix II (EP2S30F484C3) Stratix III (EP3SE110F780C2) MegaCore Version 7.2 1–3 8B10B Encoder/Decoder MegaCore Function User Guide Performance Table 1–3. Resource Utilization and Performance (Cyclone II, Cyclone III) Parameters Device Mode of Operation Cyclone II Cyclone III fMAX (MHz) (1) (2) LEs Register Inputs/Outputs Encoder On 100 250 Encoder Off 107 454 Decoder – 131 403 Encoder On 100 250 Encoder Off 107 454 Decoder – 131 403 Notes to Table 1–3: (1) (2) fMAX is for non-cascaded encoders/decoders. These results were obtained with the auto-ROM replacement feature disabled in the Quartus II software. Enabling this feature produces a smaller but slower MegaCore function. Table 1–4. Resource Utilization and Performance (Stratix II) Parameters Device Stratix II Combinational Logic ALUTs Registers fMAX (MHz) (1) (2) Mode of Operation Register Inputs/Outputs Encoder On 61 51 444 Encoder Off 68 13 585 Decoder – 55 33 447 Notes to Table 1–4: (1) (2) fMAX is for non-cascaded encoders/decoders. These results were obtained with the auto-ROM replacement feature disabled in the Quartus II software. Enabling this feature produces a smaller but slower MegaCore function. 1–4 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 About This MegaCore Function Table 1–5. Resource Utilization and Performance (Stratix III) Parameters Device Stratix III Combinational Logic ALUTs Registers fMAX (MHz) (1) (2) Mode of Operation Register Inputs/Outputs Encoder On 60 51 510 Encoder Off 68 13 675 Decoder – 55 33 520 Notes to Table 1–5: (1) (2) Altera Corporation October 2007 fMAX is for non-cascaded encoders/decoders. These results were obtained with the auto-ROM replacement feature disabled in the Quartus II software. Enabling this feature produces a smaller but slower MegaCore function. MegaCore Version 7.2 1–5 8B10B Encoder/Decoder MegaCore Function User Guide Performance 1–6 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 2. Getting Started Design Flow To evaluate the 8B10B Encoder/Decoder MegaCore® function using the OpenCore Plus feature include these steps in your design flow: 1. Obtain and install the 8B10B Encoder/Decoder MegaCore Function. The 8B10B Encoder/Decoder MegaCore Function is part of the MegaCore IP Library, which is distributed with the Quartus® II software and downloadable from the Altera website, www.altera.com. f For system requirements and installation instructions, refer to Quartus II Installation & Licensing for Windows or Quartus II Installation & Licensing for UNIX & Linux Workstations on the Altera website. Figure 2–1 shows the directory structure after you install the 8B10B Encoder/Decoder, where <path> is the installation directory. The default installation directory on Windows is c:\altera\71; on UNIX and Linux it is /opt/altera/71. Figure 2–1. Directory Structure <path> Installation directory ip Contains the MegaCore IP Library. common Contains the shared components. ed8b10b Contains the 8B10B Encoder/Decoder MegaCore function files and documentation. doc Contains the documentation for the MegaCore function. lib Contains encrypted lower-level design files. Altera Corporation October 2007 2. Create a custom variation of the 8B10B Encoder/Decoder MegaCore Function. 3. Implement the rest of your design using the design entry method of your choice. MegaCore Version 7.2 2–1 8B10B Encoder/Decoder MegaCore Function User Guide 8B10B Encoder /Decoder Walkthrough 4. f Use the IP functional simulation model to verify the operation of your design. For more information on IP functional simulation models, refer to the Simulating Altera IP in Third-Party Simulation Tools chapter in Volume 3 of the Quartus II Handbook. 5. Use the Quartus II software to compile your design. 1 6. You can also generate an OpenCore Plus time-limited programming file, which you can use to verify the operation of your design in hardware. Purchase a license for the 8B10B Encoder/Decoder MegaCore Function. After you have purchased a license for the 8B10B Encoder/Decoder MegaCore Function, follow these additional steps: 8B10B Encoder /Decoder Walkthrough 1. Set up licensing. 2. Generate a programming file for the Altera® device(s) on your board. 3. Program the Altera device(s) with the completed design. This walkthrough shows you how to create an 8B10B Encoder/Decoder MegaCore function using the MegaWizard interface and the Quartus II software. After generating a custom variation of the 8B10B Encoder/Decoder MegaCore function, you can incorporate it into your overall project. This walkthrough consists of these steps: ■ ■ ■ ■ ■ ■ Create a New Quartus II Project Launch MegaWizard Plug-in Manager Parameterize Set Up Simulation Generate Files Set Constraints Create a New Quartus II Project You need to create a new Quartus II project with the New Project Wizard, which specifies the working directory for the project, assigns the project name, and designates the name of the top-level design entity. 2–2 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started To create a new project follow these steps: 1. Choose Programs > Altera > Quartus II <version> (Windows Start menu) to run the Quartus II software. Alternatively, you can use the Quartus II Web Edition software. 2. Choose New Project Wizard (File menu). 3. Click Next in the New Project Wizard Introduction page (the introduction does not display if you turned it off previously). 4. In the New Project Wizard: Directory, Name, Top-Level Entity page, enter the following information: a. Specify the working directory for your project. For example, this walkthrough uses the directory: c:\altera\projects\ed8b10b_project b. Specify the name of the project. This walkthrough uses the project name: ed8b10b_example 1 5. Click Next to close this page and display the New Project Wizard: Add Files page. 1 6. Altera Corporation October 2007 The Quartus II software automatically specifies a top-level design entity that has the same name as the project. Do not change it. When you specify a directory that does not already exist, a message asks if the specified directory should be created. Click Yes to create the directory. If you installed the MegaCore IP Library in a different directory from where you installed the Quartus II software, you must add the user libraries: a. Click User Libraries. b. Type <path>\ip into the Library name box, where <path> is the directory in which you installed the 8B10B Encoder/Decoder MegaCore Function. c. Click Add to add the path to the Quartus II project. MegaCore Version 7.2 2–3 8B10B Encoder/Decoder MegaCore Function User Guide 8B10B Encoder /Decoder Walkthrough d. Click OK to save the library path in the project. 7. Click Next to close this page and display the New Project Wizard: Family & Device Settings page. 8. On the New Project Wizard: Family & Device Settings page, choose the target device family in the Family list. 9. The remaining pages in the New Project Wizard are optional. Click Finish to complete the Quartus II project. You have finished creating your new Quartus II project. Launch MegaWizard Plug-in Manager To launch the MegaWizard Plug-in Manager in the Quartus II software, follow these steps: 1. Start the MegaWizard® Plug-In Manager by choosing the MegaWizard Plug-In Manager command (Tools menu). The MegaWizard Plug-In Manager dialog box displays (see Figure 2–2). 1 Refer to the Quartus II Help for more information on how to use the MegaWizard Plug-In Manager. Figure 2–2. MegaWizard Plug-in Manager 2. Specify that you want to create a new custom megafunction variation and click Next. 3. Expand the Communications > Encoding/Decoding directory, then click 8B10B Encoder-Decoder v7.1. 2–4 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started 4. Choose the device family you want to use for this MegaCore function, for example Stratix II GX. 5. Select the output file type for your design; the MegaWizard interface supports VHDL and Verilog HDL. 6. The MegaWizard Plug-In Manager shows the project path that you specified in the New Project Wizard. Append a variation name for the MegaCore function output files <project path>\<variation name>. Figure 2–3 shows the MegaWizard Plug-In Manager after you have made these settings. Figure 2–3. Select the MegaCore Function 7. Altera Corporation October 2007 Click Next to display the Parameter Settings page for the 8B10B Encoder/Decoder MegaCore Function (see Figure 2–4). MegaCore Version 7.2 2–5 8B10B Encoder/Decoder MegaCore Function User Guide 8B10B Encoder /Decoder Walkthrough 1 You can change the page that the MegaWizard Plug-In Manager displays by clicking Next or Back at the bottom of the dialog box. You can move directly to a named page by clicking the Parameter Settings, Simulation Model, or Summary tab. Figure 2–4. Parameters Parameterize To parameterize your MegaCore function, follow these steps: 1. Select the mode of operation, either Encoder or Decoder 2. If you selected Encoder, turn on the Register inputs/outputs check box for a three-cycle latency, or turn off the Register inputs/outputs check box for a single-cycle latency. 1 The Decoder always has registered inputs and outputs. 2–6 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started 3. Select the mode of operation, either Encoder or Decoder. 4. If you selected Encoder, turn on the Register inputs/outputs check box for a three cycle latency, or turn off the Register inputs/outputs check box for a single cycle latency. 1 5. The Decoder always has registered inputs and outputs. Click Next (or the Simulation Model tab) to display the simulation setup page (see Figure 2–5). Figure 2–5. Simulation Model Set Up Simulation An IP functional simulation model is a cycle-accurate VHDL or Verilog HDL model file produced by the Quartus II software. The model allows for fast functional simulation of IP using industry-standard VHDL and Verilog HDL simulators. Altera Corporation October 2007 MegaCore Version 7.2 2–7 8B10B Encoder/Decoder MegaCore Function User Guide 8B10B Encoder /Decoder Walkthrough c You may only use these models for simulation purposes and expressly not for synthesis or any other purposes. Using these models for synthesis creates a nonfunctional design. To generate an IP functional simulation model for your MegaCore function, follow these steps: 1. Turn on Generate Simulation Model. 2. Choose the language you want from the Language list. 3. Click Next (or the Summary page) to display the summary page (see Figure 2–6). Figure 2–6. Summary Page Generate Files You can use the check boxes in the Summary page to enable or disable the generation of specified files. A gray checkmark indicates a file that is automatically generated; a red checkmark indicates an optional file. 2–8 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started You can click Back to display the previous page or click Parameters Setting, Simulation Library, or Summary Page, if you want to change any of the MegaWizard options. To generate the files, follow these steps: 1. Turn on the files you want to generate (see Figure 2–6). 2. To generate the specified files and close the MegaWizard Plug-in Manager, click Finish. 1 The generation phase may take several minutes to complete. When the file generation is complete, you can go to the project directory and view a list of generated files in the file <variation name>.html (the files that are listed in the following table). Table 2–1 describes the generated files and other files that may be in your project directory. The names and types of files specified in the summary vary based on whether you created your design with VHDL or Verilog HDL Table 2–1. Generated Files Note (1) (Part 1 of 2) Filename (2) Description <variation name>.bsf Quartus II symbol file for the MegaCore function variation. You can use this file in the Quartus II block diagram editor. <variation name>.cmp VHDL component declaration file <variation name>.html The MegaCore function report file. <variation name>.v A MegaCore function variation file, which defines a Verilog HDL top-level description of the custom MegaCore function. Instantiate the entity defined by this file inside of your design. Include this file when compiling your design in the Quartus II software. <variation name>.vo Verilog HDL IP functional simulation model. <variation namez>_bb.v Verilog HDL black-box file for the MegaCore function variation. Use this file when using a third-party EDA tool to synthesize your design. <variation name>_constraints.tcl Tool command language (tcl) script used to set constraints. <variation name>_enc8b10b.ocp An OpenCore Plus file, needed for time-limited or tethered hardware evaluation. <variation name>_enc8b10b.v Verilog HDL RTL for this MegaCore function variation. <variation name>_run_modelsim.tcl A Tcl script to automate the process of running the provided demo testbench with the IP functional simulation model. Altera Corporation October 2007 MegaCore Version 7.2 2–9 8B10B Encoder/Decoder MegaCore Function User Guide 8B10B Encoder /Decoder Walkthrough Table 2–1. Generated Files Note (1) (Part 2 of 2) Filename (2) Description A Verilog HDL module with the top-level demo testbench for the core. <variation name>_tb.v Notes to Table 2–1: (1) (2) (3) These files are variation dependent, some may be absent or their names may change. <variation name> is a prefix variation name supplied automatically by the MegaWizard interface. If you choose the decoder mode, the file name is <variation name>_dec8b10b. Set Constraints The 8B10B Encoder/Decoder MegaCore function variations include a tool command language (Tcl) script. Use this Tcl script to constrain your design. To run the Tcl script in the Quartus II software, in a Win32 operating system, follow either of these sets of steps: 1. Select TCL Scripts (Tools menu) 2. Select the applicable Tcl file for your variation: <variation name>_constraints. tcl 3. Click Run. or 1. Click on Tcl Console under Utility_Windows (View menu) 2. In the Tcl console window, type: source <variation name>_constraints.tcl To run the Tcl script in a UNIX or Linux operating system terminal, type: cd..<project_directory> quartus_sh -t <variation name>_constraints.tcl 2–10 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started 1 Depending on the type of constraints applied by the Tcl script, analysis and synthesis may be run twice. For example, if hierarchy independent constraints are needed, the Tcl script runs analysis and synthesis before applying the constraints. Therefore, when you run a full compilation, after running the Tcl script, the analysis and synthesis are run a second time. You can now integrate your custom MegaCore function variation into your design, simulate, and compile. Altera Corporation October 2007 MegaCore Version 7.2 2–11 8B10B Encoder/Decoder MegaCore Function User Guide Simulate the Design Simulate the Design f You can simulate your design using the generated VHDL and Verilog HDL IP functional simulation models. For more information on IP functional simulation models, refer to the Simulating Altera IP in Third-Party Simulation Tools chapter in Volume 3 of the Quartus II Handbook. Altera also provides a Verilog HDL demonstration testbench, including scripts to compile and run the demonstration testbench using a variety of simulators and models. This testbench demonstrates the typical behavior of an 8B10B MegaCore function, and how to instantiate a model in a design. The demonstration testbench does not perform any error checking. f For a complete list of models or libraries required to simulate the 8B10B Encoder/Decoder MegaCore function, refer to the _run_modelsim.tcl scripts provided with the demonstration testbench. IP Functional Simulation Model To use the demonstration testbench with IP functional simulation models in the ModelSim® simulator, follow these steps: 1. Start the ModelSim simulator. 2. From the ModelSim File menu, use Change Directory to change the working directory to the directory where you created your 8B10B Encoder/Decoder variation. 3. In the ModelSim Transcript window, execute the command do<variation_name>_run_modelsim.tcl which sets up the required libraries, compiles the netlist files, and runs the testbench. The ModelSim Transcript window displays messages from the testbench reflecting the results of the simulation. 1 In all cases, the testbench is in Verilog HDL, therefore a license to run mixed language simulations is required to run the testbench with the VHDL model. 1 Altera recommends that you disable the auto-ROM replacement feature in the Quartus II software. Enabling this feature produces a smaller but slower MegaCore function. 2–12 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Getting Started Compile the Design You can use the Quartus II software to compile your design. Refer to Quartus II Help for instructions on compiling your design. Program a Device After you have compiled your design, program your targeted Altera device, and verify your design in hardware. With Altera's free OpenCore Plus evaluation feature, you can evaluate the 8B10B Encoder/Decoder MegaCore function before you purchase a license. OpenCore Plus evaluation allows you to generate an IP functional simulation model and produce a time-limited programming file. f For more information on IP functional simulation models, refer to the Simulating Altera IP in Third-Party Simulation Tools chapter in Volume 3 of the Quartus II Handbook Version 7.1. f For more information on OpenCore Plus hardware evaluation using the 8B10B Encoder/Decoder, see “OpenCore Plus Time-Out Behavior” on page 3–9 and AN 320: OpenCore Plus Evaluation of Megafunctions. Set Up Licensing You need to purchase a license for the MegaCore function only when you are completely satisfied with its functionality and performance, and want to take your design to production. After you purchase a license for 8B10B Encoder/Decoder, you can request a license file from the Altera website at www.altera.com/licensing and install it on your computer. When you request a license file, Altera emails you a license.dat file. If you do not have Internet access, contact your local Altera representative. Altera Corporation October 2007 MegaCore Version 7.2 2–13 8B10B Encoder/Decoder MegaCore Function User Guide Set Up Licensing 2–14 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 3. Specifications Functional Description The MegaCore® function consists of an encoder (ENC8B10B) and a decoder (DEC8B10B). See Figure 3–2 on page 3–3. The encoder encodes one 8-bit byte of data into a 10-bit transmission code, and the decoder decodes a 10-bit code into one 8-bit byte of data. Figure 3–1 illustrates the bidirectional conversion process. The eight input bits are named A, B, C, D, E, F, G, H. Bit A is the least significant bit (LSB), and bit H is the most significant bit (MSB). They are split into two groups: The five-bit group A, B, C, D, E, and the three-bit group F, G, H. The coded bits are named a, b, c, d, e, i, f, g, h, j (the order is not alphabetical). These bits are also split into two groups: the six-bit group a, b, c, d, e, i, and the four-bit group f, g, h, j. Figure 3–1. 8b10b Conversion 7 6 5 4 3 2 1 0 H G F E D C B A 8b10b Conversion j h g f i e d c b a 9 8 7 6 5 4 3 2 1 0 MSB sent last LSB sent first In bit serial transmission, the LSB is usually transmitted first, while the MSB is usually transmitted last. Disparity Disparity is the difference between the number of 1s and 0s in the encoded word. Altera Corporation October 2007 MegaCore Version 7.2 7.23–1 Functional Description ■ ■ ■ Neutral disparity indicates the number of 1s and 0s are equal. Positive disparity indicates more 1s than 0s. Negative disparity indicates more 0s than 1s. The MegaCore function is designed to maintain a neutral average disparity. Average disparity determines the direct current (DC) component of a serial line. Running disparity is a record of the cumulative disparity of every encoded word, and is tracked by the encoder. To guarantee neutral average disparity, a positive running disparity must be followed by neutral or negative disparity; a negative running disparity must be followed by neutral or positive disparity. The running disparity error output (rderr) is asserted when any of the following rules apply: ■ ■ ■ ■ f The current running disparity is positive and the 6-bit group has more ones than zeros or is 111000 The current running disparity is negative and the 6-bit group has more zeros than ones or is 000111 The running disparity after 6-bit group is positive and the 4-bit group has more ones than zeros or is 1100 The running disparity after 6-bit group is negative and the 4-bit group has more zeros than ones or is 0011 1 rderr is asserted for some invalid 10-bit codes and not for others, strictly based on the rules stated above. The computation of rderr is completely independent of that of the special control character error (kerr) signal. 1 A 10-bit code that corresponds to a valid encoding but that has the wrong disparity—though technically an invalid code—does not cause the kerr signal to be asserted. Only rderr is asserted. For details on running disparity rules, refer to the IEEE 802.3z specification, paragraph 36.2.4.4. Generic Framing Procedure The 8B10B Encoder/Decoder MegaCore function can be used within generic framing procedure (GFP) applications. See Figure 3–2 on page 3–3 for an example. 3–2 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Specifications Figure 3–2. 8B10B Encoder/Decoder GFP Typical Application Ingress Gigabit Ethernet Stream (8B/10B Encoded) Egress Transport Network 8B/10B Decoder GFP Mapper GFP Data Stream (64B/65B Encoded) GFP Demapper 8B/10B Encoder Gigabit Ethernet Stream (8B/10B Encoded) On ingress to the transport network, if the decoder receives an unrecognized codeword, such as an illegal codeword or a legal codeword with a running disparity error, it asserts the kerr or rderr signals respectively. By asserting these error signals, the decoder indicates to the mapper that an invalid codeword has been received, the mapper then generates a special control character, the 10B_ERR code. In addition, the mapper remaps the 8B/10B codewords into 64B/65B codewords before sending the data to the transport network. On egress from the transport network, the demapper decodes the 64B/65B codewords and sends them to the 8B/10B encoder. When the encoder receives the 10B_ERR code, it sends out one of the two 10-bit illegal codewords with neutral disparity: 001111 0001(RD-) or 110000 1110(RD+), depending on the running disparity. Character Codes In addition to 256 data characters, the 8b/10b code defines thirteen outof-band indicators, also called special control characters. The 256 data characters are named Dx.y, and the special control characters are named Kx.y—except for the special code 10B_ERR (see Table 3–1 on page 3–4). The x value corresponds to the five-bit group, and the y value to the threebit group. The special control characters indicate, for example, whether the data is idle, test data, or data delimiters. In applications where encoded characters are transmitted bit-serially, the comma character (K28.5) is usually used for alignment purposes as its 10-bit code is guaranteed not to occur elsewhere in the encoded bit stream, except after K28.7 which is normally only sent during diagnostic. Altera Corporation October 2007 MegaCore Version 7.2 3–3 8B10B Encoder/Decoder MegaCore Function User Guide Functional Description Table 3–1 lists the special K codes used by the MegaCore function. Table 3–1. Character Codes 10-Bit Special K Codes Equivalent 8-Bit Codes K28.0 8'b000_11100 K28.1 8'b001_11100 K28.2 8'b010_11100 K28.3 8'b011_11100 K28.4 8'b100_11100 K28.5 (1) 8'b101_11100 K28.6 8'b110_11100 K28.7 8'b111_11100 K23.7 8'b111_10111 K27.7 8'b111_11011 K29.7 8'b111_11101 K30.7 8'b111_11110 10B_ERR 8'b111_11111 Note to Table 3–1: (1) K28.5 is a comma character used for alignment purposes, and to represent the IDLE code. Encoder To encode an 8-bit word, the 8-bit value must be applied to the datain inputs and the ena input must be asserted (active high). When one of the thirteen special 10-bit codes is to be inserted, the equivalent 8-bit code is placed on the datain lines and the kin input is asserted. The MegaCore function performs error checking to ensure the out-of-band 8-bit code is valid. If not, the kerr output is asserted. See Table 3–1 for a list of the valid K codes. 1 Although the 10B_ERR code is considered to be an invalid special character, it does not cause the kerr signal to be asserted. Idle (K28.5) characters can be automatically inserted when ena is not asserted by asserting the idle_ins input. The encoder encodes invalid characters in the same way it encodes Idle (K28.5) codes. The decoder treats invalid characters as Idle codes. 3–4 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Specifications Figure 3–3 shows a block diagram of the encoder. Figure 3–3. Encoder clk kerr reset_n kin ena dataout [9:0] valid idle_ins datain [7:0] rdin rdout rdcascade rdforce Disparity The running disparity can be forced to positive or negative, allowing the user to insert a special resynchronization pattern, or disparity errors. When the rdforce input is asserted, the value on the rdin port is assumed to be the current running disparity. Setting rdin to 0 forces the encoder to produce an encoded word with positive or neutral disparity. Setting rdin to 1 forces the encoder to produce an encoded word with negative or neutral disparity. Cascaded Encoding Two encoders can be cascaded to allow for 16-bit word encoding. The encoders are cascaded by connecting the rdcascade output of the most significant byte (MSByte) encoder to the rdin input of the least significant byte (LSByte) encoder, and by connecting the rdout output of the LSByte encoder to the rdin input of the MSByte encoder. These connections ensure proper running disparity computation. The rdforce inputs must be asserted (active high) for the encoders to take into account the value on the rdin inputs, rather than use their internally generated running disparity. Both ena inputs must be high or low at the same time. The kin [1] signal relates to datain[15:8], and kin[0] relates to datain[7:0]. Figure 3–4 on page 3–6 shows two encoders connected together to perform cascaded encoding. If the encoded words are to be transmitted serially, the result of encoding datain[15:8] should be transmitted first. Altera Corporation October 2007 MegaCore Version 7.2 3–5 8B10B Encoder/Decoder MegaCore Function User Guide Functional Description Figure 3–4. Cascaded Encoding Note (1) clk reset_n kin [1] kerr dataout [9:0] kin [1:0] ena valid idle_ins datain [15:0] datain [15:8] rdin rdout rdcascade rdforce clk kerr reset_n dataout [9:0] kin [0] ena idle_ins valid rdout datain [7:0] rdin rdcascade rdforce Note to Figure 3–4: (1) The ena, idle_ins, and rdforce signals are set high (logic 1). Encoding Latency When the register inputs/outputs parameter is turned on, the encoder is pipelined, thus it takes three clock cycles for a character to be encoded. The encoded value—corresponding to the values of datain and kin sampled by the encoder on rising edge n—is output shortly after rising edge n+2, and is available to be sampled on the rising edge of clock cycle n+3. (See Figure 3–5 on page 3–7). To enable cascaded encoding, the data paths fed by the rdforce and rdin inputs are not pipelined. Because rdforce and rdin are normally only used in cascaded configurations, this should not be a problem. In cases where the rdforce and rdin inputs are to be used in noncascaded configurations, they should be delayed two clock cycles with respect to their corresponding datain and kin values. 3–6 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Specifications When the register inputs/outputs parameter is turned off, the encoder takes one clock cycle to encode a character. The encoded value— corresponding to the values of datain and kin sampled by the encoder on rising edge n—is output shortly after rising edge n, and is available to be sampled on the rising edge of clock cycle n+1. (See Figure 3–6). Figure 3–5. Encoder Timing Diagram—Three Cycle Latency n n+1 n+2 n+3 clk datain, kin, en, idle_ins a b c dataout, rdout, kerr, valid a rdforce, rdin d e f g a b c d e b c d e f a rdcascade c b d e f Figure 3–6. Encoder Timing Diagram—One Cycle Latency n n+1 clk datain, kin, en, idle_ins a dataout, rdout, kerr, valid rdforce, rdin rdcascade a a b c d e f g a b c d e f b c d e f g b c d e f g Fibre Channel and IEEE 802.3z 1000BaseX In Fibre Channel and IEEE 802.3z 1000BaseX applications the encoder does not automatically select the correct 8-bit data for Fibre Channel EOF or 1000BaseX Idle ordered sets. The running disparity based selection of the correct 8-bit data must be made before passing the data to the encoder. Altera Corporation October 2007 MegaCore Version 7.2 3–7 8B10B Encoder/Decoder MegaCore Function User Guide Functional Description Decoder Data and identified 10-bit special K codes are converted from 10 bits to 8 bits; see Table 3–1 on page 3–4 for a list of the valid K codes, and Figure 3–1 on page 3–1 for an illustration of the conversion process. When special 10-bit K codes are received, the special K codes are translated to 8-bit values, and the kout signal is asserted. The decoder also checks for invalid 10-bit codes. When the decoder receives an invalid code, it asserts the kerr signal and decodes the value to an arbitrary number. 1 The decoder flags the 10B_ERR characters as invalid codes and asserts the kerr signal. When the idle_del signal is asserted, it deletes all 10-bit words identified as the special IDLE character of K28.5. When the receiver detects a disparity error, the rderr signal is asserted. Figure 3–7 shows a block diagram of the decoder. Figure 3–7. Decoder clk valid reset_n dataout [7:0] idle_del kout ena kerr datain [9:0] rderr rdin rdout rdforce rdcascade Cascaded Decoding Two decoders can be cascaded to decode two words simultaneously. The decoders are cascaded—in a similar fashion as the encoders—by connecting the rdcascade output of the first decoder to the rdin input of the second decoder, and by connecting the rdout output of the second decoder to the rdin input of the first decoder. The rdforce inputs of both decoders must be tied high. 3–8 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Specifications To enable cascaded decoding, the data paths fed by the rdin and rdforce inputs are not pipelined. If these inputs are to be used in noncascaded decoders, they should be delayed by one clock cycle with respect to their corresponding datain and kin inputs. Decoding Latency The decoder is pipelined, thus it takes two clock cycles for a character to be decoded. The decoded value—corresponding to the value of datain sampled by the decoder on rising edge n—is output shortly after rising edge n+1, and is available to be sampled on the rising edge of clock cycle n+2. (See Figure 3–6 on page 3–7). Figure 3–8. Decoder Timing Diagram n n+1 n+2 n+3 clk datain, ena a b dataout, kout kerr, rdout, rderr rdforce, rdin a c d e f g a b c d e b c d e f OpenCore Plus Time-Out Behavior OpenCore® Plus hardware evaluation can support the following two modes of operation: ■ ■ Untethered—the design runs for a limited time Tethered—requires a connection between your board and the host computer. If tethered mode is supported by all megafunctions in a design, the device can operate for a longer time or indefinitely All megafunctions in a device time out simultaneously when the most restrictive evaluation time is reached. If there is more than one megafunction in a design, a specific megafunction’s time-out behavior may be masked by the time-out behavior of the other megafunctions. 1 Altera Corporation October 2007 For MegaCore functions, the untethered timeout is 1 hour; the tethered timeout value is indefinite. MegaCore Version 7.2 3–9 8B10B Encoder/Decoder MegaCore Function User Guide Parameters Your design stops working after the hardware evaluation time expires, and the following events occur: ■ ■ f Parameters For the encoder: ● The ena input signal is forced low (deasserted) ● The dataout output is forced to the k28.5 pattern ● The valid output is forced low (deasserted) For the decoder: ● The ena input signal is forced low (deasserted) ● The dataout output is forced to all zeros ● The valid output is forced low (deasserted) For more information on OpenCore Plus hardware evaluation, see “OpenCore Plus Evaluation” on page 1–2 and AN 320: OpenCore Plus Evaluation of Megafunctions. Table 3–2 shows the 8B10B Encoder/Decoder function parameters, which can only be set in the MegaWizard Interface (see “Parameterize” on page 2–6). Table 3–2. 8B10B Encoder/Decoder Parameters Parameter Signals Value Mode of operation Encoder or Decoder Register inputs/outputs On for a three cycle latency. Off for a one-cycle latency. Tables 3–3 and 3–4 show the encoder and decoder signals. Table 3–3. Encoder Signals (Part 1 of 2) Signal Name Direction Description clk Input Clock. The input is latched, and the result is output on this clock. There is a one clock cycle latency between the input and output. reset_n Input Active low, reset. Asynchronously resets all registers in the MegaCore function. This signal should be deasserted synchronously to the rising edge of clk. kin Input Command byte indicator. When high, indicates that the input is a command byte, not a data byte. ena Input Enable encoder signal. When high, indicates that the data currently present on the datain input is to be encoded. 3–10 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007 Specifications Table 3–3. Encoder Signals (Part 2 of 2) Signal Name Direction Description idle_ins Input Idle character insert. When high, idle (K28.5) characters are inserted when ena is not asserted. datain[7:0] Input Data input. This is the 8-bit input word, data or command. rdin Input Running disparity input. When rdforce is high, the value on this pin is used as the current running disparity instead of the internally generated one. rdforce Input Force running disparity. When high, the rdin value overrides the internally generated running disparity. kerr Output Special K character error. This signal is set high when ena and kin are high and the value on datain is not a valid special K character. dataout[9:0] Output Data output. This is the 10-bit encoded output. valid Output Valid signal. When high, indicates that a valid encoded word is present on the dataout output. rdout Output Running disparity output. The current running disparity (after encoding the word present on the dataout output). rdcascade Output Cascaded running disparity. Used when encoders are cascaded. Table 3–4. Decoder Signals (Part 1 of 2) Signal Name Direction Description clk Input Clock. The input is latched, and the result output on this clock. There is a three clock cycle latency between the input and output. reset_n Input Active low, reset. Asynchronously resets all registers in the MegaCore function. This signal must be deasserted synchronously to the rising edge of clk. idle_del Input Idle delete signal. When high, idle words (K28.5) are removed from the stream (i.e. valid is set low when idle words are received). ena Input Enable decoder signal. When high, indicates that the data currently present on the datain input is to be decoded. datain[9:0] Input Data input. This is the 10-bit encoded input word. rdin Input Running disparity input. When rdforce is high, the value on this pin is used as the current running disparity instead of the internally generated one. rdforce Input Force running disparity. When high, the rdin value overrides the internally generated running disparity. Altera Corporation October 2007 MegaCore Version 7.2 3–11 8B10B Encoder/Decoder MegaCore Function User Guide Signals Table 3–4. Decoder Signals (Part 2 of 2) Signal Name valid Direction Output Description Valid signal. This signal is asserted when ena is asserted and new, nonidle data is present on dataout, even if it is the result of an illegal codeword. If an illegal codeword is received, kerr is also asserted. valid is also asserted for idle characters (K28.5) when ena is asserted and idle_del is not asserted. dataout[7:0] Output Data output. This is the 8-bit decoded data or command. kout Output Command output. When high, indicates that the output is a command byte, not a data byte. kerr Output Special K error. Asserted high when an invalid 10-bit word is received, or when a 10B_ERR character is received. rderr Output Running disparity error. When high indicates the running disparity rules have been violated. rdout Output Running disparity output. The current running disparity (after decoding the word present on the dataout output). rdcascade Output Cascaded running disparity. Used when decoders are cascaded. 3–12 MegaCore Version 7.2 8B10B Encoder/Decoder MegaCore Function User Guide Altera Corporation October 2007