Compare commits

..

35 Commits

Author SHA1 Message Date
3c13e3289a Merge branch 'new_structure' 2026-03-02 19:38:21 +01:00
4e3521e94a Added missing signal modules 2026-03-02 19:28:36 +01:00
50f71a2985 Added new master checker and changed to synchronous reset checks 2026-03-02 18:02:47 +01:00
628972ccaa New slave checker and updated gpio and gpio_banks 2026-03-02 13:48:30 +01:00
a6a5c6ea3f Made timer synthesizable 2026-03-01 21:11:08 +01:00
5b940758b6 Added formal verification set to timer internally 2026-03-01 21:00:57 +01:00
105dbed8e4 Added back in the jtag bridge
Now talking over the bus instead of using dpram
2026-02-27 17:39:43 +01:00
6f680377db jtag memory selectable 2026-02-27 16:09:33 +01:00
3a9b2acf9e New wishbone-jtag bridge 2026-02-27 15:56:56 +01:00
838204653a TImer working with tests
TODO: think of other way of shifting in data. Bit errors make uploading difficult
2026-02-25 22:01:28 +01:00
3a3c951409 Added timer, still wip 2026-02-25 20:54:12 +01:00
f2f9644830 Added qerv files 2026-02-25 20:52:07 +01:00
13f72e698f jtag memory interface working 2026-02-25 16:14:37 +01:00
9930ce4461 Working CPP way of writing data 2026-02-24 16:40:17 +01:00
8f4e887b9d Added JTAG interface with testbench 2026-02-23 15:37:49 +01:00
20cfece6e3 Added soclet with gpio banks to top 2026-02-22 20:00:42 +01:00
a97028c2ba cleanup 2026-02-22 18:49:03 +01:00
5e951f9b61 Working SERV cpu 2026-02-22 18:48:17 +01:00
ac6aea90b6 Merge branch 'master' of ssh://git.joppeb.nl:222/joppe/fpga_modem 2026-02-22 16:07:34 +01:00
dc946cd793 Moved serv to own tree 2026-02-22 16:03:21 +01:00
a261264fda Added serv and made a blinky testbench for it 2026-02-21 19:24:18 +01:00
Joppe Blondel
49b8a77480 Combined all sigmadelta things to one input block 2025-10-19 20:03:51 +02:00
Joppe Blondel
165faefa59 Added decimation 2025-10-19 17:26:09 +02:00
Joppe Blondel
771fa58769 Added K IIR lpf filter 2025-10-19 17:02:29 +02:00
Joppe Blondel
b2858ac5ee Added mul tb and fixed 2025-10-19 16:18:40 +02:00
Joppe Blondel
eb7caaf2c5 Added PLL/clock generator and SD RC model 2025-10-19 15:36:55 +02:00
Joppe Blondel
3b04f3a6be Added lvds and sampler 2025-10-08 18:01:03 +02:00
Jojojoppe
324bb108e3 Added planahead script and fixed conversion 2025-10-06 16:49:28 +02:00
Jojojoppe
06ef70e1ee Improved NCO: 200MHz 2025-10-06 16:25:40 +02:00
Jojojoppe
1e9d7b7680 Got rid of ftw_we and tested on hw with freq sweep 2025-10-05 23:42:51 +02:00
Jojojoppe
83cc449c6f Using remotesyn and added NCO 2025-10-05 23:20:25 +02:00
Jojojoppe
639541728f Added decimator 2025-10-01 21:52:21 +02:00
Jojojoppe
e0151d093f Added sampler and RC model 2025-10-01 21:15:20 +02:00
Jojojoppe
ee58fccba4 Added pll to simulation 2025-10-01 17:24:53 +02:00
Jojojoppe
42e9bd0a0a initial commit 2025-10-01 16:40:05 +02:00
38 changed files with 1432 additions and 398 deletions

View File

@@ -55,7 +55,7 @@ $label"
$label" $label"
printf 'Result: FAIL (%s)\n' "$label" printf 'Result: FAIL (%s)\n' "$label"
printf 'Captured log for %s:\n' "$label" printf 'Captured log for %s:\n' "$label"
cat "$log_file" | grep summary cat "$log_file" #| grep summary
rm -f "$log_file" rm -f "$log_file"
return 1 return 1
fi fi

View File

@@ -0,0 +1,26 @@
CAPI=2:
name: joppeb:primitive:lvds_comparator:1.0
description: LVDS comparator wrapper
filesets:
wrapper:
files:
- lvds_comparator.v
file_type: verilogSource
generic:
files:
- lvds_comparator_generic_impl.v
file_type: verilogSource
spartan6:
files:
- lvds_comparator_spartan6.v
file_type: verilogSource
targets:
default:
filesets:
- wrapper
- generic
- spartan6
toplevel: lvds_comparator

View File

