blob: 42ecf451d4a30d3b26258254294bd7a229a996e3 [file] [log] [blame]
Matt Venn08cd6eb2020-11-16 12:01:14 +01001`default_nettype none
Tim Edwardsef8312e2020-09-22 17:20:06 -04002/*--------------------------------------------------------------*/
3/* caravel, a project harness for the Google/SkyWater sky130 */
4/* fabrication process and open source PDK */
5/* */
6/* Copyright 2020 efabless, Inc. */
7/* Written by Tim Edwards, December 2019 */
8/* and Mohamed Shalan, August 2020 */
9/* This file is open source hardware released under the */
10/* Apache 2.0 license. See file LICENSE. */
11/* */
12/*--------------------------------------------------------------*/
13
14`timescale 1 ns / 1 ps
15
Tim Edwardse2ef6732020-10-12 17:25:12 -040016`define USE_POWER_PINS
Tim Edwardsc5265b82020-09-25 17:08:59 -040017`define UNIT_DELAY #1
Tim Edwardsef8312e2020-09-22 17:20:06 -040018
Ahmed Ghazy22d29d62020-10-28 03:42:02 +020019`include "defines.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040020`include "pads.v"
21
Tim Edwards4286ae12020-10-11 14:52:01 -040022/* NOTE: Need to pass the PDK root directory to iverilog with option -I */
Tim Edwardsef8312e2020-09-22 17:20:06 -040023
Tim Edwards4286ae12020-10-11 14:52:01 -040024`include "libs.ref/sky130_fd_io/verilog/sky130_fd_io.v"
Tim Edwards4c733352020-10-12 16:32:36 -040025`include "libs.ref/sky130_fd_io/verilog/sky130_ef_io.v"
Tim Edwards4286ae12020-10-11 14:52:01 -040026
27`include "libs.ref/sky130_fd_sc_hd/verilog/primitives.v"
28`include "libs.ref/sky130_fd_sc_hd/verilog/sky130_fd_sc_hd.v"
29`include "libs.ref/sky130_fd_sc_hvl/verilog/primitives.v"
30`include "libs.ref/sky130_fd_sc_hvl/verilog/sky130_fd_sc_hvl.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040031
32`include "mgmt_soc.v"
Tim Edwards44bab472020-10-04 22:09:54 -040033`include "housekeeping_spi.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040034`include "digital_pll.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040035`include "caravel_clocking.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040036`include "mgmt_core.v"
Tim Edwards53d92182020-10-11 21:47:40 -040037`include "mgmt_protect.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040038`include "mprj_io.v"
39`include "chip_io.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040040`include "user_id_programming.v"
Tim Edwardsb86fc842020-10-13 17:11:54 -040041`include "user_project_wrapper.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040042`include "gpio_control_block.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040043`include "clock_div.v"
Tim Edwardsf51dd082020-10-05 16:30:24 -040044`include "simple_por.v"
Manar55ec3692020-10-30 16:32:18 +020045`include "storage_bridge_wb.v"
Ahmed Ghazy2517fa82020-11-08 23:34:41 +020046`include "DFFRAM.v"
Manar68e03632020-11-09 13:25:13 +020047`include "DFFRAMBB.v"
Manar55ec3692020-10-30 16:32:18 +020048`include "sram_1rw1r_32_256_8_sky130.v"
49`include "storage.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040050
Tim Edwards05537512020-10-06 14:59:26 -040051/*------------------------------*/
52/* Include user project here */
53/*------------------------------*/
54`include "user_proj_example.v"
55
Manar55ec3692020-10-30 16:32:18 +020056// `ifdef USE_OPENRAM
57// `include "sram_1rw1r_32_256_8_sky130.v"
58// `endif
Tim Edwardsef8312e2020-09-22 17:20:06 -040059
60module caravel (
Tim Edwards9eda80d2020-10-08 21:36:44 -040061 inout vddio, // Common 3.3V padframe/ESD power
62 inout vssio, // Common padframe/ESD ground
63 inout vdda, // Management 3.3V power
64 inout vssa, // Common analog ground
65 inout vccd, // Management/Common 1.8V power
66 inout vssd, // Common digital ground
67 inout vdda1, // User area 1 3.3V power
68 inout vdda2, // User area 2 3.3V power
69 inout vssa1, // User area 1 analog ground
70 inout vssa2, // User area 2 analog ground
71 inout vccd1, // User area 1 1.8V power
72 inout vccd2, // User area 2 1.8V power
73 inout vssd1, // User area 1 digital ground
74 inout vssd2, // User area 2 digital ground
75
Tim Edwards04ba17f2020-10-02 22:27:50 -040076 inout gpio, // Used for external LDO control
Tim Edwardsef8312e2020-09-22 17:20:06 -040077 inout [`MPRJ_IO_PADS-1:0] mprj_io,
Tim Edwardsba328902020-10-27 15:03:22 -040078 output [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out,
Tim Edwardsef8312e2020-09-22 17:20:06 -040079 input clock, // CMOS core clock input, not a crystal
Tim Edwards04ba17f2020-10-02 22:27:50 -040080 input resetb,
81
82 // Note that only two pins are available on the flash so dual and
83 // quad flash modes are not available.
84
Tim Edwardsef8312e2020-09-22 17:20:06 -040085 output flash_csb,
86 output flash_clk,
87 output flash_io0,
Tim Edwards04ba17f2020-10-02 22:27:50 -040088 output flash_io1
Tim Edwardsef8312e2020-09-22 17:20:06 -040089);
90
Tim Edwards04ba17f2020-10-02 22:27:50 -040091 //------------------------------------------------------------
92 // This value is uniquely defined for each user project.
93 //------------------------------------------------------------
94 parameter USER_PROJECT_ID = 32'h0;
Tim Edwardsef8312e2020-09-22 17:20:06 -040095
Tim Edwards04ba17f2020-10-02 22:27:50 -040096 // These pins are overlaid on mprj_io space. They have the function
97 // below when the management processor is in reset, or in the default
98 // configuration. They are assigned to uses in the user space by the
99 // configuration program running off of the SPI flash. Note that even
100 // when the user has taken control of these pins, they can be restored
101 // to the original use by setting the resetb pin low. The SPI pins and
102 // UART pins can be connected directly to an FTDI chip as long as the
103 // FTDI chip sets these lines to high impedence (input function) at
104 // all times except when holding the chip in reset.
105
106 // JTAG = mprj_io[0] (inout)
107 // SDO = mprj_io[1] (output)
108 // SDI = mprj_io[2] (input)
109 // CSB = mprj_io[3] (input)
110 // SCK = mprj_io[4] (input)
111 // ser_rx = mprj_io[5] (input)
112 // ser_tx = mprj_io[6] (output)
113 // irq = mprj_io[7] (input)
114
115 // These pins are reserved for any project that wants to incorporate
116 // its own processor and flash controller. While a user project can
117 // technically use any available I/O pins for the purpose, these
118 // four pins connect to a pass-through mode from the SPI slave (pins
119 // 1-4 above) so that any SPI flash connected to these specific pins
120 // can be accessed through the SPI slave even when the processor is in
121 // reset.
122
Tim Edwards44bab472020-10-04 22:09:54 -0400123 // user_flash_csb = mprj_io[8]
124 // user_flash_sck = mprj_io[9]
125 // user_flash_io0 = mprj_io[10]
126 // user_flash_io1 = mprj_io[11]
Tim Edwards04ba17f2020-10-02 22:27:50 -0400127
128 // One-bit GPIO dedicated to management SoC (outside of user control)
129 wire gpio_out_core;
130 wire gpio_in_core;
131 wire gpio_mode0_core;
132 wire gpio_mode1_core;
133 wire gpio_outenb_core;
134 wire gpio_inenb_core;
135
Tim Edwards6d9739d2020-10-19 11:00:49 -0400136 // User Project Control (pad-facing)
Tim Edwards04ba17f2020-10-02 22:27:50 -0400137 wire mprj_io_loader_resetn;
138 wire mprj_io_loader_clock;
139 wire mprj_io_loader_data;
140
Tim Edwardsef8312e2020-09-22 17:20:06 -0400141 wire [`MPRJ_IO_PADS-1:0] mprj_io_hldh_n;
142 wire [`MPRJ_IO_PADS-1:0] mprj_io_enh;
143 wire [`MPRJ_IO_PADS-1:0] mprj_io_inp_dis;
Tim Edwards44bab472020-10-04 22:09:54 -0400144 wire [`MPRJ_IO_PADS-1:0] mprj_io_oeb;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400145 wire [`MPRJ_IO_PADS-1:0] mprj_io_ib_mode_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400146 wire [`MPRJ_IO_PADS-1:0] mprj_io_vtrip_sel;
147 wire [`MPRJ_IO_PADS-1:0] mprj_io_slow_sel;
148 wire [`MPRJ_IO_PADS-1:0] mprj_io_holdover;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400149 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_en;
150 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_sel;
151 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_pol;
152 wire [`MPRJ_IO_PADS*3-1:0] mprj_io_dm;
153 wire [`MPRJ_IO_PADS-1:0] mprj_io_in;
154 wire [`MPRJ_IO_PADS-1:0] mprj_io_out;
155
Tim Edwards6d9739d2020-10-19 11:00:49 -0400156 // User Project Control (user-facing)
Tim Edwards44bab472020-10-04 22:09:54 -0400157 wire [`MPRJ_IO_PADS-1:0] user_io_oeb;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400158 wire [`MPRJ_IO_PADS-1:0] user_io_in;
159 wire [`MPRJ_IO_PADS-1:0] user_io_out;
160
161 /* Padframe control signals */
162 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link;
163 wire mgmt_serial_clock;
164 wire mgmt_serial_resetn;
165
Tim Edwards6d9739d2020-10-19 11:00:49 -0400166 // User Project Control management I/O
Tim Edwards44bab472020-10-04 22:09:54 -0400167 // There are two types of GPIO connections:
168 // (1) Full Bidirectional: Management connects to in, out, and oeb
169 // Uses: JTAG and SDO
170 // (2) Selectable bidirectional: Management connects to in and out,
171 // which are tied together. oeb is grounded (oeb from the
172 // configuration is used)
173
174 // SDI = mprj_io[2] (input)
175 // CSB = mprj_io[3] (input)
176 // SCK = mprj_io[4] (input)
177 // ser_rx = mprj_io[5] (input)
178 // ser_tx = mprj_io[6] (output)
179 // irq = mprj_io[7] (input)
180
181 wire [`MPRJ_IO_PADS-1:0] mgmt_io_in;
182 wire jtag_out, sdo_out;
183 wire jtag_outenb, sdo_outenb;
184
185 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc1; /* no-connects */
186 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc3; /* no-connects */
187 wire [1:0] mgmt_io_nc2; /* no-connects */
188
Tim Edwards04ba17f2020-10-02 22:27:50 -0400189 // Power-on-reset signal. The reset pad generates the sense-inverted
190 // reset at 3.3V. The 1.8V signal and the inverted 1.8V signal are
191 // derived.
192
Tim Edwardsef8312e2020-09-22 17:20:06 -0400193 wire porb_h;
194 wire porb_l;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400195
Tim Edwardsf51dd082020-10-05 16:30:24 -0400196 wire rstb_h;
197 wire rstb_l;
198
Tim Edwards44bab472020-10-04 22:09:54 -0400199 // To be considered: Master hold signal on all user pads (?)
200 // For now, set holdh_n to 1 (NOTE: This is in the 3.3V domain)
201 // and setting enh to porb_h.
Tim Edwards9eda80d2020-10-08 21:36:44 -0400202 assign mprj_io_hldh_n = {`MPRJ_IO_PADS{vddio}};
Tim Edwards44bab472020-10-04 22:09:54 -0400203 assign mprj_io_enh = {`MPRJ_IO_PADS{porb_h}};
204
Tim Edwardsef8312e2020-09-22 17:20:06 -0400205 chip_io padframe(
206 // Package Pins
Tim Edwards9eda80d2020-10-08 21:36:44 -0400207 .vddio(vddio),
208 .vssio(vssio),
209 .vdda(vdda),
210 .vssa(vssa),
211 .vccd(vccd),
212 .vssd(vssd),
213 .vdda1(vdda1),
214 .vdda2(vdda2),
215 .vssa1(vssa1),
216 .vssa2(vssa2),
217 .vccd1(vccd1),
218 .vccd2(vccd2),
219 .vssd1(vssd1),
220 .vssd2(vssd2),
221
Tim Edwardsef8312e2020-09-22 17:20:06 -0400222 .gpio(gpio),
223 .mprj_io(mprj_io),
224 .clock(clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400225 .resetb(resetb),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400226 .flash_csb(flash_csb),
227 .flash_clk(flash_clk),
228 .flash_io0(flash_io0),
229 .flash_io1(flash_io1),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400230 // SoC Core Interface
Tim Edwardsef8312e2020-09-22 17:20:06 -0400231 .porb_h(porb_h),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400232 .resetb_core_h(rstb_h),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400233 .clock_core(clock_core),
234 .gpio_out_core(gpio_out_core),
235 .gpio_in_core(gpio_in_core),
236 .gpio_mode0_core(gpio_mode0_core),
237 .gpio_mode1_core(gpio_mode1_core),
238 .gpio_outenb_core(gpio_outenb_core),
239 .gpio_inenb_core(gpio_inenb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400240 .flash_csb_core(flash_csb_core),
241 .flash_clk_core(flash_clk_core),
242 .flash_csb_oeb_core(flash_csb_oeb_core),
243 .flash_clk_oeb_core(flash_clk_oeb_core),
244 .flash_io0_oeb_core(flash_io0_oeb_core),
245 .flash_io1_oeb_core(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400246 .flash_csb_ieb_core(flash_csb_ieb_core),
247 .flash_clk_ieb_core(flash_clk_ieb_core),
248 .flash_io0_ieb_core(flash_io0_ieb_core),
249 .flash_io1_ieb_core(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400250 .flash_io0_do_core(flash_io0_do_core),
251 .flash_io1_do_core(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400252 .flash_io0_di_core(flash_io0_di_core),
253 .flash_io1_di_core(flash_io1_di_core),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200254 .por(por_l),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400255 .mprj_io_in(mprj_io_in),
256 .mprj_io_out(mprj_io_out),
Tim Edwards44bab472020-10-04 22:09:54 -0400257 .mprj_io_oeb(mprj_io_oeb),
Manar14d35ac2020-10-21 22:47:15 +0200258 .mprj_io_hldh_n(mprj_io_hldh_n),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400259 .mprj_io_enh(mprj_io_enh),
Manar14d35ac2020-10-21 22:47:15 +0200260 .mprj_io_inp_dis(mprj_io_inp_dis),
261 .mprj_io_ib_mode_sel(mprj_io_ib_mode_sel),
262 .mprj_io_vtrip_sel(mprj_io_vtrip_sel),
263 .mprj_io_slow_sel(mprj_io_slow_sel),
264 .mprj_io_holdover(mprj_io_holdover),
265 .mprj_io_analog_en(mprj_io_analog_en),
266 .mprj_io_analog_sel(mprj_io_analog_sel),
267 .mprj_io_analog_pol(mprj_io_analog_pol),
268 .mprj_io_dm(mprj_io_dm)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400269 );
270
271 // SoC core
Tim Edwards04ba17f2020-10-02 22:27:50 -0400272 wire caravel_clk;
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400273 wire caravel_clk2;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400274 wire caravel_rstn;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400275
276 wire [7:0] spi_ro_config_core;
277
278 // LA signals
279 wire [127:0] la_output_core; // From CPU to MPRJ
280 wire [127:0] la_data_in_mprj; // From CPU to MPRJ
281 wire [127:0] la_data_out_mprj; // From CPU to MPRJ
282 wire [127:0] la_output_mprj; // From MPRJ to CPU
283 wire [127:0] la_oen; // LA output enable from CPU perspective (active-low)
284
Tim Edwards6d9739d2020-10-19 11:00:49 -0400285 // WB MI A (User Project)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400286 wire mprj_cyc_o_core;
287 wire mprj_stb_o_core;
288 wire mprj_we_o_core;
289 wire [3:0] mprj_sel_o_core;
290 wire [31:0] mprj_adr_o_core;
291 wire [31:0] mprj_dat_o_core;
292 wire mprj_ack_i_core;
293 wire [31:0] mprj_dat_i_core;
294
295 // WB MI B (xbar)
296 wire xbar_cyc_o_core;
297 wire xbar_stb_o_core;
298 wire xbar_we_o_core;
299 wire [3:0] xbar_sel_o_core;
300 wire [31:0] xbar_adr_o_core;
301 wire [31:0] xbar_dat_o_core;
302 wire xbar_ack_i_core;
303 wire [31:0] xbar_dat_i_core;
304
Tim Edwards04ba17f2020-10-02 22:27:50 -0400305 // Mask revision
306 wire [31:0] mask_rev;
307
Manar14d35ac2020-10-21 22:47:15 +0200308 wire mprj_clock;
309 wire mprj_clock2;
310 wire mprj_resetn;
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200311 wire mprj_reset;
Manar14d35ac2020-10-21 22:47:15 +0200312 wire mprj_cyc_o_user;
313 wire mprj_stb_o_user;
314 wire mprj_we_o_user;
315 wire [3:0] mprj_sel_o_user;
316 wire [31:0] mprj_adr_o_user;
317 wire [31:0] mprj_dat_o_user;
318 wire mprj_vcc_pwrgood;
319 wire mprj2_vcc_pwrgood;
320 wire mprj_vdd_pwrgood;
321 wire mprj2_vdd_pwrgood;
322
Manar55ec3692020-10-30 16:32:18 +0200323 // Storage area
324 // Management R/W interface
Manarffe6cad2020-11-09 19:09:04 +0200325 wire [`RAM_BLOCKS-1:0] mgmt_ena;
326 wire [`RAM_BLOCKS-1:0] mgmt_wen;
327 wire [(`RAM_BLOCKS*4)-1:0] mgmt_wen_mask;
Manar55ec3692020-10-30 16:32:18 +0200328 wire [7:0] mgmt_addr;
329 wire [31:0] mgmt_wdata;
Manarffe6cad2020-11-09 19:09:04 +0200330 wire [(`RAM_BLOCKS*32)-1:0] mgmt_rdata;
Manar55ec3692020-10-30 16:32:18 +0200331 // Management RO interface
Manarffe6cad2020-11-09 19:09:04 +0200332 wire mgmt_ena_ro;
333 wire [7:0] mgmt_addr_ro;
334 wire [31:0] mgmt_rdata_ro;
Manar55ec3692020-10-30 16:32:18 +0200335
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200336 mgmt_core soc (
Manar61dce922020-11-10 19:26:28 +0200337 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200338 .vdd1v8(vccd),
Tim Edwards9eda80d2020-10-08 21:36:44 -0400339 .vss(vssa),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400340 `endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400341 // GPIO (1 pin)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400342 .gpio_out_pad(gpio_out_core),
343 .gpio_in_pad(gpio_in_core),
344 .gpio_mode0_pad(gpio_mode0_core),
345 .gpio_mode1_pad(gpio_mode1_core),
346 .gpio_outenb_pad(gpio_outenb_core),
347 .gpio_inenb_pad(gpio_inenb_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400348 // Primary SPI flash controller
Tim Edwardsef8312e2020-09-22 17:20:06 -0400349 .flash_csb(flash_csb_core),
350 .flash_clk(flash_clk_core),
351 .flash_csb_oeb(flash_csb_oeb_core),
352 .flash_clk_oeb(flash_clk_oeb_core),
353 .flash_io0_oeb(flash_io0_oeb_core),
354 .flash_io1_oeb(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400355 .flash_csb_ieb(flash_csb_ieb_core),
356 .flash_clk_ieb(flash_clk_ieb_core),
357 .flash_io0_ieb(flash_io0_ieb_core),
358 .flash_io1_ieb(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400359 .flash_io0_do(flash_io0_do_core),
360 .flash_io1_do(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400361 .flash_io0_di(flash_io0_di_core),
362 .flash_io1_di(flash_io1_di_core),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400363 // Master Reset
364 .resetb(rstb_l),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400365 .porb(porb_l),
366 // Clocks and reset
Tim Edwardsef8312e2020-09-22 17:20:06 -0400367 .clock(clock_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400368 .core_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400369 .user_clk(caravel_clk2),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400370 .core_rstn(caravel_rstn),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400371 // Logic Analyzer
372 .la_input(la_data_out_mprj),
373 .la_output(la_output_core),
374 .la_oen(la_oen),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400375 // User Project IO Control
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400376 .mprj_vcc_pwrgood(mprj_vcc_pwrgood),
377 .mprj2_vcc_pwrgood(mprj2_vcc_pwrgood),
378 .mprj_vdd_pwrgood(mprj_vdd_pwrgood),
379 .mprj2_vdd_pwrgood(mprj2_vdd_pwrgood),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400380 .mprj_io_loader_resetn(mprj_io_loader_resetn),
381 .mprj_io_loader_clock(mprj_io_loader_clock),
382 .mprj_io_loader_data(mprj_io_loader_data),
Tim Edwards44bab472020-10-04 22:09:54 -0400383 .mgmt_in_data(mgmt_io_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400384 .mgmt_out_data({mgmt_io_in[(`MPRJ_IO_PADS-1):2], mgmt_io_nc2}),
Tim Edwardsba328902020-10-27 15:03:22 -0400385 .pwr_ctrl_out(pwr_ctrl_out),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400386 .sdo_out(sdo_out),
387 .sdo_outenb(sdo_outenb),
388 .jtag_out(jtag_out),
389 .jtag_outenb(jtag_outenb),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400390 // User Project Slave ports (WB MI A)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400391 .mprj_cyc_o(mprj_cyc_o_core),
392 .mprj_stb_o(mprj_stb_o_core),
393 .mprj_we_o(mprj_we_o_core),
394 .mprj_sel_o(mprj_sel_o_core),
395 .mprj_adr_o(mprj_adr_o_core),
396 .mprj_dat_o(mprj_dat_o_core),
397 .mprj_ack_i(mprj_ack_i_core),
398 .mprj_dat_i(mprj_dat_i_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400399 // mask data
Manar55ec3692020-10-30 16:32:18 +0200400 .mask_rev(mask_rev),
Manarffe6cad2020-11-09 19:09:04 +0200401 // MGMT area R/W interface
Manar55ec3692020-10-30 16:32:18 +0200402 .mgmt_ena(mgmt_ena),
403 .mgmt_wen_mask(mgmt_wen_mask),
404 .mgmt_wen(mgmt_wen),
405 .mgmt_addr(mgmt_addr),
406 .mgmt_wdata(mgmt_wdata),
407 .mgmt_rdata(mgmt_rdata),
Manarffe6cad2020-11-09 19:09:04 +0200408 // MGMT area RO interface
409 .mgmt_ena_ro(mgmt_ena_ro),
410 .mgmt_addr_ro(mgmt_addr_ro),
411 .mgmt_rdata_ro(mgmt_rdata_ro)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400412 );
413
Tim Edwards53d92182020-10-11 21:47:40 -0400414 /* Clock and reset to user space are passed through a tristate */
415 /* buffer like the above, but since they are intended to be */
416 /* always active, connect the enable to the logic-1 output from */
417 /* the vccd1 domain. */
418
Tim Edwards53d92182020-10-11 21:47:40 -0400419 mgmt_protect mgmt_buffers (
Tim Edwards53d92182020-10-11 21:47:40 -0400420 .vccd(vccd),
421 .vssd(vssd),
422 .vccd1(vccd1),
423 .vssd1(vssd1),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400424 .vdda1(vdda1),
425 .vssa1(vssa1),
426 .vdda2(vdda2),
427 .vssa2(vssa2),
Tim Edwards21a9aac2020-10-12 22:05:18 -0400428
Tim Edwards53d92182020-10-11 21:47:40 -0400429 .caravel_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400430 .caravel_clk2(caravel_clk2),
Tim Edwards53d92182020-10-11 21:47:40 -0400431 .caravel_rstn(caravel_rstn),
432 .mprj_cyc_o_core(mprj_cyc_o_core),
433 .mprj_stb_o_core(mprj_stb_o_core),
434 .mprj_we_o_core(mprj_we_o_core),
435 .mprj_sel_o_core(mprj_sel_o_core),
436 .mprj_adr_o_core(mprj_adr_o_core),
437 .mprj_dat_o_core(mprj_dat_o_core),
438 .la_output_core(la_output_core),
439 .la_oen(la_oen),
440
441 .user_clock(mprj_clock),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400442 .user_clock2(mprj_clock2),
Tim Edwards53d92182020-10-11 21:47:40 -0400443 .user_resetn(mprj_resetn),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200444 .user_reset(mprj_reset),
Tim Edwards53d92182020-10-11 21:47:40 -0400445 .mprj_cyc_o_user(mprj_cyc_o_user),
446 .mprj_stb_o_user(mprj_stb_o_user),
447 .mprj_we_o_user(mprj_we_o_user),
448 .mprj_sel_o_user(mprj_sel_o_user),
449 .mprj_adr_o_user(mprj_adr_o_user),
450 .mprj_dat_o_user(mprj_dat_o_user),
Tim Edwards32d05422020-10-19 19:43:52 -0400451 .la_data_in_mprj(la_data_in_mprj),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400452 .user1_vcc_powergood(mprj_vcc_pwrgood),
453 .user2_vcc_powergood(mprj2_vcc_pwrgood),
454 .user1_vdd_powergood(mprj_vdd_pwrgood),
455 .user2_vdd_powergood(mprj2_vdd_pwrgood)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400456 );
Tim Edwards53d92182020-10-11 21:47:40 -0400457
Tim Edwardsef8312e2020-09-22 17:20:06 -0400458
Tim Edwardsb86fc842020-10-13 17:11:54 -0400459 /*----------------------------------------------*/
460 /* Wrapper module around the user project */
461 /*----------------------------------------------*/
Tim Edwards05537512020-10-06 14:59:26 -0400462
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200463 user_project_wrapper mprj (
Tim Edwards21a9aac2020-10-12 22:05:18 -0400464 .vdda1(vdda1), // User area 1 3.3V power
465 .vdda2(vdda2), // User area 2 3.3V power
466 .vssa1(vssa1), // User area 1 analog ground
467 .vssa2(vssa2), // User area 2 analog ground
468 .vccd1(vccd1), // User area 1 1.8V power
469 .vccd2(vccd2), // User area 2 1.8V power
470 .vssd1(vssd1), // User area 1 digital ground
471 .vssd2(vssd2), // User area 2 digital ground
472
Tim Edwards53d92182020-10-11 21:47:40 -0400473 .wb_clk_i(mprj_clock),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200474 .wb_rst_i(mprj_reset),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400475 // MGMT SoC Wishbone Slave
Tim Edwards53d92182020-10-11 21:47:40 -0400476 .wbs_cyc_i(mprj_cyc_o_user),
477 .wbs_stb_i(mprj_stb_o_user),
478 .wbs_we_i(mprj_we_o_user),
479 .wbs_sel_i(mprj_sel_o_user),
480 .wbs_adr_i(mprj_adr_o_user),
481 .wbs_dat_i(mprj_dat_o_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400482 .wbs_ack_o(mprj_ack_i_core),
483 .wbs_dat_o(mprj_dat_i_core),
484 // Logic Analyzer
485 .la_data_in(la_data_in_mprj),
486 .la_data_out(la_data_out_mprj),
487 .la_oen (la_oen),
488 // IO Pads
Tim Edwards05537512020-10-06 14:59:26 -0400489 .io_in (user_io_in),
Tim Edwardsef2b68d2020-10-11 17:00:44 -0400490 .io_out(user_io_out),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400491 .io_oeb(user_io_oeb),
492 // Independent clock
493 .user_clock2(mprj_clock2)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400494 );
495
Tim Edwards05537512020-10-06 14:59:26 -0400496 /*--------------------------------------*/
497 /* End user project instantiation */
498 /*--------------------------------------*/
499
Tim Edwards04ba17f2020-10-02 22:27:50 -0400500 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link_shifted;
501
Tim Edwards251e0df2020-10-05 11:02:12 -0400502 assign gpio_serial_link_shifted = {gpio_serial_link[`MPRJ_IO_PADS-2:0], mprj_io_loader_data};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400503
Tim Edwards251e0df2020-10-05 11:02:12 -0400504 // Each control block sits next to an I/O pad in the user area.
505 // It gets input through a serial chain from the previous control
506 // block and passes it to the next control block. Due to the nature
507 // of the shift register, bits are presented in reverse, as the first
508 // bit in ends up as the last bit of the last I/O pad control block.
Tim Edwards44bab472020-10-04 22:09:54 -0400509
Tim Edwards89f09242020-10-05 15:17:34 -0400510 // There are two types of block; the first two are configured to be
511 // full bidirectional under control of the management Soc (JTAG and
512 // SDO). The rest are configured to be default (input).
513
Tim Edwards251e0df2020-10-05 11:02:12 -0400514 gpio_control_block #(
Tim Edwards89f09242020-10-05 15:17:34 -0400515 .DM_INIT(3'b110), // Mode = output, strong up/down
Tim Edwards496a08a2020-10-26 15:44:51 -0400516 .OENB_INIT(1'b1) // Enable output signaling from wire
Tim Edwards89f09242020-10-05 15:17:34 -0400517 ) gpio_control_bidir [1:0] (
Manar61dce922020-11-10 19:26:28 +0200518 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200519 .vccd(vccd),
520 .vssd(vssd),
521 .vccd1(vccd1),
522 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400523 `endif
Tim Edwards44bab472020-10-04 22:09:54 -0400524
Tim Edwards04ba17f2020-10-02 22:27:50 -0400525 // Management Soc-facing signals
526
Tim Edwardsc18c4742020-10-03 11:26:39 -0400527 .resetn(mprj_io_loader_resetn),
528 .serial_clock(mprj_io_loader_clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400529
Tim Edwards89f09242020-10-05 15:17:34 -0400530 .mgmt_gpio_in(mgmt_io_in[1:0]),
531 .mgmt_gpio_out({sdo_out, jtag_out}),
532 .mgmt_gpio_oeb({sdo_outenb, jtag_outenb}),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400533
534 // Serial data chain for pad configuration
Tim Edwards89f09242020-10-05 15:17:34 -0400535 .serial_data_in(gpio_serial_link_shifted[1:0]),
536 .serial_data_out(gpio_serial_link[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400537
538 // User-facing signals
Tim Edwards89f09242020-10-05 15:17:34 -0400539 .user_gpio_out(user_io_out[1:0]),
540 .user_gpio_oeb(user_io_oeb[1:0]),
541 .user_gpio_in(user_io_in[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400542
543 // Pad-facing signals (Pad GPIOv2)
Tim Edwards89f09242020-10-05 15:17:34 -0400544 .pad_gpio_inenb(mprj_io_inp_dis[1:0]),
545 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[1:0]),
546 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[1:0]),
547 .pad_gpio_slow_sel(mprj_io_slow_sel[1:0]),
548 .pad_gpio_holdover(mprj_io_holdover[1:0]),
549 .pad_gpio_ana_en(mprj_io_analog_en[1:0]),
550 .pad_gpio_ana_sel(mprj_io_analog_sel[1:0]),
551 .pad_gpio_ana_pol(mprj_io_analog_pol[1:0]),
552 .pad_gpio_dm(mprj_io_dm[5:0]),
553 .pad_gpio_outenb(mprj_io_oeb[1:0]),
554 .pad_gpio_out(mprj_io_out[1:0]),
555 .pad_gpio_in(mprj_io_in[1:0])
556 );
557
558 gpio_control_block gpio_control_in [`MPRJ_IO_PADS-1:2] (
Manar61dce922020-11-10 19:26:28 +0200559 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200560 .vccd(vccd),
561 .vssd(vssd),
562 .vccd1(vccd1),
563 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400564 `endif
Tim Edwards89f09242020-10-05 15:17:34 -0400565
566 // Management Soc-facing signals
567
568 .resetn(mprj_io_loader_resetn),
569 .serial_clock(mprj_io_loader_clock),
570
571 .mgmt_gpio_in(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
572 .mgmt_gpio_out(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
573 .mgmt_gpio_oeb(1'b1),
574
575 // Serial data chain for pad configuration
576 .serial_data_in(gpio_serial_link_shifted[(`MPRJ_IO_PADS-1):2]),
577 .serial_data_out(gpio_serial_link[(`MPRJ_IO_PADS-1):2]),
578
579 // User-facing signals
580 .user_gpio_out(user_io_out[(`MPRJ_IO_PADS-1):2]),
581 .user_gpio_oeb(user_io_oeb[(`MPRJ_IO_PADS-1):2]),
582 .user_gpio_in(user_io_in[(`MPRJ_IO_PADS-1):2]),
583
584 // Pad-facing signals (Pad GPIOv2)
585 .pad_gpio_inenb(mprj_io_inp_dis[(`MPRJ_IO_PADS-1):2]),
586 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[(`MPRJ_IO_PADS-1):2]),
587 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[(`MPRJ_IO_PADS-1):2]),
588 .pad_gpio_slow_sel(mprj_io_slow_sel[(`MPRJ_IO_PADS-1):2]),
589 .pad_gpio_holdover(mprj_io_holdover[(`MPRJ_IO_PADS-1):2]),
590 .pad_gpio_ana_en(mprj_io_analog_en[(`MPRJ_IO_PADS-1):2]),
591 .pad_gpio_ana_sel(mprj_io_analog_sel[(`MPRJ_IO_PADS-1):2]),
592 .pad_gpio_ana_pol(mprj_io_analog_pol[(`MPRJ_IO_PADS-1):2]),
593 .pad_gpio_dm(mprj_io_dm[(`MPRJ_IO_PADS*3-1):6]),
594 .pad_gpio_outenb(mprj_io_oeb[(`MPRJ_IO_PADS-1):2]),
595 .pad_gpio_out(mprj_io_out[(`MPRJ_IO_PADS-1):2]),
596 .pad_gpio_in(mprj_io_in[(`MPRJ_IO_PADS-1):2])
Tim Edwards04ba17f2020-10-02 22:27:50 -0400597 );
598
Tim Edwards04ba17f2020-10-02 22:27:50 -0400599 user_id_programming #(
600 .USER_PROJECT_ID(USER_PROJECT_ID)
601 ) user_id_value (
Tim Edwards21a9aac2020-10-12 22:05:18 -0400602 .vdd1v8(vccd),
603 .vss(vssd),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400604 .mask_rev(mask_rev)
605 );
606
Tim Edwardsf51dd082020-10-05 16:30:24 -0400607 // Power-on-reset circuit
608 simple_por por (
Tim Edwards9eda80d2020-10-08 21:36:44 -0400609 .vdd3v3(vddio),
610 .vss(vssio),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400611 .porb_h(porb_h)
612 );
613
614 // XRES (chip input pin reset) reset level converter
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200615 sky130_fd_sc_hvl__lsbufhv2lv_1 rstb_level (
616`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400617 .VPWR(vddio),
618 .VPB(vddio),
619 .LVPWR(vccd),
620 .VNB(vssio),
621 .VGND(vssio),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200622`endif
Tim Edwardsf51dd082020-10-05 16:30:24 -0400623 .A(rstb_h),
624 .X(rstb_l)
625 );
626
Manar55ec3692020-10-30 16:32:18 +0200627 // Storage area
Manarffe6cad2020-11-09 19:09:04 +0200628 storage storage(
Manar55ec3692020-10-30 16:32:18 +0200629 .mgmt_clk(caravel_clk),
630 .mgmt_ena(mgmt_ena),
631 .mgmt_wen(mgmt_wen),
632 .mgmt_wen_mask(mgmt_wen_mask),
633 .mgmt_addr(mgmt_addr),
634 .mgmt_wdata(mgmt_wdata),
635 .mgmt_rdata(mgmt_rdata),
636 // Management RO interface
Manarffe6cad2020-11-09 19:09:04 +0200637 .mgmt_ena_ro(mgmt_ena_ro),
638 .mgmt_addr_ro(mgmt_addr_ro),
639 .mgmt_rdata_ro(mgmt_rdata_ro)
Manar55ec3692020-10-30 16:32:18 +0200640 );
641
Tim Edwardsef8312e2020-09-22 17:20:06 -0400642endmodule