1 # ================================== Steps to add peripherals ============
2 # Step-1: create interface declaration for the peripheral to be added.
3 # Remember these are interfaces defined for the pinmux and hence
4 # will be opposite to those defined at the peripheral.
5 # For eg. the output TX from the UART will be input (method Action)
7 # These changes will have to be done in interface_decl.py
8 # Step-2 define the wires that will be required to transfer data from the
9 # peripheral interface to the IO cell and vice-versa. Create a
10 # mkDWire for each input/output between the peripheral and the
11 # pinmux. Also create an implicit wire of GenericIOType for each cell
12 # that can be connected to a each bit from the peripheral.
13 # These changes will have to be done in wire_def.py
14 # Step-3: create the definitions for each of the methods defined above.
15 # These changes will have to be done in interface_decl.py
16 # ========================================================================
18 # default module imports
24 # project module imports
25 from bsv
.interface_decl
import Interfaces
, mux_interface
, io_interface
26 from parse
import Parse
27 from bsv
.actual_pinmux
import init
28 from bsv
.bus_transactors
import axi4_lite
32 This BSV file has been generated by the PinMux tool available at:
33 https://bitbucket.org/casl/pinmux.
35 Authors: Neel Gala, Luke
36 Date of generation: ''' + time
.strftime("%c") + '''
39 header
= copyright
+ '''
49 def pinmuxgen(pth
=None, verify
=True):
50 """ populating the file with the code
53 p
= Parse(pth
, verify
)
54 iocells
= Interfaces()
55 iocells
.ifaceadd('io', p
.N_IO
, io_interface
, 0)
56 ifaces
= Interfaces(pth
)
57 #ifaces.ifaceadd('io', p.N_IO, io_interface, 0)
62 bp
= os
.path
.join(pth
, bp
)
63 if not os
.path
.exists(bp
):
65 bl
= os
.path
.join(bp
, 'bsv_lib')
66 if not os
.path
.exists(bl
):
69 cwd
= os
.path
.split(__file__
)[0]
71 # copy over template and library files
72 shutil
.copyfile(os
.path
.join(cwd
, 'Makefile.template'),
73 os
.path
.join(bp
, 'Makefile'))
74 cwd
= os
.path
.join(cwd
, 'bsv_lib')
75 for fname
in ['AXI4_Lite_Types.bsv', 'Semi_FIFOF.bsv',
76 'gpio.bsv', 'mux.bsv',
77 'AXI4_Types.bsv', 'defined_types.bsv',
78 'AXI4_Fabric.bsv', 'Uart16550.bsv',
79 'AXI4_Lite_Fabric.bsv', 'ConcatReg.bsv',
80 'Uart_bs.bsv', 'RS232_modified.bsv',
81 'AXI4Lite_AXI4_Bridge.bsv',
82 'I2C_top.bsv', 'I2C_Defs.bsv',
83 'plic.bsv', 'Cur_Cycle.bsv',
84 'ClockDiv.bsv', 'axi_addr_generator.bsv',
85 'jtagdtm_new.bsv', 'jtagdefines.bsv',
87 'pwm.bsv', 'qspi.bsv', 'qspi.defs',
89 shutil
.copyfile(os
.path
.join(cwd
, fname
),
90 os
.path
.join(bl
, fname
))
92 bus
= os
.path
.join(bp
, 'busenable.bsv')
93 pmp
= os
.path
.join(bp
, 'pinmux.bsv')
94 ptp
= os
.path
.join(bp
, 'PinTop.bsv')
95 bvp
= os
.path
.join(bp
, 'bus.bsv')
96 idef
= os
.path
.join(bp
, 'instance_defines.bsv')
97 slow
= os
.path
.join(bp
, 'slow_peripherals.bsv')
98 slowt
= os
.path
.join(cwd
, 'slow_peripherals_template.bsv')
100 write_pmp(pmp
, p
, ifaces
, iocells
)
101 write_ptp(ptp
, p
, ifaces
)
102 write_bvp(bvp
, p
, ifaces
)
103 write_bus(bus
, p
, ifaces
)
104 write_instances(idef
, p
, ifaces
)
105 write_slow(slow
, slowt
, p
, ifaces
, iocells
)
108 def write_slow(slow
, template
, p
, ifaces
, iocells
):
109 """ write out the slow_peripherals.bsv file.
110 joins all the peripherals together into one AXI Lite interface
112 with
open(template
) as bsv_file
:
113 template
= bsv_file
.read()
114 imports
= ifaces
.slowimport()
115 ifdecl
= ifaces
.slowifdeclmux()
116 regdef
= ifaces
.axi_reg_def()
117 slavedecl
= ifaces
.axi_slave_idx()
118 fnaddrmap
= ifaces
.axi_addr_map()
119 mkslow
= ifaces
.mkslow_peripheral()
120 mkcon
= ifaces
.mk_connection()
121 mkcellcon
= ifaces
.mk_cellconn()
122 pincon
= ifaces
.mk_pincon()
123 inst
= ifaces
.slowifinstance()
124 mkplic
= ifaces
.mk_plic()
125 with
open(slow
, "w") as bsv_file
:
126 bsv_file
.write(template
.format(imports
, ifdecl
, regdef
, slavedecl
,
127 fnaddrmap
, mkslow
, mkcon
, mkcellcon
,
128 pincon
, inst
, mkplic
))
131 def write_bus(bus
, p
, ifaces
):
132 # package and interface declaration followed by
133 # the generic io_cell definition
134 with
open(bus
, "w") as bsv_file
:
135 ifaces
.busfmt(bsv_file
)
138 def write_pmp(pmp
, p
, ifaces
, iocells
):
139 # package and interface declaration followed by
140 # the generic io_cell definition
141 with
open(pmp
, "w") as bsv_file
:
142 bsv_file
.write(header
)
144 cell_bit_width
= 'Bit#(%d)' % p
.cell_bitwidth
146 interface MuxSelectionLines;
148 // declare the method which will capture the user pin-mux
149 // selection values.The width of the input is dependent on the number
150 // of muxes happening per IO. For now we have a generalized width
151 // where each IO will have the same number of muxes.''')
153 for cell
in p
.muxed_cells
:
154 bsv_file
.write(mux_interface
.ifacefmt(cell
[0], cell_bit_width
))
156 bsv_file
.write("\n endinterface\n")
160 interface IOCellSide;
161 // declare the interface to the IO cells.
162 // Each IO cell will have 1 input field (output from pin mux)
163 // and an output and out-enable field (input to pinmux)''')
165 # == create method definitions for all iocell interfaces ==#
166 iocells
.ifacefmt(bsv_file
)
168 # ===== finish interface definition and start module definition=======
169 bsv_file
.write("\n endinterface\n")
171 # ===== io cell definition =======
174 interface PeripheralSide;
175 // declare the interface to the peripherals
176 // Each peripheral's function will be either an input, output
177 // or be bi-directional. an input field will be an output from the
178 // peripheral and an output field will be an input to the peripheral.
179 // Bi-directional functions also have an output-enable (which
180 // again comes *in* from the peripheral)''')
181 # ==============================================================
183 # == create method definitions for all peripheral interfaces ==#
184 ifaces
.ifacefmt(bsv_file
)
185 bsv_file
.write("\n endinterface\n")
187 # ===== finish interface definition and start module definition=======
190 interface Ifc_pinmux;
191 // this interface controls how each IO cell is routed. setting
192 // any given IO cell's mux control value will result in redirection
193 // of not just the input or output to different peripheral functions
194 // but also the *direction* control - if appropriate - as well.
195 interface MuxSelectionLines mux_lines;
197 // this interface contains the inputs, outputs and direction-control
198 // lines for all peripherals. GPIO is considered to also be just
199 // a peripheral because it also has in, out and direction-control.
200 interface PeripheralSide peripheral_side;
202 // this interface is to be linked to the individual IO cells.
203 // if looking at a "non-muxed" GPIO design, basically the
204 // IO cell input, output and direction-control wires are cut
205 // (giving six pairs of dangling wires, named left and right)
206 // these iocells are routed in their place on one side ("left")
207 // and the matching *GPIO* peripheral interfaces in/out/dir
208 // connect to the OTHER side ("right"). the result is that
209 // the muxer settings end up controlling the routing of where
210 // the I/O from the IOcell actually goes.
211 interface IOCellSide iocell_side;
214 module mkpinmux(Ifc_pinmux);
216 # ====================================================================
218 # ======================= create wire and registers =================#
220 // the followins wires capture the pin-mux selection
221 // values for each mux assigned to a CELL
223 for cell
in p
.muxed_cells
:
224 bsv_file
.write(mux_interface
.wirefmt(
225 cell
[0], cell_bit_width
))
227 iocells
.wirefmt(bsv_file
)
228 ifaces
.wirefmt(bsv_file
)
231 # ====================================================================
232 # ========================= Actual pinmuxing ========================#
234 /*====== This where the muxing starts for each io-cell======*/
235 Wire#(Bit#(1)) val0<-mkDWire(0); // need a zero
237 bsv_file
.write(p
.pinmux
)
239 /*============================================================*/
241 # ====================================================================
242 # ================= interface definitions for each method =============#
244 interface mux_lines = interface MuxSelectionLines
246 for cell
in p
.muxed_cells
:
248 mux_interface
.ifacedef(
249 cell
[0], cell_bit_width
))
250 bsv_file
.write("\n endinterface;")
253 interface iocell_side = interface IOCellSide
255 iocells
.ifacedef(bsv_file
)
256 bsv_file
.write("\n endinterface;")
259 interface peripheral_side = interface PeripheralSide
261 ifaces
.ifacedef(bsv_file
)
262 bsv_file
.write("\n endinterface;")
264 bsv_file
.write(footer
)
265 print("BSV file successfully generated: bsv_src/pinmux.bsv")
266 # ======================================================================
269 def write_ptp(ptp
, p
, ifaces
):
270 with
open(ptp
, 'w') as bsv_file
:
271 bsv_file
.write(copyright
+ '''
274 interface Ifc_PintTop;
275 method ActionValue#(Bool) write(Bit#({0}) addr, Bit#({1}) data);
276 method Tuple2#(Bool,Bit#({1})) read(Bit#({0}) addr);
277 interface PeripheralSide peripheral_side;
280 module mkPinTop(Ifc_PintTop);
281 // instantiate the pin-mux module here
282 Ifc_pinmux pinmux <-mkpinmux;
284 // declare the registers which will be used to mux the IOs
285 '''.format(p
.ADDR_WIDTH
, p
.DATA_WIDTH
))
287 cell_bit_width
= str(p
.cell_bitwidth
)
288 for cell
in p
.muxed_cells
:
290 Reg#(Bit#({0})) rg_muxio_{1} <-mkReg(0);'''.format(
291 cell_bit_width
, cell
[0]))
294 // rule to connect the registers to the selection lines of the
296 rule connect_selection_registers;''')
298 for cell
in p
.muxed_cells
:
300 pinmux.mux_lines.cell{0}_mux(rg_muxio_{0});'''.format(cell
[0]))
304 // method definitions for the write user interface
305 method ActionValue#(Bool) write(Bit#({2}) addr, Bit#({3}) data);
307 case (addr[{0}:{1}])'''.format(p
.upper_offset
, p
.lower_offset
,
308 p
.ADDR_WIDTH
, p
.DATA_WIDTH
))
310 for cell
in p
.muxed_cells
:
312 {0}: rg_muxio_{1}<=truncate(data);'''.format(index
, cell
[0]))
322 // method definitions for the read user interface
323 method Tuple2#(Bool,Bit#({3})) read(Bit#({2}) addr);
326 case (addr[{0}:{1}])'''.format(p
.upper_offset
, p
.lower_offset
,
327 p
.ADDR_WIDTH
, p
.DATA_WIDTH
))
329 for cell
in p
.muxed_cells
:
331 {0}: data=zeroExtend(rg_muxio_{1});'''.format(index
, cell
[0]))
337 return tuple2(err,data);
339 interface peripheral_side=pinmux.peripheral_side;
345 def write_bvp(bvp
, p
, ifaces
):
346 # ######## Generate bus transactors ################
347 gpiocfg
= '\t\tinterface GPIO_config#({4}) bank{3}_config;\n' \
348 '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) bank{3}_slave;'
349 muxcfg
= '\t\tinterface MUX_config#({4}) muxb{3}_config;\n' \
350 '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) muxb{3}_slave;'
352 gpiodec
= '\tGPIO#({0}) mygpio{1} <- mkgpio();'
353 muxdec
= '\tMUX#({0}) mymux{1} <- mkmux();'
354 gpioifc
= '\tinterface bank{0}_config=mygpio{0}.pad_config;\n' \
355 '\tinterface bank{0}_slave=mygpio{0}.axi_slave;'
356 muxifc
= '\tinterface muxb{0}_config=mymux{0}.mux_config;\n' \
357 '\tinterface muxb{0}_slave=mymux{0}.axi_slave;'
358 with
open(bvp
, 'w') as bsv_file
:
359 # assume here that all muxes have a 1:1 gpio
363 iks
= sorted(ifaces
.keys())
365 if not iname
.startswith('gpio'): # TODO: declare other interfaces
369 npins
= len(ifc
.pinspecs
)
370 cfg
.append(gpiocfg
.format(p
.ADDR_WIDTH
, p
.DATA_WIDTH
,
373 cfg
.append(muxcfg
.format(p
.ADDR_WIDTH
, p
.DATA_WIDTH
,
376 decl
.append(gpiodec
.format(npins
, bank
))
377 decl
.append(muxdec
.format(npins
, bank
))
378 idec
.append(gpioifc
.format(bank
))
379 idec
.append(muxifc
.format(bank
))
382 print dir(ifaces
['gpioa'])
383 print ifaces
['gpioa'].pinspecs
384 gpiodecl
= '\n'.join(decl
) + '\n' + '\n'.join(idec
)
385 gpiocfg
= '\n'.join(cfg
)
386 bsv_file
.write(axi4_lite
.format(gpiodecl
, gpiocfg
))
387 # ##################################################
390 def write_instances(idef
, p
, ifaces
):
391 with
open(idef
, 'w') as bsv_file
:
396 `define Reg_width {1}
399 // TODO: work out if these are needed
403 `define DCACHE_BLOCK_SIZE 4
404 `define DCACHE_WORD_SIZE 8
405 `define PERFMONITORS 64
406 `define DCACHE_WAYS 4
407 `define DCACHE_TAG_BITS 20 // tag_bits = 52
409 `define PLICBase 'h0c000000
410 `define PLICEnd 'h10000000
411 `define INTERRUPT_PINS 64
413 `define BAUD_RATE 130
415 `define BAUD_RATE 5 //130 //
418 bsv_file
.write(txt
.format(p
.ADDR_WIDTH
, p
.DATA_WIDTH
))