Skip to content

Commit

Permalink
jesd204c_phy: guidelines fixes
Browse files Browse the repository at this point in the history 
Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
@gastmaier
gastmaier committed Aug 15, 2023
1 parent 2f459b0 commit 3744683
Show file tree
Hide file tree
Showing 6 changed files with 435 additions and 461 deletions.
356 changes: 170 additions & 186 deletions library/intel/jesd204c_phy/jesd204c_phy_adaptor_rx.v
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,37 @@
// ***************************************************************************
// ***************************************************************************
// Copyright 2023 (c) Analog Devices, Inc. All rights reserved.
//
// The ADI JESD204 Core is released under the following license, which is
// different than all other HDL cores in this repository.
// In this HDL repository, there are many different and unique modules, consisting
// of various HDL (Verilog or VHDL) components. The individual modules are
// developed independently, and may be accompanied by separate and unique license
// terms.
//
// Please read this, and understand the freedoms and responsibilities you have
// by using this source code/core.
// The user should read each of these license terms, and understand the
// freedoms and responsibilities that he or she has by using this source/core.
//
// The JESD204 HDL, is copyright © 2016-2017 Analog Devices Inc.
//
// This core is free software, you can use run, copy, study, change, ask
// questions about and improve this core. Distribution of source, or resulting
// binaries (including those inside an FPGA or ASIC) require you to release the
// source of the entire project (excluding the system libraries provide by the
// tools/compiler/FPGA vendor). These are the terms of the GNU General Public
// License version 2 as published by the Free Software Foundation.
//
// This core is distributed in the hope that it will be useful, but WITHOUT ANY
// This core is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
// A PARTICULAR PURPOSE.
//
// Redistribution and use of source or resulting binaries, with or without modification
// of this file, are permitted under one of the following two license terms:
//
// You should have received a copy of the GNU General Public License version 2
// along with this source code, and binary. If not, see
// <http://www.gnu.org/licenses/>.
// 1. The GNU General Public License version 2 as published by the
// Free Software Foundation, which can be found in the top level directory
// of this repository (LICENSE_GPL2), and also online at:
// <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
//
// Commercial licenses (with commercial support) of this JESD204 core are also
// available under terms different than the General Public License. (e.g. they
// do not require you to accompany any image (FPGA or ASIC) using the JESD204
// core with any corresponding source code.) For these alternate terms you must
// purchase a license from Analog Devices Technology Licensing Office. Users
// interested in such a license should contact [email protected] for
// more information. This commercial license is sub-licensable (if you purchase
// chips from Analog Devices, incorporate them into your PCB level product, and
// purchase a JESD204 license, end users of your product will also have a
// license to use this core in a commercial setting without releasing their
// source code).
// OR
//
// In addition, we kindly ask you to acknowledge ADI in any program, application
// or publication in which you use this JESD204 HDL core. (You are not required
// to do so; it is up to your common sense to decide whether you want to comply
// with this request or not.) For general publications, we suggest referencing :
// “The design and implementation of the JESD204 HDL Core used in this project
// is copyright © 2016-2017, Analog Devices, Inc.”
// 2. An ADI specific BSD license, which can be found in the top level directory
// of this repository (LICENSE_ADIBSD), and also on-line at:
// https://github.com/analogdevicesinc/hdl/blob/master/LICENSE_ADIBSD
// This will allow to generate bit files and not release the source code,
// as long as it attaches to an ADI device.
//
// ***************************************************************************
// ***************************************************************************

