Subversion Repositories wf3d

//=======================================================================

// Project Monophony

//   Wire-Frame 3D Graphics Accelerator IP Core

//

// File:

//   fm_fifo.v

//

// Abstract:

//   FIFO with data clear

//

// Author:

//   Kenji Ishimaru (info.info.wf3d@gmail.com)

//

//======================================================================

//

// Copyright (c) 2016, Kenji Ishimaru

// 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.

//

// 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.

//

// Revision History

module fm_fifo (

  clk_core,

  rst_x,

  i_wstrobe,

  i_dt,

  o_full,

  i_renable,

  o_dt,

  o_empty,

  o_dnum

);

// set default parameters

parameter P_WIDTH = 32;

parameter P_RANGE = 2;

parameter P_DEPTH = 1 << P_RANGE;

parameter P_CLEAR = "FALSE";

////////////////////////////

// I/O definition

////////////////////////////

input         clk_core;            // system clock

input         rst_x;          // system reset

input         i_wstrobe;      // write strobe

input  [P_WIDTH-1:0] i_dt;      // write data

output        o_full;         // write data full

input         i_renable;      // read enable

output [P_WIDTH-1:0] o_dt;      // read data

output        o_empty;        // read data empty

output [P_RANGE:0] o_dnum;      // written data number

/////////////////////////

//  Register definition

/////////////////////////

reg [P_RANGE-1:0] rs_write_counter;

reg [P_RANGE-1:0] rs_read_counter;

// data registers

reg [P_WIDTH-1:0] rs_data_buffer[0:P_DEPTH-1];

reg [P_RANGE:0] rs_status;

/////////////////////////

//  wire definition

/////////////////////////

wire             o_full;

wire             o_empty;

wire [P_WIDTH-1:0] o_dt;

wire [1:0]       w_status;

wire             w_we;

wire             w_re;

/////////////////////////

//  assign statement

/////////////////////////

assign o_full  = (rs_status == P_DEPTH);

assign o_empty = (rs_status == 0);

assign o_dt = rs_data_buffer[rs_read_counter];

assign o_dnum = rs_status;

assign w_we = !o_full & i_wstrobe;

assign w_re = i_renable & !o_empty;

assign w_status = {w_re,w_we};

////////////////////////

// always statement

///////////////////////

  // write side

  always @(posedge clk_core or negedge rst_x) begin

    if (~rst_x) begin

      rs_write_counter <= 'd0;

    end else begin

      if (w_we) begin

        rs_write_counter <= rs_write_counter + 1'b1;

      end

    end

  end

generate

  if (P_CLEAR == "TRUE") begin

    integer i;

    always @(posedge clk_core or negedge rst_x) begin

      if (~rst_x) begin

        for(i=0;i<P_DEPTH;i=i+1) rs_data_buffer[i] <= 'd0;

      end else begin

        if (w_we) begin

          rs_data_buffer[rs_write_counter] <= i_dt;

        end

      end

    end

  end else begin

    always @(posedge clk_core) begin

      if (w_we) begin

        rs_data_buffer[rs_write_counter] <= i_dt;

      end

    end

  end

endgenerate

  // read side

  always @(posedge clk_core or negedge rst_x) begin

    if (~rst_x) begin

      rs_read_counter <= 'd0;

    end else begin

      if (w_re) begin

        rs_read_counter <= rs_read_counter + 1'b1;

      end

    end

  end

  // status counter

  always @(posedge clk_core or negedge rst_x) begin

    if (~rst_x) begin

      rs_status <= 'd0;

    end else begin

      case (w_status)

        2'b01:  rs_status <= rs_status + 1'b1; // write

        2'b10:  rs_status <= rs_status - 1'b1; // read

        default:  rs_status <= rs_status;      // nothing to do 

      endcase

    end

  end

endmodule