fifo_same_clock.v 5.84 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/*!
 * <b>Module:</b>fifo_same_clock
 * @file fifo_same_clock.v
 * @date 2014-05-20  
 * @author Andrey Filippov
 *
 * @brief Configurable synchronous FIFO using the same clock for read and write
 *
 * @copyright Copyright (c) 2014 Elphel, Inc.
 *
 * <b>License:</b>
12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * fifo_same_clock.v is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 *  fifo_same_clock.v is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/> .
25 26 27 28 29 30
 *
 * Additional permission under GNU GPL version 3 section 7:
 * If you modify this Program, or any covered work, by linking or combining it
 * with independent modules provided by the FPGA vendor only (this permission
 * does not extend to any 3-rd party modules, "soft cores" or macros) under
 * different license terms solely for the purpose of generating binary "bitstream"
31
 * files and/or simulating the code, the copyright holders of this Program give
32 33
 * you the right to distribute the covered work without those independent modules
 * as long as the source code for them is available from the FPGA vendor free of
Andrey Filippov's avatar
Andrey Filippov committed
34
 * charge, and there is no dependence on any encrypted modules for simulating of
35 36 37
 * the combined code. This permission applies to you if the distributed code
 * contains all the components and scripts required to completely simulate it
 * with at least one of the Free Software programs.
38
 */
39
`timescale 1ns/1ps
40
`include "system_defines.vh" 
Andrey Filippov's avatar
Andrey Filippov committed
41
//`define DEBUG_FIFO 1 
42 43 44 45 46 47 48 49
module fifo_same_clock
#(
  parameter integer DATA_WIDTH=16,
  parameter integer DATA_DEPTH=4
)
    (
  input                   rst,      // reset, active high
  input                   clk,      // clock - positive edge
Andrey Filippov's avatar
Andrey Filippov committed
50
  input                   sync_rst, // synchronously reset fifo;
51 52 53 54
  input                   we,       // write enable
  input                   re,       // read enable
  input  [DATA_WIDTH-1:0] data_in,  // input data
  output [DATA_WIDTH-1:0] data_out, // output data
Andrey Filippov's avatar
Andrey Filippov committed
55
  output                  nempty,   // FIFO has some data
56
  output reg              half_full // FIFO half full
Andrey Filippov's avatar
Andrey Filippov committed
57 58 59 60 61 62 63 64
`ifdef DEBUG_FIFO
    ,output reg                 under,    // debug outputs - under - attempt to read from empty
    output reg                  over,      // overwritten
    output reg [DATA_DEPTH-1:0] wcount,
    output reg [DATA_DEPTH-1:0] rcount,
    output     [DATA_DEPTH-1:0] num_in_fifo
    
`endif
65 66
  );
    localparam integer DATA_2DEPTH=(1<<DATA_DEPTH)-1;
Andrey Filippov's avatar
Andrey Filippov committed
67 68 69 70
//ISExst: FF/Latch ddrc_test01.axibram_write_i.waddr_i.fill[4] has a constant value of 0 in block <ddrc_test01>. This FF/Latch will be trimmed during the optimization process.
//ISExst: FF/Latch ddrc_test01.axibram_read_i.raddr_i.fill[4] has a constant value of 0 in block <ddrc_test01>. This FF/Latch will be trimmed during the optimization process.
//ISExst: FF/Latch ddrc_test01.axibram_write_i.wdata_i.fill[4] has a constant value of 0 in block <ddrc_test01>. This FF/Latch will be trimmed during the optimization process.
// Do not understand - why?
Andrey Filippov's avatar
Andrey Filippov committed
71
    reg  [DATA_DEPTH-1:0] fill=0; // RAM fill
72 73 74 75
    reg  [DATA_WIDTH-1:0] inreg;
    reg  [DATA_WIDTH-1:0] outreg;
    reg  [DATA_DEPTH-1:0] ra;
    reg  [DATA_DEPTH-1:0] wa;