`timescale 1ns/100ps

Expand Down Expand Up @@ -71,165 +62,158 @@ module jesd204c_phy_adaptor_rx #(
output reg o_status_rate_mismatch = 'b0
);

wire i_valid;
wire [65:0] i_data;
wire i_slip_done;

wire [65:0] o_data;

assign i_valid = i_phy_data[68];
assign i_slip_done = i_phy_data[70];
assign i_data = {i_phy_data[66:40],i_phy_data[38:0]};

// shallow FIFO
parameter SIZE = 4;
localparam ADDR_WIDTH = $clog2(SIZE);

reg [ADDR_WIDTH:0] i_wr_addr = 'h00;
reg [ADDR_WIDTH:0] o_rd_addr = 'h00;
reg o_sha_disable = 1'b1;
reg o_ref_tag = 1'b0;

wire i_mem_wr_en;
wire o_rx_ready;
wire o_slip_done;

// write to memory when PHY is ready and link clock domain is
// also running achieved with two sync_bits
always @(posedge i_clk) begin
if (~i_phy_rx_ready) begin
i_wr_addr <= 'h00;
end else if (i_mem_wr_en & i_valid) begin
i_wr_addr <= i_wr_addr + 1'b1;
wire i_valid;
wire [65:0] i_data;
wire i_slip_done;

wire [65:0] o_data;

assign i_valid = i_phy_data[68];
assign i_slip_done = i_phy_data[70];
assign i_data = {i_phy_data[66:40],i_phy_data[38:0]};

// shallow FIFO
parameter SIZE = 4;
localparam ADDR_WIDTH = $clog2(SIZE);

reg [ADDR_WIDTH:0] i_wr_addr = 'h00;
reg [ADDR_WIDTH:0] o_rd_addr = 'h00;
reg o_sha_disable = 1'b1;
reg o_ref_tag = 1'b0;

wire i_mem_wr_en;
wire o_rx_ready;
wire o_slip_done;

// write to memory when PHY is ready and link clock domain is
// also running achieved with two sync_bits
always @(posedge i_clk) begin
if (~i_phy_rx_ready) begin
i_wr_addr <= 'h00;
end else if (i_mem_wr_en & i_valid) begin
i_wr_addr <= i_wr_addr + 1'b1;
end
end
end

sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_rx_ready_cdc (
.in_bits(i_phy_rx_ready),
.out_clk(o_clk),
.out_resetn(1'b1),
.out_bits(o_rx_ready)
);

sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_rx_ready_back_cdc (
.in_bits(o_rx_ready),
.out_clk(i_clk),
.out_resetn(1'b1),
.out_bits(i_mem_wr_en)
);

ad_mem #(
.DATA_WIDTH (2+66),
.ADDRESS_WIDTH (ADDR_WIDTH)
) i_ad_mem (
.clka(i_clk),
.wea(i_mem_wr_en & i_valid),
.addra(i_wr_addr[ADDR_WIDTH-1:0]),
.dina({i_slip_done,i_wr_addr[ADDR_WIDTH],i_data}),

.clkb(o_clk),
.reb(1'b1),
.addrb(o_rd_addr[ADDR_WIDTH-1:0]),
.doutb({o_slip_done,o_tag,o_data})
);

// When at least one element is written into the memory read can start
sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_i_mem_wr_en_cdc (
.in_bits(i_mem_wr_en),
.out_clk(o_clk),
.out_resetn(o_rx_ready),
.out_bits(o_mem_rd)
);

always @(posedge o_clk) begin
if (~o_rx_ready) begin
o_rd_addr <= 'h00;
o_sha_disable <= 1'b1;
o_ref_tag <= 1'b0;
end else if (o_mem_rd) begin
o_rd_addr <= o_rd_addr + 1'b1;
o_sha_disable <= 1'b0;
o_ref_tag <= o_rd_addr[ADDR_WIDTH];
sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_rx_ready_cdc (
.in_bits(i_phy_rx_ready),
.out_clk(o_clk),
.out_resetn(1'b1),
.out_bits(o_rx_ready));

sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_rx_ready_back_cdc (
.in_bits(o_rx_ready),
.out_clk(i_clk),
.out_resetn(1'b1),
.out_bits(i_mem_wr_en));

ad_mem #(
.DATA_WIDTH (2+66),
.ADDRESS_WIDTH (ADDR_WIDTH)
) i_ad_mem (
.clka(i_clk),
.wea(i_mem_wr_en & i_valid),
.addra(i_wr_addr[ADDR_WIDTH-1:0]),
.dina({i_slip_done,i_wr_addr[ADDR_WIDTH],i_data}),
.clkb(o_clk),
.reb(1'b1),
.addrb(o_rd_addr[ADDR_WIDTH-1:0]),
.doutb({o_slip_done,o_tag,o_data}));

// When at least one element is written into the memory read can start
sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_i_mem_wr_en_cdc (
.in_bits(i_mem_wr_en),
.out_clk(o_clk),
.out_resetn(o_rx_ready),
.out_bits(o_mem_rd));

always @(posedge o_clk) begin
if (~o_rx_ready) begin
o_rd_addr <= 'h00;
o_sha_disable <= 1'b1;
o_ref_tag <= 1'b0;
end else if (o_mem_rd) begin
o_rd_addr <= o_rd_addr + 1'b1;
o_sha_disable <= 1'b0;
o_ref_tag <= o_rd_addr[ADDR_WIDTH];
end
end
end

// Detect overflow or underflow by checking reference tag against received
// one over the memory
always @(posedge o_clk) begin
if (~o_rx_ready) begin
o_status_rate_mismatch <= 1'b0;
end else if (o_tag ^ o_ref_tag) begin
o_status_rate_mismatch <= 1'b1;

// Detect overflow or underflow by checking reference tag against received
// one over the memory
always @(posedge o_clk) begin
if (~o_rx_ready) begin
o_status_rate_mismatch <= 1'b0;
end else if (o_tag ^ o_ref_tag) begin
o_status_rate_mismatch <= 1'b1;
end
end
end

wire o_slip_done_edge;
reg o_slip_done_d = 1'b0;
reg o_slip_done_2d = 1'b0;
reg o_slip_done_3d = 1'b0;
always @(posedge o_clk) begin
o_slip_done_d <= o_slip_done;
o_slip_done_2d <= o_slip_done_d;
o_slip_done_3d <= o_slip_done_2d;
end

// Slip is done actually two clock cycle after the falling edge of
// parallel_data[70]
assign o_slip_done_edge = ~o_slip_done_2d & o_slip_done_3d;

wire o_slip_req;
wire i_slip_req;

// Sync slip request
sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_slip_req_cdc (
.in_bits(o_slip_req),
.out_clk(i_clk),
.out_resetn(~i_slip_done),
.out_bits(i_slip_req)
);

reg [6:0] bitslip_quiet_cnt = 7'h40;
wire o_slip_done_edge;
reg o_slip_done_d = 1'b0;
reg o_slip_done_2d = 1'b0;
reg o_slip_done_3d = 1'b0;
always @(posedge o_clk) begin
o_slip_done_d <= o_slip_done;
o_slip_done_2d <= o_slip_done_d;
o_slip_done_3d <= o_slip_done_2d;
end

// Avoid asserting bitslip faster than 64 clock cycles from the assertion of
// bitslip done
always @(posedge i_clk) begin
if (i_slip_req & bitslip_quiet_cnt[6]) begin
i_phy_bitslip <= 1'b1;
end else if (i_slip_done) begin
i_phy_bitslip <= 1'b0;
// Slip is done actually two clock cycle after the falling edge of
// parallel_data[70]
assign o_slip_done_edge = ~o_slip_done_2d & o_slip_done_3d;

wire o_slip_req;
wire i_slip_req;

// Sync slip request
sync_bits #(
.NUM_OF_BITS (1),
.ASYNC_CLK (1)
) i_slip_req_cdc (
.in_bits(o_slip_req),
.out_clk(i_clk),
.out_resetn(~i_slip_done),
.out_bits(i_slip_req));

reg [6:0] bitslip_quiet_cnt = 7'h40;

// Avoid asserting bitslip faster than 64 clock cycles from the assertion of
// bitslip done
always @(posedge i_clk) begin
if (i_slip_req & bitslip_quiet_cnt[6]) begin
i_phy_bitslip <= 1'b1;
end else if (i_slip_done) begin
i_phy_bitslip <= 1'b0;
end
end
end

always @(posedge i_clk) begin
if (i_slip_done) begin
bitslip_quiet_cnt <= 7'b0;
end else if (~bitslip_quiet_cnt[6]) begin
bitslip_quiet_cnt <= bitslip_quiet_cnt + 7'b1;
always @(posedge i_clk) begin
if (i_slip_done) begin
bitslip_quiet_cnt <= 7'b0;
end else if (~bitslip_quiet_cnt[6]) begin
bitslip_quiet_cnt <= bitslip_quiet_cnt + 7'b1;
end
end
end

// Sync header alignment
sync_header_align i_sync_header_align (
.clk(o_clk),
.reset(o_sha_disable),
.i_data(o_data),
.i_slip(o_slip_req),
.i_slip_done(o_slip_done_edge),
.o_data(o_phy_data),
.o_header(o_phy_header),
.o_block_sync(o_phy_block_sync)
);

// Sync header alignment
sync_header_align i_sync_header_align (
.clk(o_clk),
.reset(o_sha_disable),
.i_data(o_data),
.i_slip(o_slip_req),
.i_slip_done(o_slip_done_edge),
.o_data(o_phy_data),
.o_header(o_phy_header),
.o_block_sync(o_phy_block_sync));

endmodule
Loading

0 comments on commit 3744683

Please sign in to comment.