@@ -0,0 +1,19 @@
module lvds_comparator(
input wire a,
input wire b,
output wire o
);
`ifdef FPGA_SPARTAN6
lvds_comparator_spartan6_impl impl_i (
.a(a),
.b(b),
.o(o)
);
`else
lvds_comparator_generic_impl impl_i (
.a(a),
.b(b),
.o(o)
);
`endif
endmodule

View File

@@ -0,0 +1,7 @@
module lvds_comparator_generic_impl (
input wire a,
input wire b,
output wire o
);
assign o = a;
endmodule

View File

@@ -0,0 +1,14 @@
module lvds_comparator_spartan6_impl (
input wire a,
input wire b,
output wire o
);
IBUFDS #(
.DIFF_TERM("FALSE"),
.IOSTANDARD("LVDS33")
) lvds_buf (
.O(o),
.I(a),
.IB(b)
);
endmodule

View File

@@ -0,0 +1,29 @@
CAPI=2:
name: joppeb:signal:decimate_by_r_q15:1.0
description: Q1.15 integer-rate decimator
filesets:
rtl:
files:
- decimate_by_r_q15.v
file_type: verilogSource
targets:
default:
filesets:
- rtl
toplevel: decimate_by_r_q15
parameters:
- R
- CNT_W
parameters:
R:
datatype: int
description: Integer decimation ratio
paramtype: vlogparam
CNT_W:
datatype: int
description: Counter width for the decimation counter
paramtype: vlogparam

View File

@@ -0,0 +1,74 @@
`timescale 1ns/1ps
// =============================================================================
// Decimator by R
// Reduces the effective sample rate by an integer factor R by selecting every
// R-th input sample. Generates a one-cycle 'o_valid' pulse each time a new
// decimated sample is produced.
//
// Implements:
// For each valid input sample:
// if (count == R-1):
// count <= 0
// o_q15 <= i_q15
// o_valid <= 1
// else:
// count <= count + 1
//
// parameters:
// -- R : integer decimation factor (e.g., 400)
// output sample rate = input rate / R
// -- CNT_W : counter bit width, must satisfy 2^CNT_W > R
//
// inout:
// -- i_clk : input clock (same rate as 'i_valid')
// -- i_rst_n : active-low synchronous reset
// -- i_valid : input data strobe; assert 1'b1 if input is always valid
// -- i_q15 : signed 16-bit Q1.15 input sample (full-rate)
// -- o_valid : single-cycle pulse every R samples (decimated rate strobe)
// -- o_q15 : signed 16-bit Q1.15 output sample (decimated stream)
//
// Notes:
// - This module performs *pure downsampling* (sample selection only).
// It does not include any anti-alias filtering; high-frequency content
// above the new Nyquist limit (Fs_out / 2) will alias into the baseband.
// - For most applications, an anti-alias low-pass filter such as
// lpf_iir_q15 or a FIR stage should precede this decimator.
// - The output sample rate is given by:
// Fs_out = Fs_in / R
// - Typical usage: interface between high-rate sigma-delta or oversampled
// data streams and lower-rate processing stages.
// =============================================================================
module decimate_by_r_q15 #(
parameter integer R = 400, // decimation factor
parameter integer CNT_W = 10 // width so that 2^CNT_W > R (e.g., 10 for 750)
)(
input wire i_clk,
input wire i_rst_n,
input wire i_valid, // assert 1'b1 if always valid
input wire signed [15:0] i_q15, // Q1.15 sample at full rate
output reg o_valid, // 1-cycle pulse every R samples
output reg signed [15:0] o_q15 // Q1.15 sample at decimated rate
);
reg [CNT_W-1:0] cnt;
always @(posedge i_clk or negedge i_rst_n) begin
if (!i_rst_n) begin
cnt <= {CNT_W{1'b0}};
o_valid <= 1'b0;
o_q15 <= 16'sd0;
end else begin
o_valid <= 1'b0;
if (i_valid) begin
if (cnt == R-1) begin
cnt <= {CNT_W{1'b0}};
o_q15 <= i_q15;
o_valid <= 1'b1;
end else begin
cnt <= cnt + 1'b1;
end
end
end
end
endmodule

View File

@@ -0,0 +1,24 @@
CAPI=2:
name: joppeb:signal:lpf_iir_q15_k:1.0
description: First-order Q1.15 IIR low-pass filter
filesets:
rtl:
files:
- lpf_iir_q15_k.v
file_type: verilogSource
targets:
default:
filesets:
- rtl
toplevel: lpf_iir_q15_k
parameters:
- K
parameters:
K:
datatype: int
description: Filter shift factor
paramtype: vlogparam

View File

@@ -0,0 +1,64 @@
`timescale 1ns/1ps
// =============================================================================
// Low-Pass IIR Filter (Q1.15)
// Simple first-order infinite impulse response filter, equivalent to an
// exponential moving average. Provides an adjustable smoothing factor based
// on parameter K.
//
// Implements:
// Y[n+1] = Y[n] + (X[n] - Y[n]) / 2^K
//
// This is a purely digital one-pole low-pass filter whose time constant
// approximates that of an analog RC filter, where alpha = 1 / 2^K.
//
// The larger K is, the slower the filter responds (stronger smoothing).
// The smaller K is, the faster it reacts to changes.
//
// parameters:
// -- K : filter shift factor (integer, 4..14 typical)
// cutoff frequency Fs / ( * 2^K)
// larger K lower cutoff
//
// inout:
// -- i_clk : input clock
// -- i_rst_n : active-low reset
// -- i_x_q15 : signed 16-bit Q1.15 input sample (e.g., 0..0x7FFF)
// -- o_y_q15 : signed 16-bit Q1.15 filtered output
//
// Notes:
// - The arithmetic right shift implements division by 2^K.
// - Internal arithmetic is Q1.15 fixed-point with saturation
// to [0, 0x7FFF] (for non-negative signals).
// - Useful for smoothing noisy ADC / sigma-delta data streams
// or modeling an RC envelope follower.
// =============================================================================
module lpf_iir_q15_k #(
parameter integer K = 10 // try 8..12; bigger = more smoothing
)(
input wire i_clk,
input wire i_rst_n,
input wire signed [15:0] i_x_q15, // Q1.15 input (e.g., 0..0x7FFF)
output reg signed [15:0] o_y_q15 // Q1.15 output
);
wire signed [15:0] e_q15 = i_x_q15 - o_y_q15;
wire signed [15:0] delta_q15 = e_q15 >>> K; // arithmetic shift
wire signed [15:0] y_next = o_y_q15 + delta_q15; // clamp to [0, 0x7FFF] (handy if your signal is non-negative)
function signed [15:0] clamp01;
input signed [15:0] v;
begin
if (v < 16'sd0)
clamp01 = 16'sd0;
else if (v > 16'sh7FFF)
clamp01 = 16'sh7FFF;
else
clamp01 = v;
end
endfunction
always @(posedge i_clk or negedge i_rst_n) begin
if (!i_rst_n) o_y_q15 <= 16'sd0;
else o_y_q15 <= clamp01(y_next);
end
endmodule

View File

@@ -8,23 +8,23 @@
// -- CLK_HZ : input clock frequency in Hz // -- CLK_HZ : input clock frequency in Hz
// -- FS_HZ : output sample frequency in Hz // -- FS_HZ : output sample frequency in Hz
// inout: // inout:
// -- clk : input clock // -- i_clk : input clock
// -- rst_n : reset // -- i_rst_n : reset
// -- freq_hz : decimal number of desired generated frequency in Hz, 0-FS/2 // -- i_freq_hz : decimal number of desired generated frequency in Hz, 0-FS/2
// -- sin_q15/cos_q15 : I and Q outputs // -- o_sin_q15/o_cos_q15 : I and Q outputs
// -- clk_en : output valid strobe // -- o_clk_en : output valid strobe
// ============================================================================= // =============================================================================
module nco_q15 #( module nco_q15 #(
parameter integer CLK_HZ = 120_000_000, // input clock parameter integer CLK_HZ = 120_000_000, // input clock
parameter integer FS_HZ = 40_000 // sample rate parameter integer FS_HZ = 40_000 // sample rate
)( )(
input wire clk, // CLK_HZ domain input wire i_clk, // CLK_HZ domain
input wire rst_n, // async active-low reset input wire i_rst_n, // async active-low reset
input wire [31:0] freq_hz, // desired output frequency (Hz), 0..FS_HZ/2 input wire [31:0] i_freq_hz, // desired output frequency (Hz), 0..FS_HZ/2
output reg signed [15:0] sin_q15, // Q1.15 sine output reg signed [15:0] o_sin_q15, // Q1.15 sine
output reg signed [15:0] cos_q15, // Q1.15 cosine output reg signed [15:0] o_cos_q15, // Q1.15 cosine
output reg clk_en // 1-cycle strobe @ FS_HZ output reg o_clk_en // 1-cycle strobe @ FS_HZ
); );
localparam integer PHASE_FRAC_BITS = 6; localparam integer PHASE_FRAC_BITS = 6;
localparam integer QTR_ADDR_BITS = 6; localparam integer QTR_ADDR_BITS = 6;
@@ -41,17 +41,17 @@ module nco_q15 #(
endfunction endfunction
reg [clog2(DIV)-1:0] tick_cnt; reg [clog2(DIV)-1:0] tick_cnt;
always @(posedge clk or negedge rst_n) begin always @(posedge i_clk or negedge i_rst_n) begin
if (!rst_n) begin tick_cnt <= 0; clk_en <= 1'b0; end if (!i_rst_n) begin tick_cnt <= 0; o_clk_en <= 1'b0; end
else begin else begin
clk_en <= 1'b0; o_clk_en <= 1'b0;
if (tick_cnt == DIV-1) begin tick_cnt <= 0; clk_en <= 1'b1; end if (tick_cnt == DIV-1) begin tick_cnt <= 0; o_clk_en <= 1'b1; end
else tick_cnt <= tick_cnt + 1'b1; else tick_cnt <= tick_cnt + 1'b1;
end end
end end
// 32-cycle shift-add multiply: prod = freq_hz * RECIP (no multiplications themself) // 32-cycle shift-add multiply: prod = i_freq_hz * RECIP (no multiplications themself)
// Starts at clk_en, finishes in 32 cycles (<< available cycles per sample). // Starts at o_clk_en, finishes in 32 cycles (<< available cycles per sample).
reg mul_busy; reg mul_busy;
reg [5:0] mul_i; // 0..31 reg [5:0] mul_i; // 0..31
reg [31:0] f_reg; reg [31:0] f_reg;
@@ -59,15 +59,15 @@ module nco_q15 #(
wire [95:0] recip_shift = {{32{1'b0}}, RECIP} << mul_i; // shift constant by i wire [95:0] recip_shift = {{32{1'b0}}, RECIP} << mul_i; // shift constant by i
always @(posedge clk or negedge rst_n) begin always @(posedge i_clk or negedge i_rst_n) begin
if (!rst_n) begin if (!i_rst_n) begin
mul_busy <= 1'b0; mul_i <= 6'd0; f_reg <= 32'd0; acc <= 96'd0; mul_busy <= 1'b0; mul_i <= 6'd0; f_reg <= 32'd0; acc <= 96'd0;
end else begin end else begin
if (clk_en && !mul_busy) begin if (o_clk_en && !mul_busy) begin
// kick off a new multiply this sample // kick off a new multiply this sample
mul_busy <= 1'b1; mul_busy <= 1'b1;
mul_i <= 6'd0; mul_i <= 6'd0;
f_reg <= (freq_hz > (FS_HZ>>1)) ? (FS_HZ>>1) : freq_hz; // clamp to Nyquist f_reg <= (i_freq_hz > (FS_HZ>>1)) ? (FS_HZ>>1) : i_freq_hz; // clamp to Nyquist
acc <= 96'd0; acc <= 96'd0;
end else if (mul_busy) begin end else if (mul_busy) begin
// add shifted RECIP if bit is set // add shifted RECIP if bit is set
@@ -86,16 +86,16 @@ module nco_q15 #(
wire [95:0] acc_round = acc + (96'd1 << (SHIFT-1)); wire [95:0] acc_round = acc + (96'd1 << (SHIFT-1));
wire [PHASE_BITS-1:0] ftw_next = acc_round[SHIFT +: PHASE_BITS]; // >> SHIFT wire [PHASE_BITS-1:0] ftw_next = acc_round[SHIFT +: PHASE_BITS]; // >> SHIFT
always @(posedge clk or negedge rst_n) begin always @(posedge i_clk or negedge i_rst_n) begin
if (!rst_n) ftw_q <= {PHASE_BITS{1'b0}}; if (!i_rst_n) ftw_q <= {PHASE_BITS{1'b0}};
else if (!mul_busy) ftw_q <= ftw_next; // update once product ready else if (!mul_busy) ftw_q <= ftw_next; // update once product ready
end end
// Phase accumulator (advance at FS_HZ) // Phase accumulator (advance at FS_HZ)
reg [PHASE_BITS-1:0] phase; reg [PHASE_BITS-1:0] phase;
always @(posedge clk or negedge rst_n) begin always @(posedge i_clk or negedge i_rst_n) begin
if (!rst_n) phase <= {PHASE_BITS{1'b0}}; if (!i_rst_n) phase <= {PHASE_BITS{1'b0}};
else if (clk_en) phase <= phase + ftw_q; else if (o_clk_en) phase <= phase + ftw_q;
end end
// Cosine phase = sine phase + 90° // Cosine phase = sine phase + 90°
@@ -113,8 +113,8 @@ module nco_q15 #(
// 64-entry quarter-wave LUT // 64-entry quarter-wave LUT
wire [7:0] mag_sin_u8, mag_cos_u8; wire [7:0] mag_sin_u8, mag_cos_u8;
sine_qtr_lut64 u_lut_s (.addr(idx_sin), .dout(mag_sin_u8)); sine_qtr_lut64 u_lut_s (.i_addr(idx_sin), .o_dout(mag_sin_u8));
sine_qtr_lut64 u_lut_c (.addr(idx_cos), .dout(mag_cos_u8)); sine_qtr_lut64 u_lut_c (.i_addr(idx_cos), .o_dout(mag_cos_u8));
// Scale to Q1.15 and apply sign // Scale to Q1.15 and apply sign
wire signed [15:0] mag_sin_q15 = {1'b0, mag_sin_u8, 7'd0}; wire signed [15:0] mag_sin_q15 = {1'b0, mag_sin_u8, 7'd0};
@@ -125,39 +125,39 @@ module nco_q15 #(
wire signed [15:0] sin_next = sin_neg ? -mag_sin_q15 : mag_sin_q15; wire signed [15:0] sin_next = sin_neg ? -mag_sin_q15 : mag_sin_q15;
wire signed [15:0] cos_next = cos_neg ? -mag_cos_q15 : mag_cos_q15; wire signed [15:0] cos_next = cos_neg ? -mag_cos_q15 : mag_cos_q15;
always @(posedge clk or negedge rst_n) begin always @(posedge i_clk or negedge i_rst_n) begin
if (!rst_n) begin if (!i_rst_n) begin
sin_q15 <= 16'sd0; cos_q15 <= 16'sd0; o_sin_q15 <= 16'sd0; o_cos_q15 <= 16'sd0;
end else if (clk_en) begin end else if (o_clk_en) begin
sin_q15 <= sin_next; cos_q15 <= cos_next; o_sin_q15 <= sin_next; o_cos_q15 <= cos_next;
end end
end end
endmodule endmodule
module sine_qtr_lut64( module sine_qtr_lut64(
input wire [5:0] addr, input wire [5:0] i_addr,
output reg [7:0] dout output reg [7:0] o_dout
); );
always @* begin always @* begin
case (addr) case (i_addr)
6'd0: dout = 8'd0; 6'd1: dout = 8'd6; 6'd2: dout = 8'd13; 6'd3: dout = 8'd19; 6'd0: o_dout = 8'd0; 6'd1: o_dout = 8'd6; 6'd2: o_dout = 8'd13; 6'd3: o_dout = 8'd19;
6'd4: dout = 8'd25; 6'd5: dout = 8'd31; 6'd6: dout = 8'd37; 6'd7: dout = 8'd44; 6'd4: o_dout = 8'd25; 6'd5: o_dout = 8'd31; 6'd6: o_dout = 8'd37; 6'd7: o_dout = 8'd44;
6'd8: dout = 8'd50; 6'd9: dout = 8'd56; 6'd10: dout = 8'd62; 6'd11: dout = 8'd68; 6'd8: o_dout = 8'd50; 6'd9: o_dout = 8'd56; 6'd10: o_dout = 8'd62; 6'd11: o_dout = 8'd68;
6'd12: dout = 8'd74; 6'd13: dout = 8'd80; 6'd14: dout = 8'd86; 6'd15: dout = 8'd92; 6'd12: o_dout = 8'd74; 6'd13: o_dout = 8'd80; 6'd14: o_dout = 8'd86; 6'd15: o_dout = 8'd92;
6'd16: dout = 8'd98; 6'd17: dout = 8'd103; 6'd18: dout = 8'd109; 6'd19: dout = 8'd115; 6'd16: o_dout = 8'd98; 6'd17: o_dout = 8'd103; 6'd18: o_dout = 8'd109; 6'd19: o_dout = 8'd115;
6'd20: dout = 8'd120; 6'd21: dout = 8'd126; 6'd22: dout = 8'd131; 6'd23: dout = 8'd136; 6'd20: o_dout = 8'd120; 6'd21: o_dout = 8'd126; 6'd22: o_dout = 8'd131; 6'd23: o_dout = 8'd136;
6'd24: dout = 8'd142; 6'd25: dout = 8'd147; 6'd26: dout = 8'd152; 6'd27: dout = 8'd157; 6'd24: o_dout = 8'd142; 6'd25: o_dout = 8'd147; 6'd26: o_dout = 8'd152; 6'd27: o_dout = 8'd157;
6'd28: dout = 8'd162; 6'd29: dout = 8'd167; 6'd30: dout = 8'd171; 6'd31: dout = 8'd176; 6'd28: o_dout = 8'd162; 6'd29: o_dout = 8'd167; 6'd30: o_dout = 8'd171; 6'd31: o_dout = 8'd176;
6'd32: dout = 8'd180; 6'd33: dout = 8'd185; 6'd34: dout = 8'd189; 6'd35: dout = 8'd193; 6'd32: o_dout = 8'd180; 6'd33: o_dout = 8'd185; 6'd34: o_dout = 8'd189; 6'd35: o_dout = 8'd193;
6'd36: dout = 8'd197; 6'd37: dout = 8'd201; 6'd38: dout = 8'd205; 6'd39: dout = 8'd208; 6'd36: o_dout = 8'd197; 6'd37: o_dout = 8'd201; 6'd38: o_dout = 8'd205; 6'd39: o_dout = 8'd208;
6'd40: dout = 8'd212; 6'd41: dout = 8'd215; 6'd42: dout = 8'd219; 6'd43: dout = 8'd222; 6'd40: o_dout = 8'd212; 6'd41: o_dout = 8'd215; 6'd42: o_dout = 8'd219; 6'd43: o_dout = 8'd222;
6'd44: dout = 8'd225; 6'd45: dout = 8'd228; 6'd46: dout = 8'd231; 6'd47: dout = 8'd233; 6'd44: o_dout = 8'd225; 6'd45: o_dout = 8'd228; 6'd46: o_dout = 8'd231; 6'd47: o_dout = 8'd233;
6'd48: dout = 8'd236; 6'd49: dout = 8'd238; 6'd50: dout = 8'd240; 6'd51: dout = 8'd242; 6'd48: o_dout = 8'd236; 6'd49: o_dout = 8'd238; 6'd50: o_dout = 8'd240; 6'd51: o_dout = 8'd242;
6'd52: dout = 8'd244; 6'd53: dout = 8'd246; 6'd54: dout = 8'd247; 6'd55: dout = 8'd249; 6'd52: o_dout = 8'd244; 6'd53: o_dout = 8'd246; 6'd54: o_dout = 8'd247; 6'd55: o_dout = 8'd249;
6'd56: dout = 8'd250; 6'd57: dout = 8'd251; 6'd58: dout = 8'd252; 6'd59: dout = 8'd253; 6'd56: o_dout = 8'd250; 6'd57: o_dout = 8'd251; 6'd58: o_dout = 8'd252; 6'd59: o_dout = 8'd253;
6'd60: dout = 8'd254; 6'd61: dout = 8'd254; 6'd62: dout = 8'd255; 6'd63: dout = 8'd255; 6'd60: o_dout = 8'd254; 6'd61: o_dout = 8'd254; 6'd62: o_dout = 8'd255; 6'd63: o_dout = 8'd255;
default: dout=8'd0; default: o_dout=8'd0;
endcase endcase
end end
endmodule endmodule

View File

@@ -15,12 +15,12 @@ module tb_nco_q15();
wire out_en; wire out_en;
nco_q15 #(.CLK_HZ(120_000_000), .FS_HZ(40_000)) nco ( nco_q15 #(.CLK_HZ(120_000_000), .FS_HZ(40_000)) nco (
.clk (clk), .i_clk (clk),
.rst_n (resetn), .i_rst_n (resetn),
.freq_hz(freq), .i_freq_hz(freq),
.sin_q15(sin_q15), .o_sin_q15(sin_q15),
.cos_q15(cos_q15), .o_cos_q15(cos_q15),
.clk_en (out_en) .o_clk_en (out_en)
); );
initial begin initial begin
@@ -39,4 +39,4 @@ module tb_nco_q15();
$finish; $finish;
end; end;
endmodule endmodule

View File

@@ -0,0 +1,91 @@
// rc_alpha_q15.vh
// Plain Verilog-2001 constant function: R(ohm), C(pF), Fs(Hz) -> alpha_q15 (Q1.15)
// Uses fixed-point approximation: 1 - exp(-x) ≈ x - x^2/2 + x^3/6, where x = 1/(Fs*R*C)
// All integer math; suitable for elaboration-time constant folding (e.g., XST).
`ifndef RC_ALPHA_Q15_VH
`define RC_ALPHA_Q15_VH
function integer alpha_q15_from_rc;
input integer R_OHM; // ohms
input integer C_PF; // picofarads
input integer FS_HZ; // Hz
// Choose QN for x. N=24 is a good balance for accuracy/width.
integer N;
// We'll keep everything as unsigned vectors; inputs copied into vectors first.
reg [63:0] R_u, C_u, FS_u;
// x = 1 / (Fs * R * C) with C in pF -> x = 1e12 / (Fs*R*C_pf)
// x_qN = round( x * 2^N ) = round( (1e12 << N) / denom )
reg [127:0] NUM_1E12_SLLN; // big enough for 1e12 << N
reg [127:0] DENOM; // Fs*R*C
reg [127:0] X_qN; // x in QN
// Powers
reg [255:0] X2; // x^2 in Q(2N)
reg [383:0] X3; // x^3 in Q(3N)
integer term1_q15;
integer term2_q15;
integer term3_q15;
integer acc;
begin
N = 24;
// Copy integer inputs into 64-bit vectors (no bit-slicing of integers)
R_u = R_OHM[31:0];
C_u = C_PF[31:0];
FS_u = FS_HZ[31:0];
// Denominator = Fs * R * C_pf (fits in < 2^64 for typical values)
DENOM = 128'd0;
DENOM = FS_u;
DENOM = DENOM * R_u;
DENOM = DENOM * C_u;
// // Guard: avoid divide by zero
// if (DENOM == 0) begin
// alpha_q15_from_rc = 0;
// disable alpha_q15_from_rc;
// end
// Numerator = (1e12 << N). 1e12 * 2^24 ≈ 1.6777e19 (fits in 2^64..2^65),
// so use 128 bits to be safe.
NUM_1E12_SLLN = 128'd1000000000000 << N;
// x_qN = rounded division
X_qN = (NUM_1E12_SLLN + (DENOM >> 1)) / DENOM;
// Powers
X2 = X_qN * X_qN;
X3 = X2 * X_qN;
// Convert terms to Q1.15:
// term1 = x -> shift from QN to Q15
term1_q15 = (X_qN >> (N - 15)) & 16'hFFFF;
// term2 = x^2 / 2 -> Q(2N) to Q15 and /2
term2_q15 = (X2 >> (2*N - 15 + 1)) & 16'hFFFF;
// term3 = x^3 / 6 -> Q(3N) to Q15, then /6 with rounding
begin : gen_t3
reg [383:0] tmp_q15_wide;
reg [383:0] tmp_div6;
tmp_q15_wide = (X3 >> (3*N - 15));
tmp_div6 = (tmp_q15_wide + 6'd3) / 6;
term3_q15 = tmp_div6[15:0];
end
// Combine and clamp
acc = term1_q15 - term2_q15 + term3_q15;
if (acc < 0) acc = 0;
else if (acc > 16'h7FFF) acc = 16'h7FFF;
alpha_q15_from_rc = acc;
end
endfunction
`endif

View File

@@ -0,0 +1,55 @@
`timescale 1ns/1ps
// =============================================================================
// RC model to convert sigma delta samples to Q1.15
// Models the RC circuit on the outside of the FPGA
// Uses: Yn+1 = Yn + (sd - Yn)*(1-exp(-T/RC))
// parameters:
// -- alpha_q15 : the 1-exp(-T/RC), defaults to R=3k3, C=220p and T=1/15MHz
// rounded to only use two bits (0b3b -> 0b00), the less
// bits the better
// inout:
// -- i_clk : input clock
// -- i_rst_n : reset signal
// -- i_sd_sample : 1 bit sample output from sd sampler
// -- o_sample_q15 : output samples in q.15
// =============================================================================
module rcmodel_q15 #(
parameter integer alpha_q15 = 16'sh0b00
)(
input wire i_clk,
input wire i_rst_n,
input wire i_sd_sample,
output wire [15:0] o_sample_q15
);
reg signed [15:0] y_q15;
wire signed [15:0] sd_q15 = i_sd_sample ? 16'sh7fff : 16'sh0000;
wire signed [15:0] e_q15 = sd_q15 - y_q15;
// wire signed [31:0] prod_q30 = $signed(e_q15) * $signed(alpha_q15);
wire signed [31:0] prod_q30;
// Use shift-add algorithm for multiplication
mul_const_shiftadd #(
.C($signed(alpha_q15)),
.IN_W(16),
.OUT_W(32)
) alpha_times_e (
.i_x(e_q15),
.o_y(prod_q30)
);
wire signed [15:0] y_next_q15 = y_q15 + (prod_q30>>>15);
// clamp to [0, 0x7FFF] (keeps signal view tidy)
function signed [15:0] clamp01_q15(input signed [15:0] v);
if (v < 16'sd0000) clamp01_q15 = 16'sd0000;
else if (v > 16'sh7FFF) clamp01_q15 = 16'sh7FFF;
else clamp01_q15 = v;
endfunction
always @(posedge i_clk or negedge i_rst_n) begin
if (!i_rst_n) y_q15 <= 16'sd0000;
else y_q15 <= clamp01_q15(y_next_q15);
end
assign o_sample_q15 = y_q15;
endmodule

View File

@@ -0,0 +1,57 @@
module sd_adc_q15 #(
parameter integer R_OHM = 3300,
parameter integer C_PF = 220
)(
input wire i_clk_15,
input wire i_rst_n,
input wire i_adc_a,
input wire i_adc_b,
output wire o_adc,
output wire signed [15:0] o_signal_q15,
output wire o_signal_valid
);
`include "rc_alpha_q15.vh"
wire sd_signal;
wire signed [15:0] raw_sample_biased;
wire signed [15:0] raw_sample_q15;
wire signed [15:0] lpf_sample_q15;
sd_sampler sd_sampler(
.i_clk(i_clk_15),
.i_a(i_adc_a), .i_b(i_adc_b),
.o_sample(sd_signal)
);
assign o_adc = sd_signal;
localparam integer alpha_q15_int = alpha_q15_from_rc(R_OHM, C_PF, 15000000);
localparam signed [15:0] alpha_q15 = alpha_q15_int[15:0];
localparam signed [15:0] alpha_q15_top = alpha_q15 & 16'hff00;
rcmodel_q15 #(
.alpha_q15(alpha_q15_top)
) rc_model (
.i_clk(i_clk_15), .i_rst_n(i_rst_n),
.i_sd_sample(sd_signal),
.o_sample_q15(raw_sample_q15)
);
lpf_iir_q15_k #(
.K(10)
) lpf (
.i_clk(i_clk_15), .i_rst_n(i_rst_n),
.i_x_q15(raw_sample_q15),
.o_y_q15(lpf_sample_q15)
);
decimate_by_r_q15 #(
.R(375), // 15MHz/375 = 40KHz
.CNT_W(10)
) decimate (
.i_clk(i_clk_15), .i_rst_n(i_rst_n),
.i_valid(1'b1), .i_q15(lpf_sample_q15),
.o_valid(o_signal_valid), .o_q15(o_signal_q15)
);
endmodule

View File

@@ -0,0 +1,18 @@
module sd_sampler(
input wire i_clk,
input wire i_a,
input wire i_b,
output wire o_sample
);
wire comp_out;
lvds_comparator comp (
.a(i_a), .b(i_b), .o(comp_out)
);
reg registered_comp_out;
always @(posedge i_clk)
registered_comp_out <= comp_out;
assign o_sample = registered_comp_out;
endmodule

View File

@@ -0,0 +1,57 @@
CAPI=2:
name: joppeb:signal:sd_adc_q15:1.0
description: Sigma-delta ADC front-end with Q1.15 output
filesets:
rtl_common:
depend:
- joppeb:primitive:lvds_comparator
- joppeb:signal:lpf_iir_q15_k
- joppeb:signal:decimate_by_r_q15
- joppeb:util:mul_const
files:
- rtl/rc_alpha_q15.vh:
is_include_file: true
- rtl/rcmodel_q15.v
- rtl/sd_adc_q15.v
file_type: verilogSource
rtl_sampler:
files:
- rtl/sd_sampler.v
file_type: verilogSource
sim_sampler:
files:
- sim/sd_sampler.v
file_type: verilogSource
tb:
files:
- tb/tb_sd_adc_q15.v
file_type: verilogSource
targets:
default:
filesets:
- rtl_common
- rtl_sampler
toplevel: sd_adc_q15
parameters:
- R_OHM
- C_PF
sim:
default_tool: icarus
filesets:
- rtl_common
- sim_sampler
- tb
toplevel: tb_sd_adc_q15
parameters:
R_OHM:
datatype: int
description: RC filter resistor value in ohms
paramtype: vlogparam
C_PF:
datatype: int
description: RC filter capacitor value in pF
paramtype: vlogparam

View File

@@ -0,0 +1,111 @@
`timescale 1ns/1ps
// =============================================================================
// Sigma-Delta sampler
// Simulates an RC circuit between o_sample and i_b and i_a sine at i_a
// =============================================================================
module sd_sampler(
input wire i_clk,
input wire i_a,
input wire i_b,
output wire o_sample
);
// Sine source (i_a input / P)
parameter real F_HZ = 5000; // input sine frequency (1 kHz)
parameter real AMP = 1.5; // sine amplitude (V)
parameter real VCM = 1.65; // common-mode (V), centered in 0..3.3V
// Comparator behavior
parameter real VTH = 0.0; // threshold on (vp - vn)
parameter real VHYST = 0.05; // symmetric hysteresis half-width (V)
parameter integer ADD_HYST = 0; // 1 to enable hysteresis
// 1-bit DAC rails (feedback into RC)
parameter real VLOW = 0.0; // DAC 0 (V)
parameter real VHIGH = 3.3; // DAC 1 (V)
// RC filter (i_b input / N)
parameter real R_OHMS = 3300.0; // 3.3k
parameter real C_FARADS = 220e-12; // 220 pF
// Integration step (ties to `timescale`)
parameter integer TSTEP_NS = 10; // sim step in ns (choose << tau)
// ===== Internal state (simulation only) =====
real vp, vn; // comparator i_a/i_b inputs
real v_rc; // RC node voltage (== vn)
real v_dac; // DAC output voltage from o_sample
real t_s; // time in seconds
real dt_s; // step in seconds
real tau_s; // R*C time constant in seconds
real two_pi;
reg q; // comparator latched output (pre-delay)
reg out;
reg sampler;
initial sampler <= 1'b0;
always @(posedge i_clk) begin
sampler <= out;
end
assign o_sample = sampler;
// Helper task: update comparator with optional hysteresis
task automatic comp_update;
real diff;
begin
diff = (vp - vn);
if (ADD_HYST != 0) begin
// simple symmetric hysteresis around VTH
if (q && (diff < (VTH - VHYST))) q = 1'b0;
else if (!q && (diff > (VTH + VHYST))) q = 1'b1;
// else hold
end else begin
q = (diff > VTH) ? 1'b1 : 1'b0;
end
end
endtask
initial begin
// Init constants
two_pi = 6.283185307179586;
tau_s = R_OHMS * C_FARADS; // ~7.26e-7 s
dt_s = TSTEP_NS * 1.0e-9;
// Init states
t_s = 0.0;
q = 1'b0; // start low
out = 1'b0;
v_dac= VLOW;
v_rc = (VHIGH + VLOW)/2.0; // start mid-rail to reduce start-up transient
vn = v_rc;
vp = VCM;
// Main sim loop
forever begin
#(TSTEP_NS); // advance discrete time step
t_s = t_s + dt_s;
// 1) Update DAC from previous comparator state
v_dac = sampler ? VHIGH : VLOW;
// 2) RC low-pass driven by DAC: Euler step
// dv = (v_dac - v_rc) * dt/tau
v_rc = v_rc + (v_dac - v_rc) * (dt_s / tau_s);
vn = v_rc;
// 3) Input sine on i_a
vp = VCM + AMP * $sin(two_pi * F_HZ * t_s);
// 4) Comparator decision (with optional hysteresis)
comp_update();
// 5) Output with propagation delay
out = q;
end
end
endmodule

View File

@@ -0,0 +1,36 @@
`timescale 1ns/1ps
module tb_sd_adc_q15();
// Clock and reset generation
reg clk;
reg resetn;
initial clk <= 1'b0;
initial resetn <= 1'b0;
always #6.667 clk <= !clk;
initial #40 resetn <= 1'b1;
// Default run
initial begin
$dumpfile("out.vcd");
$dumpvars;
#2_000_000
$finish;
end;
wire sd_a;
wire sd_b;
wire sd_o;
wire signed [15:0] decimated_q15;
wire decimated_valid;
sd_adc_q15 #(
.R_OHM(3300),
.C_PF(220)
) dut(
.i_clk_15(clk), .i_rst_n(resetn),
.i_adc_a(sd_a), .i_adc_b(sd_b), .o_adc(sd_o),
.o_signal_q15(decimated_q15),
.o_signal_valid(decimated_valid)
);
endmodule

View File

@@ -99,7 +99,8 @@ module mcu_peripherals (
.i_wb_dat(gpio_wbs_dat_w), .i_wb_dat(gpio_wbs_dat_w),
.i_wb_adr(gpio_wbs_adr), .i_wb_adr(gpio_wbs_adr),
.i_wb_we(gpio_wbs_we), .i_wb_we(gpio_wbs_we),
.i_wb_stb(gpio_wbs_stb & gpio_wbs_cyc), .i_wb_stb(gpio_wbs_stb),
.i_wb_cyc(gpio_wbs_cyc),
.i_wb_sel(gpio_wbs_sel), .i_wb_sel(gpio_wbs_sel),
.o_wb_rdt(gpio_wbs_dat_r), .o_wb_rdt(gpio_wbs_dat_r),
.o_wb_ack(gpio_wbs_ack), .o_wb_ack(gpio_wbs_ack),
@@ -110,9 +111,7 @@ module mcu_peripherals (
assign wbs_dat_r[0*32 +: 32] = gpio_wbs_dat_r; assign wbs_dat_r[0*32 +: 32] = gpio_wbs_dat_r;
assign wbs_ack[0] = gpio_wbs_ack; assign wbs_ack[0] = gpio_wbs_ack;
wb_countdown_timer #( wb_countdown_timer timer (
.address(TIMER_BASE_ADDR)
) timer (
.i_clk(i_clk), .i_clk(i_clk),
.i_rst(i_rst), .i_rst(i_rst),
.o_irq(o_timer_irq), .o_irq(o_timer_irq),

View File

@@ -81,12 +81,12 @@ module toplevel #(
.CLK_HZ(15_000_000), .CLK_HZ(15_000_000),
.FS_HZ(80_000) .FS_HZ(80_000)
) nco ( ) nco (
.clk (clk_15), .i_clk (clk_15),
.rst_n (sys_resetn), .i_rst_n (sys_resetn),
.freq_hz(GPIO_A), .i_freq_hz(GPIO_A),
.sin_q15(sin_q15), .o_sin_q15(sin_q15),
.cos_q15(), .o_cos_q15(),
.clk_en (clk_en) .o_clk_en (clk_en)
); );
reg [5:0] dac_code; reg [5:0] dac_code;

View File

@@ -0,0 +1,15 @@
CAPI=2:
name: joppeb:util:mul_const:1.0
description: Constant multiplier helpers implemented with shift-add logic
filesets:
rtl:
files:
- rtl/mul_const.v
file_type: verilogSource
targets:
default:
filesets:
- rtl

View File

@@ -0,0 +1,31 @@
`timescale 1ns/1ps
module mul_const_shiftadd #(
parameter integer C = 0,
parameter integer IN_W = 16,
parameter integer OUT_W = 32
)(
input wire signed [IN_W-1:0] i_x,
output reg signed [OUT_W-1:0] o_y
);
integer k;
integer abs_c;
reg signed [OUT_W-1:0] acc;
reg signed [OUT_W-1:0] x_ext;
always @* begin
abs_c = (C < 0) ? -C : C;
acc = {OUT_W{1'b0}};
x_ext = {{(OUT_W-IN_W){i_x[IN_W-1]}}, i_x};
for (k = 0; k < 32; k = k + 1) begin
if (abs_c[k])
acc = acc + (x_ext <<< k);
end
if (C < 0)
o_y = -acc;
else
o_y = acc;
end
endmodule

View File

@@ -1,99 +1,205 @@
`timescale 1ns/1ps // formal_wb_master_checker.v
//
// Wishbone Classic master-side protocol checker (plain Verilog).
// Use when your DUT is a *master* and the bus/slave is the environment.
module formal_wb_master_checker ( module formal_wb_master_checker #(
input wire i_clk, parameter OPT_USE_ERR = 0,
input wire i_rst, parameter OPT_USE_RTY = 0,
input wire i_wb_rst,
input wire [31:0] i_wb_adr, // If 1: require responses only when STB=1 (stricter than spec permission).
input wire [31:0] i_wb_dat, // If 0: allow "ghost" responses with STB=0; we only COUNT termination when STB=1.
input wire [3:0] i_wb_sel, parameter OPT_STRICT_RESP_WITH_STB = 0,
input wire i_wb_we,
input wire i_wb_stb, // If 1: require ACK/ERR/RTY to be single-cycle pulses.
input wire i_wb_cyc, // If 0: allow them to be held.
input wire [31:0] o_wb_rdt, parameter OPT_PULSE_RESP = 1,
input wire o_wb_ack
// If 1: after a synchronous reset has been asserted for one clock,
// require the master to hold CYC/STB low.
parameter OPT_STRICT_RESET = 1,
// Optional widths
parameter AW = 32,
parameter DW = 32,
parameter SW = 4
) (
input wire i_clk,
input wire i_rst,
input wire i_wb_rst,
// Master -> bus
input wire i_wb_cyc,
input wire i_wb_stb,
input wire i_wb_we,
input wire [AW-1:0] i_wb_adr,
input wire [DW-1:0] i_wb_dat,
input wire [SW-1:0] i_wb_sel,
// Bus/slave -> master
input wire o_wb_ack,
input wire o_wb_err,
input wire o_wb_rty,
input wire [DW-1:0] o_wb_rdt
); );
`ifdef FORMAL
// -----------------------------
// Reset combine
// -----------------------------
wire rst_any;
assign rst_any = i_rst | i_wb_rst;
// -----------------------------
// Formal infrastructure
// -----------------------------
reg f_past_valid; reg f_past_valid;
initial f_past_valid = 1'b0; initial f_past_valid = 1'b0;
always @(posedge i_clk)
always @(posedge i_clk) begin
f_past_valid <= 1'b1; f_past_valid <= 1'b1;
// A1: Slave ACK must correspond to either a same-cycle or previous-cycle request wire f_resp_any;
if(o_wb_ack) assign f_resp_any = o_wb_ack
A1: assume( | (OPT_USE_ERR ? o_wb_err : 1'b0)
(i_wb_cyc && i_wb_stb) || | (OPT_USE_RTY ? o_wb_rty : 1'b0);
(f_past_valid && $past(i_wb_cyc && i_wb_stb))
);
// A2: Slave must not ACK outside an active cycle // A "real" termination in Classic requires STB high (handshake qualifies the transfer)
if(!i_wb_cyc) wire f_terminate;
A2: assume(!o_wb_ack); assign f_terminate = i_wb_cyc && i_wb_stb && f_resp_any;
// A3: Once STB has been low for a full cycle, slave ACK must be low // -----------------------------
if( // Track exactly one outstanding request (Classic)
f_past_valid && // -----------------------------
!$past(i_wb_stb) && reg f_pending;
!i_wb_stb initial f_pending = 1'b0;
)
A3: assume(!o_wb_ack);
// R1: Reset must leave the master initialized on the following cycle always @(posedge i_clk or posedge rst_any) begin
if(f_past_valid && $past(i_rst || i_wb_rst)) begin if (rst_any) begin
R1: assert(!i_wb_cyc); f_pending <= 1'b0;
R2: assert(!i_wb_stb); end else if (!i_wb_cyc) begin
// Dropping CYC ends the bus cycle and clears any outstanding request
f_pending <= 1'b0;
end else begin
// Start pending when STB is asserted and none is pending
if (!f_pending && i_wb_stb)
f_pending <= 1'b1;
// Clear pending only on a real termination (STB && response)
if (f_terminate)
f_pending <= 1'b0;
end end
// R3: STB never high without CYC
if(i_wb_stb)
R3: assert(i_wb_cyc);
// R4-R9: Once a request starts, hold it stable until the slave responds
if(
f_past_valid &&
!$past(i_rst || i_wb_rst) &&
$past(i_wb_cyc && i_wb_stb && !o_wb_ack) &&
!o_wb_ack &&
!(i_rst || i_wb_rst)
) begin
R4: assert(i_wb_cyc);
R5: assert(i_wb_stb);
R6: assert(i_wb_adr == $past(i_wb_adr));
R7: assert(i_wb_dat == $past(i_wb_dat));
R8: assert(i_wb_sel == $past(i_wb_sel));
R9: assert(i_wb_we == $past(i_wb_we));
end
// R10: Once CYC is low, STB must also be low
if(!i_wb_cyc)
R10: assert(!i_wb_stb);
// C1: We eventually initiate a request
C1: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb);
// C2: We eventually get an ACK during an active request
C2: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && o_wb_ack);
// C3: A delayed ACK occurs for a request issued in a previous cycle.
// This does not require the request to drop in the ACK cycle.
C3: cover(f_past_valid && !i_rst && !i_wb_rst &&
$past(i_wb_cyc && i_wb_stb) && o_wb_ack);
// C4: A wait state happens: request asserted, no ACK for at least 1 cycle
C4: cover(f_past_valid && !i_rst && !i_wb_rst &&
$past(i_wb_cyc && i_wb_stb && !o_wb_ack) &&
(i_wb_cyc && i_wb_stb && !o_wb_ack));
// C5-C6: Read and write both occur (even if only once each)
C5: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && !i_wb_we);
C6: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && i_wb_we);
// C7: A transfer completes and the master drops CYC sometime after
C7: cover(f_past_valid && !i_rst && !i_wb_rst &&
$past(i_wb_cyc && i_wb_stb && o_wb_ack) && !i_wb_cyc);
end end
wire unused = &{1'b0, o_wb_rdt}; // -----------------------------
// Reset rules (Wishbone synchronous reset semantics)
// -----------------------------
always @(posedge i_clk) if (f_past_valid) begin
if (rst_any) begin
// R00: Monitor pending state must be cleared during reset
R00: assert(f_pending == 1'b0);
if (OPT_STRICT_RESET && $past(rst_any)) begin
// R01: After reset was asserted on the prior clock, master must be idle
R01: assert(!i_wb_cyc);
// R02: After reset was asserted on the prior clock, master must not strobe
R02: assert(!i_wb_stb);
end
if ($past(rst_any)) begin
// A00: After reset was asserted on the prior clock, environment should not respond
A00: assume(!o_wb_ack);
if (OPT_USE_ERR) A01: assume(!o_wb_err);
if (OPT_USE_RTY) A02: assume(!o_wb_rty);
end
end
end
// -----------------------------
// Master-side RULES (ASSERTIONS)
// -----------------------------
always @(posedge i_clk) if (f_past_valid && !rst_any) begin
// R10: STB must imply CYC (no strobe outside of a cycle)
if (i_wb_stb) begin
R10: assert(i_wb_cyc);
end
// R11: While a request is pending and NOT terminated, master must keep CYC asserted
if ($past(f_pending) && !$past(f_terminate)) begin
R11: assert(i_wb_cyc);
end
// R12: While a request is pending and NOT terminated, master must keep STB asserted
if ($past(f_pending) && !$past(f_terminate)) begin
R12: assert(i_wb_stb);
end
// R13: Address stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
R13: assert(i_wb_adr == $past(i_wb_adr));
end
// R14: WE stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
R14: assert(i_wb_we == $past(i_wb_we));
end
// R15: SEL stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
R15: assert(i_wb_sel == $past(i_wb_sel));
end
// R16: Write data stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
R16: assert(i_wb_dat == $past(i_wb_dat));
end
end
// -----------------------------
// Environment SLAVE assumptions
// -----------------------------
always @(posedge i_clk) if (f_past_valid && !rst_any) begin
// A10: Any response must occur only during an active cycle
if (f_resp_any) begin
A10: assume(i_wb_cyc);
end
// A11: Optional strict profile: response only when STB=1
if (OPT_STRICT_RESP_WITH_STB && f_resp_any) begin
A11: assume(i_wb_stb);
end
// A12-A14: Mutual exclusion between ACK/ERR/RTY (recommended)
if (o_wb_ack) begin
if (OPT_USE_ERR) A12s1: assume(!o_wb_err);
if (OPT_USE_RTY) A12s2: assume(!o_wb_rty);
end
if (OPT_USE_ERR && o_wb_err) begin
A13s1: assume(!o_wb_ack);
if (OPT_USE_RTY) A13s2: assume(!o_wb_rty);
end
if (OPT_USE_RTY && o_wb_rty) begin
A14s1: assume(!o_wb_ack);
if (OPT_USE_ERR) A14s2: assume(!o_wb_err);
end
// A15-A17: Optional pulse-only responses
if (OPT_PULSE_RESP) begin
if ($past(o_wb_ack)) begin
A15: assume(!o_wb_ack);
end
if (OPT_USE_ERR && $past(o_wb_err)) begin
A16: assume(!o_wb_err);
end
if (OPT_USE_RTY && $past(o_wb_rty)) begin
A17: assume(!o_wb_rty);
end
end
end
// -----------------------------
// Coverage: explore protocol space ("state diagram" witnesses)
// -----------------------------
// TODO
`endif
endmodule endmodule