76
//    wire [DATA_DEPTH-1:0] next_fill;
77 78 79 80
    reg  wem;
    wire rem;
    reg  out_full=0; //output register full
    reg  [DATA_WIDTH-1:0]   ram [0:DATA_2DEPTH];
81
    
Andrey Filippov's avatar
Andrey Filippov committed
82 83
    reg  ram_nempty;
    
84
//    assign next_fill = fill[DATA_DEPTH-1:0]+((wem && ~rem)?1:((~wem && rem && ram_nempty)?-1:0));
Andrey Filippov's avatar
Andrey Filippov committed
85 86 87 88 89 90 91 92
    assign rem= ram_nempty && (re || !out_full); 
    assign data_out=outreg;
    assign nempty=out_full;
    
`ifdef DEBUG_FIFO
    assign num_in_fifo=fill[DATA_DEPTH-1:0];
`endif
    
93
    always @ (posedge  clk or posedge  rst) begin
94 95 96 97 98
      if      (rst)          fill <= 0;
      else if (sync_rst)     fill <= 0;
//      else               fill <= next_fill;
      else if ( wem && ~rem) fill <= fill + 1;
      else if (~wem &&  rem) fill <= fill - 1;
Andrey Filippov's avatar
Andrey Filippov committed
99 100 101 102 103 104 105
      
      if (rst)           wem <= 0;
      else if (sync_rst) wem <= 0;
      else               wem <= we;
      
      if   (rst)         ram_nempty <= 0;
      else if (sync_rst) ram_nempty <= 0;
106 107 108
//      else               ram_nempty <= (next_fill != 0);
//      else               ram_nempty <= wem || (|fill[DATA_DEPTH-1:1]) || (fill[0] && !rem);
      else               ram_nempty <= (|fill[DATA_DEPTH-1:1]) || (fill[0] && wem) || ((fill[0] || wem) && !rem) ;
Andrey Filippov's avatar
Andrey Filippov committed
109
     
Andrey Filippov's avatar
Andrey Filippov committed
110 111 112 113 114 115 116
      if (rst)           wa <= 0;
      else if (sync_rst) wa <= 0;
      else if (wem)      wa <= wa+1;
      
      if (rst)              ra <=  0;
      else if (sync_rst)    ra <= 0;
      else if (rem)         ra <= ra+1;
Andrey Filippov's avatar
Andrey Filippov committed
117
      else if (!ram_nempty) ra <= wa; // Just recover from bit errors
118 119

      if (rst)             out_full <= 0;
Andrey Filippov's avatar
Andrey Filippov committed
120
      else if (sync_rst)   out_full <= 0;
121 122
      else if (rem && ~re) out_full <= 1;
      else if (re && ~rem) out_full <= 0;
Andrey Filippov's avatar
Andrey Filippov committed
123 124

`ifdef DEBUG_FIFO
Andrey Filippov's avatar
Andrey Filippov committed
125 126 127
      if (rst)            wcount <= 0;
      else if (sync_rst)  wcount <= 0;
      else if (we)        wcount <= wcount + 1;
Andrey Filippov's avatar
Andrey Filippov committed
128

Andrey Filippov's avatar
Andrey Filippov committed
129 130 131
      if (rst)           rcount <= 0;
      else if (sync_rst) rcount <= 0;
      else if (re)       rcount <= rcount + 1;
Andrey Filippov's avatar
Andrey Filippov committed
132
`endif      
133
    end
Andrey Filippov's avatar
Andrey Filippov committed
134 135

// no reset elements
136 137
    always @ (posedge  clk) begin
      half_full <=(fill & (1<<(DATA_DEPTH-1)))!=0;
Andrey Filippov's avatar
Andrey Filippov committed
138
      if (wem) ram[wa] <= inreg;
139
      if (we)  inreg  <= data_in;
Andrey Filippov's avatar
Andrey Filippov committed
140 141 142 143 144
      if (rem) outreg <= ram[ra];
`ifdef DEBUG_FIFO
      under <= ~we & re & ~nempty; // underrun error
      over <=  we & ~re & (fill == (1<< (DATA_DEPTH-1)));    // overrun error
`endif      
145 146
    end
endmodule