Parameterizable Macros for Intel® FPGAs User Guide

Download PDF
ID 772350
Date 10/02/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. Answers to Top FAQs 2. Parameterizable Macros for Intel FPGAs Overview 3. Dual-Port Random Access Memory (RAM) Parameterizable Macros 4. FIFO Parameterizable Macros 5. I/O PLL Parameterizable Macros 6. CDC Parameterizable Macros 7. Document Revision History for the Parameterizable Macros for Intel FPGAs User Guide 8. Parameterizable Macros for Intel FPGAs User Guide Archives
2. Parameterizable Macros for Intel FPGAs Overview x
2.1. Available Parameterizable Macros for Intel FPGAs 2.2. Inserting HDL Code from Parameterizable Macro Templates
3. Dual-Port Random Access Memory (RAM) Parameterizable Macros x
3.1. Simple Dual-Port RAM Parameterizable Macro (simple_dual_port_ram) 3.2. True Dual-Port RAM Parameterizable Macro (true_dual_port_ram)
3.1. Simple Dual-Port RAM Parameterizable Macro (simple_dual_port_ram) x
3.1.1. Simple Dual-Port RAM Parameterizable Macro Port Descriptions 3.1.2. Simple Dual-Port RAM Parameterizable Macro Parameters 3.1.3. Simple Dual-Port RAM VHDL Instantiation Template 3.1.4. Simple Dual-Port RAM Verilog Instantiation Template 3.1.5. Simple Dual-Port RAM SystemVerilog Instantiation Template
3.2. True Dual-Port RAM Parameterizable Macro (true_dual_port_ram) x
3.2.1. True Dual-Port RAM Parameterizable Macro Port Descriptions 3.2.2. True Dual-Port RAM Parameterizable Macro Parameters 3.2.3. True Dual-Port RAM VHDL Instantiation Template 3.2.4. True Dual-Port RAM Verilog Instantiation Template 3.2.5. True Dual-Port RAM SystemVerilog Instantiation Template
4. FIFO Parameterizable Macros x
4.1. Synchronous FIFO Parameterizable Macro (sync_fifo) 4.2. Asynchronous FIFO Parameterizable Macro (async_fifo)
4.1. Synchronous FIFO Parameterizable Macro (sync_fifo) x
4.1.1. Synchronous FIFO Parameterizable Macro Port Descriptions 4.1.2. Synchronous FIFO Parameterizable Macro Parameters 4.1.3. Synchronous FIFO VHDL Instantiation Template 4.1.4. Synchronous FIFO Verilog Instantiation Template 4.1.5. Synchronous FIFO SystemVerilog Instantiation Template
4.2. Asynchronous FIFO Parameterizable Macro (async_fifo) x
4.2.1. Asynchronous FIFO Parameterizable Macro Port Descriptions 4.2.2. Asynchronous FIFO Parameterizable Macro Parameters 4.2.3. Asynchronous FIFO VHDL Instantiation Template 4.2.4. Asynchronous FIFO Verilog Instantiation Template 4.2.5. Asynchronous FIFO SystemVerilog Instantiation Template
5. I/O PLL Parameterizable Macros x
5.1. I/O PLL Parameterizable Macro Port Descriptions 5.2. I/O PLL Parameterizable Macro Parameters 5.3. Basic I/O PLL VHDL Instantiation Template 5.4. Basic I/O PLL Verilog Instantiation Template 5.5. Basic I/O PLL SystemVerilog Instantiation Template
6. CDC Parameterizable Macros x
6.1. Synchronous Reset Synchronizer Parameterizable Macro (ipm_cdc_sync_rst) 6.2. Asynchronous Reset Synchronizer Parameterizable Macro (ipm_cdc_async_rst) 6.3. Synchronizer Using Single Clock Parameterizable Macro (ipm_cdc_1clk_sync) 6.4. Synchronizer Using Two Clocks Parameterizable Macro (ipm_cdc_2clks_sync) 6.5. Glitchless Clock MUX Parameterizable Macro (ipm_cdc_glitchless_clk_mux) 6.6. Bus Synchronizer Parameterizable Macro (ipm_cdc_bus_sync)
6.1. Synchronous Reset Synchronizer Parameterizable Macro (ipm_cdc_sync_rst) x
6.1.1. Synchronous Reset Synchronizer Parameterizable Macro Port Descriptions 6.1.2. Synchronous Reset Synchronizer Parameterizable Macro Parameters 6.1.3. Synchronous Reset Synchronizer VHDL Instantiation Template 6.1.4. Synchronous Reset Synchronizer Verilog Instantiation Template 6.1.5. Synchronous Reset Synchronizer SystemVerilog Instantiation Template
6.2. Asynchronous Reset Synchronizer Parameterizable Macro (ipm_cdc_async_rst) x
6.2.1. Asynchronous Reset Synchronizer Parameterizable Macro Port Descriptions 6.2.2. Asynchronous Reset Synchronizer Parameterizable Macro Parameters 6.2.3. Asynchronous Reset Synchronizer VHDL Instantiation Template 6.2.4. Asynchronous Reset Synchronizer Verilog Instantiation Template 6.2.5. Asynchronous Reset Synchronizer SystemVerilog Instantiation Template
6.3. Synchronizer Using Single Clock Parameterizable Macro (ipm_cdc_1clk_sync) x
6.3.1. Synchronizer Using Single Clock Parameterizable Macro Port Descriptions 6.3.2. Synchronizer Using Single Clock Parameterizable Macro Parameters 6.3.3. Synchronizer Using Single Clock VHDL Instantiation Template 6.3.4. Synchronizer Using Single Clock Verilog Instantiation Template 6.3.5. Synchronizer Using Single Clock SystemVerilog Instantiation Template
6.4. Synchronizer Using Two Clocks Parameterizable Macro (ipm_cdc_2clks_sync) x
6.4.1. Synchronizer Using Two Clocks Parameterizable Macro Port Descriptions 6.4.2. Synchronizer Using Two Clocks Parameterizable Macro Parameters 6.4.3. Synchronizer Using Two Clocks VHDL Instantiation Template 6.4.4. Synchronizer Using Two Clocks Verilog Instantiation Template 6.4.5. Synchronizer Using Two Clocks SystemVerilog Instantiation Template
6.5. Glitchless Clock MUX Parameterizable Macro (ipm_cdc_glitchless_clk_mux) x
6.5.1. Glitchless Clock MUX Parameterizable Macro Port Descriptions 6.5.2. Glitchless Clock MUX Parameterizable Macro Parameters 6.5.3. Glitchless Clock MUX VHDL Instantiation Template 6.5.4. Glitchless Clock MUX Verilog Instantiation Template 6.5.5. Glitchless Clock MUX SystemVerilog Instantiation Template
6.6. Bus Synchronizer Parameterizable Macro (ipm_cdc_bus_sync) x
6.6.1. Bus Synchronizer Parameterizable Macro Port Descriptions 6.6.2. Bus Synchronizer Parameterizable Macro Parameters 6.6.3. Bus Synchronizer VHDL Instantiation Template 6.6.4. Bus Synchronizer Verilog Instantiation Template 6.6.5. Bus Synchronizer SystemVerilog Instantiation Template
1. Answers to Top FAQs
2. Parameterizable Macros for Intel FPGAs Overview
3. Dual-Port Random Access Memory (RAM) Parameterizable Macros
4. FIFO Parameterizable Macros
5. I/O PLL Parameterizable Macros
6. CDC Parameterizable Macros
7. Document Revision History for the Parameterizable Macros for Intel FPGAs User Guide
8. Parameterizable Macros for Intel FPGAs User Guide Archives

