XPM_CDC_SINGLE - XPM_CDC_SINGLE - 2026.1 English - Parameterized Macro: Single-bit Synchronizer - UG1485

Versal Architecture Premium Series Libaries Guide (UG1485)

Document ID
UG1485
Release Date
2026-06-23
Version
2026.1 English

Parameterized Macro: Single-bit Synchronizer

  • MACRO_GROUP: XPM
  • MACRO_SUBGROUP: XPM_CDC
Page-1 Sheet.1 XPM_CDC_SINGLE XPM_CDC_SINGLE Text Line.108 src_in src_in Text Line.25 dest_out dest_out Text Line.9 dest_clk dest_clk Text Line.16 src_clk src_clk Sheet.6 Sheet.7 Sheet.8 X15896-031116 Sheet.9 Sheet.10 Sheet.11 X15896-061319

Introduction

This macro synchronizes a one-bit signal from the source clock domain to the destination clock domain.

For proper operation, the destination clock must sample the input data two or more times. You can define the number of register stages that the synchronizers use. An optional input register can register the input in the source clock domain before synchronization. You can also enable a simulation feature to generate messages that report any potential misuse of the macro.

Port Descriptions

Port Direction Width Domain Sense Handling if Unused Function
dest_clk Input 1 NA EDGE_RISING Active Clock signal for the destination clock domain.
dest_out Output 1 dest_clk NA Active This registered output synchronizes src_in to the destination clock domain.
src_clk Input 1 NA EDGE_RISING 0

Input clock signal for src_in if SRC_INPUT_REG = 1.

Unused when SRC_INPUT_REG = 0.

src_in Input 1 src_clk NA Active Input signal to synchronize to dest_clk domain.

Design Entry Method

Instantiation Yes
Inference No
IP and IP Integrator Catalog No

Available Attributes

Attribute Type Allowed Values Default Description
DEST_SYNC_FF DECIMAL 2 to 10 4 This parameter sets the number of register stages that synchronize the signal in the destination clock domain.
INIT_SYNC_FF DECIMAL 0, 1 0

0: Disable behavioral simulation initialization values on synchronization registers.

1: Enable behavioral simulation initialization values on synchronization registers.

SIM_ASSERT_CHK DECIMAL 0, 1 0

0: Disable simulation message reporting. This does not report messages related to potential misuse.

1: Enable simulation message reporting. This reports messages related to potential misuse.

SRC_INPUT_REG DECIMAL 1, 0 1

0: Do not register input (src_in)

1: Register input (src_in) after using src_clk

VHDL Instantiation Template

Unless they already exist, copy the following two statements and paste them before the entity declaration.
Library xpm;
use xpm.vcomponents.all;

-- xpm_cdc_single: Single-bit Synchronizer
-- Xilinx Parameterized Macro, version 2026.1

xpm_cdc_single_inst : xpm_cdc_single
generic map (
   DEST_SYNC_FF => 4,   -- DECIMAL; range: 2-10
   INIT_SYNC_FF => 0,   -- DECIMAL; 0=disable simulation init values, 1=enable simulation init values
   SIM_ASSERT_CHK => 0, -- DECIMAL; 0=disable simulation messages, 1=enable simulation messages
   SRC_INPUT_REG => 1   -- DECIMAL; 0=do not register input, 1=register input
)
port map (
   src_clk => src_clk, -- 1-bit input: Optional; required when SRC_INPUT_REG = 1
   src_in => src_in, -- 1-bit input: Input signal to synchronize to dest_clk domain.
   dest_clk => dest_clk, -- 1-bit input: Clock signal for the destination clock domain.
   dest_out => dest_out -- 1-bit output: This registered output synchronizes src_in to the destination clock domain.
);

-- End of xpm_cdc_single_inst instantiation

Verilog Instantiation Template


// xpm_cdc_single: Single-bit Synchronizer
// Xilinx Parameterized Macro, version 2026.1

xpm_cdc_single #(
   .DEST_SYNC_FF(4),   // DECIMAL; range: 2-10
   .INIT_SYNC_FF(0),   // DECIMAL; 0=disable simulation init values, 1=enable simulation init values
   .SIM_ASSERT_CHK(0), // DECIMAL; 0=disable simulation messages, 1=enable simulation messages
   .SRC_INPUT_REG(1)   // DECIMAL; 0=do not register input, 1=register input
)
xpm_cdc_single_inst (
   .src_clk(src_clk), // 1-bit input: Optional; required when SRC_INPUT_REG = 1
   .src_in(src_in), // 1-bit input: Input signal to synchronize to dest_clk domain.
   .dest_clk(dest_clk), // 1-bit input: Clock signal for the destination clock domain.
   .dest_out(dest_out) // 1-bit output: This registered output synchronizes src_in to the destination clock domain.
);

// End of xpm_cdc_single_inst instantiation

Related Information