blob: 23851dd34efced32c1fb3cea13004b7f398033b7 [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
33`include "mgmt_soc.v"
Tim Edwards44bab472020-10-04 22:09:54 -040034`include "housekeeping_spi.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040035`include "digital_pll.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040036`include "caravel_clocking.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040037`include "mgmt_core.v"
Tim Edwards53d92182020-10-11 21:47:40 -040038`include "mgmt_protect.v"
Tim Edwardsbc035512020-11-23 11:16:08 -050039`include "mgmt_protect_hv.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040040`include "mprj_io.v"
41`include "chip_io.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040042`include "user_id_programming.v"
Tim Edwardsb86fc842020-10-13 17:11:54 -040043`include "user_project_wrapper.v"
Tim Edwards04ba17f2020-10-02 22:27:50 -040044`include "gpio_control_block.v"
Tim Edwards3245e2f2020-10-10 14:02:11 -040045`include "clock_div.v"
Tim Edwardsf51dd082020-10-05 16:30:24 -040046`include "simple_por.v"
Manar55ec3692020-10-30 16:32:18 +020047`include "storage_bridge_wb.v"
Ahmed Ghazy2517fa82020-11-08 23:34:41 +020048`include "DFFRAM.v"
Manar68e03632020-11-09 13:25:13 +020049`include "DFFRAMBB.v"
Manar55ec3692020-10-30 16:32:18 +020050`include "sram_1rw1r_32_256_8_sky130.v"
51`include "storage.v"
Tim Edwardsef8312e2020-09-22 17:20:06 -040052
Tim Edwards05537512020-10-06 14:59:26 -040053/*------------------------------*/
54/* Include user project here */
55/*------------------------------*/
56`include "user_proj_example.v"
57
Manar55ec3692020-10-30 16:32:18 +020058// `ifdef USE_OPENRAM
59// `include "sram_1rw1r_32_256_8_sky130.v"
60// `endif
Tim Edwardsef8312e2020-09-22 17:20:06 -040061
62module caravel (
Tim Edwards9eda80d2020-10-08 21:36:44 -040063 inout vddio, // Common 3.3V padframe/ESD power
64 inout vssio, // Common padframe/ESD ground
65 inout vdda, // Management 3.3V power
66 inout vssa, // Common analog ground
67 inout vccd, // Management/Common 1.8V power
68 inout vssd, // Common digital ground
69 inout vdda1, // User area 1 3.3V power
70 inout vdda2, // User area 2 3.3V power
71 inout vssa1, // User area 1 analog ground
72 inout vssa2, // User area 2 analog ground
73 inout vccd1, // User area 1 1.8V power
74 inout vccd2, // User area 2 1.8V power
75 inout vssd1, // User area 1 digital ground
76 inout vssd2, // User area 2 digital ground
77
Tim Edwards04ba17f2020-10-02 22:27:50 -040078 inout gpio, // Used for external LDO control
Tim Edwardsef8312e2020-09-22 17:20:06 -040079 inout [`MPRJ_IO_PADS-1:0] mprj_io,
Tim Edwardsba328902020-10-27 15:03:22 -040080 output [`MPRJ_PWR_PADS-1:0] pwr_ctrl_out,
Tim Edwardsef8312e2020-09-22 17:20:06 -040081 input clock, // CMOS core clock input, not a crystal
Tim Edwards04ba17f2020-10-02 22:27:50 -040082 input resetb,
83
84 // Note that only two pins are available on the flash so dual and
85 // quad flash modes are not available.
86
Tim Edwardsef8312e2020-09-22 17:20:06 -040087 output flash_csb,
88 output flash_clk,
89 output flash_io0,
Tim Edwards04ba17f2020-10-02 22:27:50 -040090 output flash_io1
Tim Edwardsef8312e2020-09-22 17:20:06 -040091);
92
Tim Edwards04ba17f2020-10-02 22:27:50 -040093 //------------------------------------------------------------
94 // This value is uniquely defined for each user project.
95 //------------------------------------------------------------
96 parameter USER_PROJECT_ID = 32'h0;
Tim Edwardsef8312e2020-09-22 17:20:06 -040097
Tim Edwards04ba17f2020-10-02 22:27:50 -040098 // These pins are overlaid on mprj_io space. They have the function
99 // below when the management processor is in reset, or in the default
100 // configuration. They are assigned to uses in the user space by the
101 // configuration program running off of the SPI flash. Note that even
102 // when the user has taken control of these pins, they can be restored
103 // to the original use by setting the resetb pin low. The SPI pins and
104 // UART pins can be connected directly to an FTDI chip as long as the
105 // FTDI chip sets these lines to high impedence (input function) at
106 // all times except when holding the chip in reset.
107
108 // JTAG = mprj_io[0] (inout)
109 // SDO = mprj_io[1] (output)
110 // SDI = mprj_io[2] (input)
111 // CSB = mprj_io[3] (input)
112 // SCK = mprj_io[4] (input)
113 // ser_rx = mprj_io[5] (input)
114 // ser_tx = mprj_io[6] (output)
115 // irq = mprj_io[7] (input)
116
117 // These pins are reserved for any project that wants to incorporate
118 // its own processor and flash controller. While a user project can
119 // technically use any available I/O pins for the purpose, these
120 // four pins connect to a pass-through mode from the SPI slave (pins
121 // 1-4 above) so that any SPI flash connected to these specific pins
122 // can be accessed through the SPI slave even when the processor is in
123 // reset.
124
Tim Edwards44bab472020-10-04 22:09:54 -0400125 // user_flash_csb = mprj_io[8]
126 // user_flash_sck = mprj_io[9]
127 // user_flash_io0 = mprj_io[10]
128 // user_flash_io1 = mprj_io[11]
Tim Edwards04ba17f2020-10-02 22:27:50 -0400129
130 // One-bit GPIO dedicated to management SoC (outside of user control)
131 wire gpio_out_core;
132 wire gpio_in_core;
133 wire gpio_mode0_core;
134 wire gpio_mode1_core;
135 wire gpio_outenb_core;
136 wire gpio_inenb_core;
137
Tim Edwards6d9739d2020-10-19 11:00:49 -0400138 // User Project Control (pad-facing)
Tim Edwards04ba17f2020-10-02 22:27:50 -0400139 wire mprj_io_loader_resetn;
140 wire mprj_io_loader_clock;
141 wire mprj_io_loader_data;
142
Tim Edwardsef8312e2020-09-22 17:20:06 -0400143 wire [`MPRJ_IO_PADS-1:0] mprj_io_hldh_n;
144 wire [`MPRJ_IO_PADS-1:0] mprj_io_enh;
145 wire [`MPRJ_IO_PADS-1:0] mprj_io_inp_dis;
Tim Edwards44bab472020-10-04 22:09:54 -0400146 wire [`MPRJ_IO_PADS-1:0] mprj_io_oeb;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400147 wire [`MPRJ_IO_PADS-1:0] mprj_io_ib_mode_sel;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400148 wire [`MPRJ_IO_PADS-1:0] mprj_io_vtrip_sel;
149 wire [`MPRJ_IO_PADS-1:0] mprj_io_slow_sel;
150 wire [`MPRJ_IO_PADS-1:0] mprj_io_holdover;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400151 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_en;
152 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_sel;
153 wire [`MPRJ_IO_PADS-1:0] mprj_io_analog_pol;
154 wire [`MPRJ_IO_PADS*3-1:0] mprj_io_dm;
155 wire [`MPRJ_IO_PADS-1:0] mprj_io_in;
156 wire [`MPRJ_IO_PADS-1:0] mprj_io_out;
157
Tim Edwards6d9739d2020-10-19 11:00:49 -0400158 // User Project Control (user-facing)
Tim Edwards44bab472020-10-04 22:09:54 -0400159 wire [`MPRJ_IO_PADS-1:0] user_io_oeb;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400160 wire [`MPRJ_IO_PADS-1:0] user_io_in;
161 wire [`MPRJ_IO_PADS-1:0] user_io_out;
Tim Edwards581068f2020-11-19 12:45:25 -0500162 wire [`MPRJ_IO_PADS-8:0] user_analog_io;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400163
164 /* Padframe control signals */
165 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link;
166 wire mgmt_serial_clock;
167 wire mgmt_serial_resetn;
168
Tim Edwards6d9739d2020-10-19 11:00:49 -0400169 // User Project Control management I/O
Tim Edwards44bab472020-10-04 22:09:54 -0400170 // There are two types of GPIO connections:
171 // (1) Full Bidirectional: Management connects to in, out, and oeb
172 // Uses: JTAG and SDO
173 // (2) Selectable bidirectional: Management connects to in and out,
174 // which are tied together. oeb is grounded (oeb from the
175 // configuration is used)
176
177 // SDI = mprj_io[2] (input)
178 // CSB = mprj_io[3] (input)
179 // SCK = mprj_io[4] (input)
180 // ser_rx = mprj_io[5] (input)
181 // ser_tx = mprj_io[6] (output)
182 // irq = mprj_io[7] (input)
183
184 wire [`MPRJ_IO_PADS-1:0] mgmt_io_in;
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200185 wire jtag_out, sdo_out;
186 wire jtag_outenb, sdo_outenb;
Tim Edwards44bab472020-10-04 22:09:54 -0400187
188 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc1; /* no-connects */
189 wire [`MPRJ_IO_PADS-3:0] mgmt_io_nc3; /* no-connects */
190 wire [1:0] mgmt_io_nc2; /* no-connects */
191
Tim Edwards581068f2020-11-19 12:45:25 -0500192 wire clock_core;
193
Tim Edwards04ba17f2020-10-02 22:27:50 -0400194 // Power-on-reset signal. The reset pad generates the sense-inverted
195 // reset at 3.3V. The 1.8V signal and the inverted 1.8V signal are
196 // derived.
197
Tim Edwardsef8312e2020-09-22 17:20:06 -0400198 wire porb_h;
199 wire porb_l;
Tim Edwards581068f2020-11-19 12:45:25 -0500200 wire por_l;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400201
Tim Edwardsf51dd082020-10-05 16:30:24 -0400202 wire rstb_h;
203 wire rstb_l;
204
Tim Edwards581068f2020-11-19 12:45:25 -0500205 wire flash_clk_core, flash_csb_core;
206 wire flash_clk_oeb_core, flash_csb_oeb_core;
207 wire flash_clk_ieb_core, flash_csb_ieb_core;
208 wire flash_io0_oeb_core, flash_io1_oeb_core;
209 wire flash_io2_oeb_core, flash_io3_oeb_core;
210 wire flash_io0_ieb_core, flash_io1_ieb_core;
211 wire flash_io2_ieb_core, flash_io3_ieb_core;
212 wire flash_io0_do_core, flash_io1_do_core;
213 wire flash_io2_do_core, flash_io3_do_core;
214 wire flash_io0_di_core, flash_io1_di_core;
215 wire flash_io2_di_core, flash_io3_di_core;
216
Tim Edwards44bab472020-10-04 22:09:54 -0400217 // To be considered: Master hold signal on all user pads (?)
218 // For now, set holdh_n to 1 (NOTE: This is in the 3.3V domain)
219 // and setting enh to porb_h.
Tim Edwards9eda80d2020-10-08 21:36:44 -0400220 assign mprj_io_hldh_n = {`MPRJ_IO_PADS{vddio}};
Tim Edwards44bab472020-10-04 22:09:54 -0400221 assign mprj_io_enh = {`MPRJ_IO_PADS{porb_h}};
222
Tim Edwardsef8312e2020-09-22 17:20:06 -0400223 chip_io padframe(
224 // Package Pins
Tim Edwards9eda80d2020-10-08 21:36:44 -0400225 .vddio(vddio),
226 .vssio(vssio),
227 .vdda(vdda),
228 .vssa(vssa),
229 .vccd(vccd),
230 .vssd(vssd),
231 .vdda1(vdda1),
232 .vdda2(vdda2),
233 .vssa1(vssa1),
234 .vssa2(vssa2),
235 .vccd1(vccd1),
236 .vccd2(vccd2),
237 .vssd1(vssd1),
238 .vssd2(vssd2),
239
Tim Edwardsef8312e2020-09-22 17:20:06 -0400240 .gpio(gpio),
241 .mprj_io(mprj_io),
242 .clock(clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400243 .resetb(resetb),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400244 .flash_csb(flash_csb),
245 .flash_clk(flash_clk),
246 .flash_io0(flash_io0),
247 .flash_io1(flash_io1),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400248 // SoC Core Interface
Tim Edwardsef8312e2020-09-22 17:20:06 -0400249 .porb_h(porb_h),
Tim Edwards581068f2020-11-19 12:45:25 -0500250 .por(por_l),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400251 .resetb_core_h(rstb_h),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400252 .clock_core(clock_core),
253 .gpio_out_core(gpio_out_core),
254 .gpio_in_core(gpio_in_core),
255 .gpio_mode0_core(gpio_mode0_core),
256 .gpio_mode1_core(gpio_mode1_core),
257 .gpio_outenb_core(gpio_outenb_core),
258 .gpio_inenb_core(gpio_inenb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400259 .flash_csb_core(flash_csb_core),
260 .flash_clk_core(flash_clk_core),
261 .flash_csb_oeb_core(flash_csb_oeb_core),
262 .flash_clk_oeb_core(flash_clk_oeb_core),
263 .flash_io0_oeb_core(flash_io0_oeb_core),
264 .flash_io1_oeb_core(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400265 .flash_csb_ieb_core(flash_csb_ieb_core),
266 .flash_clk_ieb_core(flash_clk_ieb_core),
267 .flash_io0_ieb_core(flash_io0_ieb_core),
268 .flash_io1_ieb_core(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400269 .flash_io0_do_core(flash_io0_do_core),
270 .flash_io1_do_core(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400271 .flash_io0_di_core(flash_io0_di_core),
272 .flash_io1_di_core(flash_io1_di_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400273 .mprj_io_in(mprj_io_in),
274 .mprj_io_out(mprj_io_out),
Tim Edwards44bab472020-10-04 22:09:54 -0400275 .mprj_io_oeb(mprj_io_oeb),
Manar14d35ac2020-10-21 22:47:15 +0200276 .mprj_io_hldh_n(mprj_io_hldh_n),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400277 .mprj_io_enh(mprj_io_enh),
Manar14d35ac2020-10-21 22:47:15 +0200278 .mprj_io_inp_dis(mprj_io_inp_dis),
279 .mprj_io_ib_mode_sel(mprj_io_ib_mode_sel),
280 .mprj_io_vtrip_sel(mprj_io_vtrip_sel),
281 .mprj_io_slow_sel(mprj_io_slow_sel),
282 .mprj_io_holdover(mprj_io_holdover),
283 .mprj_io_analog_en(mprj_io_analog_en),
284 .mprj_io_analog_sel(mprj_io_analog_sel),
285 .mprj_io_analog_pol(mprj_io_analog_pol),
Tim Edwards581068f2020-11-19 12:45:25 -0500286 .mprj_io_dm(mprj_io_dm),
287 .mprj_analog_io(user_analog_io)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400288 );
289
290 // SoC core
Tim Edwards04ba17f2020-10-02 22:27:50 -0400291 wire caravel_clk;
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400292 wire caravel_clk2;
Tim Edwards04ba17f2020-10-02 22:27:50 -0400293 wire caravel_rstn;
Tim Edwardsef8312e2020-09-22 17:20:06 -0400294
295 wire [7:0] spi_ro_config_core;
296
297 // LA signals
Tim Edwards43e5c602020-11-19 15:59:50 -0500298 wire [127:0] la_data_in_user; // From CPU to MPRJ
299 wire [127:0] la_data_in_mprj; // From MPRJ to CPU
Tim Edwardsef8312e2020-09-22 17:20:06 -0400300 wire [127:0] la_data_out_mprj; // From CPU to MPRJ
Tim Edwards43e5c602020-11-19 15:59:50 -0500301 wire [127:0] la_data_out_user; // From MPRJ to CPU
302 wire [127:0] la_oen_user; // From CPU to MPRJ
303 wire [127:0] la_oen_mprj; // From CPU to MPRJ
304
Tim Edwards6d9739d2020-10-19 11:00:49 -0400305 // WB MI A (User Project)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400306 wire mprj_cyc_o_core;
307 wire mprj_stb_o_core;
308 wire mprj_we_o_core;
309 wire [3:0] mprj_sel_o_core;
310 wire [31:0] mprj_adr_o_core;
311 wire [31:0] mprj_dat_o_core;
312 wire mprj_ack_i_core;
313 wire [31:0] mprj_dat_i_core;
314
315 // WB MI B (xbar)
316 wire xbar_cyc_o_core;
317 wire xbar_stb_o_core;
318 wire xbar_we_o_core;
319 wire [3:0] xbar_sel_o_core;
320 wire [31:0] xbar_adr_o_core;
321 wire [31:0] xbar_dat_o_core;
322 wire xbar_ack_i_core;
323 wire [31:0] xbar_dat_i_core;
324
Tim Edwards04ba17f2020-10-02 22:27:50 -0400325 // Mask revision
326 wire [31:0] mask_rev;
327
Manar14d35ac2020-10-21 22:47:15 +0200328 wire mprj_clock;
329 wire mprj_clock2;
330 wire mprj_resetn;
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200331 wire mprj_reset;
Manar14d35ac2020-10-21 22:47:15 +0200332 wire mprj_cyc_o_user;
333 wire mprj_stb_o_user;
334 wire mprj_we_o_user;
335 wire [3:0] mprj_sel_o_user;
336 wire [31:0] mprj_adr_o_user;
337 wire [31:0] mprj_dat_o_user;
338 wire mprj_vcc_pwrgood;
339 wire mprj2_vcc_pwrgood;
340 wire mprj_vdd_pwrgood;
341 wire mprj2_vdd_pwrgood;
342
Manar55ec3692020-10-30 16:32:18 +0200343 // Storage area
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200344 // Management R/W interface
345 wire [`RAM_BLOCKS-1:0] mgmt_ena;
Manarffe6cad2020-11-09 19:09:04 +0200346 wire [`RAM_BLOCKS-1:0] mgmt_wen;
347 wire [(`RAM_BLOCKS*4)-1:0] mgmt_wen_mask;
Manar55ec3692020-10-30 16:32:18 +0200348 wire [7:0] mgmt_addr;
349 wire [31:0] mgmt_wdata;
Manarffe6cad2020-11-09 19:09:04 +0200350 wire [(`RAM_BLOCKS*32)-1:0] mgmt_rdata;
Manar55ec3692020-10-30 16:32:18 +0200351 // Management RO interface
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200352 wire mgmt_ena_ro;
Manarffe6cad2020-11-09 19:09:04 +0200353 wire [7:0] mgmt_addr_ro;
354 wire [31:0] mgmt_rdata_ro;
Manar55ec3692020-10-30 16:32:18 +0200355
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200356 mgmt_core soc (
Manar61dce922020-11-10 19:26:28 +0200357 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200358 .vdd1v8(vccd),
Tim Edwards9eda80d2020-10-08 21:36:44 -0400359 .vss(vssa),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400360 `endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400361 // GPIO (1 pin)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400362 .gpio_out_pad(gpio_out_core),
363 .gpio_in_pad(gpio_in_core),
364 .gpio_mode0_pad(gpio_mode0_core),
365 .gpio_mode1_pad(gpio_mode1_core),
366 .gpio_outenb_pad(gpio_outenb_core),
367 .gpio_inenb_pad(gpio_inenb_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400368 // Primary SPI flash controller
Tim Edwardsef8312e2020-09-22 17:20:06 -0400369 .flash_csb(flash_csb_core),
370 .flash_clk(flash_clk_core),
371 .flash_csb_oeb(flash_csb_oeb_core),
372 .flash_clk_oeb(flash_clk_oeb_core),
373 .flash_io0_oeb(flash_io0_oeb_core),
374 .flash_io1_oeb(flash_io1_oeb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400375 .flash_csb_ieb(flash_csb_ieb_core),
376 .flash_clk_ieb(flash_clk_ieb_core),
377 .flash_io0_ieb(flash_io0_ieb_core),
378 .flash_io1_ieb(flash_io1_ieb_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400379 .flash_io0_do(flash_io0_do_core),
380 .flash_io1_do(flash_io1_do_core),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400381 .flash_io0_di(flash_io0_di_core),
382 .flash_io1_di(flash_io1_di_core),
Tim Edwardsf51dd082020-10-05 16:30:24 -0400383 // Master Reset
384 .resetb(rstb_l),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400385 .porb(porb_l),
386 // Clocks and reset
Tim Edwardsef8312e2020-09-22 17:20:06 -0400387 .clock(clock_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400388 .core_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400389 .user_clk(caravel_clk2),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400390 .core_rstn(caravel_rstn),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200391 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500392 .la_input(la_data_in_mprj),
393 .la_output(la_data_out_mprj),
394 .la_oen(la_oen_mprj),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400395 // User Project IO Control
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400396 .mprj_vcc_pwrgood(mprj_vcc_pwrgood),
397 .mprj2_vcc_pwrgood(mprj2_vcc_pwrgood),
398 .mprj_vdd_pwrgood(mprj_vdd_pwrgood),
399 .mprj2_vdd_pwrgood(mprj2_vdd_pwrgood),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400400 .mprj_io_loader_resetn(mprj_io_loader_resetn),
401 .mprj_io_loader_clock(mprj_io_loader_clock),
402 .mprj_io_loader_data(mprj_io_loader_data),
Tim Edwards44bab472020-10-04 22:09:54 -0400403 .mgmt_in_data(mgmt_io_in),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400404 .mgmt_out_data({mgmt_io_in[(`MPRJ_IO_PADS-1):2], mgmt_io_nc2}),
Tim Edwardsba328902020-10-27 15:03:22 -0400405 .pwr_ctrl_out(pwr_ctrl_out),
Tim Edwardsca2f3182020-10-06 10:05:11 -0400406 .sdo_out(sdo_out),
407 .sdo_outenb(sdo_outenb),
408 .jtag_out(jtag_out),
409 .jtag_outenb(jtag_outenb),
Tim Edwards6d9739d2020-10-19 11:00:49 -0400410 // User Project Slave ports (WB MI A)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400411 .mprj_cyc_o(mprj_cyc_o_core),
412 .mprj_stb_o(mprj_stb_o_core),
413 .mprj_we_o(mprj_we_o_core),
414 .mprj_sel_o(mprj_sel_o_core),
415 .mprj_adr_o(mprj_adr_o_core),
416 .mprj_dat_o(mprj_dat_o_core),
417 .mprj_ack_i(mprj_ack_i_core),
418 .mprj_dat_i(mprj_dat_i_core),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400419 // mask data
Manar55ec3692020-10-30 16:32:18 +0200420 .mask_rev(mask_rev),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200421 // MGMT area R/W interface
422 .mgmt_ena(mgmt_ena),
Manar55ec3692020-10-30 16:32:18 +0200423 .mgmt_wen_mask(mgmt_wen_mask),
424 .mgmt_wen(mgmt_wen),
425 .mgmt_addr(mgmt_addr),
426 .mgmt_wdata(mgmt_wdata),
427 .mgmt_rdata(mgmt_rdata),
Manarffe6cad2020-11-09 19:09:04 +0200428 // MGMT area RO interface
429 .mgmt_ena_ro(mgmt_ena_ro),
430 .mgmt_addr_ro(mgmt_addr_ro),
431 .mgmt_rdata_ro(mgmt_rdata_ro)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400432 );
433
Tim Edwards53d92182020-10-11 21:47:40 -0400434 /* Clock and reset to user space are passed through a tristate */
435 /* buffer like the above, but since they are intended to be */
436 /* always active, connect the enable to the logic-1 output from */
437 /* the vccd1 domain. */
438
Tim Edwards53d92182020-10-11 21:47:40 -0400439 mgmt_protect mgmt_buffers (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200440 `ifdef USE_POWER_PINS
Tim Edwards53d92182020-10-11 21:47:40 -0400441 .vccd(vccd),
442 .vssd(vssd),
443 .vccd1(vccd1),
444 .vssd1(vssd1),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400445 .vdda1(vdda1),
446 .vssa1(vssa1),
447 .vdda2(vdda2),
448 .vssa2(vssa2),
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200449 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400450
Tim Edwards53d92182020-10-11 21:47:40 -0400451 .caravel_clk(caravel_clk),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400452 .caravel_clk2(caravel_clk2),
Tim Edwards53d92182020-10-11 21:47:40 -0400453 .caravel_rstn(caravel_rstn),
454 .mprj_cyc_o_core(mprj_cyc_o_core),
455 .mprj_stb_o_core(mprj_stb_o_core),
456 .mprj_we_o_core(mprj_we_o_core),
457 .mprj_sel_o_core(mprj_sel_o_core),
458 .mprj_adr_o_core(mprj_adr_o_core),
459 .mprj_dat_o_core(mprj_dat_o_core),
Tim Edwards43e5c602020-11-19 15:59:50 -0500460 .la_data_out_core(la_data_out_user),
461 .la_data_out_mprj(la_data_out_mprj),
462 .la_data_in_core(la_data_in_user),
463 .la_data_in_mprj(la_data_in_mprj),
464 .la_oen_mprj(la_oen_mprj),
465 .la_oen_core(la_oen_user),
Tim Edwards53d92182020-10-11 21:47:40 -0400466
467 .user_clock(mprj_clock),
Tim Edwards7a8cbb12020-10-12 11:32:11 -0400468 .user_clock2(mprj_clock2),
Tim Edwards53d92182020-10-11 21:47:40 -0400469 .user_resetn(mprj_resetn),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200470 .user_reset(mprj_reset),
Tim Edwards53d92182020-10-11 21:47:40 -0400471 .mprj_cyc_o_user(mprj_cyc_o_user),
472 .mprj_stb_o_user(mprj_stb_o_user),
473 .mprj_we_o_user(mprj_we_o_user),
474 .mprj_sel_o_user(mprj_sel_o_user),
475 .mprj_adr_o_user(mprj_adr_o_user),
476 .mprj_dat_o_user(mprj_dat_o_user),
Tim Edwards05ad4fc2020-10-19 22:12:33 -0400477 .user1_vcc_powergood(mprj_vcc_pwrgood),
478 .user2_vcc_powergood(mprj2_vcc_pwrgood),
479 .user1_vdd_powergood(mprj_vdd_pwrgood),
480 .user2_vdd_powergood(mprj2_vdd_pwrgood)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400481 );
Tim Edwards53d92182020-10-11 21:47:40 -0400482
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200483
Tim Edwardsb86fc842020-10-13 17:11:54 -0400484 /*----------------------------------------------*/
485 /* Wrapper module around the user project */
486 /*----------------------------------------------*/
Tim Edwards05537512020-10-06 14:59:26 -0400487
Ahmed Ghazy22d29d62020-10-28 03:42:02 +0200488 user_project_wrapper mprj (
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200489 `ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400490 .vdda1(vdda1), // User area 1 3.3V power
491 .vdda2(vdda2), // User area 2 3.3V power
492 .vssa1(vssa1), // User area 1 analog ground
493 .vssa2(vssa2), // User area 2 analog ground
494 .vccd1(vccd1), // User area 1 1.8V power
495 .vccd2(vccd2), // User area 2 1.8V power
496 .vssd1(vssd1), // User area 1 digital ground
497 .vssd2(vssd2), // User area 2 digital ground
Ahmed Ghazyfe9c3bb2020-11-26 15:29:48 +0200498 `endif
Tim Edwards21a9aac2020-10-12 22:05:18 -0400499
Tim Edwards53d92182020-10-11 21:47:40 -0400500 .wb_clk_i(mprj_clock),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200501 .wb_rst_i(mprj_reset),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200502 // MGMT SoC Wishbone Slave
Tim Edwards53d92182020-10-11 21:47:40 -0400503 .wbs_cyc_i(mprj_cyc_o_user),
504 .wbs_stb_i(mprj_stb_o_user),
505 .wbs_we_i(mprj_we_o_user),
506 .wbs_sel_i(mprj_sel_o_user),
507 .wbs_adr_i(mprj_adr_o_user),
508 .wbs_dat_i(mprj_dat_o_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400509 .wbs_ack_o(mprj_ack_i_core),
510 .wbs_dat_o(mprj_dat_i_core),
511 // Logic Analyzer
Tim Edwards43e5c602020-11-19 15:59:50 -0500512 .la_data_in(la_data_in_user),
513 .la_data_out(la_data_out_user),
514 .la_oen(la_oen_user),
Tim Edwardsef8312e2020-09-22 17:20:06 -0400515 // IO Pads
Tim Edwards05537512020-10-06 14:59:26 -0400516 .io_in (user_io_in),
Tim Edwardsef2b68d2020-10-11 17:00:44 -0400517 .io_out(user_io_out),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400518 .io_oeb(user_io_oeb),
Tim Edwards581068f2020-11-19 12:45:25 -0500519 .analog_io(user_analog_io),
Tim Edwardsb86fc842020-10-13 17:11:54 -0400520 // Independent clock
521 .user_clock2(mprj_clock2)
Tim Edwardsef8312e2020-09-22 17:20:06 -0400522 );
523
Tim Edwards05537512020-10-06 14:59:26 -0400524 /*--------------------------------------*/
525 /* End user project instantiation */
526 /*--------------------------------------*/
527
Tim Edwards04ba17f2020-10-02 22:27:50 -0400528 wire [`MPRJ_IO_PADS-1:0] gpio_serial_link_shifted;
529
Tim Edwards251e0df2020-10-05 11:02:12 -0400530 assign gpio_serial_link_shifted = {gpio_serial_link[`MPRJ_IO_PADS-2:0], mprj_io_loader_data};
Tim Edwards04ba17f2020-10-02 22:27:50 -0400531
Tim Edwards251e0df2020-10-05 11:02:12 -0400532 // Each control block sits next to an I/O pad in the user area.
533 // It gets input through a serial chain from the previous control
534 // block and passes it to the next control block. Due to the nature
535 // of the shift register, bits are presented in reverse, as the first
536 // bit in ends up as the last bit of the last I/O pad control block.
Tim Edwards44bab472020-10-04 22:09:54 -0400537
Tim Edwards89f09242020-10-05 15:17:34 -0400538 // There are two types of block; the first two are configured to be
539 // full bidirectional under control of the management Soc (JTAG and
540 // SDO). The rest are configured to be default (input).
541
Tim Edwards251e0df2020-10-05 11:02:12 -0400542 gpio_control_block #(
Tim Edwards89f09242020-10-05 15:17:34 -0400543 .DM_INIT(3'b110), // Mode = output, strong up/down
Tim Edwards496a08a2020-10-26 15:44:51 -0400544 .OENB_INIT(1'b1) // Enable output signaling from wire
Tim Edwards89f09242020-10-05 15:17:34 -0400545 ) gpio_control_bidir [1:0] (
Manar61dce922020-11-10 19:26:28 +0200546 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200547 .vccd(vccd),
548 .vssd(vssd),
549 .vccd1(vccd1),
550 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400551 `endif
Tim Edwards44bab472020-10-04 22:09:54 -0400552
Tim Edwards04ba17f2020-10-02 22:27:50 -0400553 // Management Soc-facing signals
554
Tim Edwardsc18c4742020-10-03 11:26:39 -0400555 .resetn(mprj_io_loader_resetn),
556 .serial_clock(mprj_io_loader_clock),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400557
Tim Edwards89f09242020-10-05 15:17:34 -0400558 .mgmt_gpio_in(mgmt_io_in[1:0]),
559 .mgmt_gpio_out({sdo_out, jtag_out}),
560 .mgmt_gpio_oeb({sdo_outenb, jtag_outenb}),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400561
562 // Serial data chain for pad configuration
Tim Edwards89f09242020-10-05 15:17:34 -0400563 .serial_data_in(gpio_serial_link_shifted[1:0]),
564 .serial_data_out(gpio_serial_link[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400565
566 // User-facing signals
Tim Edwards89f09242020-10-05 15:17:34 -0400567 .user_gpio_out(user_io_out[1:0]),
568 .user_gpio_oeb(user_io_oeb[1:0]),
569 .user_gpio_in(user_io_in[1:0]),
Tim Edwards04ba17f2020-10-02 22:27:50 -0400570
571 // Pad-facing signals (Pad GPIOv2)
Tim Edwards89f09242020-10-05 15:17:34 -0400572 .pad_gpio_inenb(mprj_io_inp_dis[1:0]),
573 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[1:0]),
574 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[1:0]),
575 .pad_gpio_slow_sel(mprj_io_slow_sel[1:0]),
576 .pad_gpio_holdover(mprj_io_holdover[1:0]),
577 .pad_gpio_ana_en(mprj_io_analog_en[1:0]),
578 .pad_gpio_ana_sel(mprj_io_analog_sel[1:0]),
579 .pad_gpio_ana_pol(mprj_io_analog_pol[1:0]),
580 .pad_gpio_dm(mprj_io_dm[5:0]),
581 .pad_gpio_outenb(mprj_io_oeb[1:0]),
582 .pad_gpio_out(mprj_io_out[1:0]),
583 .pad_gpio_in(mprj_io_in[1:0])
584 );
585
586 gpio_control_block gpio_control_in [`MPRJ_IO_PADS-1:2] (
Manar61dce922020-11-10 19:26:28 +0200587 `ifdef USE_POWER_PINS
Manar68e03632020-11-09 13:25:13 +0200588 .vccd(vccd),
589 .vssd(vssd),
590 .vccd1(vccd1),
591 .vssd1(vssd1),
Tim Edwards53d92182020-10-11 21:47:40 -0400592 `endif
Tim Edwards89f09242020-10-05 15:17:34 -0400593
594 // Management Soc-facing signals
595
596 .resetn(mprj_io_loader_resetn),
597 .serial_clock(mprj_io_loader_clock),
598
599 .mgmt_gpio_in(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
600 .mgmt_gpio_out(mgmt_io_in[(`MPRJ_IO_PADS-1):2]),
601 .mgmt_gpio_oeb(1'b1),
602
603 // Serial data chain for pad configuration
604 .serial_data_in(gpio_serial_link_shifted[(`MPRJ_IO_PADS-1):2]),
605 .serial_data_out(gpio_serial_link[(`MPRJ_IO_PADS-1):2]),
606
607 // User-facing signals
608 .user_gpio_out(user_io_out[(`MPRJ_IO_PADS-1):2]),
609 .user_gpio_oeb(user_io_oeb[(`MPRJ_IO_PADS-1):2]),
610 .user_gpio_in(user_io_in[(`MPRJ_IO_PADS-1):2]),
611
612 // Pad-facing signals (Pad GPIOv2)
613 .pad_gpio_inenb(mprj_io_inp_dis[(`MPRJ_IO_PADS-1):2]),
614 .pad_gpio_ib_mode_sel(mprj_io_ib_mode_sel[(`MPRJ_IO_PADS-1):2]),
615 .pad_gpio_vtrip_sel(mprj_io_vtrip_sel[(`MPRJ_IO_PADS-1):2]),
616 .pad_gpio_slow_sel(mprj_io_slow_sel[(`MPRJ_IO_PADS-1):2]),
617 .pad_gpio_holdover(mprj_io_holdover[(`MPRJ_IO_PADS-1):2]),
618 .pad_gpio_ana_en(mprj_io_analog_en[(`MPRJ_IO_PADS-1):2]),
619 .pad_gpio_ana_sel(mprj_io_analog_sel[(`MPRJ_IO_PADS-1):2]),
620 .pad_gpio_ana_pol(mprj_io_analog_pol[(`MPRJ_IO_PADS-1):2]),
621 .pad_gpio_dm(mprj_io_dm[(`MPRJ_IO_PADS*3-1):6]),
622 .pad_gpio_outenb(mprj_io_oeb[(`MPRJ_IO_PADS-1):2]),
623 .pad_gpio_out(mprj_io_out[(`MPRJ_IO_PADS-1):2]),
624 .pad_gpio_in(mprj_io_in[(`MPRJ_IO_PADS-1):2])
Tim Edwards04ba17f2020-10-02 22:27:50 -0400625 );
626
Tim Edwards04ba17f2020-10-02 22:27:50 -0400627 user_id_programming #(
628 .USER_PROJECT_ID(USER_PROJECT_ID)
629 ) user_id_value (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200630`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400631 .vdd1v8(vccd),
632 .vss(vssd),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200633`endif
Tim Edwards04ba17f2020-10-02 22:27:50 -0400634 .mask_rev(mask_rev)
635 );
636
Tim Edwardsf51dd082020-10-05 16:30:24 -0400637 // Power-on-reset circuit
638 simple_por por (
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200639`ifdef USE_POWER_PINS
Tim Edwards9eda80d2020-10-08 21:36:44 -0400640 .vdd3v3(vddio),
Tim Edwards581068f2020-11-19 12:45:25 -0500641 .vdd1v8(vccd),
Tim Edwards9eda80d2020-10-08 21:36:44 -0400642 .vss(vssio),
Ahmed Ghazy27200e92020-11-25 22:07:02 +0200643`endif
Tim Edwards581068f2020-11-19 12:45:25 -0500644 .porb_h(porb_h),
645 .porb_l(porb_l),
646 .por_l(por_l)
Tim Edwardsf51dd082020-10-05 16:30:24 -0400647 );
648
649 // XRES (chip input pin reset) reset level converter
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200650 sky130_fd_sc_hvl__lsbufhv2lv_1 rstb_level (
651`ifdef USE_POWER_PINS
Tim Edwards21a9aac2020-10-12 22:05:18 -0400652 .VPWR(vddio),
653 .VPB(vddio),
654 .LVPWR(vccd),
655 .VNB(vssio),
656 .VGND(vssio),
Ahmed Ghazy69663c72020-11-18 20:15:53 +0200657`endif
Tim Edwardsf51dd082020-10-05 16:30:24 -0400658 .A(rstb_h),
659 .X(rstb_l)
660 );
661
Manar55ec3692020-10-30 16:32:18 +0200662 // Storage area
Manarffe6cad2020-11-09 19:09:04 +0200663 storage storage(
Manar55ec3692020-10-30 16:32:18 +0200664 .mgmt_clk(caravel_clk),
665 .mgmt_ena(mgmt_ena),
666 .mgmt_wen(mgmt_wen),
667 .mgmt_wen_mask(mgmt_wen_mask),
668 .mgmt_addr(mgmt_addr),
669 .mgmt_wdata(mgmt_wdata),
670 .mgmt_rdata(mgmt_rdata),
Ahmed Ghazydf4dd882020-11-25 18:38:42 +0200671 // Management RO interface
Manarffe6cad2020-11-09 19:09:04 +0200672 .mgmt_ena_ro(mgmt_ena_ro),
673 .mgmt_addr_ro(mgmt_addr_ro),
674 .mgmt_rdata_ro(mgmt_rdata_ro)
Manar55ec3692020-10-30 16:32:18 +0200675 );
676
Tim Edwardsef8312e2020-09-22 17:20:06 -0400677endmodule
Tim Edwards581068f2020-11-19 12:45:25 -0500678// `default_nettype wire