4.1.2. Synchronous FIFO Parameterizable Macro Parameters

Table 6.  SYNC_FIFO Parameterizable Macro Parameters
Parameter Allowed Values Description
DATA_WIDTH Device and ADDR_WIDTH dependent Specifies the width of the data and q ports. The default value is 8.
ADDR_WIDTH Device and DATA_WIDTH dependent Specifies the width of the usedw port. The default value is 11.
ENABLE_ACLR

ON

OFF

Specifies whether to set ENABLE_ACLR parameter ON or OFF. Asynchronous clear choice for data output of FIFO.
ENABLE_SCLR

ON

OFF

Specifies whether to ENABLE_SCLR parameter ON or OFF. Synchronous clear choice for data output of FIFO.
ENABLE_SHOWAHEAD

ON

OFF

Specifies whether the FIFO is in normal mode (OFF) or show-ahead mode (ON).

For normal mode, the FIFO treats the rdreq port as a normal read request that only performs read operation when the port is asserted.

For show-ahead mode, FIFO treats the rdreq port as a read-acknowledge that automatically outputs the first word of valid data in the FIFO (when the empty port is low) without asserting the rdreq signal. Asserting the rdreq signal causes the FIFO IP to output the next data word, if available.

Setting ON to this parameter may reduce performance.

MAXIMUM_DEPTH AUTO, 32, 64, 128, 256, 512, 1024, 2048 (default), 4096, 8192, 16384

Specifies the available slicing depth of the RAM slices.

OVERFLOW_CHECKING

ON

OFF

Specifies whether or not to enable the protection circuitry for overflow checking that disables the wrreq port when the FIFO is full. The values are ON or OFF. If omitted, the default is ON.
UNDERFLOW_CHECKING

ON

OFF

Specifies whether or not to enable the protection circuitry for underflow checking that disables the rdreq port when the FIFO is empty. The values are ON or OFF. If omitted, the default is ON.

Note that reading from an empty SCFIFO gives unpredictable results.

ADD_RAM_OUTPUT_REGISTER

ON

OFF

Specifies whether to register the q output. The values are ON and OFF. The default value is OFF.
ALMOST_FULL_VALUE 1 (default) Sets the threshold value for the almost_full port. When the number of words stored in the FIFO is greater than or equal to this value, the almost_full port is asserted.
ALMOST_EMPTY_VALUE 1 (default) Sets the threshold value for the almost_empty port. When the number of words stored in the FIFO is lesser than this value, the almost_empty port is asserted.
ALLOW_RWCYCLE_WHEN_FULL

ON

OFF

Allows you to combine read and write cycles to an already full SCFIFO, so that it remains full. The values are ON and OFF. The default is OFF. Use this parameter only when the OVERFLOW_CHECKING parameter is set to ON.
BYTE_SIZE

5

8 (default)

9

10

Specifies the size of the byte for byte-enable mode
BYTE_EN_WIDTH 1 (default)

Width of the byte-enable bus at Port A.

This width should be equal to DATA_WIDTH divided by BYTE_SIZE.

Note: The Intel Quartus Prime Pro Edition software version 23.2 includes the following parameter changes with respect to prior parameterizable macros versions. To avoid an error during compilation, you must update your RTL code accordingly:
  1. The parameter RAM_BLOCK_TYPE (AUTO, MLAB, M20K) is removed in Intel Quartus Prime Pro Edition software version 23.2.
  2. The parameter MAXIMUM_DEPTH allowed values are only AUTO, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, and 16384 in Intel Quartus Prime Pro Edition software version 23.2.
Level Two Title