From 1c51bdc9f94ff66bc8434aa97c397bc9c06d14ab Mon Sep 17 00:00:00 2001
From: dam1n19 <dam1n19@soton.ac.uk>
Date: Thu, 27 Apr 2023 13:29:35 +0100
Subject: [PATCH] SOC1-167: Moved generic library files into own repository
---
mem/verilog/SROM_Ax32.v | 127 +++++++++++++++++++++++++++
pads/verilog/GLIB_PADLIB.v | 139 ++++++++++++++++++++++++++++++
pads/verilog/PAD_ANALOG.v | 18 ++++
pads/verilog/PAD_INOUT8MA_NOE.v | 39 +++++++++
pads/verilog/PAD_INOUT8MA_OE.v | 39 +++++++++
pads/verilog/PAD_VDDIO.v | 18 ++++
pads/verilog/PAD_VDDSOC.v | 19 ++++
pads/verilog/PAD_VSS.v | 18 ++++
pads/verilog/PAD_VSSIO.v | 19 ++++
sync/verilog/SYNCHRONIZER_EDGES.v | 42 +++++++++
10 files changed, 478 insertions(+)
create mode 100644 mem/verilog/SROM_Ax32.v
create mode 100755 pads/verilog/GLIB_PADLIB.v
create mode 100644 pads/verilog/PAD_ANALOG.v
create mode 100644 pads/verilog/PAD_INOUT8MA_NOE.v
create mode 100644 pads/verilog/PAD_INOUT8MA_OE.v
create mode 100644 pads/verilog/PAD_VDDIO.v
create mode 100644 pads/verilog/PAD_VDDSOC.v
create mode 100644 pads/verilog/PAD_VSS.v
create mode 100644 pads/verilog/PAD_VSSIO.v
create mode 100644 sync/verilog/SYNCHRONIZER_EDGES.v
diff --git a/mem/verilog/SROM_Ax32.v b/mem/verilog/SROM_Ax32.v
new file mode 100644
index 0000000..f2c3a9a
--- /dev/null
+++ b/mem/verilog/SROM_Ax32.v
@@ -0,0 +1,127 @@
+//-----------------------------------------------------------------------------
+//
+// Synthesizable byte-write addressible R/W (random-access) memory
+//
+// Synchronous data write, flow-though (non-pipeline registered) read data
+//
+// Auto-gernerates a synthesizable verilog ROM design
+// and binary text file for custom ROM via programming
+//
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2021-3, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module SROM_Ax32
+ #(parameter ADDRWIDTH = 10,
+ parameter filename = "rom32.hex",
+ parameter romgen = 0
+ )
+ (input wire CLK,
+ input wire [ADDRWIDTH-1:0] ADDR, //Address Input
+ input wire SEL, //Select (active-high)
+ output wire [31:0] RDATA); //Read Data
+
+ localparam MEMDEPTH = (1 << (ADDRWIDTH)-1)-1;
+ localparam romgenfile = "bootrom.v";
+ localparam bingenfile = "bootrom.bintxt";
+
+ // Reg declarations
+ reg [7:0] rombyte0 [0:MEMDEPTH];
+ reg [7:0] rombyte1 [0:MEMDEPTH];
+ reg [7:0] rombyte2 [0:MEMDEPTH];
+ reg [7:0] rombyte3 [0:MEMDEPTH];
+
+ reg [ADDRWIDTH-1:0] addr_r; // registered Address for read access
+
+// optional simulation RAM_INIT option to suppress 'X' initial contents
+`ifdef MEM_INIT
+ reg [7:0] fileimage [((4<<ADDRWIDTH)-1):0];
+ function [31:0] NoX32; input [31:0] n; NoX32 = (((^n) === 1'bx) ? 32'h0 : n); endfunction
+ integer fd; // file descriptor for file output
+ integer fd2; // file descriptor for file 2 output
+ integer i;
+ reg [39:0] today [0:1];
+
+initial
+ begin
+ $system("date +%y%m%d%H%M >date_file"); //format yymmdd
+ $readmemh("date_file", today);
+ $display("data_file: %x", today[0]);
+
+ for (i=0; i<= MEMDEPTH; i=i+1) begin
+ rombyte0[i] <= 8'he5;
+ rombyte1[i] <= 8'he5;
+ rombyte2[i] <= 8'he5;
+ rombyte3[i] <= 8'he5;
+ end
+ if (filename != "") begin
+ $readmemh(filename, fileimage);
+ for (i = 0; i <= MEMDEPTH; i=i+1) begin
+ rombyte0[i] <= fileimage[(i<<2)+0];
+ rombyte1[i] <= fileimage[(i<<2)+1];
+ rombyte2[i] <= fileimage[(i<<2)+2];
+ rombyte3[i] <= fileimage[(i<<2)+3];
+ end
+ end
+ if (romgen != 0)
+ begin
+ fd = $fopen(romgenfile);
+ fd2 = $fopen(bingenfile);
+ if ((fd == 0) || (fd2 == 0)) begin
+ $display("rom32gen: Error, zero returned in response to $fopen\n");
+ end
+ else begin
+ $display(fd,"rom32gen: Generating output file\n");
+ $fwrite(fd,"//------------------------------------------------------------------------------------\n");
+ $fwrite(fd,"// customised auto-generated synthesizable ROM module abstraction\n");
+ $fwrite(fd,"// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.\n");
+ $fwrite(fd,"//\n");
+ $fwrite(fd,"// Contributors\n");
+ $fwrite(fd,"//\n");
+ $fwrite(fd,"// David Flynn (d.w.flynn@soton.ac.uk)\n");
+ $fwrite(fd,"// Date: %x\n", today[0]);
+ $fwrite(fd,"// Copyright (c) 2021-2, SoC Labs (www.soclabs.org)\n");
+ $fwrite(fd,"//------------------------------------------------------------------------------------\n");
+ $fwrite(fd,"module bootrom (\n");
+ $fwrite(fd," input wire CLK,\n");
+ $fwrite(fd," input wire EN,\n");
+ $fwrite(fd," input wire [%0d:2] ADDR,\n", ADDRWIDTH+1);
+ $fwrite(fd," output reg [31:0] RDATA );\n");
+ $fwrite(fd,"reg [%0d:2] addr_r;\n", ADDRWIDTH+1);
+ $fwrite(fd,"always @(posedge CLK) if (EN) addr_r <= ADDR;\n");
+ $fwrite(fd,"always @(addr_r)");
+ $fwrite(fd," case(addr_r[%0d:2]) \n", ADDRWIDTH+1);
+ if (ADDRWIDTH > 8)
+ for (i = 0; i < 4 << (ADDRWIDTH); i=i+4) begin
+ $fwrite(fd," %2d'h%3x : RDATA <= 32'h%8x; // 0x%04x\n", ADDRWIDTH, i>>2, NoX32({fileimage[i+3],fileimage[i+2],fileimage[i+1],fileimage[i+0]}), i );
+ $fwrite(fd2,"%32b\n",NoX32({fileimage[i+3],fileimage[i+2],fileimage[i+1],fileimage[i+0]}));
+ end
+ else
+ for (i = 0; i < 4 << (ADDRWIDTH); i=i+4) begin
+ $fwrite(fd," %2d'h%2x : RDATA <= 32'h%8x; // 0x%04x\n", ADDRWIDTH, i>>2, NoX32({fileimage[i+3],fileimage[i+2],fileimage[i+1],fileimage[i+0]}), i );
+ $fwrite(fd2,"%32b\n",NoX32({fileimage[i+3],fileimage[i+2],fileimage[i+1],fileimage[i+0]}));
+ end
+ $fwrite(fd," default : RDATA <=32'h0;\n");
+ $fwrite(fd," endcase\n");
+ $fwrite(fd,"endmodule\n");
+ $fclose(fd);
+ $fclose(fd2);
+ end
+ end
+ end
+`endif
+
+// synchonous address and control
+
+ always @(posedge CLK) // update on any byte lane read
+ if (SEL)
+ addr_r <= ADDR[ADDRWIDTH-1:0];
+
+ assign RDATA = {rombyte3[addr_r],rombyte2[addr_r],rombyte1[addr_r],rombyte0[addr_r]};
+
+endmodule
diff --git a/pads/verilog/GLIB_PADLIB.v b/pads/verilog/GLIB_PADLIB.v
new file mode 100755
index 0000000..bc10d2b
--- /dev/null
+++ b/pads/verilog/GLIB_PADLIB.v
@@ -0,0 +1,139 @@
+// GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_INOUT8MA_NOE (
+ // Inouts
+ PAD,
+ // Outputs
+ O,
+ // Inputs
+ I,
+ NOE
+ );
+ inout PAD;
+ output I;
+ input O;
+ input NOE;
+
+`ifdef BEHAVIORAL_PADS
+ assign I = PAD;
+ assign PAD = ~NOE ? O : 1'bz;
+`else
+ bufif1 #2 (PAD, O, ~NOE);
+ buf #1 (I, PAD);
+ always @(PAD)
+ begin
+ if (($countdrivers(PAD) > 1) && (PAD === 1'bx))
+ $display("%t ++BUS CONFLICT++ : %m", $realtime);
+ end
+`endif // ifdef BEHAVIORAL_PADS
+endmodule // PAD_INOUT8MA_NOE
+
+module PAD_INOUT8MA_OE (
+ // Inouts
+ PAD,
+ // Outputs
+ O,
+ // Inputs
+ I,
+ OE
+ );
+ inout PAD;
+ output I;
+ input O;
+ input OE;
+`ifdef BEHAVIORAL_PADS
+ assign I = PAD;
+ assign PAD = OE ? O : 1'bz;
+`else
+ bufif1 #2 (PAD, O, OE);
+ buf #1 (I, PAD);
+
+ always @(PAD)
+ begin
+ if (($countdrivers(PAD) > 1) && (PAD === 1'bx))
+ $display("%t ++BUS CONFLICT++ : %m", $realtime);
+ end
+`endif // ifdef BEHAVIORAL_PADS
+endmodule // PAD_INOUT8MA_OE
+
+module PAD_VDDIO (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_VDDIO
+
+module PAD_VSSIO (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_VSSSIO
+
+// core logic supply rails (1V0, 0V)
+module PAD_VDDSOC (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_VDDSOC
+
+module PAD_VSS (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_VSS
+
+// VDDISOL
+module PAD_ANALOG (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_ANALOG
+
+`ifdef TSMC_PADS
+
+// VDDSOC
+module PVDD1CDG (
+ inout wire VDD
+ );
+endmodule // PVDD1CDG
+
+//VDDIO
+module PVDD2CDG (
+ inout wire VDDPST
+ );
+endmodule // PVDD2CDG
+
+module PVDD2POC (
+ inout wire VDDPST
+ );
+endmodule // PVDD2CDG
+
+module PVSS3CDG (
+ inout wire VSS
+ );
+endmodule // PVSS3CDG
+
+// VDDISOL
+module PVDD1ANA (
+ inout wire AVDD
+ );
+endmodule // PVDD1ANA
+
+
+module PCORNER ( ); endmodule
+module PFILLER20 ( ); endmodule
+module PFILLER1 ( ); endmodule
+module PFILLER0005 ( ); endmodule
+
+module PAD60LU ( ); endmodule
+
+`endif
diff --git a/pads/verilog/PAD_ANALOG.v b/pads/verilog/PAD_ANALOG.v
new file mode 100644
index 0000000..2715fb3
--- /dev/null
+++ b/pads/verilog/PAD_ANALOG.v
@@ -0,0 +1,18 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+// VDDISOL
+module PAD_ANALOG (
+ PAD
+ );
+ inout PAD;
+endmodule // PAD_ANALOG
diff --git a/pads/verilog/PAD_INOUT8MA_NOE.v b/pads/verilog/PAD_INOUT8MA_NOE.v
new file mode 100644
index 0000000..42123e8
--- /dev/null
+++ b/pads/verilog/PAD_INOUT8MA_NOE.v
@@ -0,0 +1,39 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_INOUT8MA_NOE (
+ // Inouts
+ PAD,
+ // Outputs
+ O,
+ // Inputs
+ I,
+ NOE
+ );
+ inout PAD;
+ output I;
+ input O;
+ input NOE;
+
+`ifdef BEHAVIORAL_PADS
+ assign I = PAD;
+ assign PAD = ~NOE ? O : 1'bz;
+`else
+ bufif1 #2 (PAD, O, ~NOE);
+ buf #1 (I, PAD);
+ always @(PAD)
+ begin
+ if (($countdrivers(PAD) > 1) && (PAD === 1'bx))
+ $display("%t ++BUS CONFLICT++ : %m", $realtime);
+ end
+`endif // ifdef BEHAVIORAL_PADS
+endmodule // PAD_INOUT8MA_NOE
diff --git a/pads/verilog/PAD_INOUT8MA_OE.v b/pads/verilog/PAD_INOUT8MA_OE.v
new file mode 100644
index 0000000..12d3009
--- /dev/null
+++ b/pads/verilog/PAD_INOUT8MA_OE.v
@@ -0,0 +1,39 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_INOUT8MA_OE (
+ // Inouts
+ PAD,
+ // Outputs
+ O,
+ // Inputs
+ I,
+ OE
+ );
+ inout PAD;
+ output I;
+ input O;
+ input OE;
+`ifdef BEHAVIORAL_PADS
+ assign I = PAD;
+ assign PAD = OE ? O : 1'bz;
+`else
+ bufif1 #2 (PAD, O, OE);
+ buf #1 (I, PAD);
+
+ always @(PAD)
+ begin
+ if (($countdrivers(PAD) > 1) && (PAD === 1'bx))
+ $display("%t ++BUS CONFLICT++ : %m", $realtime);
+ end
+`endif // ifdef BEHAVIORAL_PADS
+endmodule // PAD_INOUT8MA_OE
diff --git a/pads/verilog/PAD_VDDIO.v b/pads/verilog/PAD_VDDIO.v
new file mode 100644
index 0000000..e8eda59
--- /dev/null
+++ b/pads/verilog/PAD_VDDIO.v
@@ -0,0 +1,18 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_VDDIO (
+ PAD
+ );
+ inout PAD;
+ assign PAD = 1'b1;
+ endmodule // PAD_VDDIO
diff --git a/pads/verilog/PAD_VDDSOC.v b/pads/verilog/PAD_VDDSOC.v
new file mode 100644
index 0000000..02de9e9
--- /dev/null
+++ b/pads/verilog/PAD_VDDSOC.v
@@ -0,0 +1,19 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+// core logic supply rails (1V0, 0V)
+module PAD_VDDSOC (
+ PAD
+ );
+ inout PAD;
+ assign PAD = 1'b1;
+endmodule // PAD_VDDSOC
diff --git a/pads/verilog/PAD_VSS.v b/pads/verilog/PAD_VSS.v
new file mode 100644
index 0000000..ea07cca
--- /dev/null
+++ b/pads/verilog/PAD_VSS.v
@@ -0,0 +1,18 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_VSS (
+ PAD
+ );
+ inout PAD;
+ assign PAD = 1'b0;
+endmodule // PAD_VSS
diff --git a/pads/verilog/PAD_VSSIO.v b/pads/verilog/PAD_VSSIO.v
new file mode 100644
index 0000000..42d9edb
--- /dev/null
+++ b/pads/verilog/PAD_VSSIO.v
@@ -0,0 +1,19 @@
+// from GLIB_PADLIB.v
+//-----------------------------------------------------------------------------
+// soclabs generic IO pad model
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright � 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module PAD_VSSIO (
+ PAD
+ );
+ inout PAD;
+ assign PAD = 1'b0;
+endmodule // PAD_VSSIO
+
diff --git a/sync/verilog/SYNCHRONIZER_EDGES.v b/sync/verilog/SYNCHRONIZER_EDGES.v
new file mode 100644
index 0000000..c669ec1
--- /dev/null
+++ b/sync/verilog/SYNCHRONIZER_EDGES.v
@@ -0,0 +1,42 @@
+// A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+//
+// Contributors
+//
+// David Flynn (d.w.flynn@soton.ac.uk)
+//
+// Copyright © 2022, SoC Labs (www.soclabs.org)
+//-----------------------------------------------------------------------------
+
+module SYNCHRONIZER_EDGES (
+ input wire testmode_i
+ ,input wire clk_i
+ ,input wire reset_n_i
+ ,input wire asyn_i
+ ,output wire syn_o
+ ,output wire syn_del_o
+ ,output wire posedge_o
+ ,output wire negedge_o
+ );
+
+reg sync_stage1;
+reg sync_stage2;
+reg sync_stage3;
+
+ always @(posedge clk_i or negedge reset_n_i)
+ if(~reset_n_i) begin
+ sync_stage1 <= 1'b0;
+ sync_stage2 <= 1'b0;
+ sync_stage3 <= 1'b0;
+ end
+ else begin
+ sync_stage1 <= asyn_i;
+ sync_stage2 <= sync_stage1;
+ sync_stage3 <= sync_stage2;
+ end
+
+assign syn_o = (testmode_i) ? asyn_i : sync_stage2;
+assign syn_del_o = (testmode_i) ? asyn_i : sync_stage3;
+assign posedge_o = (testmode_i) ? asyn_i : ( sync_stage2 & !sync_stage3);
+assign negedge_o = (testmode_i) ? asyn_i : (!sync_stage2 & sync_stage3);
+
+endmodule
--
GitLab