blob: 51d65298ea63a6b36f5d039ee70544026726ff95 [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 Edwardsc5265b82020-09-25 17:08:59 -040016`define UNIT_DELAY #1
Tim Edwardsef8312e2020-09-22 17:20:06 -040017
Ahmed Ghazy31c34652020-12-01 19:59:44 +020018`ifdef SIM
19
20`define USE_POWER_PINS
21
Ahmed Ghazy22d29d62020-10-28 03:42:02 +020022`include "defines.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040023`include "pads.v"
24
Tim Edwards4286ae12020-10-11 14:52:01 -040025/* NOTE: Need to pass the PDK root directory to iverilog with option -I */
Tim Edwardsef8312e2020-09-22 17:20:06 -040026
Tim Edwards4286ae12020-10-11 14:52:01 -040027`include "libs.ref/sky130_fd_io/verilog/sky130_fd_io.v"
Tim Edwards4c733352020-10-12 16:32:36 -040028`include "libs.ref/sky130_fd_io/verilog/sky130_ef_io.v"
Ahmed Ghazy65065c62020-12-01 17:06:16 +020029`include "libs.ref/sky130_fd_io/verilog/sky130_ef_io__gpiov2_pad_wrapped.v"
Tim Edwards4286ae12020-10-11 14:52:01 -040030
31`include "libs.ref/sky130_fd_sc_hd/verilog/primitives.v"
32`include "libs.ref/sky130_fd_sc_hd/verilog/sky130_fd_sc_hd.v"
33`include "libs.ref/sky130_fd_sc_hvl/verilog/primitives.v"
34`include "libs.ref/sky130_fd_sc_hvl/verilog/sky130_fd_sc_hvl.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040035
manarabdelatya115bdd2020-12-01 11:19:12 +020036`ifdef GL
37 `include "gl/mgmt_core.v"
38`else
39 `include "mgmt_soc.v"
40 `include "housekeeping_spi.v"
41 `include "caravel_clocking.v"
42 `include "mgmt_core.v"
43`endif
44
Tim Edwardsef8312e2020-09-22 17:20:06 -040045`include "digital_pll.v"
Tim Edwards53d92182020-10-11 21:47:40 -040046`include "mgmt_protect.v"
Tim Edwardsbc035512020-11-23 11:16:08 -050047`include "mgmt_protect_hv.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040048`include "mprj_io.v"
49`include "chip_io.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040050`include "user_id_programming.v"
Tim Edwardsb86fc842020-10-13 17:11:54 -040051`include "user_project_wrapper.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040052`include "gpio_control_block.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040053`include "clock_div.v"
Tim Edwardsf51dd082020-10-05 16:30:24 -040054`include "simple_por.v"
Manar55ec3692020-10-30 16:32:18 +020055`include "storage_bridge_wb.v"
Ahmed Ghazy2517fa82020-11-08 23:34:41 +020056`include "DFFRAM.v"
Manar68e03632020-11-09 13:25:13 +020057`include "DFFRAMBB.v"
Manar55ec3692020-10-30 16:32:18 +020058`include "sram_1rw1r_32_256_8_sky130.v"
59`include "storage.v"
Ahmed Ghazy1d1679d2020-11-30 17:44:45 +020060`include "sky130_fd_sc_hvl__lsbufhv2lv_1_wrapped.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040061
Tim Edwards05537512020-10-06 14:59:26 -040062/*------------------------------*/
63/* Include user project here */
64/*------------------------------*/
65`include "user_proj_example.v"
66
Manar55ec3692020-10-30 16:32:18 +020067// `ifdef USE_OPENRAM
68// `include "sram_1rw1r_32_256_8_sky130.v"
69// `endif
Ahmed Ghazy31c34652020-12-01 19:59:44 +020070`endif
Tim Edwardsef8312e2020-09-22 17:20:06 -040071
72module caravel (
Tim Edwards9eda80d2020-10-08 21:36:44 -040073 inout vddio, // Common 3.3V padframe/ESD power
74 inout vssio, // Common padframe/ESD ground
75 inout vdda, // Management 3.3V power
76 inout vssa, // Common analog ground
77 inout vccd, // Management/Common 1.8V power
78 inout vssd, // Common digital ground
79 inout vdda1, // User area 1 3.3V power
80 inout vdda2, // User area 2 3.3V power
81 inout vssa1, // User area 1 analog ground
82 inout vssa2, // User area 2 analog ground
83 inout vccd1, // User area 1 1.8V power
84 inout vccd2, // User area 2 1.8V power
85 inout vssd1, // User area 1 digital ground
86 inout vssd2, // User area 2 digital ground
87
Tim Edwards04ba17f2020-10-02 22:27:50 -040088 inout gpio, // Used for external LDO control
Tim Edwardsef8312e2020-09-22 17:20:06 -040089 inout [`MPRJ_IO_PADS-1:0] mprj_io,
Tim Edwardsba328902020-10-27 15:03:22 -040090 output [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out,
Tim Edwardsef8312e2020-09-22 17:20:06 -040091 input clock, // CMOS core clock input, not a crystal
Tim Edwards04ba17f2020-10-02 22:27:50 -040092 input resetb,
93
94 // Note that only two pins are available on the flash so dual and
95 // quad flash modes are not available.
96
Tim Edwardsef8312e2020-09-22 17:20:06 -040097 output flash_csb,
98 output flash_clk,
99 output flash_io0,
Tim Edwards04ba17f2020-10-02 22:27:50 -0400100 output flash_io1
Tim Edwardsef8312e2020-09-22 17:20:06 -0400101);
102
Tim Edwards04ba17f2020-10-02 22:27:50 -0400103 //------------------------------------------------------------
104 // This value is uniquely defined for each user project.
105 //------------------------------------------------------------
106 parameter USER_PROJECT_ID = 32'h0;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400107
Tim Edwards04ba17f2020-10-02 22:27:50 -0400108 // These pins are overlaid on mprj_io space. They have the function
109 // below when the management processor is in reset, or in the default
110 // configuration. They are assigned to uses in the user space by the
111 // configuration program running off of the SPI flash. Note that even
112 // when the user has taken control of these pins, they can be restored
113 // to the original use by setting the resetb pin low. The SPI pins and
114 // UART pins can be connected directly to an FTDI chip as long as the
115 // FTDI chip sets these lines to high impedence (input function) at
116 // all times except when holding the chip in reset.
117
118 // JTAG = mprj_io[0] (inout)
119 // SDO = mprj_io[1] (output)
120 // SDI = mprj_io[2] (input)
121 // CSB = mprj_io[3] (input)
122 // SCK = mprj_io[4] (input)
123 // ser_rx = mprj_io[5] (input)
124 // ser_tx = mprj_io[6] (output)
125 // irq = mprj_io[7] (input)
126
127 // These pins are reserved for any project that wants to incorporate
128 // its own processor and flash controller. While a user project can
129 // technically use any available I/O pins for the purpose, these
130 // four pins connect to a pass-through mode from the SPI slave (pins
131 // 1-4 above) so that any SPI flash connected to these specific pins
132 // can be accessed through the SPI slave even when the processor is in
133 // reset.
134
Tim Edwards44bab472020-10-04 22:09:54 -0400135 // user_flash_csb = mprj_io[8]
136 // user_flash_sck = mprj_io[9]
137 // user_flash_io0 = mprj_io[10]
138 // user_flash_io1 = mprj_io[11]
Tim Edwards04ba17f2020-10-02 22:27:50 -0400139
140 // One-bit GPIO dedicated to management SoC (outside of user control)
141 wire gpio_out_core;
142 wire gpio_in_core;
143 wire gpio_mode0_core;
144 wire gpio_mode1_core;
145 wire gpio_outenb_core;
146 wire gpio_inenb_core;
147
Tim Edwards6d9739d2020-10-19 11:00:49 -0400148 // User Project Control (pad-facing)
Tim Edwards04ba17f2020-10-02 22:27:50 -0400149 wire mprj_io_loader_resetn;
150 wire mprj_io_loader_clock;
151 wire mprj_io_loader_data;
152
Tim Edwardsef8312e2020-09-22 17:20:06 -0400153 wire [`MPRJ_IO_PADS-1:0] mprj_io_hldh_n;
154 wire [`MPRJ_IO_PADS-1:0] mprj_io_enh;
155 wire [`MPRJ_IO_PADS-1:0] mprj_io_inp_dis;
Tim Edwards44bab472020-10-04 22:09:54 -0400156 wire [`MPRJ_IO_PADS-1:0] mprj_io_oeb;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400157 wire [`MPRJ_IO_PADS-1:0] mprj_io_ib_mode_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400158 wire [`MPRJ_IO_PADS-1:0] mprj_io_vtrip_sel;
159 wire [`MPRJ_IO_PADS-1:0] mprj_io_slow_sel;
160 wire [`MPRJ_IO_PADS-1:0] mprj_io_holdover;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400161 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_en;
162 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_sel;
163 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_pol;
164 wire [`MPRJ_IO_PADS*3-1:0] mprj_io_dm;
165 wire [`MPRJ_IO_PADS-1:0] mprj_io_in;
166 wire [`MPRJ_IO_PADS-1:0] mprj_io_out;
167
Tim Edwards6d9739d2020-10-19 11:00:49 -0400168 // User Project Control (user-facing)
Tim Edwards44bab472020-10-04 22:09:54 -0400169 wire [`MPRJ_IO_PADS-1:0] user_io_oeb;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400170 wire [`MPRJ_IO_PADS-1:0] user_io_in;
171 wire [`MPRJ_IO_PADS-1:0] user_io_out;
Tim Edwards581068f2020-11-19 12:45:25 -0500172 wire [`MPRJ_IO_PADS-8:0] user_analog_io;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400173
174 /* Padframe control signals */
175 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link;
176 wire mgmt_serial_clock;
177 wire mgmt_serial_resetn;
178
Tim Edwards6d9739d2020-10-19 11:00:49 -0400179 // User Project Control management I/O
Tim Edwards44bab472020-10-04 22:09:54 -0400180 // There are two types of GPIO connections:
181 // (1) Full Bidirectional: Management connects to in, out, and oeb
182 // Uses: JTAG and SDO
183 // (2) Selectable bidirectional: Management connects to in and out,
184 // which are tied together. oeb is grounded (oeb from the
185 // configuration is used)
186
187 // SDI = mprj_io[2] (input)
188 // CSB = mprj_io[3] (input)
189 // SCK = mprj_io[4] (input)
190 // ser_rx = mprj_io[5] (input)
191 // ser_tx = mprj_io[6] (output)
192 // irq = mprj_io[7] (input)
193
194 wire [`MPRJ_IO_PADS-1:0] mgmt_io_in;
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200195 wire jtag_out, sdo_out;
196 wire jtag_outenb, sdo_outenb;
Tim Edwards44bab472020-10-04 22:09:54 -0400197
198 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc1; /* no-connects */
199 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc3; /* no-connects */
200 wire [1:0] mgmt_io_nc2; /* no-connects */
201
Tim Edwards581068f2020-11-19 12:45:25 -0500202 wire clock_core;
203
Tim Edwards04ba17f2020-10-02 22:27:50 -0400204 // Power-on-reset signal. The reset pad generates the sense-inverted
205 // reset at 3.3V. The 1.8V signal and the inverted 1.8V signal are
206 // derived.
207
Tim Edwardsef8312e2020-09-22 17:20:06 -0400208 wire porb_h;
209 wire porb_l;
Tim Edwards581068f2020-11-19 12:45:25 -0500210 wire por_l;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400211
Tim Edwardsf51dd082020-10-05 16:30:24 -0400212 wire rstb_h;
213 wire rstb_l;
214
Tim Edwards581068f2020-11-19 12:45:25 -0500215 wire flash_clk_core, flash_csb_core;
216 wire flash_clk_oeb_core, flash_csb_oeb_core;
217 wire flash_clk_ieb_core, flash_csb_ieb_core;
218 wire flash_io0_oeb_core, flash_io1_oeb_core;
219 wire flash_io2_oeb_core, flash_io3_oeb_core;
220 wire flash_io0_ieb_core, flash_io1_ieb_core;
221 wire flash_io2_ieb_core, flash_io3_ieb_core;
222 wire flash_io0_do_core, flash_io1_do_core;
223 wire flash_io2_do_core, flash_io3_do_core;
224 wire flash_io0_di_core, flash_io1_di_core;
225 wire flash_io2_di_core, flash_io3_di_core;
226
Tim Edwards44bab472020-10-04 22:09:54 -0400227 // To be considered: Master hold signal on all user pads (?)
228 // For now, set holdh_n to 1 (NOTE: This is in the 3.3V domain)
229 // and setting enh to porb_h.
Tim Edwards9eda80d2020-10-08 21:36:44 -0400230 assign mprj_io_hldh_n = {`MPRJ_IO_PADS{vddio}};
Tim Edwards44bab472020-10-04 22:09:54 -0400231 assign mprj_io_enh = {`MPRJ_IO_PADS{porb_h}};
232
Tim Edwardsef8312e2020-09-22 17:20:06 -0400233 chip_io padframe(
234 // Package Pins
Tim Edwards9eda80d2020-10-08 21:36:44 -0400235 .vddio(vddio),
236 .vssio(vssio),
237 .vdda(vdda),
238 .vssa(vssa),
239 .vccd(vccd),
240 .vssd(vssd),
241 .vdda1(vdda1),
242 .vdda2(vdda2),
243 .vssa1(vssa1),
244 .vssa2(vssa2),
245 .vccd1(vccd1),
246 .vccd2(vccd2),
247 .vssd1(vssd1),
248 .vssd2(vssd2),
249
Tim Edwardsef8312e2020-09-22 17:20:06 -0400250 .gpio(gpio),
251 .mprj_io(mprj_io),
252 .clock(clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400253 .resetb(resetb),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400254 .flash_csb(flash_csb),
255 .flash_clk(flash_clk),
256 .flash_io0(flash_io0),
257 .flash_io1(flash_io1),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400258 // SoC Core Interface
Tim Edwardsef8312e2020-09-22 17:20:06 -0400259 .porb_h(porb_h),
Tim Edwards581068f2020-11-19 12:45:25 -0500260 .por(por_l),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400261 .resetb_core_h(rstb_h),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400262 .clock_core(clock_core),
263 .gpio_out_core(gpio_out_core),
264 .gpio_in_core(gpio_in_core),
265 .gpio_mode0_core(gpio_mode0_core),
266 .gpio_mode1_core(gpio_mode1_core),
267 .gpio_outenb_core(gpio_outenb_core),
268 .gpio_inenb_core(gpio_inenb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400269 .flash_csb_core(flash_csb_core),
270 .flash_clk_core(flash_clk_core),
271 .flash_csb_oeb_core(flash_csb_oeb_core),
272 .flash_clk_oeb_core(flash_clk_oeb_core),
273 .flash_io0_oeb_core(flash_io0_oeb_core),
274 .flash_io1_oeb_core(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400275 .flash_csb_ieb_core(flash_csb_ieb_core),
276 .flash_clk_ieb_core(flash_clk_ieb_core),
277 .flash_io0_ieb_core(flash_io0_ieb_core),
278 .flash_io1_ieb_core(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400279 .flash_io0_do_core(flash_io0_do_core),
280 .flash_io1_do_core(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400281 .flash_io0_di_core(flash_io0_di_core),
282 .flash_io1_di_core(flash_io1_di_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400283 .mprj_io_in(mprj_io_in),
284 .mprj_io_out(mprj_io_out),
Tim Edwards44bab472020-10-04 22:09:54 -0400285 .mprj_io_oeb(mprj_io_oeb),
Manar14d35ac2020-10-21 22:47:15 +0200286 .mprj_io_hldh_n(mprj_io_hldh_n),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400287 .mprj_io_enh(mprj_io_enh),
Manar14d35ac2020-10-21 22:47:15 +0200288 .mprj_io_inp_dis(mprj_io_inp_dis),
289 .mprj_io_ib_mode_sel(mprj_io_ib_mode_sel),
290 .mprj_io_vtrip_sel(mprj_io_vtrip_sel),
291 .mprj_io_slow_sel(mprj_io_slow_sel),
292 .mprj_io_holdover(mprj_io_holdover),
293 .mprj_io_analog_en(mprj_io_analog_en),
294 .mprj_io_analog_sel(mprj_io_analog_sel),
295 .mprj_io_analog_pol(mprj_io_analog_pol),
Tim Edwards581068f2020-11-19 12:45:25 -0500296 .mprj_io_dm(mprj_io_dm),
297 .mprj_analog_io(user_analog_io)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400298 );
299
300 // SoC core
Tim Edwards04ba17f2020-10-02 22:27:50 -0400301 wire caravel_clk;
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400302 wire caravel_clk2;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400303 wire caravel_rstn;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400304
305 wire [7:0] spi_ro_config_core;
306
307 // LA signals
Tim Edwards43e5c602020-11-19 15:59:50 -0500308 wire [127:0] la_data_in_user; // From CPU to MPRJ
309 wire [127:0] la_data_in_mprj; // From MPRJ to CPU
Tim Edwardsef8312e2020-09-22 17:20:06 -0400310 wire [127:0] la_data_out_mprj; // From CPU to MPRJ
Tim Edwards43e5c602020-11-19 15:59:50 -0500311 wire [127:0] la_data_out_user; // From MPRJ to CPU
312 wire [127:0] la_oen_user; // From CPU to MPRJ
313 wire [127:0] la_oen_mprj; // From CPU to MPRJ
314
Tim Edwards6d9739d2020-10-19 11:00:49 -0400315 // WB MI A (User Project)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400316 wire mprj_cyc_o_core;
317 wire mprj_stb_o_core;
318 wire mprj_we_o_core;
319 wire [3:0] mprj_sel_o_core;
320 wire [31:0] mprj_adr_o_core;
321 wire [31:0] mprj_dat_o_core;
322 wire mprj_ack_i_core;
323 wire [31:0] mprj_dat_i_core;
324
325 // WB MI B (xbar)
326 wire xbar_cyc_o_core;
327 wire xbar_stb_o_core;
328 wire xbar_we_o_core;
329 wire [3:0] xbar_sel_o_core;
330 wire [31:0] xbar_adr_o_core;
331 wire [31:0] xbar_dat_o_core;
332 wire xbar_ack_i_core;
333 wire [31:0] xbar_dat_i_core;
334
Tim Edwards04ba17f2020-10-02 22:27:50 -0400335 // Mask revision
336 wire [31:0] mask_rev;
337
Manar14d35ac2020-10-21 22:47:15 +0200338 wire mprj_clock;
339 wire mprj_clock2;
340 wire mprj_resetn;
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200341 wire mprj_reset;
Manar14d35ac2020-10-21 22:47:15 +0200342 wire mprj_cyc_o_user;
343 wire mprj_stb_o_user;
344 wire mprj_we_o_user;
345 wire [3:0] mprj_sel_o_user;
346 wire [31:0] mprj_adr_o_user;
347 wire [31:0] mprj_dat_o_user;
348 wire mprj_vcc_pwrgood;
349 wire mprj2_vcc_pwrgood;
350 wire mprj_vdd_pwrgood;
351 wire mprj2_vdd_pwrgood;
352
Manar55ec3692020-10-30 16:32:18 +0200353 // Storage area
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200354 // Management R/W interface
355 wire [`RAM_BLOCKS-1:0] mgmt_ena;
Manarffe6cad2020-11-09 19:09:04 +0200356 wire [`RAM_BLOCKS-1:0] mgmt_wen;
357 wire [(`RAM_BLOCKS*4)-1:0] mgmt_wen_mask;
Manar55ec3692020-10-30 16:32:18 +0200358 wire [7:0] mgmt_addr;
359 wire [31:0] mgmt_wdata;
Manarffe6cad2020-11-09 19:09:04 +0200360 wire [(`RAM_BLOCKS*32)-1:0] mgmt_rdata;
Manar55ec3692020-10-30 16:32:18 +0200361 // Management RO interface
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200362 wire mgmt_ena_ro;
Manarffe6cad2020-11-09 19:09:04 +0200363 wire [7:0] mgmt_addr_ro;
364 wire [31:0] mgmt_rdata_ro;
Manar55ec3692020-10-30 16:32:18 +0200365
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200366 mgmt_core soc (
Manar61dce922020-11-10 19:26:28 +0200367 `ifdef USE_POWER_PINS
manarabdelatya115bdd2020-12-01 11:19:12 +0200368 .VPWR(vccd),
369 .VGND(vssa),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400370 `endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400371 // GPIO (1 pin)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400372 .gpio_out_pad(gpio_out_core),
373 .gpio_in_pad(gpio_in_core),
374 .gpio_mode0_pad(gpio_mode0_core),
375 .gpio_mode1_pad(gpio_mode1_core),
376 .gpio_outenb_pad(gpio_outenb_core),
377 .gpio_inenb_pad(gpio_inenb_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400378 // Primary SPI flash controller
Tim Edwardsef8312e2020-09-22 17:20:06 -0400379 .flash_csb(flash_csb_core),
380 .flash_clk(flash_clk_core),
381 .flash_csb_oeb(flash_csb_oeb_core),
382 .flash_clk_oeb(flash_clk_oeb_core),
383 .flash_io0_oeb(flash_io0_oeb_core),
384 .flash_io1_oeb(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400385 .flash_csb_ieb(flash_csb_ieb_core),
386 .flash_clk_ieb(flash_clk_ieb_core),
387 .flash_io0_ieb(flash_io0_ieb_core),
388 .flash_io1_ieb(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400389 .flash_io0_do(flash_io0_do_core),
390 .flash_io1_do(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400391 .flash_io0_di(flash_io0_di_core),
392 .flash_io1_di(flash_io1_di_core),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400393 // Master Reset
394 .resetb(rstb_l),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400395 .porb(porb_l),
396 // Clocks and reset
Tim Edwardsef8312e2020-09-22 17:20:06 -0400397 .clock(clock_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400398 .core_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400399 .user_clk(caravel_clk2),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400400 .core_rstn(caravel_rstn),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200401 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500402 .la_input(la_data_in_mprj),
403 .la_output(la_data_out_mprj),
404 .la_oen(la_oen_mprj),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400405 // User Project IO Control
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400406 .mprj_vcc_pwrgood(mprj_vcc_pwrgood),
407 .mprj2_vcc_pwrgood(mprj2_vcc_pwrgood),
408 .mprj_vdd_pwrgood(mprj_vdd_pwrgood),
409 .mprj2_vdd_pwrgood(mprj2_vdd_pwrgood),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400410 .mprj_io_loader_resetn(mprj_io_loader_resetn),
411 .mprj_io_loader_clock(mprj_io_loader_clock),
412 .mprj_io_loader_data(mprj_io_loader_data),
Tim Edwards44bab472020-10-04 22:09:54 -0400413 .mgmt_in_data(mgmt_io_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400414 .mgmt_out_data({mgmt_io_in[(`MPRJ_IO_PADS-1):2], mgmt_io_nc2}),
Tim Edwardsba328902020-10-27 15:03:22 -0400415 .pwr_ctrl_out(pwr_ctrl_out),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400416 .sdo_out(sdo_out),
417 .sdo_outenb(sdo_outenb),
418 .jtag_out(jtag_out),
419 .jtag_outenb(jtag_outenb),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400420 // User Project Slave ports (WB MI A)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400421 .mprj_cyc_o(mprj_cyc_o_core),
422 .mprj_stb_o(mprj_stb_o_core),
423 .mprj_we_o(mprj_we_o_core),
424 .mprj_sel_o(mprj_sel_o_core),
425 .mprj_adr_o(mprj_adr_o_core),
426 .mprj_dat_o(mprj_dat_o_core),
427 .mprj_ack_i(mprj_ack_i_core),
428 .mprj_dat_i(mprj_dat_i_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400429 // mask data
Manar55ec3692020-10-30 16:32:18 +0200430 .mask_rev(mask_rev),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200431 // MGMT area R/W interface
432 .mgmt_ena(mgmt_ena),
Manar55ec3692020-10-30 16:32:18 +0200433 .mgmt_wen_mask(mgmt_wen_mask),
434 .mgmt_wen(mgmt_wen),
435 .mgmt_addr(mgmt_addr),
436 .mgmt_wdata(mgmt_wdata),
437 .mgmt_rdata(mgmt_rdata),
Manarffe6cad2020-11-09 19:09:04 +0200438 // MGMT area RO interface
439 .mgmt_ena_ro(mgmt_ena_ro),
440 .mgmt_addr_ro(mgmt_addr_ro),
441 .mgmt_rdata_ro(mgmt_rdata_ro)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400442 );
443
Tim Edwards53d92182020-10-11 21:47:40 -0400444 /* Clock and reset to user space are passed through a tristate */
445 /* buffer like the above, but since they are intended to be */
446 /* always active, connect the enable to the logic-1 output from */
447 /* the vccd1 domain. */
448
Tim Edwards53d92182020-10-11 21:47:40 -0400449 mgmt_protect mgmt_buffers (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200450 `ifdef USE_POWER_PINS
Tim Edwards53d92182020-10-11 21:47:40 -0400451 .vccd(vccd),
452 .vssd(vssd),
453 .vccd1(vccd1),
454 .vssd1(vssd1),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400455 .vdda1(vdda1),
456 .vssa1(vssa1),
457 .vdda2(vdda2),
458 .vssa2(vssa2),
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200459 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400460
Tim Edwards53d92182020-10-11 21:47:40 -0400461 .caravel_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400462 .caravel_clk2(caravel_clk2),
Tim Edwards53d92182020-10-11 21:47:40 -0400463 .caravel_rstn(caravel_rstn),
464 .mprj_cyc_o_core(mprj_cyc_o_core),
465 .mprj_stb_o_core(mprj_stb_o_core),
466 .mprj_we_o_core(mprj_we_o_core),
467 .mprj_sel_o_core(mprj_sel_o_core),
468 .mprj_adr_o_core(mprj_adr_o_core),
469 .mprj_dat_o_core(mprj_dat_o_core),
Tim Edwards43e5c602020-11-19 15:59:50 -0500470 .la_data_out_core(la_data_out_user),
471 .la_data_out_mprj(la_data_out_mprj),
472 .la_data_in_core(la_data_in_user),
473 .la_data_in_mprj(la_data_in_mprj),
474 .la_oen_mprj(la_oen_mprj),
475 .la_oen_core(la_oen_user),
Tim Edwards53d92182020-10-11 21:47:40 -0400476
477 .user_clock(mprj_clock),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400478 .user_clock2(mprj_clock2),
Tim Edwards53d92182020-10-11 21:47:40 -0400479 .user_resetn(mprj_resetn),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200480 .user_reset(mprj_reset),
Tim Edwards53d92182020-10-11 21:47:40 -0400481 .mprj_cyc_o_user(mprj_cyc_o_user),
482 .mprj_stb_o_user(mprj_stb_o_user),
483 .mprj_we_o_user(mprj_we_o_user),
484 .mprj_sel_o_user(mprj_sel_o_user),
485 .mprj_adr_o_user(mprj_adr_o_user),
486 .mprj_dat_o_user(mprj_dat_o_user),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400487 .user1_vcc_powergood(mprj_vcc_pwrgood),
488 .user2_vcc_powergood(mprj2_vcc_pwrgood),
489 .user1_vdd_powergood(mprj_vdd_pwrgood),
490 .user2_vdd_powergood(mprj2_vdd_pwrgood)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400491 );
Tim Edwards53d92182020-10-11 21:47:40 -0400492
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200493
Tim Edwardsb86fc842020-10-13 17:11:54 -0400494 /*----------------------------------------------*/
495 /* Wrapper module around the user project */
496 /*----------------------------------------------*/
Tim Edwards05537512020-10-06 14:59:26 -0400497
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200498 user_project_wrapper mprj (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200499 `ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400500 .vdda1(vdda1), // User area 1 3.3V power
501 .vdda2(vdda2), // User area 2 3.3V power
502 .vssa1(vssa1), // User area 1 analog ground
503 .vssa2(vssa2), // User area 2 analog ground
504 .vccd1(vccd1), // User area 1 1.8V power
505 .vccd2(vccd2), // User area 2 1.8V power
506 .vssd1(vssd1), // User area 1 digital ground
507 .vssd2(vssd2), // User area 2 digital ground
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200508 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400509
Tim Edwards53d92182020-10-11 21:47:40 -0400510 .wb_clk_i(mprj_clock),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200511 .wb_rst_i(mprj_reset),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200512 // MGMT SoC Wishbone Slave
Tim Edwards53d92182020-10-11 21:47:40 -0400513 .wbs_cyc_i(mprj_cyc_o_user),
514 .wbs_stb_i(mprj_stb_o_user),
515 .wbs_we_i(mprj_we_o_user),
516 .wbs_sel_i(mprj_sel_o_user),
517 .wbs_adr_i(mprj_adr_o_user),
518 .wbs_dat_i(mprj_dat_o_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400519 .wbs_ack_o(mprj_ack_i_core),
520 .wbs_dat_o(mprj_dat_i_core),
521 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500522 .la_data_in(la_data_in_user),
523 .la_data_out(la_data_out_user),
524 .la_oen(la_oen_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400525 // IO Pads
Tim Edwards05537512020-10-06 14:59:26 -0400526 .io_in (user_io_in),
Tim Edwardsef2b68d2020-10-11 17:00:44 -0400527 .io_out(user_io_out),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400528 .io_oeb(user_io_oeb),
Tim Edwards581068f2020-11-19 12:45:25 -0500529 .analog_io(user_analog_io),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400530 // Independent clock
531 .user_clock2(mprj_clock2)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400532 );
533
Tim Edwards05537512020-10-06 14:59:26 -0400534 /*--------------------------------------*/
535 /* End user project instantiation */
536 /*--------------------------------------*/
537
Tim Edwards04ba17f2020-10-02 22:27:50 -0400538 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link_shifted;
539
Tim Edwards251e0df2020-10-05 11:02:12 -0400540 assign gpio_serial_link_shifted = {gpio_serial_link[`MPRJ_IO_PADS-2:0], mprj_io_loader_data};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400541
Tim Edwards251e0df2020-10-05 11:02:12 -0400542 // Each control block sits next to an I/O pad in the user area.
543 // It gets input through a serial chain from the previous control
544 // block and passes it to the next control block. Due to the nature
545 // of the shift register, bits are presented in reverse, as the first
546 // bit in ends up as the last bit of the last I/O pad control block.
Tim Edwards44bab472020-10-04 22:09:54 -0400547
Tim Edwards89f09242020-10-05 15:17:34 -0400548 // There are two types of block; the first two are configured to be
549 // full bidirectional under control of the management Soc (JTAG and
550 // SDO). The rest are configured to be default (input).
551
Tim Edwards251e0df2020-10-05 11:02:12 -0400552 gpio_control_block #(
Tim Edwards89f09242020-10-05 15:17:34 -0400553 .DM_INIT(3'b110), // Mode = output, strong up/down
Tim Edwards496a08a2020-10-26 15:44:51 -0400554 .OENB_INIT(1'b1) // Enable output signaling from wire
Tim Edwards89f09242020-10-05 15:17:34 -0400555 ) gpio_control_bidir [1:0] (
Manar61dce922020-11-10 19:26:28 +0200556 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200557 .vccd(vccd),
558 .vssd(vssd),
559 .vccd1(vccd1),
560 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400561 `endif
Tim Edwards44bab472020-10-04 22:09:54 -0400562
Tim Edwards04ba17f2020-10-02 22:27:50 -0400563 // Management Soc-facing signals
564
Tim Edwardsc18c4742020-10-03 11:26:39 -0400565 .resetn(mprj_io_loader_resetn),
566 .serial_clock(mprj_io_loader_clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400567
Tim Edwards89f09242020-10-05 15:17:34 -0400568 .mgmt_gpio_in(mgmt_io_in[1:0]),
569 .mgmt_gpio_out({sdo_out, jtag_out}),
570 .mgmt_gpio_oeb({sdo_outenb, jtag_outenb}),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400571
572 // Serial data chain for pad configuration
Tim Edwards89f09242020-10-05 15:17:34 -0400573 .serial_data_in(gpio_serial_link_shifted[1:0]),
574 .serial_data_out(gpio_serial_link[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400575
576 // User-facing signals
Tim Edwards89f09242020-10-05 15:17:34 -0400577 .user_gpio_out(user_io_out[1:0]),
578 .user_gpio_oeb(user_io_oeb[1:0]),
579 .user_gpio_in(user_io_in[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400580
581 // Pad-facing signals (Pad GPIOv2)
Tim Edwards89f09242020-10-05 15:17:34 -0400582 .pad_gpio_inenb(mprj_io_inp_dis[1:0]),
583 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[1:0]),
584 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[1:0]),
585 .pad_gpio_slow_sel(mprj_io_slow_sel[1:0]),
586 .pad_gpio_holdover(mprj_io_holdover[1:0]),
587 .pad_gpio_ana_en(mprj_io_analog_en[1:0]),
588 .pad_gpio_ana_sel(mprj_io_analog_sel[1:0]),
589 .pad_gpio_ana_pol(mprj_io_analog_pol[1:0]),
590 .pad_gpio_dm(mprj_io_dm[5:0]),
591 .pad_gpio_outenb(mprj_io_oeb[1:0]),
592 .pad_gpio_out(mprj_io_out[1:0]),
593 .pad_gpio_in(mprj_io_in[1:0])
594 );
595
596 gpio_control_block gpio_control_in [`MPRJ_IO_PADS-1:2] (
Manar61dce922020-11-10 19:26:28 +0200597 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200598 .vccd(vccd),
599 .vssd(vssd),
600 .vccd1(vccd1),
601 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400602 `endif
Tim Edwards89f09242020-10-05 15:17:34 -0400603
604 // Management Soc-facing signals
605
606 .resetn(mprj_io_loader_resetn),
607 .serial_clock(mprj_io_loader_clock),
608
609 .mgmt_gpio_in(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
610 .mgmt_gpio_out(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
611 .mgmt_gpio_oeb(1'b1),
612
613 // Serial data chain for pad configuration
614 .serial_data_in(gpio_serial_link_shifted[(`MPRJ_IO_PADS-1):2]),
615 .serial_data_out(gpio_serial_link[(`MPRJ_IO_PADS-1):2]),
616
617 // User-facing signals
618 .user_gpio_out(user_io_out[(`MPRJ_IO_PADS-1):2]),
619 .user_gpio_oeb(user_io_oeb[(`MPRJ_IO_PADS-1):2]),
620 .user_gpio_in(user_io_in[(`MPRJ_IO_PADS-1):2]),
621
622 // Pad-facing signals (Pad GPIOv2)
623 .pad_gpio_inenb(mprj_io_inp_dis[(`MPRJ_IO_PADS-1):2]),
624 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[(`MPRJ_IO_PADS-1):2]),
625 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[(`MPRJ_IO_PADS-1):2]),
626 .pad_gpio_slow_sel(mprj_io_slow_sel[(`MPRJ_IO_PADS-1):2]),
627 .pad_gpio_holdover(mprj_io_holdover[(`MPRJ_IO_PADS-1):2]),
628 .pad_gpio_ana_en(mprj_io_analog_en[(`MPRJ_IO_PADS-1):2]),
629 .pad_gpio_ana_sel(mprj_io_analog_sel[(`MPRJ_IO_PADS-1):2]),
630 .pad_gpio_ana_pol(mprj_io_analog_pol[(`MPRJ_IO_PADS-1):2]),
631 .pad_gpio_dm(mprj_io_dm[(`MPRJ_IO_PADS*3-1):6]),
632 .pad_gpio_outenb(mprj_io_oeb[(`MPRJ_IO_PADS-1):2]),
633 .pad_gpio_out(mprj_io_out[(`MPRJ_IO_PADS-1):2]),
634 .pad_gpio_in(mprj_io_in[(`MPRJ_IO_PADS-1):2])
Tim Edwards04ba17f2020-10-02 22:27:50 -0400635 );
636
Tim Edwards04ba17f2020-10-02 22:27:50 -0400637 user_id_programming #(
638 .USER_PROJECT_ID(USER_PROJECT_ID)
639 ) user_id_value (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200640`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400641 .vdd1v8(vccd),
642 .vss(vssd),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200643`endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400644 .mask_rev(mask_rev)
645 );
646
Tim Edwardsf51dd082020-10-05 16:30:24 -0400647 // Power-on-reset circuit
648 simple_por por (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200649`ifdef USE_POWER_PINS
Tim Edwards9eda80d2020-10-08 21:36:44 -0400650 .vdd3v3(vddio),
Tim Edwards581068f2020-11-19 12:45:25 -0500651 .vdd1v8(vccd),
Tim Edwards9eda80d2020-10-08 21:36:44 -0400652 .vss(vssio),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200653`endif
Tim Edwards581068f2020-11-19 12:45:25 -0500654 .porb_h(porb_h),
655 .porb_l(porb_l),
656 .por_l(por_l)
Tim Edwardsf51dd082020-10-05 16:30:24 -0400657 );
658
659 // XRES (chip input pin reset) reset level converter
Ahmed Ghazy1d1679d2020-11-30 17:44:45 +0200660 sky130_fd_sc_hvl__lsbufhv2lv_1_wrapped rstb_level (
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200661`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400662 .VPWR(vddio),
663 .VPB(vddio),
664 .LVPWR(vccd),
665 .VNB(vssio),
666 .VGND(vssio),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200667`endif
Tim Edwardsf51dd082020-10-05 16:30:24 -0400668 .A(rstb_h),
669 .X(rstb_l)
670 );
671
Manar55ec3692020-10-30 16:32:18 +0200672 // Storage area
Manarffe6cad2020-11-09 19:09:04 +0200673 storage storage(
Manar55ec3692020-10-30 16:32:18 +0200674 .mgmt_clk(caravel_clk),
675 .mgmt_ena(mgmt_ena),
676 .mgmt_wen(mgmt_wen),
677 .mgmt_wen_mask(mgmt_wen_mask),
678 .mgmt_addr(mgmt_addr),
679 .mgmt_wdata(mgmt_wdata),
680 .mgmt_rdata(mgmt_rdata),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200681 // Management RO interface
Manarffe6cad2020-11-09 19:09:04 +0200682 .mgmt_ena_ro(mgmt_ena_ro),
683 .mgmt_addr_ro(mgmt_addr_ro),
684 .mgmt_rdata_ro(mgmt_rdata_ro)
Manar55ec3692020-10-30 16:32:18 +0200685 );
686
Tim Edwardsef8312e2020-09-22 17:20:06 -0400687endmodule
Tim Edwards581068f2020-11-19 12:45:25 -0500688// `default_nettype wire