aboutsummaryrefslogblamecommitdiff
path: root/src/rtl/wb_sha256.v
blob: 024d0b9d9ccfa7bd2ec17d19c582c47081cfee9e (plain) (tree)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674

































































































































































































































































































































































































































































































































































































































































































                                                                                                    
//======================================================================
//
// wb_sha256.v
// -----------
// Wisbone compliant top level wrapper for the SHA-256 hash core.
//
//
// Author: Joachim Strombergson
// Copyright (c) 2014 SUNET
// 
// Redistribution and use in source and binary forms, with or 
// without modification, are permitted provided that the following 
// conditions are met: 
// 
// 1. Redistributions of source code must retain the above copyright 
//    notice, this list of conditions and the following disclaimer. 
// 
// 2. 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. 
// 
// 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 OWNER 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 wb_sha256(
                 // Clock and reset.
                 input wire           CLK_I,
                 input wire           RST_I,
                 
                 // Control and status.
                 input wire           STB_I,
                 input wire           WE_I,
                 output wire          ACK_O,
                 output wire          ERR_O,
              
                 // Address and data.
                 input wire  [7 : 0]  ADR_I,
                 input wire  [31 : 0] DAT_I,              
                 output wire [31 : 0] DAT_O
                );

  
  //----------------------------------------------------------------
  // Internal constant and parameter definitions.
  //----------------------------------------------------------------
  parameter ADDR_NAME0       = 8'h00;
  parameter ADDR_NAME1       = 8'h01;
  parameter ADDR_VERSION     = 8'h02;

  parameter ADDR_CTRL          = 8'h08;
  parameter CTRL_INIT_BIT      = 0;
  parameter CTRL_INIT_VALUE    = 8'h01;
  parameter CTRL_NEXT_BIT      = 1;
  parameter CTRL_NEXT_VALUE    = 8'h02;

  parameter ADDR_STATUS        = 8'h09;
  parameter STATUS_READY_BIT   = 0;
  parameter STATUS_VALID_BIT   = 1;
                             
  parameter ADDR_BLOCK0        = 8'h10;
  parameter ADDR_BLOCK1        = 8'h11;
  parameter ADDR_BLOCK2        = 8'h12;
  parameter ADDR_BLOCK3        = 8'h13;
  parameter ADDR_BLOCK4        = 8'h14;
  parameter ADDR_BLOCK5        = 8'h15;
  parameter ADDR_BLOCK6        = 8'h16;
  parameter ADDR_BLOCK7        = 8'h17;
  parameter ADDR_BLOCK8        = 8'h18;
  parameter ADDR_BLOCK9        = 8'h19;
  parameter ADDR_BLOCK10       = 8'h1a;
  parameter ADDR_BLOCK11       = 8'h1b;
  parameter ADDR_BLOCK12       = 8'h1c;
  parameter ADDR_BLOCK13       = 8'h1d;
  parameter ADDR_BLOCK14       = 8'h1e;
  parameter ADDR_BLOCK15       = 8'h1f;
                             
  parameter ADDR_DIGEST0       = 8'h20;
  parameter ADDR_DIGEST1       = 8'h21;
  parameter ADDR_DIGEST2       = 8'h22;
  parameter ADDR_DIGEST3       = 8'h23;
  parameter ADDR_DIGEST4       = 8'h24;
  parameter ADDR_DIGEST5       = 8'h25;
  parameter ADDR_DIGEST6       = 8'h26;
  parameter ADDR_DIGEST7       = 8'h27;

  parameter CORE_NAME0   = 32'h73686132; // "sha2"
  parameter CORE_NAME1   = 32'h2d323536; // "-256"
  parameter CORE_VERSION = 32'h302e3830; // "0.80"

  
  //----------------------------------------------------------------
  // Registers including update variables and write enable.
  //----------------------------------------------------------------
  reg init_reg;
  reg next_reg;
  reg ctrl_we;
  
  reg ready_reg;

  reg [31 : 0] block0_reg;
  reg          block0_we;
  reg [31 : 0] block1_reg;
  reg          block1_we;
  reg [31 : 0] block2_reg;
  reg          block2_we;
  reg [31 : 0] block3_reg;
  reg          block3_we;
  reg [31 : 0] block4_reg;
  reg          block4_we;
  reg [31 : 0] block5_reg;
  reg          block5_we;
  reg [31 : 0] block6_reg;
  reg          block6_we;
  reg [31 : 0] block7_reg;
  reg          block7_we;
  reg [31 : 0] block8_reg;
  reg          block8_we;
  reg [31 : 0] block9_reg;
  reg          block9_we;
  reg [31 : 0] block10_reg;
  reg          block10_we;
  reg [31 : 0] block11_reg;
  reg          block11_we;
  reg [31 : 0] block12_reg;
  reg          block12_we;
  reg [31 : 0] block13_reg;
  reg          block13_we;
  reg [31 : 0] block14_reg;
  reg          block14_we;
  reg [31 : 0] block15_reg;
  reg          block15_we;

  reg [255 : 0] digest_reg;

  reg digest_valid_reg;

  
  //----------------------------------------------------------------
  // Wires.
  //----------------------------------------------------------------
  wire           core_init;
  wire           core_next;
  wire           core_ready;
  wire [511 : 0] core_block;
  wire [255 : 0] core_digest;
  wire           core_digest_valid;

  reg [31 : 0]   tmp_data_out;
  reg            tmp_ACK_O;
  reg            tmp_ERR_O;

  wire reset_n;
  
  
  //----------------------------------------------------------------
  // Concurrent connectivity for ports etc.
  //----------------------------------------------------------------
  assign core_init = init_reg;

  assign core_next = next_reg;

  assign core_block = {block0_reg, block1_reg, block2_reg, block3_reg,
                       block4_reg, block5_reg, block6_reg, block7_reg,
                       block8_reg, block9_reg, block10_reg, block11_reg,
                       block12_reg, block13_reg, block14_reg, block15_reg};

  assign DAT_O = tmp_data_out;

  assign ACK_O = tmp_ACK_O;
  assign ERR_O = tmp_ERR_O;

  assign reset_n = ~RST_I;
    
             
  //----------------------------------------------------------------
  // core instantiation.
  //----------------------------------------------------------------
  sha256_core core(
                   .clk(CLK_I),
                   .reset_n(reset_n),
                   
                   .init(core_init),
                   .next(core_next),
                  
                   .block(core_block),
                   
                   .ready(core_ready),
                   
                   .digest(core_digest),
                   .digest_valid(core_digest_valid)
                  );
  
  
  //----------------------------------------------------------------
  // reg_update
  //
  // Update functionality for all registers in the core.
  // All registers are positive edge triggered with synchronous
  // active low reset. All registers have write enable.
  //----------------------------------------------------------------
  always @ (posedge CLK_I)
    begin
      if (!reset_n)
        begin
          init_reg         <= 0;
          next_reg         <= 0;
          ready_reg        <= 0;
          digest_reg       <= 256'h0000000000000000000000000000000000000000000000000000000000000000;
          digest_valid_reg <= 0;
          block0_reg       <= 32'h00000000;
          block1_reg       <= 32'h00000000;
          block2_reg       <= 32'h00000000;
          block3_reg       <= 32'h00000000;
          block4_reg       <= 32'h00000000;
          block5_reg       <= 32'h00000000;
          block6_reg       <= 32'h00000000;
          block7_reg       <= 32'h00000000;
          block8_reg       <= 32'h00000000;
          block9_reg       <= 32'h00000000;
          block10_reg      <= 32'h00000000;
          block11_reg      <= 32'h00000000;
          block12_reg      <= 32'h00000000;
          block13_reg      <= 32'h00000000;
          block14_reg      <= 32'h00000000;
          block15_reg      <= 32'h00000000;
        end
      else
        begin
          ready_reg        <= core_ready;
          digest_valid_reg <= core_digest_valid;

          if (ctrl_we)
            begin
              init_reg <= DAT_I[CTRL_INIT_BIT];
              next_reg <= DAT_I[CTRL_NEXT_BIT];
            end
          
          if (core_digest_valid)
            begin
              digest_reg <= core_digest;
            end

          if (block0_we)
            begin
              block0_reg <= DAT_I;
            end

          if (block1_we)
            begin
              block1_reg <= DAT_I;
            end

          if (block2_we)
            begin
              block2_reg <= DAT_I;
            end

          if (block3_we)
            begin
              block3_reg <= DAT_I;
            end

          if (block4_we)
            begin
              block4_reg <= DAT_I;
            end

          if (block5_we)
            begin
              block5_reg <= DAT_I;
            end

          if (block6_we)
            begin
              block6_reg <= DAT_I;
            end

          if (block7_we)
            begin
              block7_reg <= DAT_I;
            end

          if (block8_we)
            begin
              block8_reg <= DAT_I;
            end

          if (block9_we)
            begin
              block9_reg <= DAT_I;
            end

          if (block10_we)
            begin
              block10_reg <= DAT_I;
            end

          if (block11_we)
            begin
              block11_reg <= DAT_I;
            end

          if (block12_we)
            begin
              block12_reg <= DAT_I;
            end

          if (block13_we)
            begin
              block13_reg <= DAT_I;
            end

          if (block14_we)
            begin
              block14_reg <= DAT_I;
            end

          if (block15_we)
            begin
              block15_reg <= DAT_I;
            end
          
        end
    end // reg_update


  //----------------------------------------------------------------
  // addr_decoder
  //
  // IF SEL_I is enabled will either try to write to or read
  // from the internal registers.
  //----------------------------------------------------------------
  always @*
    begin : addr_decoder
      ctrl_we      = 0;
      block0_we    = 0;
      block1_we    = 0;
      block2_we    = 0;
      block3_we    = 0;
      block4_we    = 0;
      block5_we    = 0;
      block6_we    = 0;
      block7_we    = 0;
      block8_we    = 0;
      block9_we    = 0;
      block10_we   = 0;
      block11_we   = 0;
      block12_we   = 0;
      block13_we   = 0;
      block14_we   = 0;
      block15_we   = 0;
      tmp_data_out = 32'h00000000;
      tmp_ERR_O    = 0;
      tmp_ACK_O    = 0;
      
      if (STB_I)
        begin
          if (WE_I)
            begin
              case (ADR_I)
                // Write operations.
                ADDR_CTRL:
                  begin
                    ctrl_we = 1;
                    tmp_ACK_O = 1;
                  end
                
                ADDR_BLOCK0:
                  begin
                    block0_we = 1;
                    tmp_ACK_O = 1;
                   end

                ADDR_BLOCK1:
                  begin
                    block1_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK2:
                  begin
                    block2_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK3:
                  begin
                    block3_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK4:
                  begin
                    block4_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK5:
                  begin
                    block5_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK6:
                  begin
                    block6_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK7:
                  begin
                    block7_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK8:
                  begin
                    block8_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK9:
                  begin
                    block9_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK10:
                  begin
                    block10_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK11:
                  begin
                    block11_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK12:
                  begin
                    block12_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK13:
                  begin
                    block13_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK14:
                  begin
                    block14_we = 1;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK15:
                  begin
                    block15_we = 1;
                    tmp_ACK_O = 1;
                  end
                
                default:
                  begin
                    tmp_ERR_O = 1;
                  end
              endcase // case (ADR_I)
            end // if (WE_I)

          else
            begin
              case (ADR_I)
                // Read operations.
                ADDR_NAME0:
                  begin
                    tmp_data_out = CORE_NAME0;
                    tmp_ACK_O = 1;
                  end
                
                ADDR_NAME1:
                  begin
                    tmp_data_out = CORE_NAME1;
                    tmp_ACK_O = 1;
                  end

                ADDR_VERSION:
                  begin
                    tmp_data_out = CORE_VERSION;
                    tmp_ACK_O = 1;
                  end
                
                ADDR_CTRL:
                  begin
                    tmp_data_out = {28'h0000000, 2'b00, next_reg, init_reg};
                    tmp_ACK_O = 1;
                  end
                
                ADDR_STATUS:
                  begin
                    tmp_data_out = {28'h0000000, 2'b00, digest_valid_reg, ready_reg};
                    tmp_ACK_O = 1;
                  end
                
                ADDR_BLOCK0:
                  begin
                    tmp_data_out = block0_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK1:
                  begin
                    tmp_data_out = block1_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK2:
                  begin
                    tmp_data_out = block2_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK3:
                  begin
                    tmp_data_out = block3_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK4:
                  begin
                    tmp_data_out = block4_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK5:
                  begin
                    tmp_data_out = block5_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK6:
                  begin
                    tmp_data_out = block6_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK7:
                  begin
                    tmp_data_out = block7_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK8:
                  begin
                    tmp_data_out = block8_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK9:
                  begin
                    tmp_data_out = block9_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK10:
                  begin
                    tmp_data_out = block10_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK11:
                  begin
                    tmp_data_out = block11_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK12:
                  begin
                    tmp_data_out = block12_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK13:
                  begin
                    tmp_data_out = block13_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK14:
                  begin
                    tmp_data_out = block14_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_BLOCK15:
                  begin
                    tmp_data_out = block15_reg;
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST0:
                  begin
                    tmp_data_out = digest_reg[255 : 224];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST1:
                  begin
                    tmp_data_out = digest_reg[223 : 192];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST2:
                  begin
                    tmp_data_out = digest_reg[191 : 160];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST3:
                  begin
                    tmp_data_out = digest_reg[159 : 128];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST4:
                  begin
                    tmp_data_out = digest_reg[127 :  96];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST5:
                  begin
                    tmp_data_out = digest_reg[95  :  64];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST6:
                  begin
                    tmp_data_out = digest_reg[63  :  32];
                    tmp_ACK_O = 1;
                  end

                ADDR_DIGEST7:
                  begin
                    tmp_data_out = digest_reg[31  :   0];
                    tmp_ACK_O = 1;
                  end
                
                default:
                  begin
                    tmp_ERR_O = 1;
                  end
              endcase // case (ADR_I)
            end
        end
    end // addr_decoder
endmodule // wb_sha256

//======================================================================
// EOF wb_sha256.v
//======================================================================