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