src/bsv/pinmux_generator.py

   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)
   6 #           for the pinmux.
   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 # ========================================================================
  17
  18 # default module imports
  19 import shutil
  20 import os
  21 import os.path
  22 import time
  23
  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
  29
  30 copyright = '''
  31 /*
  32    This BSV file has been generated by the PinMux tool available at:
  33    https://bitbucket.org/casl/pinmux.
  34
  35    Authors: Neel Gala, Luke
  36    Date of generation: ''' + time.strftime("%c") + '''
  37 */
  38 '''
  39 header = copyright + '''
  40 package pinmux;
  41
  42 import GetPut::*;
  43 import Vector::*;
  44
  45 '''
  46 footer = '''
  47    endmodule
  48 endpackage
  49 '''
  50
  51
  52 def pinmuxgen(pth=None, verify=True):
  53     """ populating the file with the code
  54     """
  55
  56     p = Parse(pth, verify)
  57     iocells = Interfaces()
  58     iocells.ifaceadd('io', p.N_IO, io_interface, 0)
  59     ifaces = Interfaces(pth)
  60     #ifaces.ifaceadd('io', p.N_IO, io_interface, 0)
  61     init(p, ifaces)
  62
  63     bp = 'bsv_src'
  64     if pth:
  65         bp = os.path.join(pth, bp)
  66     if not os.path.exists(bp):
  67         os.makedirs(bp)
  68     bl = os.path.join(bp, 'bsv_lib')
  69     if not os.path.exists(bl):
  70         os.makedirs(bl)
  71
  72     cwd = os.path.split(__file__)[0]
  73
  74     # copy over template and library files
  75     shutil.copyfile(os.path.join(cwd, 'Makefile.template'),
  76                     os.path.join(bp, 'Makefile'))
  77     cwd = os.path.join(cwd, 'bsv_lib')
  78     for fname in []:
  79         shutil.copyfile(os.path.join(cwd, fname),
  80                         os.path.join(bl, fname))
  81
  82     bus = os.path.join(bp, 'busenable.bsv')
  83     pmp = os.path.join(bp, 'pinmux.bsv')
  84     bvp = os.path.join(bp, 'bus.bsv')
  85     idef = os.path.join(bp, 'instance_defines.bsv')
  86     slow = os.path.join(bp, 'slow_peripherals.bsv')
  87     slowt = os.path.join(cwd, 'slow_peripherals_template.bsv')
  88     slowmf = os.path.join(bp, 'slow_memory_map.bsv')
  89     slowmt = os.path.join(cwd, 'slow_tuple2_template.bsv')
  90     fastmf = os.path.join(bp, 'fast_memory_map.bsv')
  91     fastmt = os.path.join(cwd, 'fast_tuple2_template.bsv')
  92     soc = os.path.join(bp, 'socgen.bsv')
  93     soct = os.path.join(cwd, 'soc_template.bsv')
  94
  95     write_pmp(pmp, p, ifaces, iocells)
  96     write_bvp(bvp, p, ifaces)
  97     write_bus(bus, p, ifaces)
  98     write_instances(idef, p, ifaces)
  99     write_slow(slow, slowt, slowmf, slowmt, p, ifaces, iocells)
 100     write_soc(soc, soct, fastmf, fastmt, p, ifaces, iocells)
 101
 102
 103 def write_slow(slow, slowt, slowmf, slowmt, p, ifaces, iocells):
 104     """ write out the slow_peripherals.bsv file.
 105         joins all the peripherals together into one AXI Lite interface
 106     """
 107     imports = ifaces.slowimport()
 108     ifdecl = ifaces.slowifdeclmux() + '\n' + ifaces.extifdecl()
 109     regdef = ifaces.axi_reg_def()
 110     slavedecl = ifaces.axi_slave_idx()
 111     fnaddrmap = ifaces.axi_addr_map()
 112     mkslow = ifaces.mkslow_peripheral()
 113     mkcon = ifaces.mk_connection()
 114     mkcellcon = ifaces.mk_cellconn()
 115     pincon = ifaces.mk_pincon()
 116     inst = ifaces.extifinstance()
 117     inst2 = ifaces.extifinstance2()
 118     mkplic = ifaces.mk_plic()
 119     numsloirqs = ifaces.mk_sloirqsdef()
 120     ifacedef = ifaces.mk_ext_ifacedef()
 121     ifacedef = ifaces.mk_ext_ifacedef()
 122     clockcon = ifaces.mk_slowclk_con()
 123
 124     with open(slow, "w") as bsv_file:
 125         with open(slowt) as f:
 126             slowt = f.read()
 127         bsv_file.write(slowt.format(imports, ifdecl, regdef, slavedecl,
 128                                     fnaddrmap, mkslow, mkcon, mkcellcon,
 129                                     pincon, inst, mkplic,
 130                                     numsloirqs, ifacedef,
 131                                     inst2, clockcon))
 132
 133     with open(slowmf, "w") as bsv_file:
 134         with open(slowmt) as f:
 135             slowmt = f.read()
 136         bsv_file.write(slowmt.format(regdef, slavedecl, fnaddrmap))
 137
 138
 139 def write_soc(soc, soct, fastmf, fastmt, p, ifaces, iocells):
 140     """ write out the soc.bsv file.
 141         joins all the peripherals together as AXI Masters
 142     """
 143     ifaces.fastbusmode = True  # side-effects... shouldn't really do this
 144
 145     imports = ifaces.slowimport()
 146     ifdecl = ifaces.fastifdecl()
 147     regdef = ifaces.axi_fastmem_def()
 148     slavedecl = ifaces.axi_fastslave_idx()
 149     mastdecl = ifaces.axi_master_idx()
 150     fnaddrmap = ifaces.axi_fastaddr_map()
 151     mkfast = ifaces.mkfast_peripheral()
 152     mkcon = ifaces.mk_fast_connection()
 153     mkmstcon = ifaces.mk_master_connection()
 154     mkcellcon = ifaces.mk_cellconn()
 155     pincon = ifaces.mk_fast_pincon()
 156     inst = ifaces.extfastifinstance()
 157     mkplic = ifaces.mk_plic()
 158     numsloirqs = ifaces.mk_sloirqsdef()
 159     ifacedef = ifaces.mk_ext_ifacedef()
 160     dma = ifaces.mk_dma_irq()
 161     num_dmachannels = ifaces.num_dmachannels()
 162     clockcon = ifaces.mk_fastclk_con()
 163
 164     with open(soc, "w") as bsv_file:
 165         with open(soct) as f:
 166             soct = f.read()
 167         bsv_file.write(soct.format(imports, ifdecl, mkfast,
 168                                    slavedecl, mastdecl, mkcon,
 169                                    inst, dma, num_dmachannels,
 170                                    pincon, regdef, fnaddrmap,
 171                                    clockcon, mkmstcon,
 172                                    ))
 173
 174     with open(fastmf, "w") as bsv_file:
 175         with open(fastmt) as f:
 176             fastmt = f.read()
 177         bsv_file.write(fastmt.format(regdef, slavedecl, mastdecl, fnaddrmap))
 178
 179
 180 def write_bus(bus, p, ifaces):
 181     # package and interface declaration followed by
 182     # the generic io_cell definition
 183     with open(bus, "w") as bsv_file:
 184         ifaces.busfmt(bsv_file)
 185
 186
 187 def write_pmp(pmp, p, ifaces, iocells):
 188     # package and interface declaration followed by
 189     # the generic io_cell definition
 190     with open(pmp, "w") as bsv_file:
 191         bsv_file.write(header)
 192
 193         bwid_template = 'Bit#(%d)'
 194         bsv_file.write('''\
 195       (*always_ready,always_enabled*)
 196       interface MuxSelectionLines;
 197
 198       // declare the method which will capture the user pin-mux
 199       // selection values.The width of the input is dependent on the number
 200       // of muxes happening per IO. For now we have a generalized width
 201       // where each IO will have the same number of muxes.''')
 202
 203         for cell in p.muxed_cells:
 204             cellnum = cell[0]
 205             bitwidth = p.get_muxbitwidth(cellnum)
 206             if bitwidth == 0:
 207                 continue
 208             cell_bit_width = bwid_template % bitwidth
 209             bsv_file.write(mux_interface.ifacefmt(cellnum, cell_bit_width))
 210
 211         bsv_file.write("\n      endinterface\n")
 212
 213         bsv_file.write('''
 214
 215       interface IOCellSide;
 216       // declare the interface to the IO cells.
 217       // Each IO cell will have 1 input field (output from pin mux)
 218       // and an output and out-enable field (input to pinmux)''')
 219
 220         # == create method definitions for all iocell interfaces ==#
 221         iocells.ifacefmt(bsv_file)
 222
 223         # ===== finish interface definition and start module definition=======
 224         bsv_file.write("\n      endinterface\n")
 225
 226         ifaces.ifacepfmt(bsv_file)
 227         # ===== io cell definition =======
 228         bsv_file.write('''
 229       (*always_ready,always_enabled*)
 230       interface PeripheralSide;
 231       // declare the interface to the peripherals
 232       // Each peripheral's function will be either an input, output
 233       // or be bi-directional.  an input field will be an output from the
 234       // peripheral and an output field will be an input to the peripheral.
 235       // Bi-directional functions also have an output-enable (which
 236       // again comes *in* from the peripheral)''')
 237         # ==============================================================
 238
 239         # == create method definitions for all peripheral interfaces ==#
 240         ifaces.ifacefmt2(bsv_file)
 241         bsv_file.write("\n      endinterface\n")
 242
 243         # ===== finish interface definition and start module definition=======
 244         bsv_file.write('''
 245
 246    interface Ifc_pinmux;
 247       // this interface controls how each IO cell is routed.  setting
 248       // any given IO cell's mux control value will result in redirection
 249       // of not just the input or output to different peripheral functions
 250       // but also the *direction* control - if appropriate - as well.
 251       interface MuxSelectionLines mux_lines;
 252
 253       // this interface contains the inputs, outputs and direction-control
 254       // lines for all peripherals.  GPIO is considered to also be just
 255       // a peripheral because it also has in, out and direction-control.
 256       interface PeripheralSide peripheral_side;
 257
 258       // this interface is to be linked to the individual IO cells.
 259       // if looking at a "non-muxed" GPIO design, basically the
 260       // IO cell input, output and direction-control wires are cut
 261       // (giving six pairs of dangling wires, named left and right)
 262       // these iocells are routed in their place on one side ("left")
 263       // and the matching *GPIO* peripheral interfaces in/out/dir
 264       // connect to the OTHER side ("right").  the result is that
 265       // the muxer settings end up controlling the routing of where
 266       // the I/O from the IOcell actually goes.
 267       interface IOCellSide iocell_side;
 268    endinterface
 269
 270    (*synthesize*)
 271    module mkpinmux(Ifc_pinmux);
 272 ''')
 273         # ====================================================================
 274
 275         # ======================= create wire and registers =================#
 276         bsv_file.write('''
 277       // the followins wires capture the pin-mux selection
 278       // values for each mux assigned to a CELL
 279 ''')
 280         for cell in p.muxed_cells:
 281             cellnum = cell[0]
 282             bitwidth = p.get_muxbitwidth(cellnum)
 283             if bitwidth == 0:
 284                 continue
 285             cell_bit_width = bwid_template % bitwidth
 286             bsv_file.write(mux_interface.wirefmt(cellnum, cell_bit_width))
 287
 288         iocells.wirefmt(bsv_file)
 289         ifaces.wirefmt(bsv_file)
 290
 291         bsv_file.write("\n")
 292         # ====================================================================
 293         # ========================= Actual pinmuxing ========================#
 294         bsv_file.write('''
 295       /*====== This where the muxing starts for each io-cell======*/
 296       Wire#(Bit#(1)) val0<-mkDWire(0); // need a zero
 297 ''')
 298         bsv_file.write(p.pinmux)
 299         bsv_file.write('''
 300       /*============================================================*/
 301 ''')
 302         # ====================================================================
 303         # ================= interface definitions for each method =============#
 304         bsv_file.write('''
 305     interface mux_lines = interface MuxSelectionLines
 306 ''')
 307         for cell in p.muxed_cells:
 308             cellnum = cell[0]
 309             bitwidth = p.get_muxbitwidth(cellnum)
 310             if bitwidth == 0:
 311                 continue
 312             cell_bit_width = bwid_template % bitwidth
 313             bsv_file.write(
 314                 mux_interface.ifacedef(
 315                     cellnum, cell_bit_width))
 316         bsv_file.write("\n    endinterface;")
 317
 318         bsv_file.write('''
 319
 320     interface iocell_side = interface IOCellSide
 321 ''')
 322         iocells.ifacedef(bsv_file)
 323         bsv_file.write("\n     endinterface;")
 324
 325         bsv_file.write('''
 326
 327      interface peripheral_side = interface PeripheralSide
 328 ''')
 329         ifaces.ifacedef2(bsv_file)
 330         bsv_file.write("\n      endinterface;")
 331
 332         bsv_file.write(footer)
 333         print("BSV file successfully generated: bsv_src/pinmux.bsv")
 334         # ======================================================================
 335
 336
 337 def write_bvp(bvp, p, ifaces):
 338     # ######## Generate bus transactors ################
 339     gpiocfg = '\t\tinterface GPIO_config#({4}) bank{3}_config;\n' \
 340               '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) bank{3}_slave;'
 341     muxcfg = '\t\tinterface MUX_config#({4}) muxb{3}_config;\n' \
 342         '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) muxb{3}_slave;'
 343
 344     gpiodec = '\tGPIO#({0}) mygpio{1} <- mkgpio();'
 345     muxdec = '\tMUX#({0}) mymux{1} <- mkmux();'
 346     gpioifc = '\tinterface bank{0}_config=mygpio{0}.pad_config;\n' \
 347               '\tinterface bank{0}_slave=mygpio{0}.axi_slave;'
 348     muxifc = '\tinterface muxb{0}_config=mymux{0}.mux_config;\n' \
 349         '\tinterface muxb{0}_slave=mymux{0}.axi_slave;'
 350     with open(bvp, 'w') as bsv_file:
 351         # assume here that all muxes have a 1:1 gpio
 352         cfg = []
 353         decl = []
 354         idec = []
 355         iks = sorted(ifaces.keys())
 356         for iname in iks:
 357             if not iname.startswith('gpio'):  # TODO: declare other interfaces
 358                 continue
 359             bank = iname[4:]
 360             ifc = ifaces[iname]
 361             npins = len(ifc.pinspecs)
 362             cfg.append(gpiocfg.format(p.ADDR_WIDTH, p.DATA_WIDTH,
 363                                       0,  # USERSPACE
 364                                       bank, npins))
 365             cfg.append(muxcfg.format(p.ADDR_WIDTH, p.DATA_WIDTH,
 366                                      0,  # USERSPACE
 367                                      bank, npins))
 368             decl.append(gpiodec.format(npins, bank))
 369             decl.append(muxdec .format(npins, bank))
 370             idec.append(gpioifc.format(bank))
 371             idec.append(muxifc.format(bank))
 372         print dir(ifaces)
 373         print ifaces.items()
 374         print dir(ifaces['gpioa'])
 375         print ifaces['gpioa'].pinspecs
 376         gpiodecl = '\n'.join(decl) + '\n' + '\n'.join(idec)
 377         gpiocfg = '\n'.join(cfg)
 378         bsv_file.write(axi4_lite.format(gpiodecl, gpiocfg))
 379     # ##################################################
 380
 381
 382 def write_instances(idef, p, ifaces):
 383     with open(idef, 'w') as bsv_file:
 384         txt = '''\
 385 `define ADDR {0}
 386 `define PADDR {2}
 387 `define DATA {1}
 388 `define Reg_width {1}
 389 `define USERSPACE 0
 390 `define RV64
 391
 392 // TODO: work out if these are needed
 393 `define PWM_AXI4Lite
 394 `define PRFDEPTH 6
 395 `define VADDR 39
 396 `define DCACHE_BLOCK_SIZE 4
 397 `define DCACHE_WORD_SIZE 8
 398 `define PERFMONITORS                            64
 399 `define DCACHE_WAYS 4
 400 `define DCACHE_TAG_BITS 20      // tag_bits = 52
 401
 402 // CLINT
 403     `define ClintBase       'h02000000
 404     `define ClintEnd        'h020BFFFF
 405
 406 `define PLIC
 407         `define PLICBase                'h0c000000
 408         `define PLICEnd         'h10000000
 409 `define INTERRUPT_PINS 64
 410
 411 `define BAUD_RATE 130
 412 `ifdef simulate
 413   `define BAUD_RATE 5 //130 //
 414 `endif
 415 '''
 416         bsv_file.write(txt.format(p.ADDR_WIDTH,
 417                                   p.DATA_WIDTH,
 418                                   p.PADDR_WIDTH))