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 '''
  43 footer = '''
  44    endmodule
  45 endpackage
  46 '''
  47
  48
  49 def pinmuxgen(pth=None, verify=True):
  50     """ populating the file with the code
  51     """
  52
  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)
  58     init(p, ifaces)
  59
  60     bp = 'bsv_src'
  61     if pth:
  62         bp = os.path.join(pth, bp)
  63     if not os.path.exists(bp):
  64         os.makedirs(bp)
  65     bl = os.path.join(bp, 'bsv_lib')
  66     if not os.path.exists(bl):
  67         os.makedirs(bl)
  68
  69     cwd = os.path.split(__file__)[0]
  70
  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         shutil.copyfile(os.path.join(cwd, fname),
  78                         os.path.join(bl, fname))
  79
  80     bus = os.path.join(bp, 'busenable.bsv')
  81     pmp = os.path.join(bp, 'pinmux.bsv')
  82     ptp = os.path.join(bp, 'PinTop.bsv')
  83     bvp = os.path.join(bp, 'bus.bsv')
  84     idef = os.path.join(bp, 'instance_defines.bsv')
  85     slow = os.path.join(bp, 'slow_peripherals.bsv')
  86     slowt = os.path.join(cwd, 'slow_peripherals_template.bsv')
  87
  88     write_pmp(pmp, p, ifaces, iocells)
  89     write_ptp(ptp, p, ifaces)
  90     write_bvp(bvp, p, ifaces)
  91     write_bus(bus, p, ifaces)
  92     write_instances(idef, p, ifaces)
  93     write_slow(slow, slowt, p, ifaces)
  94
  95
  96 def write_slow(slow, template, p, ifaces):
  97     """ write out the slow_peripherals.bsv file.
  98         joins all the peripherals together into one AXI Lite interface
  99     """
 100     with open(template) as bsv_file:
 101         template = bsv_file.read()
 102     imports = ifaces.slowimport()
 103     ifdecl = ifaces.slowifdecl()
 104     regdef = ifaces.axi_reg_def()
 105     slavedecl = ifaces.axi_slave_idx()
 106     fnaddrmap = ifaces.axi_addr_map()
 107     mkslow = ifaces.mkslow_peripheral()
 108     mkcon = ifaces.mk_connection()
 109     with open(slow, "w") as bsv_file:
 110         bsv_file.write(template.format(imports, ifdecl, regdef, slavedecl,
 111                                        fnaddrmap, mkslow, mkcon))
 112
 113
 114 def write_bus(bus, p, ifaces):
 115     # package and interface declaration followed by
 116     # the generic io_cell definition
 117     with open(bus, "w") as bsv_file:
 118         ifaces.busfmt(bsv_file)
 119
 120
 121 def write_pmp(pmp, p, ifaces, iocells):
 122     # package and interface declaration followed by
 123     # the generic io_cell definition
 124     with open(pmp, "w") as bsv_file:
 125         bsv_file.write(header)
 126
 127         cell_bit_width = 'Bit#(%d)' % p.cell_bitwidth
 128         bsv_file.write('''\
 129    interface MuxSelectionLines;
 130
 131       // declare the method which will capture the user pin-mux
 132       // selection values.The width of the input is dependent on the number
 133       // of muxes happening per IO. For now we have a generalized width
 134       // where each IO will have the same number of muxes.''')
 135
 136         for cell in p.muxed_cells:
 137             bsv_file.write(mux_interface.ifacefmt(cell[0], cell_bit_width))
 138
 139         bsv_file.write("\n      endinterface\n")
 140
 141         bsv_file.write('''
 142
 143       interface IOCellSide;
 144       // declare the interface to the IO cells.
 145       // Each IO cell will have 1 input field (output from pin mux)
 146       // and an output and out-enable field (input to pinmux)''')
 147
 148         # == create method definitions for all iocell interfaces ==#
 149         iocells.ifacefmt(bsv_file)
 150
 151         # ===== finish interface definition and start module definition=======
 152         bsv_file.write("\n      endinterface\n")
 153
 154         # ===== io cell definition =======
 155         bsv_file.write('''
 156
 157       interface PeripheralSide;
 158       // declare the interface to the peripherals
 159       // Each peripheral's function will be either an input, output
 160       // or be bi-directional.  an input field will be an output from the
 161       // peripheral and an output field will be an input to the peripheral.
 162       // Bi-directional functions also have an output-enable (which
 163       // again comes *in* from the peripheral)''')
 164         # ==============================================================
 165
 166         # == create method definitions for all peripheral interfaces ==#
 167         ifaces.ifacefmt(bsv_file)
 168         bsv_file.write("\n      endinterface\n")
 169
 170         # ===== finish interface definition and start module definition=======
 171         bsv_file.write('''
 172
 173    interface Ifc_pinmux;
 174       // this interface controls how each IO cell is routed.  setting
 175       // any given IO cell's mux control value will result in redirection
 176       // of not just the input or output to different peripheral functions
 177       // but also the *direction* control - if appropriate - as well.
 178       interface MuxSelectionLines mux_lines;
 179
 180       // this interface contains the inputs, outputs and direction-control
 181       // lines for all peripherals.  GPIO is considered to also be just
 182       // a peripheral because it also has in, out and direction-control.
 183       interface PeripheralSide peripheral_side;
 184
 185       // this interface is to be linked to the individual IO cells.
 186       // if looking at a "non-muxed" GPIO design, basically the
 187       // IO cell input, output and direction-control wires are cut
 188       // (giving six pairs of dangling wires, named left and right)
 189       // these iocells are routed in their place on one side ("left")
 190       // and the matching *GPIO* peripheral interfaces in/out/dir
 191       // connect to the OTHER side ("right").  the result is that
 192       // the muxer settings end up controlling the routing of where
 193       // the I/O from the IOcell actually goes.
 194       interface IOCellSide iocell_side;
 195    endinterface
 196    (*synthesize*)
 197    module mkpinmux(Ifc_pinmux);
 198 ''')
 199         # ====================================================================
 200
 201         # ======================= create wire and registers =================#
 202         bsv_file.write('''
 203       // the followins wires capture the pin-mux selection
 204       // values for each mux assigned to a CELL
 205 ''')
 206         for cell in p.muxed_cells:
 207             bsv_file.write(mux_interface.wirefmt(
 208                 cell[0], cell_bit_width))
 209
 210         iocells.wirefmt(bsv_file)
 211         ifaces.wirefmt(bsv_file)
 212
 213         bsv_file.write("\n")
 214         # ====================================================================
 215         # ========================= Actual pinmuxing ========================#
 216         bsv_file.write('''
 217       /*====== This where the muxing starts for each io-cell======*/
 218       Wire#(Bit#(1)) val0<-mkDWire(0); // need a zero
 219 ''')
 220         bsv_file.write(p.pinmux)
 221         bsv_file.write('''
 222       /*============================================================*/
 223 ''')
 224         # ====================================================================
 225         # ================= interface definitions for each method =============#
 226         bsv_file.write('''
 227     interface mux_lines = interface MuxSelectionLines
 228 ''')
 229         for cell in p.muxed_cells:
 230             bsv_file.write(
 231                 mux_interface.ifacedef(
 232                     cell[0], cell_bit_width))
 233         bsv_file.write("\n    endinterface;")
 234
 235         bsv_file.write('''
 236     interface iocell_side = interface IOCellSide
 237 ''')
 238         iocells.ifacedef(bsv_file)
 239         bsv_file.write("\n     endinterface;")
 240
 241         bsv_file.write('''
 242     interface peripheral_side = interface PeripheralSide
 243 ''')
 244         ifaces.ifacedef(bsv_file)
 245         bsv_file.write("\n     endinterface;")
 246
 247         bsv_file.write(footer)
 248         print("BSV file successfully generated: bsv_src/pinmux.bsv")
 249         # ======================================================================
 250
 251
 252 def write_ptp(ptp, p, ifaces):
 253     with open(ptp, 'w') as bsv_file:
 254         bsv_file.write(copyright + '''
 255 package PinTop;
 256     import pinmux::*;
 257     interface Ifc_PintTop;
 258         method ActionValue#(Bool) write(Bit#({0}) addr, Bit#({1}) data);
 259         method Tuple2#(Bool,Bit#({1})) read(Bit#({0}) addr);
 260         interface PeripheralSide peripheral_side;
 261     endinterface
 262
 263     module mkPinTop(Ifc_PintTop);
 264         // instantiate the pin-mux module here
 265         Ifc_pinmux pinmux <-mkpinmux;
 266
 267         // declare the registers which will be used to mux the IOs
 268 '''.format(p.ADDR_WIDTH, p.DATA_WIDTH))
 269
 270         cell_bit_width = str(p.cell_bitwidth)
 271         for cell in p.muxed_cells:
 272             bsv_file.write('''
 273                 Reg#(Bit#({0})) rg_muxio_{1} <-mkReg(0);'''.format(
 274                 cell_bit_width, cell[0]))
 275
 276         bsv_file.write('''
 277         // rule to connect the registers to the selection lines of the
 278         // pin-mux module
 279         rule connect_selection_registers;''')
 280
 281         for cell in p.muxed_cells:
 282             bsv_file.write('''
 283           pinmux.mux_lines.cell{0}_mux(rg_muxio_{0});'''.format(cell[0]))
 284
 285         bsv_file.write('''
 286         endrule
 287         // method definitions for the write user interface
 288         method ActionValue#(Bool) write(Bit#({2}) addr, Bit#({3}) data);
 289           Bool err=False;
 290           case (addr[{0}:{1}])'''.format(p.upper_offset, p.lower_offset,
 291                                          p.ADDR_WIDTH, p.DATA_WIDTH))
 292         index = 0
 293         for cell in p.muxed_cells:
 294             bsv_file.write('''
 295             {0}: rg_muxio_{1}<=truncate(data);'''.format(index, cell[0]))
 296             index = index + 1
 297
 298         bsv_file.write('''
 299             default: err=True;
 300           endcase
 301           return err;
 302         endmethod''')
 303
 304         bsv_file.write('''
 305         // method definitions for the read user interface
 306         method Tuple2#(Bool,Bit#({3})) read(Bit#({2}) addr);
 307           Bool err=False;
 308           Bit#(32) data=0;
 309           case (addr[{0}:{1}])'''.format(p.upper_offset, p.lower_offset,
 310                                          p.ADDR_WIDTH, p.DATA_WIDTH))
 311         index = 0
 312         for cell in p.muxed_cells:
 313             bsv_file.write('''
 314                 {0}: data=zeroExtend(rg_muxio_{1});'''.format(index, cell[0]))
 315             index = index + 1
 316
 317         bsv_file.write('''
 318             default:err=True;
 319           endcase
 320           return tuple2(err,data);
 321         endmethod
 322         interface peripheral_side=pinmux.peripheral_side;
 323     endmodule
 324 endpackage
 325 ''')
 326
 327
 328 def write_bvp(bvp, p, ifaces):
 329     # ######## Generate bus transactors ################
 330     gpiocfg = '\t\tinterface GPIO_config#({4}) bank{3}_config;\n' \
 331               '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) bank{3}_slave;'
 332     muxcfg = '\t\tinterface MUX_config#({4}) muxb{3}_config;\n' \
 333         '\t\tinterface AXI4_Lite_Slave_IFC#({0},{1},{2}) muxb{3}_slave;'
 334
 335     gpiodec = '\tGPIO#({0}) mygpio{1} <- mkgpio();'
 336     muxdec = '\tMUX#({0}) mymux{1} <- mkmux();'
 337     gpioifc = '\tinterface bank{0}_config=mygpio{0}.pad_config;\n' \
 338               '\tinterface bank{0}_slave=mygpio{0}.axi_slave;'
 339     muxifc = '\tinterface muxb{0}_config=mymux{0}.mux_config;\n' \
 340         '\tinterface muxb{0}_slave=mymux{0}.axi_slave;'
 341     with open(bvp, 'w') as bsv_file:
 342         # assume here that all muxes have a 1:1 gpio
 343         cfg = []
 344         decl = []
 345         idec = []
 346         iks = sorted(ifaces.keys())
 347         for iname in iks:
 348             if not iname.startswith('gpio'):  # TODO: declare other interfaces
 349                 continue
 350             bank = iname[4:]
 351             ifc = ifaces[iname]
 352             npins = len(ifc.pinspecs)
 353             cfg.append(gpiocfg.format(p.ADDR_WIDTH, p.DATA_WIDTH,
 354                                       0,  # USERSPACE
 355                                       bank, npins))
 356             cfg.append(muxcfg.format(p.ADDR_WIDTH, p.DATA_WIDTH,
 357                                      0,  # USERSPACE
 358                                      bank, npins))
 359             decl.append(gpiodec.format(npins, bank))
 360             decl.append(muxdec .format(npins, bank))
 361             idec.append(gpioifc.format(bank))
 362             idec.append(muxifc.format(bank))
 363         print dir(ifaces)
 364         print ifaces.items()
 365         print dir(ifaces['gpioa'])
 366         print ifaces['gpioa'].pinspecs
 367         gpiodecl = '\n'.join(decl) + '\n' + '\n'.join(idec)
 368         gpiocfg = '\n'.join(cfg)
 369         bsv_file.write(axi4_lite.format(gpiodecl, gpiocfg))
 370     # ##################################################
 371
 372
 373 def write_instances(idef, p, ifaces):
 374     with open(idef, 'w') as bsv_file:
 375         txt = '''\
 376     `define ADDR {0}
 377     `define DATA {1}
 378     `define USERSPACE 0
 379 '''
 380         bsv_file.write(txt.format(p.ADDR_WIDTH, p.DATA_WIDTH))