aboutsummaryrefslogtreecommitdiff
path: root/rtl/modular/modular_adder.v
blob: 189059d48782931070081015165d62b559b721ad (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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
//------------------------------------------------------------------------------
//
// modular_adder.v
// -----------------------------------------------------------------------------
// Modular adder.
//
// Authors: Pavel Shatov
//
// Copyright (c) 2016, NORDUnet A/S
//
// 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.
//
//------------------------------------------------------------------------------

module modular_adder
  (
   clk, rst_n,
   ena, rdy,
   ab_addr, n_addr, s_addr, s_wren,
   a_din, b_din, n_din, s_dout
   );


   //
   // Parameters
   //
   parameter	OPERAND_NUM_WORDS	= 8;
   parameter	WORD_COUNTER_WIDTH	= 3;


   //
   // Handy Numbers
   //
   localparam	[WORD_COUNTER_WIDTH-1:0]	WORD_INDEX_ZERO	= 0;
   localparam	[WORD_COUNTER_WIDTH-1:0]	WORD_INDEX_LAST	= OPERAND_NUM_WORDS - 1;


   //
   // Handy Functions
   //
   function	[WORD_COUNTER_WIDTH-1:0]	WORD_INDEX_NEXT_OR_ZERO;
      input	[WORD_COUNTER_WIDTH-1:0]	WORD_INDEX_CURRENT;
      begin
	 WORD_INDEX_NEXT_OR_ZERO = (WORD_INDEX_CURRENT < WORD_INDEX_LAST) ?
				   WORD_INDEX_CURRENT + 1'b1 : WORD_INDEX_ZERO;
      end
   endfunction


   //
   // Ports
   //
   input		wire										clk;			// system clock
   input		wire										rst_n;		// active-low async reset

   input		wire										ena;			// enable input
   output	wire 											rdy;			// ready output

   output	wire [WORD_COUNTER_WIDTH-1:0] 								ab_addr;		// index of current A and B words
   output	wire [WORD_COUNTER_WIDTH-1:0] 								n_addr;		// index of current N word
   output	wire [WORD_COUNTER_WIDTH-1:0] 								s_addr;		// index of current S word
   output	wire 											s_wren;		// store current S word now

   input		wire [                  31:0] 							a_din;		// A
   input		wire [                  31:0] 							b_din;		// B
   input		wire [                  31:0] 							n_din;		// N
   output	wire [                  31:0] 								s_dout;		// S = (A + B) mod N


   //
   // Word Indices
   //
   reg [WORD_COUNTER_WIDTH-1:0] 									index_ab;
   reg [WORD_COUNTER_WIDTH-1:0] 									index_n;
   reg [WORD_COUNTER_WIDTH-1:0] 									index_s;

   /* map registers to output ports */
   assign ab_addr	= index_ab;
   assign n_addr	= index_n;
   assign s_addr	= index_s;


   //
   // Adder
   //
   wire [31: 0] 											add32_s;
   wire 												add32_c_in;
   wire 												add32_c_out;

   adder32_wrapper adder32
     (
      .clk		(clk),
      .a			(a_din),
      .b			(b_din),
      .s			(add32_s),
      .c_in		(add32_c_in),
      .c_out	(add32_c_out)
      );


   //
   // Subtractor
   //
   wire [31: 0] 											sub32_d;
   wire 												sub32_b_in;
   wire 												sub32_b_out;

   subtractor32_wrapper subtractor32
     (
      .clk		(clk),
      .a			(add32_s),
      .b			(n_din),
      .d			(sub32_d),
      .b_in		(sub32_b_in),
      .b_out	(sub32_b_out)
      );


   //
   // FSM
   //

   localparam FSM_SHREG_WIDTH = 2*OPERAND_NUM_WORDS + 5;

   reg [FSM_SHREG_WIDTH-1:0] 										fsm_shreg;

   assign rdy = fsm_shreg[0];

   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_inc_index_ab	= fsm_shreg[FSM_SHREG_WIDTH - (0 * OPERAND_NUM_WORDS + 1) : FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 0)];
   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_inc_index_n		= fsm_shreg[FSM_SHREG_WIDTH - (0 * OPERAND_NUM_WORDS + 2) : FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 1)];
   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_store_sum_ab	= fsm_shreg[FSM_SHREG_WIDTH - (0 * OPERAND_NUM_WORDS + 3) : FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 2)];
   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_store_sum_ab_n	= fsm_shreg[FSM_SHREG_WIDTH - (0 * OPERAND_NUM_WORDS + 4) : FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 3)];
   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_store_data_s	= fsm_shreg[FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 4) : FSM_SHREG_WIDTH - (2 * OPERAND_NUM_WORDS + 3)];
   wire [OPERAND_NUM_WORDS-1:0] 									fsm_shreg_inc_index_s		= fsm_shreg[FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 5) : FSM_SHREG_WIDTH - (2 * OPERAND_NUM_WORDS + 4)];

   wire 												fsm_latch_msb_carry	= fsm_shreg[FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 2)];
   wire 												fsm_latch_msb_borrow	= fsm_shreg[FSM_SHREG_WIDTH - (1 * OPERAND_NUM_WORDS + 3)];

   wire 												inc_index_ab		= |fsm_shreg_inc_index_ab;
   wire 												inc_index_n		= |fsm_shreg_inc_index_n;
   wire 												store_sum_ab		= |fsm_shreg_store_sum_ab;
   wire 												store_sum_ab_n	= |fsm_shreg_store_sum_ab_n;
   wire 												store_data_s		= |fsm_shreg_store_data_s;
   wire 												inc_index_s		= |fsm_shreg_inc_index_s;

   always @(posedge clk or negedge rst_n)
     //
     if (rst_n == 1'b0)
       //
       fsm_shreg <= {{FSM_SHREG_WIDTH-1{1'b0}}, 1'b1};
   //
     else begin
	//
	if (rdy)	fsm_shreg <= {ena, {FSM_SHREG_WIDTH-2{1'b0}}, ~ena};
	//
	else		fsm_shreg <= {1'b0, fsm_shreg[FSM_SHREG_WIDTH-1:1]};
	//
     end







   //
   // Carry & Borrow Masking Logic
   //
   reg	add32_c_mask;
   reg	sub32_b_mask;

   always @(posedge clk) begin
      //
      add32_c_mask <= (index_ab == WORD_INDEX_ZERO) ? 1'b1 : 1'b0;
      sub32_b_mask <= (index_n  == WORD_INDEX_ZERO) ? 1'b1 : 1'b0;
      //
   end

   assign add32_c_in = add32_c_out & ~add32_c_mask;
   assign sub32_b_in = sub32_b_out & ~sub32_b_mask;


   //
   // Carry & Borrow Latch Logic
   //
   reg add32_carry_latch;
   reg sub32_borrow_latch;

   always @(posedge clk) begin
      //
      if (fsm_latch_msb_carry) add32_carry_latch <= add32_c_out;
      if (fsm_latch_msb_borrow) sub32_borrow_latch <= sub32_b_out;
      //
   end


   //
   // Intermediate Results
   //
   reg	[32*OPERAND_NUM_WORDS-1:0]		s_ab;
   reg [32*OPERAND_NUM_WORDS-1:0] 		s_ab_n;

   always @(posedge clk)
     //
     if (store_data_s) begin
	//
	s_ab		<= {{32{1'bX}}, s_ab[32*OPERAND_NUM_WORDS-1:32]};
	s_ab_n	<= {{32{1'bX}}, s_ab_n[32*OPERAND_NUM_WORDS-1:32]};
	//
     end else begin
	//
	if (store_sum_ab) s_ab <= {add32_s, s_ab[32*OPERAND_NUM_WORDS-1:32]};
	if (store_sum_ab_n) s_ab_n <= {sub32_d, s_ab_n[32*OPERAND_NUM_WORDS-1:32]};
	//
     end


   //
   // Word Index Increment Logic
   //
   always @(posedge clk)
     //
     if (rdy) begin
	//
	index_ab		<= WORD_INDEX_ZERO;
	index_n		<= WORD_INDEX_ZERO;
	index_s		<= WORD_INDEX_ZERO;
	//
     end else begin
	//
	if (inc_index_ab) index_ab <= WORD_INDEX_NEXT_OR_ZERO(index_ab);
	if (inc_index_n)	index_n	<= WORD_INDEX_NEXT_OR_ZERO(index_n);
	if (inc_index_s)	index_s	<= WORD_INDEX_NEXT_OR_ZERO(index_s);
	//
     end


   //
   // Output Sum Selector
   //
   wire	mux_select_ab = sub32_borrow_latch && !add32_carry_latch;


   //
   // Output Data and Write Enable Logic
   //
   reg 	s_wren_reg;
   reg [31: 0] s_dout_reg;
   wire [31: 0] s_dout_mux = mux_select_ab ? s_ab[31:0] : s_ab_n[31:0];

   assign s_wren = s_wren_reg;
   assign s_dout = s_dout_reg;

   always @(posedge clk)
     //
     if (rdy) begin
	//
	s_wren_reg	<= 1'b0;
	s_dout_reg	<= {32{1'bX}};
	//
     end else begin
	//
	s_wren_reg <= store_data_s;
	s_dout_reg <= store_data_s ? s_dout_mux : {32{1'bX}};
	//
     end


endmodule


//------------------------------------------------------------------------------
// End-of-File
//------------------------------------------------------------------------------