1 package slow_peripherals;
2 /*===== Project imports =====*/
3 import defined_types::*;
4 import AXI4_Lite_Fabric::*;
5 import AXI4_Lite_Types::*;
9 import AXI4Lite_AXI4_Bridge::*;
10 `include "instance_defines.bsv"
11 /*===========================*/
12 /*=== package imports ===*/
15 import ClientServer::*;
16 import Connectable::*;
19 /*=======================*/
20 /*===== Import the slow peripherals ====*/
22 import Uart16550 :: *;
26 import RS232_modified::*;
41 import axiexpansion ::*;
50 /*=====================================*/
52 /*===== interface declaration =====*/
55 interface RS232_PHY_Ifc uart0_coe;
58 interface RS232 uart1_coe;
61 (*always_ready,always_enabled*)
62 method Action gpio_in (Vector#(`IONum,Bit#(1)) inp);
63 (*always_ready,always_enabled*)
64 method Vector#(`IONum,Bit#(1)) gpio_out;
65 (*always_ready,always_enabled*)
66 method Vector#(`IONum,Bit#(1)) gpio_out_en;
69 interface I2C_out i2c0_out;
72 interface I2C_out i2c1_out;
75 interface QSPI_out qspi0_out;
78 interface QSPI_out qspi1_out;
81 interface Get#(Bit#(67)) axiexp1_out;
82 interface Put#(Bit#(67)) axiexp1_in;
85 interface PWMIO pwm_o;
88 interface Ifc_slow_peripherals;
89 interface AXI4_Slave_IFC#(`PADDR,`Reg_width,`USERSPACE) axi_slave;
90 interface SP_ios slow_ios;
92 method Bit#(1) msip_int;
93 method Bit#(1) mtip_int;
94 method Bit#(`Reg_width) mtime;
96 `ifdef PLIC method ActionValue#(Tuple2#(Bool,Bool)) intrpt_note; `endif
97 `ifdef I2C0 method Bit#(1) i2c0_isint; `endif
98 `ifdef I2C1 method Bit#(1) i2c1_isint; `endif
99 `ifdef QSPI0 method Bit#(1) qspi0_isint; `endif
100 `ifdef QSPI1 method Bit#(1) qspi1_isint; `endif
101 `ifdef UART0 method Bit#(1) uart0_intr; `endif
103 interface IOCellSide iocell_side; // mandatory interface
104 interface GPIO_config#(3) pad_configa; // depends on the number of banks
107 /*================================*/
109 function Tuple2#(Bool, Bit#(TLog#(Num_Slow_Slaves))) fn_address_mapping (Bit#(`PADDR) addr);
111 if(addr>=`UART0Base && addr<=`UART0End)
112 return tuple2(True,fromInteger(valueOf(Uart0_slave_num)));
116 if(addr>=`UART1Base && addr<=`UART1End)
117 return tuple2(True,fromInteger(valueOf(Uart1_slave_num)));
121 if(addr>=`ClintBase && addr<=`ClintEnd)
122 return tuple2(True,fromInteger(valueOf(CLINT_slave_num)));
126 if(addr>=`PLICBase && addr<=`PLICEnd)
127 return tuple2(True,fromInteger(valueOf(Plic_slave_num)));
128 else if(addr>=`GPIOBase && addr<=`GPIOEnd)
129 return tuple2(True,fromInteger(valueOf(GPIO_slave_num)));
133 if(addr>=`I2C0Base && addr<=`I2C0End)
134 return tuple2(True,fromInteger(valueOf(I2c0_slave_num)));
138 if(addr>=`I2C1Base && addr<=`I2C1End)
139 return tuple2(True,fromInteger(valueOf(I2c1_slave_num)));
143 if(addr>=`QSPI0CfgBase && addr<=`QSPI0CfgEnd)
144 return tuple2(True,fromInteger(valueOf(Qspi0_slave_num)));
145 else if(addr>=`QSPI0MemBase && addr<=`QSPI0MemEnd)
146 return tuple2(True,fromInteger(valueOf(Qspi0_slave_num)));
150 if(addr>=`QSPI1CfgBase && addr<=`QSPI1CfgEnd)
151 return tuple2(True,fromInteger(valueOf(Qspi1_slave_num)));
152 else if(addr>=`QSPI1MemBase && addr<=`QSPI1MemEnd)
153 return tuple2(True,fromInteger(valueOf(Qspi1_slave_num)));
157 if(addr>=`AxiExp1Base && addr<=`AxiExp1End)
158 return tuple2(True,fromInteger(valueOf(AxiExp1_slave_num)));
162 if(addr>=`PWMBase && addr<=`PWMEnd)
163 return tuple2(True,fromInteger(valueOf(Pwm_slave_num)));
168 // give slave number and adress map to whatever peripherals you instantiate on the AXI4_Lite
171 return tuple2(False,?);
175 module mkslow_peripherals#(Clock fast_clock, Reset fast_reset, Clock uart_clock, Reset uart_reset
176 `ifdef PWM_AXI4Lite ,Clock ext_pwm_clock `endif )(Ifc_slow_peripherals);
177 Clock sp_clock <-exposeCurrentClock; // slow peripheral clock
178 Reset sp_reset <-exposeCurrentReset; // slow peripheral reset
180 /*======= Module declarations for each peripheral =======*/
182 Uart16550_AXI4_Lite_Ifc uart0 <- mkUart16550(clocked_by uart_clock, reset_by uart_reset, sp_clock, sp_reset);
185 //Ifc_Uart_bs uart1 <- mkUart_bs(clocked_by uart_clock, reset_by uart_reset,sp_clock, sp_reset);
186 Ifc_Uart_bs uart1 <- mkUart_bs(clocked_by sp_clock, reset_by sp_reset,sp_clock, sp_reset);
189 Ifc_clint clint <- mkclint();
192 Ifc_PLIC_AXI plic <- mkplicperipheral();
193 Wire#(Bit#(TLog#(`INTERRUPT_PINS))) interrupt_id <- mkWire();
194 Vector#(`INTERRUPT_PINS, FIFO#(bit)) ff_gateway_queue <- replicateM(mkFIFO);
198 I2C_IFC i2c0 <- mkI2CController();
201 I2C_IFC i2c1 <- mkI2CController();
204 Ifc_qspi qspi0 <- mkqspi();
207 Ifc_qspi qspi1 <- mkqspi();
210 Ifc_AxiExpansion axiexp1 <- mkAxiExpansion();
213 Ifc_PWM_bus pwm_bus <- mkPWM_bus(ext_pwm_clock);
216 Ifc_pinmux pinmux <- mkpinmux; // mandatory
217 MUX#(3) muxa <- mkmux(); // mandatory. number depends on the number of instances required.
218 GPIO#(3) gpioa <- mkgpio(); // optional. depends the number of IO pins declared before.
220 /*=======================================================*/
222 AXI4_Lite_Fabric_IFC #(1, Num_Slow_Slaves, `PADDR, `Reg_width,`USERSPACE) slow_fabric <-
223 mkAXI4_Lite_Fabric(fn_address_mapping);
224 Ifc_AXI4Lite_AXI4_Bridge bridge <-mkAXI4Lite_AXI4_Bridge(fast_clock,fast_reset);
226 mkConnection (bridge.axi4_lite_master, slow_fabric.v_from_masters [0]);
227 /*======= Slave connections to AXI4Lite fabric =========*/
229 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Uart0_slave_num))],
230 uart0.slave_axi_uart);
233 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Uart1_slave_num))],
234 uart1.slave_axi_uart);
237 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(CLINT_slave_num))],
241 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Plic_slave_num))],
242 plic.axi4_slave_plic); //
243 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(GPIO_slave_num))],
247 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(I2c0_slave_num))],
251 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(I2c1_slave_num))],
252 i2c1.slave_i2c_axi); //
255 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Qspi0_slave_num))],
259 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Qspi1_slave_num))],
263 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(AxiExp1_slave_num))],
264 axiexp1.axi_slave); //
267 mkConnection (slow_fabric.v_to_slaves [fromInteger(valueOf(Pwm_slave_num))],
272 mkConnection (slow_fabric.
273 v_to_slaves[fromInteger(valueOf(Muxa_slave_num))],
275 mkConnection (slow_fabric.
276 v_to_slaves[fromInteger(valueOf(Gpioa_slave_num))],
278 rule connect_select_lines_pinmux;// mandatory
279 pinmux.mux_lines.cell0_mux(muxa.mux_config.mux[0]);
280 pinmux.mux_lines.cell1_mux(muxa.mux_config.mux[1]);
281 pinmux.mux_lines.cell2_mux(muxa.mux_config.mux[2]);
283 rule connect_i2c0_scl;
284 pinmux.peripheral_side.twi_scl_out(i2c0.out.scl_out);
285 pinmux.peripheral_side.twi_scl_outen(pack(i2c0.out.scl_out_en));
287 rule connect_i2c0_scl_in;
288 i2c0.out.scl_in(pinmux.peripheral_side.twi_scl_in);
290 rule connect_i2c0_sda;
291 pinmux.peripheral_side.twi_sda_out(i2c0.out.sda_out);
292 pinmux.peripheral_side.twi_sda_outen(pack(i2c0.out.sda_out_en));
294 rule connect_i2c0_sda_in;
295 i2c0.out.sda_in(pinmux.peripheral_side.twi_sda_in);
297 rule connect_uart1tx;
298 pinmux.peripheral_side.uart_tx(uart1.coe_rs232.sout);
300 rule connect_uart1rx;
301 uart1.coe_rs232.sin(pinmux.peripheral_side.uart_rx);
304 pinmux.peripheral_side.gpioa_a0_out(gpioa.func.gpio_out[0]);
305 pinmux.peripheral_side.gpioa_a0_outen(gpioa.func.gpio_out_en[0]);
306 pinmux.peripheral_side.gpioa_a1_out(gpioa.func.gpio_out[1]);
307 pinmux.peripheral_side.gpioa_a1_outen(gpioa.func.gpio_out_en[1]);
308 pinmux.peripheral_side.gpioa_a2_out(gpioa.func.gpio_out[2]);
309 pinmux.peripheral_side.gpioa_a2_outen(gpioa.func.gpio_out_en[2]);
310 Vector#(3,Bit#(1)) temp;
311 temp[0]=pinmux.peripheral_side.gpioa_a0_in;
312 temp[1]=pinmux.peripheral_side.gpioa_a1_in;
313 temp[2]=pinmux.peripheral_side.gpioa_a2_in;
314 gpioa.func.gpio_in(temp);
317 /*=======================================================*/
318 /*=================== PLIC Connections ==================== */
320 /*TODO DMA interrupt need to be connected to the plic
321 for(Integer i=1; i<8; i=i+1) begin
323 rule rl_connect_dma_interrupts_to_plic;
324 if(dma.interrupt_to_processor[i-1]==1'b1) begin
325 ff_gateway_queue[i].enq(1);
326 plic.ifc_external_irq[i].irq_frm_gateway(True);
330 rule rl_connect_dma_interrupts_to_plic;
331 ff_gateway_queue[i].enq(0);
336 rule rl_connect_i2c0_to_plic;
338 if(i2c0.isint()==1'b1) begin
339 ff_gateway_queue[8].enq(1);
340 plic.ifc_external_irq[8].irq_frm_gateway(True);
343 ff_gateway_queue[8].enq(0);
347 rule rl_connect_i2c1_to_plic;
349 if(i2c1.isint()==1'b1) begin
350 ff_gateway_queue[9].enq(1);
351 plic.ifc_external_irq[9].irq_frm_gateway(True);
354 ff_gateway_queue[9].enq(0);
358 rule rl_connect_i2c0_timerint_to_plic;
360 if(i2c0.timerint()==1'b1) begin
361 ff_gateway_queue[10].enq(1);
362 plic.ifc_external_irq[10].irq_frm_gateway(True);
365 ff_gateway_queue[10].enq(0);
369 rule rl_connect_i2c1_timerint_to_plic;
371 if(i2c1.timerint()==1'b1) begin
372 ff_gateway_queue[11].enq(1);
373 plic.ifc_external_irq[11].irq_frm_gateway(True);
376 ff_gateway_queue[11].enq(0);
380 rule rl_connect_i2c0_isber_to_plic;
382 if(i2c0.isber()==1'b1) begin
383 ff_gateway_queue[12].enq(1);
384 plic.ifc_external_irq[12].irq_frm_gateway(True);
387 ff_gateway_queue[12].enq(0);
391 rule rl_connect_i2c1_isber_to_plic;
393 if(i2c1.isber()==1'b1) begin
394 ff_gateway_queue[13].enq(1);
395 plic.ifc_external_irq[13].irq_frm_gateway(True);
398 ff_gateway_queue[13].enq(0);
402 for(Integer i = 14; i < 20; i=i+1) begin
403 rule rl_connect_qspi0_to_plic;
405 if(qspi0.interrupts()[i-14]==1'b1) begin
406 ff_gateway_queue[i].enq(1);
407 plic.ifc_external_irq[i].irq_frm_gateway(True);
410 ff_gateway_queue[i].enq(0);
415 for(Integer i = 20; i<26; i=i+1) begin
416 rule rl_connect_qspi1_to_plic;
418 if(qspi1.interrupts()[i-20]==1'b1) begin
419 ff_gateway_queue[i].enq(1);
420 plic.ifc_external_irq[i].irq_frm_gateway(True);
423 ff_gateway_queue[i].enq(0);
429 SyncBitIfc#(Bit#(1)) uart0_interrupt <-mkSyncBitToCC(uart_clock,uart_reset);
430 rule synchronize_the_uart0_interrupt;
431 uart0_interrupt.send(uart0.irq);
434 rule rl_connect_uart_to_plic;
436 if(uart0_interrupt.read==1'b1) begin
437 ff_gateway_queue[27].enq(1);
438 plic.ifc_external_irq[27].irq_frm_gateway(True);
442 ff_gateway_queue[27].enq(0);
446 for(Integer i = 28; i<`INTERRUPT_PINS; i=i+1) begin
447 rule rl_raise_interrupts;
448 if((i-28)<`IONum) begin //Peripheral interrupts
449 if(gpio.to_plic[i-28]==1'b1) begin
450 plic.ifc_external_irq[i].irq_frm_gateway(True);
451 ff_gateway_queue[i].enq(1);
457 rule rl_completion_msg_from_plic;
458 let id <- plic.intrpt_completion;
460 `ifdef verbose $display("Dequeing the FIFO -- PLIC Interrupt Serviced id: %d",id); `endif
463 for(Integer i=0; i <`INTERRUPT_PINS; i=i+1) begin
464 rule deq_gateway_queue;
465 if(interrupt_id==fromInteger(i)) begin
466 ff_gateway_queue[i].deq;
467 `ifdef $display($time,"Dequeing the Interrupt request for ID: %d",i); `endif
474 /*======================================================= */
476 /* ===== interface definition =======*/
477 interface axi_slave=bridge.axi_slave;
478 `ifdef PLIC method intrpt_note = plic.intrpt_note; `endif
480 method msip_int=clint.msip_int;
481 method mtip_int=clint.mtip_int;
482 method mtime=clint.mtime;
485 method i2c0_isint=i2c0.isint;
488 method i2c1_isint=i2c1.isint;
490 `ifdef QSPI0 method qspi0_isint=qspi0.interrupts[5]; `endif
491 `ifdef QSPI1 method qspi1_isint=qspi1.interrupts[5]; `endif
492 `ifdef UART0 method uart0_intr=uart0.irq; `endif
493 interface SP_ios slow_ios;
495 interface uart0_coe=uart0.coe_rs232;
498 interface uart1_coe=uart1.coe_rs232;
501 method Action gpio_in (Vector#(`IONum,Bit#(1)) inp)=gpio.gpio_in(inp);
502 method Vector#(`IONum,Bit#(1)) gpio_out=gpio.gpio_out;
503 method Vector#(`IONum,Bit#(1)) gpio_out_en=gpio.gpio_out_en;
506 interface i2c0_out=i2c0.out;
509 interface i2c1_out=i2c1.out;
512 interface qspi0_out = qspi0.out;
515 interface qspi1_out = qspi1.out;
518 interface axiexp1_out=axiexp1.slave_out;
519 interface axiexp1_in=axiexp1.slave_in;
522 interface pwm_o = pwm_bus.pwm_io;
526 interface iocell_side=pinmux.iocell_side;
527 interface pad_configa= gpioa.pad_config;
529 /*===================================*/