View File

@@ -1,101 +1,222 @@
`timescale 1ns/1ps // formal_wb_slave_checker.v
//
// Wishbone Classic slave-side protocol checker (plain Verilog).
// Use when your DUT is a *slave* and the bus/master is the environment.
module formal_wb_slave_checker #( module formal_wb_slave_checker #(
parameter combinatorial_ack = 0, parameter OPT_USE_ERR = 0,
parameter expect_wait_state = 0 parameter OPT_USE_RTY = 0,
// If 1: require slave to only assert responses when STB=1 (stricter profile).
// If 0: allow "ghost" responses with STB=0; termination still only counts when STB=1.
parameter OPT_STRICT_RESP_WITH_STB = 0,
// If 1: require termination signals to be pulses (1 cycle).
// If 0: allow them to be held.
parameter OPT_PULSE_RESP = 1,
// If 1: after a synchronous reset has been asserted for one clock,
// require the master to hold CYC/STB low.
parameter OPT_STRICT_RESET = 1,
// If 1: assert read data stable while ACK is held (useful if you allow ACK-hold).
parameter OPT_ASSERT_RDATA_STABLE_DURING_ACK = 1,
// Optional widths
parameter AW = 32,
parameter DW = 32,
parameter SW = 4
) ( ) (
input wire i_clk, input wire i_clk,
input wire i_rst, input wire i_rst,
input wire i_wb_rst, input wire i_wb_rst,
input wire [31:0] i_wb_adr,
input wire [31:0] i_wb_dat, // Master -> slave
input wire [3:0] i_wb_sel, input wire i_wb_cyc,
input wire i_wb_we, input wire i_wb_stb,
input wire i_wb_stb, input wire i_wb_we,
input wire i_wb_cyc, input wire [AW-1:0] i_wb_adr,
input wire [31:0] o_wb_rdt, input wire [DW-1:0] i_wb_dat,
input wire o_wb_ack input wire [SW-1:0] i_wb_sel,
// Slave -> master
input wire o_wb_ack,
input wire o_wb_err,
input wire o_wb_rty,
input wire [DW-1:0] o_wb_rdt
); );
`ifdef FORMAL
// -----------------------------
// Reset combine
// -----------------------------
wire rst_any;
assign rst_any = i_rst | i_wb_rst;
// -----------------------------
// Formal infrastructure
// -----------------------------
reg f_past_valid; reg f_past_valid;
initial f_past_valid = 1'b0; initial f_past_valid = 1'b0;
always @(posedge i_clk)
always @(posedge i_clk) begin
f_past_valid <= 1'b1; f_past_valid <= 1'b1;
// A1: Reset forces cyc=0, stb=0 wire f_resp_any;
if (i_rst) begin assign f_resp_any = o_wb_ack
A1: assume(!i_wb_cyc); | (OPT_USE_ERR ? o_wb_err : 1'b0)
A2: assume(!i_wb_stb); | (OPT_USE_RTY ? o_wb_rty : 1'b0);
end
// A3: std->cyc, stb never high without cyc // Real termination only counts when STB=1
if(i_wb_stb) wire f_terminate;
A3: assume(i_wb_cyc); assign f_terminate = i_wb_cyc && i_wb_stb && f_resp_any;
// A4-A9: once a request starts, hold it stable until the slave responds // -----------------------------
if(f_past_valid && $past(i_wb_cyc && i_wb_stb && !o_wb_ack)) begin // Outstanding request tracking (Classic)
A4: assume(i_wb_cyc); // -----------------------------
A5: assume(i_wb_stb); reg f_pending;
A6: assume(i_wb_adr == $past(i_wb_adr)); initial f_pending = 1'b0;
A7: assume(i_wb_dat == $past(i_wb_dat));
A8: assume(i_wb_sel == $past(i_wb_sel));
A9: assume(i_wb_we == $past(i_wb_we));
end
// R1: ACK must correspond to either a same-cycle or previous-cycle request always @(posedge i_clk or posedge rst_any) begin
if(o_wb_ack) if (rst_any) begin
R1: assert( f_pending <= 1'b0;
(i_wb_cyc && i_wb_stb) || end else if (!i_wb_cyc) begin
(f_past_valid && $past(i_wb_cyc && i_wb_stb)) f_pending <= 1'b0;
);
// R2: !CYC->!ACK : no ghost acks
if(!i_wb_cyc)
R2: assert(!o_wb_ack);
// R3: Reset must leave the slave initialized on the following cycle
if(f_past_valid && $past(i_rst || i_wb_rst))
R3: assert(!o_wb_ack);
// R4: once STB has been dropped for a full cycle, ACK must be low
if(
f_past_valid &&
!$past(i_wb_stb) &&
!i_wb_stb
)
R4: assert(!o_wb_ack);
// C1: A request occurs at all
C1: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb);
// C2-C3: A request with write and with read occur
C2: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && i_wb_we);
C3: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && !i_wb_we);
// C4: ACK happens during a request (basic progress)
C4: cover(f_past_valid && !i_rst && !i_wb_rst && i_wb_cyc && i_wb_stb && o_wb_ack);
// C5-C7: Exercise the expected ACK timing style for this slave.
if (combinatorial_ack) begin
C5: cover(f_past_valid && !i_rst && !i_wb_rst &&
(i_wb_cyc && i_wb_stb) && o_wb_ack);
end else begin end else begin
C6: cover(f_past_valid && !i_rst && !i_wb_rst && if (!f_pending && i_wb_stb)
$past(i_wb_cyc && i_wb_stb) && o_wb_ack); f_pending <= 1'b1;
// C7: Optional wait-state behavior for slaves that intentionally stall. if (f_terminate)
if (expect_wait_state) f_pending <= 1'b0;
C7: cover(f_past_valid && !i_rst && !i_wb_rst &&
$past(i_wb_cyc && i_wb_stb && !o_wb_ack) &&
(i_wb_cyc && i_wb_stb && !o_wb_ack));
end end
// C8: Master ends a cycle (CYC drops) after at least one request
C8: cover(f_past_valid && !i_rst && !i_wb_rst &&
$past(i_wb_cyc && i_wb_stb) && !i_wb_cyc);
end end
wire unused = &{1'b0, o_wb_rdt}; // -----------------------------
// Reset rules (Wishbone synchronous reset semantics)
// -----------------------------
always @(posedge i_clk) if (f_past_valid) begin
if (rst_any) begin
// R00: Monitor pending state must be cleared during reset
R00: assert(f_pending == 1'b0);
if (OPT_STRICT_RESET && $past(rst_any)) begin
// A00: After reset was asserted on the prior clock, assume master is idle
A00: assume(!i_wb_cyc);
// A01: After reset was asserted on the prior clock, assume master is not strobing
A01: assume(!i_wb_stb);
end
if ($past(rst_any)) begin
// R01: After reset was asserted on the prior clock, slave must not respond
R01: assert(!o_wb_ack);
if (OPT_USE_ERR) R02: assert(!o_wb_err);
if (OPT_USE_RTY) R03: assert(!o_wb_rty);
end
end
end
// -----------------------------
// Master/environment assumptions (Classic rules)
// -----------------------------
always @(posedge i_clk) if (f_past_valid && !rst_any) begin
// A10: STB must imply CYC
if (i_wb_stb) begin
A10: assume(i_wb_cyc);
end
// A11: While pending and not terminated, master holds CYC asserted
if ($past(f_pending) && !$past(f_terminate)) begin
A11: assume(i_wb_cyc);
end
// A12: While pending and not terminated, master holds STB asserted
if ($past(f_pending) && !$past(f_terminate)) begin
A12: assume(i_wb_stb);
end
// A13: Address stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
A13: assume(i_wb_adr == $past(i_wb_adr));
end
// A14: WE stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
A14: assume(i_wb_we == $past(i_wb_we));
end
// A15: SEL stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
A15: assume(i_wb_sel == $past(i_wb_sel));
end
// A16: Write data stable while pending and not terminated
if ($past(f_pending) && !$past(f_terminate)) begin
A16: assume(i_wb_dat == $past(i_wb_dat));
end
end
// -----------------------------
// Slave/DUT assertions (response sanity)
// -----------------------------
always @(posedge i_clk) if (f_past_valid && !rst_any) begin
// R10: Any response must occur only during an active cycle
if (f_resp_any) begin
R10: assert(i_wb_cyc);
end
// R11: Optional strict profile: response only when STB=1
if (OPT_STRICT_RESP_WITH_STB && f_resp_any) begin
R11: assert(i_wb_stb);
end
// R12-R14: Mutual exclusion of termination signals (recommended)
if (o_wb_ack) begin
if (OPT_USE_ERR) R12s1: assert(!o_wb_err);
if (OPT_USE_RTY) R12s2: assert(!o_wb_rty);
end
if (OPT_USE_ERR && o_wb_err) begin
R13s1: assert(!o_wb_ack);
if (OPT_USE_RTY) R13s2: assert(!o_wb_rty);
end
if (OPT_USE_RTY && o_wb_rty) begin
R14s1: assert(!o_wb_ack);
if (OPT_USE_ERR) R14s2: assert(!o_wb_err);
end
// R15-R17: Optional pulse-only responses
if (OPT_PULSE_RESP) begin
if ($past(o_wb_ack)) begin
R15: assert(!o_wb_ack);
end
if (OPT_USE_ERR && $past(o_wb_err)) begin
R16: assert(!o_wb_err);
end
if (OPT_USE_RTY && $past(o_wb_rty)) begin
R17: assert(!o_wb_rty);
end
end
// R18: A real termination (STB && response) should only happen when a request is pending.
if (i_wb_stb && f_resp_any) begin
R18: assert(f_pending || $past(f_pending));
end
// R19: Optional read-data stability while ACK is held (only relevant if ACK can be held)
if (OPT_ASSERT_RDATA_STABLE_DURING_ACK) begin
if (o_wb_ack && !i_wb_we && $past(o_wb_ack)) begin
R19: assert(o_wb_rdt == $past(o_wb_rdt));
end
end
// R20: If no cycle, no responses (strong sanity rule)
if (!i_wb_cyc) begin
R20: assert(!f_resp_any);
end
end
// -----------------------------
// Coverage: exercise the slave (useful witness traces)
// -----------------------------
// TODO
`endif
endmodule endmodule

View File

@@ -0,0 +1,13 @@
[options]
mode prove
[engines]
abc pdr
[script]
{{"-formal"|gen_reads}}
prep -top {{top_level}}
clk2fflogic
[files]
{{files}}

View File

@@ -0,0 +1,2 @@
SBY 17:52:48 [/data/joppe/projects/fusesoc_test/cores/wb/jtag_wb_bridge/formal/jtag_wb_bridge_prove] Removing directory '/data/joppe/projects/fusesoc_test/cores/wb/jtag_wb_bridge/formal/jtag_wb_bridge_prove'.
SBY 17:52:48 [/data/joppe/projects/fusesoc_test/cores/wb/jtag_wb_bridge/formal/jtag_wb_bridge_prove] Copy '/data/joppe/projects/fusesoc_test/cores/wb/jtag_wb_bridge/formal/{{files}}' to '/data/joppe/projects/fusesoc_test/cores/wb/jtag_wb_bridge/formal/jtag_wb_bridge_prove/src/{{files}}'.

View File

@@ -0,0 +1 @@
../jtag_wb_bridge/status.sqlite

View File

@@ -1,35 +1,29 @@
`timescale 1ns/1ps `timescale 1ns/1ps
module formal_wb_gpio #( module formal_wb_gpio;
parameter [31:0] address = 32'h00000000
);
(* gclk *) reg i_wb_clk; (* gclk *) reg i_wb_clk;
(* anyseq *) reg i_rst;
(* anyseq *) reg i_wb_rst; (* anyseq *) reg i_wb_rst;
(* anyseq *) reg [31:0] i_wb_adr; (* anyseq *) reg [31:0] i_wb_adr;
(* anyseq *) reg [31:0] i_wb_dat; (* anyseq *) reg [31:0] i_wb_dat;
(* anyseq *) reg [3:0] i_wb_sel; (* anyseq *) reg [3:0] i_wb_sel;
(* anyseq *) reg i_wb_we; (* anyseq *) reg i_wb_we;
(* anyseq *) reg i_wb_stb; (* anyseq *) reg i_wb_stb;
(* anyseq *) reg i_wb_cyc;
(* anyseq *) reg [31:0] i_gpio; (* anyseq *) reg [31:0] i_gpio;
wire [31:0] o_wb_rdt; wire [31:0] o_wb_rdt;
wire o_wb_ack; wire o_wb_ack;
wire [31:0] o_gpio; wire [31:0] o_gpio;
wire i_wb_cyc;
reg f_past_valid; reg f_past_valid;
assign i_wb_cyc = i_wb_stb || o_wb_ack; wb_gpio dut (
.i_clk(i_wb_clk),
wb_gpio #( .i_rst(i_wb_rst),
.address(address)
) dut (
.i_wb_clk(i_wb_clk),
.i_wb_rst(i_wb_rst),
.i_wb_adr(i_wb_adr), .i_wb_adr(i_wb_adr),
.i_wb_dat(i_wb_dat), .i_wb_dat(i_wb_dat),
.i_wb_sel(i_wb_sel), .i_wb_sel(i_wb_sel),
.i_wb_we(i_wb_we), .i_wb_we(i_wb_we),
.i_wb_stb(i_wb_stb), .i_wb_stb(i_wb_stb),
.i_wb_cyc(i_wb_cyc),
.i_gpio(i_gpio), .i_gpio(i_gpio),
.o_wb_rdt(o_wb_rdt), .o_wb_rdt(o_wb_rdt),
.o_wb_ack(o_wb_ack), .o_wb_ack(o_wb_ack),
@@ -38,7 +32,7 @@ module formal_wb_gpio #(
formal_wb_slave_checker wb_checker ( formal_wb_slave_checker wb_checker (
.i_clk(i_wb_clk), .i_clk(i_wb_clk),
.i_rst(i_rst), .i_rst(i_wb_rst),
.i_wb_rst(i_wb_rst), .i_wb_rst(i_wb_rst),
.i_wb_adr(i_wb_adr), .i_wb_adr(i_wb_adr),
.i_wb_dat(i_wb_dat), .i_wb_dat(i_wb_dat),
@@ -56,9 +50,13 @@ module formal_wb_gpio #(
f_past_valid <= 1'b1; f_past_valid <= 1'b1;
// R1: reads return the sampled GPIO input on the following cycle // R1: reads return the sampled GPIO input on the following cycle
if (f_past_valid && !$past(i_wb_rst) && !i_wb_rst && $past(i_wb_stb) && !$past(i_wb_we)) begin if(f_past_valid &&
!i_wb_rst && $past(!i_wb_rst) &&
o_wb_ack &&
$past(i_wb_sel)==4'hf && i_wb_sel==4'hf &&
$past(i_wb_cyc & i_wb_stb & !i_wb_we) &&
(i_wb_cyc & i_wb_stb & !i_wb_we))
assert(o_wb_rdt == $past(i_gpio)); assert(o_wb_rdt == $past(i_gpio));
end
// R2: reset clears the output register and read data register // R2: reset clears the output register and read data register
if (f_past_valid && $past(i_wb_rst)) begin if (f_past_valid && $past(i_wb_rst)) begin

View File

@@ -1,56 +1,53 @@
module wb_gpio #( module wb_gpio (
parameter address = 32'h00000000 input wire i_clk,
)( input wire i_rst,
input wire i_wb_clk,
input wire i_wb_rst, // optional; tie low if unused
input wire [31:0] i_wb_adr, // optional; can ignore for single-reg
input wire [31:0] i_wb_dat,
input wire [3:0] i_wb_sel,
input wire i_wb_we,
input wire i_wb_stb,
input wire [31:0] i_gpio,
output reg [31:0] o_wb_rdt, input wire [31:0] i_wb_adr,
output reg o_wb_ack, input wire [31:0] i_wb_dat,
output reg [31:0] o_gpio output reg [31:0] o_wb_rdt,
input wire [3:0] i_wb_sel,
input wire i_wb_we,
input wire i_wb_cyc,
input wire i_wb_stb,
output wire o_wb_ack,
input wire [31:0] i_gpio,
output wire [31:0] o_gpio
); );
// Registers
reg [31:0] gpo;
wire [31:0] gpi;
assign o_gpio = gpo;
assign gpi = i_gpio;
initial o_gpio <= 32'h00000000; reg wb_ack = 0;
initial o_wb_rdt <= 32'h00000000; assign o_wb_ack = wb_ack & i_wb_cyc & i_wb_stb;
wire addr_check; always @(posedge i_clk) begin
assign addr_check = (i_wb_adr == address); if(i_rst) begin
gpo <= 0;
wb_ack <= 0;
o_wb_rdt <= 0;
end else begin
// Ack generation
wb_ack <= i_wb_cyc & i_wb_stb & !wb_ack;
// One-cycle ACK pulse per request (works even if stb stays high) // Read cycle
initial o_wb_ack <= 1'b0; if(i_wb_cyc && i_wb_stb && !i_wb_we) begin
always @(posedge i_wb_clk) begin if(i_wb_sel[0]) o_wb_rdt[7:0] <= gpi[7:0];
if (i_wb_rst) begin if(i_wb_sel[1]) o_wb_rdt[15:8] <= gpi[15:8];
o_wb_ack <= 1'b0; if(i_wb_sel[2]) o_wb_rdt[23:16] <= gpi[23:16];
end else begin if(i_wb_sel[3]) o_wb_rdt[31:24] <= gpi[31:24];
o_wb_ack <= i_wb_stb & ~o_wb_ack; // pulse while stb asserted end
end // write cycle
end if(i_wb_cyc && i_wb_stb && i_wb_we) begin
if(i_wb_sel[0]) gpo[7:0] <= i_wb_dat[7:0];
// Read data (combinational or registered; registered here) if(i_wb_sel[1]) gpo[15:8] <= i_wb_dat[15:8];
always @(posedge i_wb_clk) begin if(i_wb_sel[2]) gpo[23:16] <= i_wb_dat[23:16];
if (i_wb_rst) begin if(i_wb_sel[3]) gpo[31:24] <= i_wb_dat[31:24];
o_wb_rdt <= 32'h0; end
end else if (i_wb_stb && !i_wb_we) begin end
o_wb_rdt <= i_gpio; end
end
end
// Write latch (update on the acknowledged cycle)
always @(posedge i_wb_clk) begin
if (i_wb_rst) begin
o_gpio <= 32'h0;
end else if (i_wb_stb && i_wb_we && addr_check && (i_wb_stb & ~o_wb_ack)) begin
// Apply byte enables (so sb works if the master uses sel)
if (i_wb_sel[0]) o_gpio[7:0] <= i_wb_dat[7:0];
if (i_wb_sel[1]) o_gpio[15:8] <= i_wb_dat[15:8];
if (i_wb_sel[2]) o_gpio[23:16] <= i_wb_dat[23:16];
if (i_wb_sel[3]) o_gpio[31:24] <= i_wb_dat[31:24];
end
end
endmodule endmodule

View File

@@ -25,8 +25,6 @@ targets:
filesets: filesets:
- rtl - rtl
toplevel: wb_gpio toplevel: wb_gpio
parameters:
- address
formal: formal:
default_tool: symbiyosys default_tool: symbiyosys
@@ -35,11 +33,3 @@ targets:
- formal_rtl - formal_rtl
- formal_cfg - formal_cfg
toplevel: formal_wb_gpio toplevel: formal_wb_gpio
parameters:
- address
parameters:
address:
datatype: int
description: Wishbone address matched by this peripheral
paramtype: vlogparam

View File

@@ -1,31 +1,28 @@
`timescale 1ns/1ps `timescale 1ns/1ps
module formal_wb_gpio_banks #( module formal_wb_gpio_banks #(
parameter integer NUM_BANKS = 2, parameter integer num_banks = 2,
parameter [31:0] BASE_ADDR = 32'h00000000
); );
(* gclk *) reg i_wb_clk; (* gclk *) reg i_clk;
(* anyseq *) reg i_rst; (* anyseq *) reg i_rst;
(* anyseq *) reg i_wb_rst;
(* anyseq *) reg [31:0] i_wb_adr; (* anyseq *) reg [31:0] i_wb_adr;
(* anyseq *) reg [31:0] i_wb_dat; (* anyseq *) reg [31:0] i_wb_dat;
(* anyseq *) reg [3:0] i_wb_sel; (* anyseq *) reg [3:0] i_wb_sel;
(* anyseq *) reg i_wb_we; (* anyseq *) reg i_wb_we;
(* anyseq *) reg i_wb_stb; (* anyseq *) reg i_wb_stb;
(* anyseq *) reg [NUM_BANKS*32-1:0] i_gpio; (* anyseq *) reg [num_banks*32-1:0] i_gpio;
wire [31:0] o_wb_rdt; wire [31:0] o_wb_rdt;
wire o_wb_ack; wire o_wb_ack;
wire [NUM_BANKS*32-1:0] o_gpio; wire [num_banks*32-1:0] o_gpio;
wire i_wb_cyc; wire i_wb_cyc;
assign i_wb_cyc = i_wb_stb || o_wb_ack; assign i_wb_cyc = i_wb_stb || o_wb_ack;
wb_gpio_banks #( wb_gpio_banks #(
.NUM_BANKS(NUM_BANKS), .num_banks(num_banks)
.BASE_ADDR(BASE_ADDR)
) dut ( ) dut (
.i_wb_clk(i_wb_clk), .i_clk(i_clk),
.i_wb_rst(i_wb_rst), .i_rst(i_rst),
.i_wb_adr(i_wb_adr), .i_wb_adr(i_wb_adr),
.i_wb_dat(i_wb_dat), .i_wb_dat(i_wb_dat),
.i_wb_sel(i_wb_sel), .i_wb_sel(i_wb_sel),
@@ -38,9 +35,9 @@ module formal_wb_gpio_banks #(
); );
formal_wb_slave_checker wb_checker ( formal_wb_slave_checker wb_checker (
.i_clk(i_wb_clk), .i_clk(i_clk),
.i_rst(i_rst), .i_rst(i_rst),
.i_wb_rst(i_wb_rst), .i_wb_rst(i_rst),
.i_wb_adr(i_wb_adr), .i_wb_adr(i_wb_adr),
.i_wb_dat(i_wb_dat), .i_wb_dat(i_wb_dat),
.i_wb_sel(i_wb_sel), .i_wb_sel(i_wb_sel),

View File

@@ -16,8 +16,10 @@ cover: smtbmc yices
prove: abc pdr prove: abc pdr
[script] [script]
read -formal clog2.vh
{{"-formal"|gen_reads}} {{"-formal"|gen_reads}}
prep -top {{top_level}} prep -top {{top_level}}
[files] [files]
src/joppeb_util_clog2_1.0/clog2.vh
{{files}} {{files}}

View File

@@ -1,63 +1,61 @@
`default_nettype none `include "clog2.vh"
module wb_gpio_banks #( module wb_gpio_banks #(
parameter integer NUM_BANKS = 4, parameter num_banks = 4
parameter [31:0] BASE_ADDR = 32'h8000_0000 )(
) ( input wire i_clk,
input wire i_wb_clk, input wire i_rst,
input wire i_wb_rst,
input wire [31:0] i_wb_adr, input wire [31:0] i_wb_adr,
input wire [31:0] i_wb_dat, input wire [31:0] i_wb_dat,
input wire [3:0] i_wb_sel, output reg [31:0] o_wb_rdt,
input wire i_wb_we, input wire [3:0] i_wb_sel,
input wire i_wb_stb, input wire i_wb_we,
input wire [NUM_BANKS*32-1:0] i_gpio, input wire i_wb_cyc,
output reg [31:0] o_wb_rdt, input wire i_wb_stb,
output reg o_wb_ack, output wire o_wb_ack,
output wire [NUM_BANKS*32-1:0] o_gpio
input wire [num_banks*32-1:0] i_gpio,
output wire [num_banks*32-1:0] o_gpio
); );
localparam sw = `CLOG2(num_banks);
wire [num_banks-1:0] bank_sel;
wire [NUM_BANKS-1:0] bank_sel; wire [num_banks-1:0] bank_ack;
wire [NUM_BANKS-1:0] bank_stb; wire [num_banks*32-1:0] bank_rdt;
wire [NUM_BANKS*32-1:0] bank_rdt;
wire [NUM_BANKS-1:0] bank_ack;
genvar gi; genvar gi;
generate generate
for (gi = 0; gi < NUM_BANKS; gi = gi + 1) begin : gen_gpio for(gi=0; gi<num_banks; gi=gi+1) begin : gen_gpio
localparam [31:0] BANK_ADDR = BASE_ADDR + (gi * 4); localparam [2+sw-1:0] addr = gi*4;
assign bank_sel[gi] = (i_wb_adr[2+sw-1:0] == addr);
wb_gpio u_gpio(
.i_clk(i_clk),
.i_rst(i_rst),
.i_wb_adr(i_wb_adr),
.i_wb_dat(i_wb_dat),
.i_wb_cyc(i_wb_cyc & bank_sel[gi]),
.i_wb_stb(i_wb_stb & bank_sel[gi]),
.i_wb_we(i_wb_we),
.i_wb_sel(i_wb_sel),
.o_wb_ack(bank_ack[gi]),
.o_wb_rdt(bank_rdt[gi*32 +: 32]),
.i_gpio(i_gpio[gi*32 +: 32]),
.o_gpio(o_gpio[gi*32 +: 32])
);
end
endgenerate
assign bank_sel[gi] = (i_wb_adr == BANK_ADDR); integer bi;
assign bank_stb[gi] = i_wb_stb & bank_sel[gi]; always @* begin
o_wb_rdt = 0;
wb_gpio #( o_wb_ack = 0;
.address(BANK_ADDR) for(bi=0; bi<num_banks; bi=bi+1) begin
) u_gpio ( if(bank_sel[bi]) begin
.i_wb_clk(i_wb_clk), o_wb_rdt = bank_rdt[bi*32 +: 32];
.i_wb_rst(i_wb_rst), o_wb_ack = bank_ack[bi];
.i_wb_adr(i_wb_adr), end
.i_wb_dat(i_wb_dat), end
.i_wb_sel(i_wb_sel), end;
.i_wb_we(i_wb_we),
.i_wb_stb(bank_stb[gi]),
.i_gpio(i_gpio[gi*32 +: 32]),
.o_wb_rdt(bank_rdt[gi*32 +: 32]),
.o_wb_ack(bank_ack[gi]),
.o_gpio(o_gpio[gi*32 +: 32])
);
end
endgenerate
integer bi;
always @* begin
o_wb_rdt = 32'h0000_0000;
o_wb_ack = 1'b0;
for (bi = 0; bi < NUM_BANKS; bi = bi + 1) begin
if (bank_sel[bi]) begin
o_wb_rdt = bank_rdt[bi*32 +: 32];
o_wb_ack = bank_ack[bi];
end
end
end
endmodule endmodule

View File

@@ -7,6 +7,7 @@ filesets:
rtl: rtl:
depend: depend:
- joppeb:wb:wb_gpio - joppeb:wb:wb_gpio
- joppeb:util:clog2
files: files:
- rtl/wb_gpio_banks.v - rtl/wb_gpio_banks.v
file_type: verilogSource file_type: verilogSource

View File

@@ -27,7 +27,7 @@ module wb_mem32 #(
wire [mem_aw-1:0] wb_word_adr = i_wb_adr[mem_aw+1:2]; wire [mem_aw-1:0] wb_word_adr = i_wb_adr[mem_aw+1:2];
assign o_wb_rdt = wb_rdt_r; assign o_wb_rdt = wb_rdt_r;
assign o_wb_ack = wb_ack_r; assign o_wb_ack = wb_ack_r & i_wb_cyc & i_wb_stb;
always @(posedge i_clk) begin always @(posedge i_clk) begin
if (i_rst || i_wb_rst) begin if (i_rst || i_wb_rst) begin

View File

@@ -31,9 +31,7 @@ module formal_wb_timer;
.o_wb_ack(o_wb_ack) .o_wb_ack(o_wb_ack)
); );
formal_wb_slave_checker #( formal_wb_slave_checker wb_checker (
.combinatorial_ack(0)
) wb_checker (
.i_clk(i_clk), .i_clk(i_clk),
.i_rst(i_rst), .i_rst(i_rst),
.i_wb_rst(i_wb_rst), .i_wb_rst(i_wb_rst),

View File

@@ -1,8 +1,6 @@
`timescale 1ns/1ps `timescale 1ns/1ps
module wb_countdown_timer #( module wb_countdown_timer (
parameter address = 32'h00000000 // Base address of peripheral
)(
input wire i_clk, input wire i_clk,
input wire i_rst, input wire i_rst,
output wire o_irq, output wire o_irq,
@@ -26,7 +24,7 @@ module wb_countdown_timer #(
reg counter_started = 0; reg counter_started = 0;
reg counter_running = 0; reg counter_running = 0;
reg prev_counter_running = 0; reg prev_counter_running = 0;
assign o_wb_ack = wb_ack; assign o_wb_ack = wb_ack & i_wb_cyc & i_wb_stb; // Make sure the ack only happend during a cycle
assign o_irq = irq_fired; assign o_irq = irq_fired;
@@ -97,4 +95,91 @@ module wb_countdown_timer #(
end end
end end
`ifdef FORMAL
// Formal verification
reg f_past_valid = 1'b0;
wire cnt_write = i_wb_cyc && i_wb_stb && i_wb_we && (i_wb_adr[3:0] == 4'h0);
wire pld_write = i_wb_cyc && i_wb_stb && i_wb_we && (i_wb_adr[3:0] == 4'h4);
wire ack_write = i_wb_cyc && i_wb_stb && i_wb_we && (i_wb_adr[3:0] == 4'h8);
reg [31:0] past_counter;
always @(posedge i_clk) begin
f_past_valid <= 1'b1;
past_counter <= counter;
// R1: Reset clears all timer state on the following cycle.
// Check counter, preload, wb_ack, o_wb_dat, irq_fired,
// counter_started, counter_running, and prev_counter_running.
if(f_past_valid && $past(i_rst)) begin
R1s1: assert(counter==0);
R1s2: assert(preload==0);
R1s3: assert(!wb_ack);
R1s4: assert(o_wb_dat==0);
R1s5: assert(!irq_fired);
R1s6: assert(!counter_started);
R1s7: assert(!counter_running);
end
// R2: irq_fired is sticky until reset or a write to BASE+8 clears it.
// -> if last cycle was irq and last cycle was not reset and not ack write then now still irq
if(f_past_valid && $past(!i_rst) && $past(irq_fired) && $past(!ack_write))
R2: assert(irq_fired);
// R3: A write to BASE+8 clears irq_fired on the following cycle.
// -> if last cycle was ack write and irq was high it must be low now
if(f_past_valid && $past(!i_rst) && $past(irq_fired) && $past(ack_write))
R3: assert(!irq_fired);
// R4: While the timer is running and no counter write overrides it,
// counter decrements by exactly one each cycle.
if(f_past_valid && $past(!i_rst) && $past(counter>1) && $past(counter_started) && $past(!cnt_write))
R4: assert(counter == $past(counter)-1);
// R5: When counter reaches zero with preload > 0 and the timer is started,
// the counter reloads from preload.
if(f_past_valid && $past(!i_rst) && $past(counter==0) && $past(preload>0) && $past(counter_started) && $past(!cnt_write))
R5: assert(counter == $past(preload));
// R6: When counter == 0 and preload == 0, the timer stops
// (counter_started deasserts unless a write rearms it).
if(f_past_valid && $past(!i_rst) && $past(counter==0) && $past(preload==0) && $past(!cnt_write) && $past(!pld_write)) begin
R6s1: assert(counter==0);
R6s2: assert(counter_started==0);
end
// R7: A write to BASE+0 or BASE+4 arms the timer
// (counter_started asserts on the following cycle).
if(f_past_valid && $past(!i_rst) && ($past(cnt_write) || $past(pld_write)))
R7: assert(counter_started==1);
// R8: o_irq always reflects irq_fired.
R8: assert(o_irq == irq_fired);
// R9: Interrupt only fired after counter was 0 two clock cycles ago
if(f_past_valid && $past(!i_rst) && $past(!irq_fired) && irq_fired)
R9: assert($past(past_counter) == 0);
// C1: Cover a counter write that starts the timer.
C1s1: cover(f_past_valid && !i_rst && cnt_write);
if(f_past_valid && $past(!i_rst) && $past(cnt_write))
C1s2: cover(counter_started);
// C2: Cover a preload write.
C2: cover(f_past_valid && !i_rst && pld_write);
// C3: Cover the counter decrementing at least once.
C3: cover(f_past_valid && $past(!i_rst) && $past(counter)==counter-1 && $past(!cnt_write) && $past(!pld_write));
// C4: Cover the counter reloading from preload.
C4: cover(f_past_valid && $past(!i_rst) && $past(counter==0) && $past(preload>0) && counter>0 && $past(!cnt_write) && $past(!pld_write));
// C5: Cover irq_fired asserting when the timer expires.
C5: cover(f_past_valid && $past(!i_rst) && $past(!irq_fired) && irq_fired && $past(counter==0));
// C6: Cover irq_fired being cleared by a write to BASE+8.
C6: cover(f_past_valid && $past(!i_rst) && $past(irq_fired) && !irq_fired && $past(ack_write));
end
`endif
endmodule endmodule

View File

@@ -28,8 +28,6 @@ targets:
filesets: filesets:
- rtl - rtl
toplevel: wb_countdown_timer toplevel: wb_countdown_timer
parameters:
- address
sim: sim:
default_tool: icarus default_tool: icarus
filesets: filesets:
@@ -44,10 +42,10 @@ targets:
- formal_cfg - formal_cfg
toplevel: formal_wb_timer toplevel: formal_wb_timer
parameters: parameters:
- address - FORMAL=true
parameters: parameters:
address: FORMAL:
datatype: int datatype: bool
description: Base address of register set description: Enable in-module formal-only logic
paramtype: vlogparam paramtype: vlogdefine