Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / design / sys / iop / niu / rtl / niu_meta_arb_syncfifo.v

// ========== Copyright Header Begin ==========================================
// 
// OpenSPARC T2 Processor File: niu_meta_arb_syncfifo.v
// Copyright (C) 1995-2007 Sun Microsystems, Inc. All Rights Reserved
// 4150 Network Circle, Santa Clara, California 95054, U.S.A.
//
// * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 
//
// This program 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; version 2 of the License.
//
// This program 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, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
// 
// For the avoidance of doubt, and except that if any non-GPL license 
// choice is available it will apply instead, Sun elects to use only 
// the General Public License version 2 (GPLv2) at this time for any 
// software where a choice of GPL license versions is made 
// available with the language indicating that GPLv2 or any later version 
// may be used, or where a choice of which version of the GPL is applied is 
// otherwise unspecified. 
//
// Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 
// CA 95054 USA or visit www.sun.com if you need additional information or 
// have any questions. 
// 
// ========== Copyright Header End ============================================
/*********************************************************************
 *
 *  niu_meta_arb_syncfifo.v
 *
 *  Parameterized synchronous fifo 
 * 
 *  Original Author(s):   Nimita Taneja
 *  Modifier(s):
 *  Project(s):          Neptune
 *
 *  Copyright (c) 2004   Sun Microsystems, Inc.
 *
 *  Revision History:  03-01-2004     : Initial Release
 *
 *  All Rights Reserved.
 *
 *  This verilog model is the confidential and proprietary property of
 *  Sun Microsystems, Inc., and the possession or use of this model
 *  requires a written license from Sun Microsystems, Inc.
 *
 **********************************************************************/

module niu_meta_arb_syncfifo (core_clk, reset , inc_rp, inc_wp, fifo_not_empty,
                   fifo_full, din, rdout, dout, count);

parameter WIDTH = 16;
parameter [31:0] DEPTH = 4;   
parameter ASIZE = 2;   

input           core_clk, reset   , inc_rp, inc_wp;
input [WIDTH-1:0]    din;

output          fifo_not_empty, fifo_full;
output [WIDTH-1:0]   rdout;
output [WIDTH-1:0]   dout;
output [ASIZE:0]    count;


reg [WIDTH-1:0]      fifo[0:DEPTH-1];
reg [ASIZE-1:0]          wp;
reg  [ASIZE-1:0]         rp;
wire [WIDTH-1:0]      dout;
reg [WIDTH-1:0]      rdout;
reg [ASIZE:0]       fifosize;
wire            fifo_not_empty;
wire            fifo_empty;
wire            fifo_full;
integer         i;
wire [ASIZE:0]      count;
assign count = fifosize;

assign fifo_full = (fifosize==DEPTH[ASIZE:0]);

// synopsys translate_off
`ifdef META_ERR_CHECK
reg     error;
always@(posedge core_clk) begin
    if (reset) error <= 0;
    else if (fifo_full & inc_wp) begin
                error = 1;
                $display($time, " %m -ERROR:  fifo overrun !!!!!!!!!");
                repeat(10) @(posedge core_clk);
        end
        else if ((fifosize == 0) & inc_rp) begin
                error = 1;
                $display($time, " %m -ERROR:  fifo underrun !!!!!!!!!");
                repeat(10) @(posedge core_clk);
        end
end
`endif
// synopsys translate_on

always@(posedge core_clk)
   if (reset)           fifosize <= 0;
   else if (inc_wp & !inc_rp)   fifosize <= fifosize +1'b1;
   else if (!inc_wp & inc_rp)   fifosize <= fifosize -1'b1;
   else                         fifosize <= fifosize;



assign fifo_not_empty   = fifosize > 0;
assign fifo_empty   = (fifosize == 0);

always@(posedge core_clk)
  if (reset)                    wp <= 0;
  else if (inc_wp & !fifo_full) wp <= wp + 1'b1;

always@(posedge core_clk)
  if (reset)                      rp <= 0;
 else if (inc_rp & !fifo_empty)  rp <= rp + 1'b1;

always@(posedge core_clk)
  if (reset) begin
        for (i=0; i<DEPTH; i=i+1) fifo[i] <= 0;
  end
  else if (inc_wp)
        fifo[wp] <= din;
  else begin
        for (i=0; i<DEPTH; i=i+1) fifo[i] <= fifo[i];
  end
/*
always@(rp or fifo[0] or fifo[1] or fifo_not_empty)
  case(rp) // synopsys parallel_case
         1'b0: dout = fifo[0] & {WIDTH{fifo_not_empty}};
         1'b1: dout = fifo[1] & {WIDTH{fifo_not_empty}};
      default: dout = fifo[0] & {WIDTH{fifo_not_empty}};
  endcase
*/

assign  dout = fifo[rp]  & {WIDTH{fifo_not_empty}};
   
always@(posedge core_clk)
  if (reset)
 rdout <= 0;
  else
     rdout <= dout;

endmodule