aboutsummaryrefslogtreecommitdiff
path: root/src/tb/tb_vndecorrelator.v
blob: 9afe843261e7dd8a20601e33dbbdca5d0640f6a9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
//======================================================================
//
// tb_vndecorrelator.v
// -------------------
// Testbench for the von Neumann decorrelator.
//
//
// Author: Joachim Strömbergson
// Copyright (c) 2019, NORDUnet A/S
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// - Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
//
// - Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// - Neither the name of the NORDUnet nor the names of its contributors may
//   be used to endorse or promote products derived from this software
//   without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//======================================================================


//------------------------------------------------------------------
// Test module.
//------------------------------------------------------------------
module tb_vndecorrelator();


  //----------------------------------------------------------------
  // Internal constant and parameter definitions.
  //----------------------------------------------------------------
  parameter DEBUG           = 1;

  parameter CLK_HALF_PERIOD = 1;
  parameter CLK_PERIOD      = 2 * CLK_HALF_PERIOD;


  //----------------------------------------------------------------
  // Register and Wire declarations.
  //----------------------------------------------------------------
  reg [31 : 0] cycle_ctr;
  reg [31 : 0] error_ctr;
  reg [31 : 0] tc_ctr;

  reg  tb_clk;
  reg  tb_reset_n;
  reg  tb_data_in;
  reg  tb_syn_in;
  wire tb_data_out;
  wire tb_syn_out;


  //----------------------------------------------------------------
  // Device Under Test.
  //----------------------------------------------------------------
  vndecorrelator dut(
                     .clk(tb_clk),
                     .reset_n(tb_reset_n),

                     .data_in(tb_data_in),
                     .syn_in(tb_syn_in),

                     .data_out(tb_data_out),
                     .syn_out(tb_syn_out)
                    );


  //----------------------------------------------------------------
  // clk_gen
  //
  // Always running clock generator process.
  //----------------------------------------------------------------
  always
    begin : clk_gen
      #CLK_HALF_PERIOD;
      tb_clk = !tb_clk;
    end // clk_gen


  //--------------------------------------------------------------------
  // dut_monitor
  //
  // Monitor displaying information every cycle.
  // Includes the cycle counter.
  //--------------------------------------------------------------------
  always @ (posedge tb_clk)
    begin : dut_monitor
      cycle_ctr = cycle_ctr + 1;

      if (DEBUG)
        begin
          $display("cycle = %016x:", cycle_ctr);
          $display("reset_n  = 0x%01x", dut.reset_n);
          $display("data_in  = 0x%01x, syn_in  = 0x%01x", dut.data_in, dut.syn_in);
          $display("data_out = 0x%01x, syn_out = 0x%01x", dut.data_out, dut.syn_out);
          $display("ctrl     = 0x%01x", dut.vndecorr_ctrl_reg);
          $display("");
        end
    end // dut_monitor


  //----------------------------------------------------------------
  // reset_dut()
  //
  // Toggle reset to put the DUT into a well known state.
  //----------------------------------------------------------------
  task reset_dut;
    begin
      $display("*** Toggle reset.");
      tb_reset_n = 0;
      #(2 * CLK_PERIOD);
      tb_reset_n = 1;
    end
  endtask // reset_dut


  //----------------------------------------------------------------
  // init_sim()
  //
  // Initialize all counters and testbed functionality as well
  // as setting the DUT inputs to defined values.
  //----------------------------------------------------------------
  task init_sim;
    begin
      cycle_ctr = 0;
      error_ctr = 0;
      tc_ctr    = 0;

      tb_clk     = 0;
      tb_reset_n = 1;
      tb_data_in = 0;
      tb_syn_in  = 0;
    end
  endtask // init_sim


  //----------------------------------------------------------------
  // decorrelation_test
  //
  // The main test functionality.
  //----------------------------------------------------------------
  initial
    begin : decorrelation_test
      $display("   -= Testbench for the vpn Neumann decorrelator =-");
      $display("    ===============================================");
      $display("");

      init_sim();
      reset_dut();

      // TC1: 1, 0 directly after eachother. Should emit 0.
      #(10 *CLK_PERIOD);
      $display("TC1: 1 directly followed by 0. Should emit 0.");
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC2: 0, 1 directly after eachother. Should generate 1.
      #(10 *CLK_PERIOD);
      $display("TC2: 0 directly followed by 1. Should emit 1.");
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC3: 0, 0 directly after eachother. Should emit nothing.
      #(10 *CLK_PERIOD);
      $display("TC3: 0 directly followed by 0. Should emit nothing.");
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC4: 1, 1 directly after eachother. Should enmit nothing.
      #(10 *CLK_PERIOD);
      $display("TC4: 1 directly followed by 1. Should emit nothing.");
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC5: 1, 0 with 10 cycles in between. Should emit 0.
      #(10 *CLK_PERIOD);
      $display("TC5: 1 and later 0. Should emit 0.");
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;
      #(10 *CLK_PERIOD);
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC6: 0, 1 with 10 cycles in between. Should emit 1.
      #(10 *CLK_PERIOD);
      $display("TC6: 0 and later 1. Should emit 1.");
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;
      #(10 *CLK_PERIOD);
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC7: 0, 0 with 10 cycles in between. Should emit nothing.
      #(10 *CLK_PERIOD);
      $display("TC7: 0 and later 0. Should emit nothing.");
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;
      #(10 *CLK_PERIOD);
      tb_data_in = 0;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      // TC8: 1, 1 with 10 cycles in between. Should emit nothing.
      #(10 *CLK_PERIOD);
      $display("TC8: 1 and later 1. Should emit nothing.");
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;
      #(10 *CLK_PERIOD);
      tb_data_in = 1;
      tb_syn_in  = 1;
      #(CLK_PERIOD);
      tb_syn_in  = 0;

      $display("");
      $display("*** von Neumann decorrelation simulation done. ***");
      $finish;
    end // decorrelation_test
endmodule // tb_vndecorrelator

//======================================================================
// EOF tb_vndecorrelator.v
//======================================================================