blob: 46cfdfd06c28f12df6153f3652df804b99e0501e [file] [log] [blame]
Tim Edwards581068f2020-11-19 12:45:25 -05001// `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"
Ahmed Ghazydf4dd882020-11-25 18:38:42 +020026`include "libs.tech/openlane/custom_cells/verilog/sky130_ef_io__gpiov2_pad_wrapped.v"
Tim Edwards4286ae12020-10-11 14:52:01 -040027
28`include "libs.ref/sky130_fd_sc_hd/verilog/primitives.v"
29`include "libs.ref/sky130_fd_sc_hd/verilog/sky130_fd_sc_hd.v"
30`include "libs.ref/sky130_fd_sc_hvl/verilog/primitives.v"
31`include "libs.ref/sky130_fd_sc_hvl/verilog/sky130_fd_sc_hvl.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040032
manarabdelatya115bdd2020-12-01 11:19:12 +020033`ifdef GL
34 `include "gl/mgmt_core.v"
35`else
36 `include "mgmt_soc.v"
37 `include "housekeeping_spi.v"
38 `include "caravel_clocking.v"
39 `include "mgmt_core.v"
40`endif
41
Tim Edwardsef8312e2020-09-22 17:20:06 -040042`include "digital_pll.v"
Tim Edwards53d92182020-10-11 21:47:40 -040043`include "mgmt_protect.v"
Tim Edwardsbc035512020-11-23 11:16:08 -050044`include "mgmt_protect_hv.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040045`include "mprj_io.v"
46`include "chip_io.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040047`include "user_id_programming.v"
Tim Edwardsb86fc842020-10-13 17:11:54 -040048`include "user_project_wrapper.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040049`include "gpio_control_block.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040050`include "clock_div.v"
Tim Edwardsf51dd082020-10-05 16:30:24 -040051`include "simple_por.v"
Manar55ec3692020-10-30 16:32:18 +020052`include "storage_bridge_wb.v"
Ahmed Ghazy2517fa82020-11-08 23:34:41 +020053`include "DFFRAM.v"
Manar68e03632020-11-09 13:25:13 +020054`include "DFFRAMBB.v"
Manar55ec3692020-10-30 16:32:18 +020055`include "sram_1rw1r_32_256_8_sky130.v"
56`include "storage.v"
Ahmed Ghazy1d1679d2020-11-30 17:44:45 +020057`include "sky130_fd_sc_hvl__lsbufhv2lv_1_wrapped.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040058
Tim Edwards05537512020-10-06 14:59:26 -040059/*------------------------------*/
60/* Include user project here */
61/*------------------------------*/
62`include "user_proj_example.v"
63
Manar55ec3692020-10-30 16:32:18 +020064// `ifdef USE_OPENRAM
65// `include "sram_1rw1r_32_256_8_sky130.v"
66// `endif
Tim Edwardsef8312e2020-09-22 17:20:06 -040067
68module caravel (
Tim Edwards9eda80d2020-10-08 21:36:44 -040069 inout vddio, // Common 3.3V padframe/ESD power
70 inout vssio, // Common padframe/ESD ground
71 inout vdda, // Management 3.3V power
72 inout vssa, // Common analog ground
73 inout vccd, // Management/Common 1.8V power
74 inout vssd, // Common digital ground
75 inout vdda1, // User area 1 3.3V power
76 inout vdda2, // User area 2 3.3V power
77 inout vssa1, // User area 1 analog ground
78 inout vssa2, // User area 2 analog ground
79 inout vccd1, // User area 1 1.8V power
80 inout vccd2, // User area 2 1.8V power
81 inout vssd1, // User area 1 digital ground
82 inout vssd2, // User area 2 digital ground
83
Tim Edwards04ba17f2020-10-02 22:27:50 -040084 inout gpio, // Used for external LDO control
Tim Edwardsef8312e2020-09-22 17:20:06 -040085 inout [`MPRJ_IO_PADS-1:0] mprj_io,
Tim Edwardsba328902020-10-27 15:03:22 -040086 output [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out,
Tim Edwardsef8312e2020-09-22 17:20:06 -040087 input clock, // CMOS core clock input, not a crystal
Tim Edwards04ba17f2020-10-02 22:27:50 -040088 input resetb,
89
90 // Note that only two pins are available on the flash so dual and
91 // quad flash modes are not available.
92
Tim Edwardsef8312e2020-09-22 17:20:06 -040093 output flash_csb,
94 output flash_clk,
95 output flash_io0,
Tim Edwards04ba17f2020-10-02 22:27:50 -040096 output flash_io1
Tim Edwardsef8312e2020-09-22 17:20:06 -040097);
98
Tim Edwards04ba17f2020-10-02 22:27:50 -040099 //------------------------------------------------------------
100 // This value is uniquely defined for each user project.
101 //------------------------------------------------------------
102 parameter USER_PROJECT_ID = 32'h0;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400103
Tim Edwards04ba17f2020-10-02 22:27:50 -0400104 // These pins are overlaid on mprj_io space. They have the function
105 // below when the management processor is in reset, or in the default
106 // configuration. They are assigned to uses in the user space by the
107 // configuration program running off of the SPI flash. Note that even
108 // when the user has taken control of these pins, they can be restored
109 // to the original use by setting the resetb pin low. The SPI pins and
110 // UART pins can be connected directly to an FTDI chip as long as the
111 // FTDI chip sets these lines to high impedence (input function) at
112 // all times except when holding the chip in reset.
113
114 // JTAG = mprj_io[0] (inout)
115 // SDO = mprj_io[1] (output)
116 // SDI = mprj_io[2] (input)
117 // CSB = mprj_io[3] (input)
118 // SCK = mprj_io[4] (input)
119 // ser_rx = mprj_io[5] (input)
120 // ser_tx = mprj_io[6] (output)
121 // irq = mprj_io[7] (input)
122
123 // These pins are reserved for any project that wants to incorporate
124 // its own processor and flash controller. While a user project can
125 // technically use any available I/O pins for the purpose, these
126 // four pins connect to a pass-through mode from the SPI slave (pins
127 // 1-4 above) so that any SPI flash connected to these specific pins
128 // can be accessed through the SPI slave even when the processor is in
129 // reset.
130
Tim Edwards44bab472020-10-04 22:09:54 -0400131 // user_flash_csb = mprj_io[8]
132 // user_flash_sck = mprj_io[9]
133 // user_flash_io0 = mprj_io[10]
134 // user_flash_io1 = mprj_io[11]
Tim Edwards04ba17f2020-10-02 22:27:50 -0400135
136 // One-bit GPIO dedicated to management SoC (outside of user control)
137 wire gpio_out_core;
138 wire gpio_in_core;
139 wire gpio_mode0_core;
140 wire gpio_mode1_core;
141 wire gpio_outenb_core;
142 wire gpio_inenb_core;
143
Tim Edwards6d9739d2020-10-19 11:00:49 -0400144 // User Project Control (pad-facing)
Tim Edwards04ba17f2020-10-02 22:27:50 -0400145 wire mprj_io_loader_resetn;
146 wire mprj_io_loader_clock;
147 wire mprj_io_loader_data;
148
Tim Edwardsef8312e2020-09-22 17:20:06 -0400149 wire [`MPRJ_IO_PADS-1:0] mprj_io_hldh_n;
150 wire [`MPRJ_IO_PADS-1:0] mprj_io_enh;
151 wire [`MPRJ_IO_PADS-1:0] mprj_io_inp_dis;
Tim Edwards44bab472020-10-04 22:09:54 -0400152 wire [`MPRJ_IO_PADS-1:0] mprj_io_oeb;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400153 wire [`MPRJ_IO_PADS-1:0] mprj_io_ib_mode_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400154 wire [`MPRJ_IO_PADS-1:0] mprj_io_vtrip_sel;
155 wire [`MPRJ_IO_PADS-1:0] mprj_io_slow_sel;
156 wire [`MPRJ_IO_PADS-1:0] mprj_io_holdover;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400157 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_en;
158 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_sel;
159 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_pol;
160 wire [`MPRJ_IO_PADS*3-1:0] mprj_io_dm;
161 wire [`MPRJ_IO_PADS-1:0] mprj_io_in;
162 wire [`MPRJ_IO_PADS-1:0] mprj_io_out;
163
Tim Edwards6d9739d2020-10-19 11:00:49 -0400164 // User Project Control (user-facing)
Tim Edwards44bab472020-10-04 22:09:54 -0400165 wire [`MPRJ_IO_PADS-1:0] user_io_oeb;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400166 wire [`MPRJ_IO_PADS-1:0] user_io_in;
167 wire [`MPRJ_IO_PADS-1:0] user_io_out;
Tim Edwards581068f2020-11-19 12:45:25 -0500168 wire [`MPRJ_IO_PADS-8:0] user_analog_io;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400169
170 /* Padframe control signals */
171 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link;
172 wire mgmt_serial_clock;
173 wire mgmt_serial_resetn;
174
Tim Edwards6d9739d2020-10-19 11:00:49 -0400175 // User Project Control management I/O
Tim Edwards44bab472020-10-04 22:09:54 -0400176 // There are two types of GPIO connections:
177 // (1) Full Bidirectional: Management connects to in, out, and oeb
178 // Uses: JTAG and SDO
179 // (2) Selectable bidirectional: Management connects to in and out,
180 // which are tied together. oeb is grounded (oeb from the
181 // configuration is used)
182
183 // SDI = mprj_io[2] (input)
184 // CSB = mprj_io[3] (input)
185 // SCK = mprj_io[4] (input)
186 // ser_rx = mprj_io[5] (input)
187 // ser_tx = mprj_io[6] (output)
188 // irq = mprj_io[7] (input)
189
190 wire [`MPRJ_IO_PADS-1:0] mgmt_io_in;
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200191 wire jtag_out, sdo_out;
192 wire jtag_outenb, sdo_outenb;
Tim Edwards44bab472020-10-04 22:09:54 -0400193
194 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc1; /* no-connects */
195 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc3; /* no-connects */
196 wire [1:0] mgmt_io_nc2; /* no-connects */
197
Tim Edwards581068f2020-11-19 12:45:25 -0500198 wire clock_core;
199
Tim Edwards04ba17f2020-10-02 22:27:50 -0400200 // Power-on-reset signal. The reset pad generates the sense-inverted
201 // reset at 3.3V. The 1.8V signal and the inverted 1.8V signal are
202 // derived.
203
Tim Edwardsef8312e2020-09-22 17:20:06 -0400204 wire porb_h;
205 wire porb_l;
Tim Edwards581068f2020-11-19 12:45:25 -0500206 wire por_l;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400207
Tim Edwardsf51dd082020-10-05 16:30:24 -0400208 wire rstb_h;
209 wire rstb_l;
210
Tim Edwards581068f2020-11-19 12:45:25 -0500211 wire flash_clk_core, flash_csb_core;
212 wire flash_clk_oeb_core, flash_csb_oeb_core;
213 wire flash_clk_ieb_core, flash_csb_ieb_core;
214 wire flash_io0_oeb_core, flash_io1_oeb_core;
215 wire flash_io2_oeb_core, flash_io3_oeb_core;
216 wire flash_io0_ieb_core, flash_io1_ieb_core;
217 wire flash_io2_ieb_core, flash_io3_ieb_core;
218 wire flash_io0_do_core, flash_io1_do_core;
219 wire flash_io2_do_core, flash_io3_do_core;
220 wire flash_io0_di_core, flash_io1_di_core;
221 wire flash_io2_di_core, flash_io3_di_core;
222
Tim Edwards44bab472020-10-04 22:09:54 -0400223 // To be considered: Master hold signal on all user pads (?)
224 // For now, set holdh_n to 1 (NOTE: This is in the 3.3V domain)
225 // and setting enh to porb_h.
Tim Edwards9eda80d2020-10-08 21:36:44 -0400226 assign mprj_io_hldh_n = {`MPRJ_IO_PADS{vddio}};
Tim Edwards44bab472020-10-04 22:09:54 -0400227 assign mprj_io_enh = {`MPRJ_IO_PADS{porb_h}};
228
Tim Edwardsef8312e2020-09-22 17:20:06 -0400229 chip_io padframe(
230 // Package Pins
Tim Edwards9eda80d2020-10-08 21:36:44 -0400231 .vddio(vddio),
232 .vssio(vssio),
233 .vdda(vdda),
234 .vssa(vssa),
235 .vccd(vccd),
236 .vssd(vssd),
237 .vdda1(vdda1),
238 .vdda2(vdda2),
239 .vssa1(vssa1),
240 .vssa2(vssa2),
241 .vccd1(vccd1),
242 .vccd2(vccd2),
243 .vssd1(vssd1),
244 .vssd2(vssd2),
245
Tim Edwardsef8312e2020-09-22 17:20:06 -0400246 .gpio(gpio),
247 .mprj_io(mprj_io),
248 .clock(clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400249 .resetb(resetb),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400250 .flash_csb(flash_csb),
251 .flash_clk(flash_clk),
252 .flash_io0(flash_io0),
253 .flash_io1(flash_io1),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400254 // SoC Core Interface
Tim Edwardsef8312e2020-09-22 17:20:06 -0400255 .porb_h(porb_h),
Tim Edwards581068f2020-11-19 12:45:25 -0500256 .por(por_l),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400257 .resetb_core_h(rstb_h),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400258 .clock_core(clock_core),
259 .gpio_out_core(gpio_out_core),
260 .gpio_in_core(gpio_in_core),
261 .gpio_mode0_core(gpio_mode0_core),
262 .gpio_mode1_core(gpio_mode1_core),
263 .gpio_outenb_core(gpio_outenb_core),
264 .gpio_inenb_core(gpio_inenb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400265 .flash_csb_core(flash_csb_core),
266 .flash_clk_core(flash_clk_core),
267 .flash_csb_oeb_core(flash_csb_oeb_core),
268 .flash_clk_oeb_core(flash_clk_oeb_core),
269 .flash_io0_oeb_core(flash_io0_oeb_core),
270 .flash_io1_oeb_core(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400271 .flash_csb_ieb_core(flash_csb_ieb_core),
272 .flash_clk_ieb_core(flash_clk_ieb_core),
273 .flash_io0_ieb_core(flash_io0_ieb_core),
274 .flash_io1_ieb_core(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400275 .flash_io0_do_core(flash_io0_do_core),
276 .flash_io1_do_core(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400277 .flash_io0_di_core(flash_io0_di_core),
278 .flash_io1_di_core(flash_io1_di_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400279 .mprj_io_in(mprj_io_in),
280 .mprj_io_out(mprj_io_out),
Tim Edwards44bab472020-10-04 22:09:54 -0400281 .mprj_io_oeb(mprj_io_oeb),
Manar14d35ac2020-10-21 22:47:15 +0200282 .mprj_io_hldh_n(mprj_io_hldh_n),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400283 .mprj_io_enh(mprj_io_enh),
Manar14d35ac2020-10-21 22:47:15 +0200284 .mprj_io_inp_dis(mprj_io_inp_dis),
285 .mprj_io_ib_mode_sel(mprj_io_ib_mode_sel),
286 .mprj_io_vtrip_sel(mprj_io_vtrip_sel),
287 .mprj_io_slow_sel(mprj_io_slow_sel),
288 .mprj_io_holdover(mprj_io_holdover),
289 .mprj_io_analog_en(mprj_io_analog_en),
290 .mprj_io_analog_sel(mprj_io_analog_sel),
291 .mprj_io_analog_pol(mprj_io_analog_pol),
Tim Edwards581068f2020-11-19 12:45:25 -0500292 .mprj_io_dm(mprj_io_dm),
293 .mprj_analog_io(user_analog_io)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400294 );
295
296 // SoC core
Tim Edwards04ba17f2020-10-02 22:27:50 -0400297 wire caravel_clk;
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400298 wire caravel_clk2;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400299 wire caravel_rstn;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400300
301 wire [7:0] spi_ro_config_core;
302
303 // LA signals
Tim Edwards43e5c602020-11-19 15:59:50 -0500304 wire [127:0] la_data_in_user; // From CPU to MPRJ
305 wire [127:0] la_data_in_mprj; // From MPRJ to CPU
Tim Edwardsef8312e2020-09-22 17:20:06 -0400306 wire [127:0] la_data_out_mprj; // From CPU to MPRJ
Tim Edwards43e5c602020-11-19 15:59:50 -0500307 wire [127:0] la_data_out_user; // From MPRJ to CPU
308 wire [127:0] la_oen_user; // From CPU to MPRJ
309 wire [127:0] la_oen_mprj; // From CPU to MPRJ
310
Tim Edwards6d9739d2020-10-19 11:00:49 -0400311 // WB MI A (User Project)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400312 wire mprj_cyc_o_core;
313 wire mprj_stb_o_core;
314 wire mprj_we_o_core;
315 wire [3:0] mprj_sel_o_core;
316 wire [31:0] mprj_adr_o_core;
317 wire [31:0] mprj_dat_o_core;
318 wire mprj_ack_i_core;
319 wire [31:0] mprj_dat_i_core;
320
321 // WB MI B (xbar)
322 wire xbar_cyc_o_core;
323 wire xbar_stb_o_core;
324 wire xbar_we_o_core;
325 wire [3:0] xbar_sel_o_core;
326 wire [31:0] xbar_adr_o_core;
327 wire [31:0] xbar_dat_o_core;
328 wire xbar_ack_i_core;
329 wire [31:0] xbar_dat_i_core;
330
Tim Edwards04ba17f2020-10-02 22:27:50 -0400331 // Mask revision
332 wire [31:0] mask_rev;
333
Manar14d35ac2020-10-21 22:47:15 +0200334 wire mprj_clock;
335 wire mprj_clock2;
336 wire mprj_resetn;
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200337 wire mprj_reset;
Manar14d35ac2020-10-21 22:47:15 +0200338 wire mprj_cyc_o_user;
339 wire mprj_stb_o_user;
340 wire mprj_we_o_user;
341 wire [3:0] mprj_sel_o_user;
342 wire [31:0] mprj_adr_o_user;
343 wire [31:0] mprj_dat_o_user;
344 wire mprj_vcc_pwrgood;
345 wire mprj2_vcc_pwrgood;
346 wire mprj_vdd_pwrgood;
347 wire mprj2_vdd_pwrgood;
348
Manar55ec3692020-10-30 16:32:18 +0200349 // Storage area
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200350 // Management R/W interface
351 wire [`RAM_BLOCKS-1:0] mgmt_ena;
Manarffe6cad2020-11-09 19:09:04 +0200352 wire [`RAM_BLOCKS-1:0] mgmt_wen;
353 wire [(`RAM_BLOCKS*4)-1:0] mgmt_wen_mask;
Manar55ec3692020-10-30 16:32:18 +0200354 wire [7:0] mgmt_addr;
355 wire [31:0] mgmt_wdata;
Manarffe6cad2020-11-09 19:09:04 +0200356 wire [(`RAM_BLOCKS*32)-1:0] mgmt_rdata;
Manar55ec3692020-10-30 16:32:18 +0200357 // Management RO interface
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200358 wire mgmt_ena_ro;
Manarffe6cad2020-11-09 19:09:04 +0200359 wire [7:0] mgmt_addr_ro;
360 wire [31:0] mgmt_rdata_ro;
Manar55ec3692020-10-30 16:32:18 +0200361
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200362 mgmt_core soc (
Manar61dce922020-11-10 19:26:28 +0200363 `ifdef USE_POWER_PINS
manarabdelatya115bdd2020-12-01 11:19:12 +0200364 .VPWR(vccd),
365 .VGND(vssa),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400366 `endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400367 // GPIO (1 pin)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400368 .gpio_out_pad(gpio_out_core),
369 .gpio_in_pad(gpio_in_core),
370 .gpio_mode0_pad(gpio_mode0_core),
371 .gpio_mode1_pad(gpio_mode1_core),
372 .gpio_outenb_pad(gpio_outenb_core),
373 .gpio_inenb_pad(gpio_inenb_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400374 // Primary SPI flash controller
Tim Edwardsef8312e2020-09-22 17:20:06 -0400375 .flash_csb(flash_csb_core),
376 .flash_clk(flash_clk_core),
377 .flash_csb_oeb(flash_csb_oeb_core),
378 .flash_clk_oeb(flash_clk_oeb_core),
379 .flash_io0_oeb(flash_io0_oeb_core),
380 .flash_io1_oeb(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400381 .flash_csb_ieb(flash_csb_ieb_core),
382 .flash_clk_ieb(flash_clk_ieb_core),
383 .flash_io0_ieb(flash_io0_ieb_core),
384 .flash_io1_ieb(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400385 .flash_io0_do(flash_io0_do_core),
386 .flash_io1_do(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400387 .flash_io0_di(flash_io0_di_core),
388 .flash_io1_di(flash_io1_di_core),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400389 // Master Reset
390 .resetb(rstb_l),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400391 .porb(porb_l),
392 // Clocks and reset
Tim Edwardsef8312e2020-09-22 17:20:06 -0400393 .clock(clock_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400394 .core_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400395 .user_clk(caravel_clk2),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400396 .core_rstn(caravel_rstn),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200397 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500398 .la_input(la_data_in_mprj),
399 .la_output(la_data_out_mprj),
400 .la_oen(la_oen_mprj),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400401 // User Project IO Control
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400402 .mprj_vcc_pwrgood(mprj_vcc_pwrgood),
403 .mprj2_vcc_pwrgood(mprj2_vcc_pwrgood),
404 .mprj_vdd_pwrgood(mprj_vdd_pwrgood),
405 .mprj2_vdd_pwrgood(mprj2_vdd_pwrgood),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400406 .mprj_io_loader_resetn(mprj_io_loader_resetn),
407 .mprj_io_loader_clock(mprj_io_loader_clock),
408 .mprj_io_loader_data(mprj_io_loader_data),
Tim Edwards44bab472020-10-04 22:09:54 -0400409 .mgmt_in_data(mgmt_io_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400410 .mgmt_out_data({mgmt_io_in[(`MPRJ_IO_PADS-1):2], mgmt_io_nc2}),
Tim Edwardsba328902020-10-27 15:03:22 -0400411 .pwr_ctrl_out(pwr_ctrl_out),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400412 .sdo_out(sdo_out),
413 .sdo_outenb(sdo_outenb),
414 .jtag_out(jtag_out),
415 .jtag_outenb(jtag_outenb),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400416 // User Project Slave ports (WB MI A)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400417 .mprj_cyc_o(mprj_cyc_o_core),
418 .mprj_stb_o(mprj_stb_o_core),
419 .mprj_we_o(mprj_we_o_core),
420 .mprj_sel_o(mprj_sel_o_core),
421 .mprj_adr_o(mprj_adr_o_core),
422 .mprj_dat_o(mprj_dat_o_core),
423 .mprj_ack_i(mprj_ack_i_core),
424 .mprj_dat_i(mprj_dat_i_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400425 // mask data
Manar55ec3692020-10-30 16:32:18 +0200426 .mask_rev(mask_rev),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200427 // MGMT area R/W interface
428 .mgmt_ena(mgmt_ena),
Manar55ec3692020-10-30 16:32:18 +0200429 .mgmt_wen_mask(mgmt_wen_mask),
430 .mgmt_wen(mgmt_wen),
431 .mgmt_addr(mgmt_addr),
432 .mgmt_wdata(mgmt_wdata),
433 .mgmt_rdata(mgmt_rdata),
Manarffe6cad2020-11-09 19:09:04 +0200434 // MGMT area RO interface
435 .mgmt_ena_ro(mgmt_ena_ro),
436 .mgmt_addr_ro(mgmt_addr_ro),
437 .mgmt_rdata_ro(mgmt_rdata_ro)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400438 );
439
Tim Edwards53d92182020-10-11 21:47:40 -0400440 /* Clock and reset to user space are passed through a tristate */
441 /* buffer like the above, but since they are intended to be */
442 /* always active, connect the enable to the logic-1 output from */
443 /* the vccd1 domain. */
444
Tim Edwards53d92182020-10-11 21:47:40 -0400445 mgmt_protect mgmt_buffers (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200446 `ifdef USE_POWER_PINS
Tim Edwards53d92182020-10-11 21:47:40 -0400447 .vccd(vccd),
448 .vssd(vssd),
449 .vccd1(vccd1),
450 .vssd1(vssd1),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400451 .vdda1(vdda1),
452 .vssa1(vssa1),
453 .vdda2(vdda2),
454 .vssa2(vssa2),
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200455 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400456
Tim Edwards53d92182020-10-11 21:47:40 -0400457 .caravel_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400458 .caravel_clk2(caravel_clk2),
Tim Edwards53d92182020-10-11 21:47:40 -0400459 .caravel_rstn(caravel_rstn),
460 .mprj_cyc_o_core(mprj_cyc_o_core),
461 .mprj_stb_o_core(mprj_stb_o_core),
462 .mprj_we_o_core(mprj_we_o_core),
463 .mprj_sel_o_core(mprj_sel_o_core),
464 .mprj_adr_o_core(mprj_adr_o_core),
465 .mprj_dat_o_core(mprj_dat_o_core),
Tim Edwards43e5c602020-11-19 15:59:50 -0500466 .la_data_out_core(la_data_out_user),
467 .la_data_out_mprj(la_data_out_mprj),
468 .la_data_in_core(la_data_in_user),
469 .la_data_in_mprj(la_data_in_mprj),
470 .la_oen_mprj(la_oen_mprj),
471 .la_oen_core(la_oen_user),
Tim Edwards53d92182020-10-11 21:47:40 -0400472
473 .user_clock(mprj_clock),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400474 .user_clock2(mprj_clock2),
Tim Edwards53d92182020-10-11 21:47:40 -0400475 .user_resetn(mprj_resetn),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200476 .user_reset(mprj_reset),
Tim Edwards53d92182020-10-11 21:47:40 -0400477 .mprj_cyc_o_user(mprj_cyc_o_user),
478 .mprj_stb_o_user(mprj_stb_o_user),
479 .mprj_we_o_user(mprj_we_o_user),
480 .mprj_sel_o_user(mprj_sel_o_user),
481 .mprj_adr_o_user(mprj_adr_o_user),
482 .mprj_dat_o_user(mprj_dat_o_user),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400483 .user1_vcc_powergood(mprj_vcc_pwrgood),
484 .user2_vcc_powergood(mprj2_vcc_pwrgood),
485 .user1_vdd_powergood(mprj_vdd_pwrgood),
486 .user2_vdd_powergood(mprj2_vdd_pwrgood)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400487 );
Tim Edwards53d92182020-10-11 21:47:40 -0400488
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200489
Tim Edwardsb86fc842020-10-13 17:11:54 -0400490 /*----------------------------------------------*/
491 /* Wrapper module around the user project */
492 /*----------------------------------------------*/
Tim Edwards05537512020-10-06 14:59:26 -0400493
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200494 user_project_wrapper mprj (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200495 `ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400496 .vdda1(vdda1), // User area 1 3.3V power
497 .vdda2(vdda2), // User area 2 3.3V power
498 .vssa1(vssa1), // User area 1 analog ground
499 .vssa2(vssa2), // User area 2 analog ground
500 .vccd1(vccd1), // User area 1 1.8V power
501 .vccd2(vccd2), // User area 2 1.8V power
502 .vssd1(vssd1), // User area 1 digital ground
503 .vssd2(vssd2), // User area 2 digital ground
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200504 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400505
Tim Edwards53d92182020-10-11 21:47:40 -0400506 .wb_clk_i(mprj_clock),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200507 .wb_rst_i(mprj_reset),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200508 // MGMT SoC Wishbone Slave
Tim Edwards53d92182020-10-11 21:47:40 -0400509 .wbs_cyc_i(mprj_cyc_o_user),
510 .wbs_stb_i(mprj_stb_o_user),
511 .wbs_we_i(mprj_we_o_user),
512 .wbs_sel_i(mprj_sel_o_user),
513 .wbs_adr_i(mprj_adr_o_user),
514 .wbs_dat_i(mprj_dat_o_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400515 .wbs_ack_o(mprj_ack_i_core),
516 .wbs_dat_o(mprj_dat_i_core),
517 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500518 .la_data_in(la_data_in_user),
519 .la_data_out(la_data_out_user),
520 .la_oen(la_oen_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400521 // IO Pads
Tim Edwards05537512020-10-06 14:59:26 -0400522 .io_in (user_io_in),
Tim Edwardsef2b68d2020-10-11 17:00:44 -0400523 .io_out(user_io_out),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400524 .io_oeb(user_io_oeb),
Tim Edwards581068f2020-11-19 12:45:25 -0500525 .analog_io(user_analog_io),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400526 // Independent clock
527 .user_clock2(mprj_clock2)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400528 );
529
Tim Edwards05537512020-10-06 14:59:26 -0400530 /*--------------------------------------*/
531 /* End user project instantiation */
532 /*--------------------------------------*/
533
Tim Edwards04ba17f2020-10-02 22:27:50 -0400534 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link_shifted;
535
Tim Edwards251e0df2020-10-05 11:02:12 -0400536 assign gpio_serial_link_shifted = {gpio_serial_link[`MPRJ_IO_PADS-2:0], mprj_io_loader_data};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400537
Tim Edwards251e0df2020-10-05 11:02:12 -0400538 // Each control block sits next to an I/O pad in the user area.
539 // It gets input through a serial chain from the previous control
540 // block and passes it to the next control block. Due to the nature
541 // of the shift register, bits are presented in reverse, as the first
542 // bit in ends up as the last bit of the last I/O pad control block.
Tim Edwards44bab472020-10-04 22:09:54 -0400543
Tim Edwards89f09242020-10-05 15:17:34 -0400544 // There are two types of block; the first two are configured to be
545 // full bidirectional under control of the management Soc (JTAG and
546 // SDO). The rest are configured to be default (input).
547
Tim Edwards251e0df2020-10-05 11:02:12 -0400548 gpio_control_block #(
Tim Edwards89f09242020-10-05 15:17:34 -0400549 .DM_INIT(3'b110), // Mode = output, strong up/down
Tim Edwards496a08a2020-10-26 15:44:51 -0400550 .OENB_INIT(1'b1) // Enable output signaling from wire
Tim Edwards89f09242020-10-05 15:17:34 -0400551 ) gpio_control_bidir [1:0] (
Manar61dce922020-11-10 19:26:28 +0200552 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200553 .vccd(vccd),
554 .vssd(vssd),
555 .vccd1(vccd1),
556 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400557 `endif
Tim Edwards44bab472020-10-04 22:09:54 -0400558
Tim Edwards04ba17f2020-10-02 22:27:50 -0400559 // Management Soc-facing signals
560
Tim Edwardsc18c4742020-10-03 11:26:39 -0400561 .resetn(mprj_io_loader_resetn),
562 .serial_clock(mprj_io_loader_clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400563
Tim Edwards89f09242020-10-05 15:17:34 -0400564 .mgmt_gpio_in(mgmt_io_in[1:0]),
565 .mgmt_gpio_out({sdo_out, jtag_out}),
566 .mgmt_gpio_oeb({sdo_outenb, jtag_outenb}),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400567
568 // Serial data chain for pad configuration
Tim Edwards89f09242020-10-05 15:17:34 -0400569 .serial_data_in(gpio_serial_link_shifted[1:0]),
570 .serial_data_out(gpio_serial_link[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400571
572 // User-facing signals
Tim Edwards89f09242020-10-05 15:17:34 -0400573 .user_gpio_out(user_io_out[1:0]),
574 .user_gpio_oeb(user_io_oeb[1:0]),
575 .user_gpio_in(user_io_in[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400576
577 // Pad-facing signals (Pad GPIOv2)
Tim Edwards89f09242020-10-05 15:17:34 -0400578 .pad_gpio_inenb(mprj_io_inp_dis[1:0]),
579 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[1:0]),
580 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[1:0]),
581 .pad_gpio_slow_sel(mprj_io_slow_sel[1:0]),
582 .pad_gpio_holdover(mprj_io_holdover[1:0]),
583 .pad_gpio_ana_en(mprj_io_analog_en[1:0]),
584 .pad_gpio_ana_sel(mprj_io_analog_sel[1:0]),
585 .pad_gpio_ana_pol(mprj_io_analog_pol[1:0]),
586 .pad_gpio_dm(mprj_io_dm[5:0]),
587 .pad_gpio_outenb(mprj_io_oeb[1:0]),
588 .pad_gpio_out(mprj_io_out[1:0]),
589 .pad_gpio_in(mprj_io_in[1:0])
590 );
591
592 gpio_control_block gpio_control_in [`MPRJ_IO_PADS-1:2] (
Manar61dce922020-11-10 19:26:28 +0200593 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200594 .vccd(vccd),
595 .vssd(vssd),
596 .vccd1(vccd1),
597 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400598 `endif
Tim Edwards89f09242020-10-05 15:17:34 -0400599
600 // Management Soc-facing signals
601
602 .resetn(mprj_io_loader_resetn),
603 .serial_clock(mprj_io_loader_clock),
604
605 .mgmt_gpio_in(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
606 .mgmt_gpio_out(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
607 .mgmt_gpio_oeb(1'b1),
608
609 // Serial data chain for pad configuration
610 .serial_data_in(gpio_serial_link_shifted[(`MPRJ_IO_PADS-1):2]),
611 .serial_data_out(gpio_serial_link[(`MPRJ_IO_PADS-1):2]),
612
613 // User-facing signals
614 .user_gpio_out(user_io_out[(`MPRJ_IO_PADS-1):2]),
615 .user_gpio_oeb(user_io_oeb[(`MPRJ_IO_PADS-1):2]),
616 .user_gpio_in(user_io_in[(`MPRJ_IO_PADS-1):2]),
617
618 // Pad-facing signals (Pad GPIOv2)
619 .pad_gpio_inenb(mprj_io_inp_dis[(`MPRJ_IO_PADS-1):2]),
620 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[(`MPRJ_IO_PADS-1):2]),
621 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[(`MPRJ_IO_PADS-1):2]),
622 .pad_gpio_slow_sel(mprj_io_slow_sel[(`MPRJ_IO_PADS-1):2]),
623 .pad_gpio_holdover(mprj_io_holdover[(`MPRJ_IO_PADS-1):2]),
624 .pad_gpio_ana_en(mprj_io_analog_en[(`MPRJ_IO_PADS-1):2]),
625 .pad_gpio_ana_sel(mprj_io_analog_sel[(`MPRJ_IO_PADS-1):2]),
626 .pad_gpio_ana_pol(mprj_io_analog_pol[(`MPRJ_IO_PADS-1):2]),
627 .pad_gpio_dm(mprj_io_dm[(`MPRJ_IO_PADS*3-1):6]),
628 .pad_gpio_outenb(mprj_io_oeb[(`MPRJ_IO_PADS-1):2]),
629 .pad_gpio_out(mprj_io_out[(`MPRJ_IO_PADS-1):2]),
630 .pad_gpio_in(mprj_io_in[(`MPRJ_IO_PADS-1):2])
Tim Edwards04ba17f2020-10-02 22:27:50 -0400631 );
632
Tim Edwards04ba17f2020-10-02 22:27:50 -0400633 user_id_programming #(
634 .USER_PROJECT_ID(USER_PROJECT_ID)
635 ) user_id_value (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200636`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400637 .vdd1v8(vccd),
638 .vss(vssd),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200639`endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400640 .mask_rev(mask_rev)
641 );
642
Tim Edwardsf51dd082020-10-05 16:30:24 -0400643 // Power-on-reset circuit
644 simple_por por (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200645`ifdef USE_POWER_PINS
Tim Edwards9eda80d2020-10-08 21:36:44 -0400646 .vdd3v3(vddio),
Tim Edwards581068f2020-11-19 12:45:25 -0500647 .vdd1v8(vccd),
Tim Edwards9eda80d2020-10-08 21:36:44 -0400648 .vss(vssio),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200649`endif
Tim Edwards581068f2020-11-19 12:45:25 -0500650 .porb_h(porb_h),
651 .porb_l(porb_l),
652 .por_l(por_l)
Tim Edwardsf51dd082020-10-05 16:30:24 -0400653 );
654
655 // XRES (chip input pin reset) reset level converter
Ahmed Ghazy1d1679d2020-11-30 17:44:45 +0200656 sky130_fd_sc_hvl__lsbufhv2lv_1_wrapped rstb_level (
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200657`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400658 .VPWR(vddio),
659 .VPB(vddio),
660 .LVPWR(vccd),
661 .VNB(vssio),
662 .VGND(vssio),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200663`endif
Tim Edwardsf51dd082020-10-05 16:30:24 -0400664 .A(rstb_h),
665 .X(rstb_l)
666 );
667
Manar55ec3692020-10-30 16:32:18 +0200668 // Storage area
Manarffe6cad2020-11-09 19:09:04 +0200669 storage storage(
Manar55ec3692020-10-30 16:32:18 +0200670 .mgmt_clk(caravel_clk),
671 .mgmt_ena(mgmt_ena),
672 .mgmt_wen(mgmt_wen),
673 .mgmt_wen_mask(mgmt_wen_mask),
674 .mgmt_addr(mgmt_addr),
675 .mgmt_wdata(mgmt_wdata),
676 .mgmt_rdata(mgmt_rdata),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200677 // Management RO interface
Manarffe6cad2020-11-09 19:09:04 +0200678 .mgmt_ena_ro(mgmt_ena_ro),
679 .mgmt_addr_ro(mgmt_addr_ro),
680 .mgmt_rdata_ro(mgmt_rdata_ro)
Manar55ec3692020-10-30 16:32:18 +0200681 );
682
Tim Edwardsef8312e2020-09-22 17:20:06 -0400683endmodule
Tim Edwards581068f2020-11-19 12:45:25 -0500684// `default_nettype wire