src/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 getopt
  20 import os
  21 import os.path
  22 import sys
  23 import time
  24 import math
  25
  26 # project module imports
  27 from interface_decl import Interfaces, mux_interface, io_interface
  28 from parse import Parse
  29 from actual_pinmux import init
  30 from bus_transactors import axi4_lite
  31
  32 copyright = '''
  33 /*
  34    This BSV file has been generated by the PinMux tool available at:
  35    https://bitbucket.org/casl/pinmux.
  36
  37    Authors: Neel Gala, Luke
  38    Date of generation: ''' + time.strftime("%c") + '''
  39 */
  40 '''
  41 header = copyright + '''
  42 package pinmux;
  43
  44    typedef struct{
  45       Bit#(1) outputval;      // output from core to pad                bit7
  46       Bit#(1) output_en;      // output enable from core to pad         bit6
  47       Bit#(1) input_en;       // input enable from core to io_cell      bit5
  48       Bit#(1) pullup_en;      // pullup enable from core to io_cell     bit4
  49       Bit#(1) pulldown_en;    // pulldown enable from core to io_cell   bit3
  50       Bit#(1) drivestrength;  // drivestrength from core to io_cell     bit2
  51       Bit#(1) pushpull_en;    // pushpull enable from core to io_cell   bit1
  52       Bit#(1) opendrain_en;   // opendrain enable form core to io_cell  bit0
  53    } GenericIOType deriving(Eq,Bits,FShow);
  54
  55 '''
  56 footer = '''
  57      endinterface;
  58    endmodule
  59 endpackage
  60 '''
  61
  62 def pinmuxgen(pth=None, verify=True):
  63     """ populating the file with the code
  64     """
  65
  66     p = Parse(pth, verify)
  67     init(p)
  68     ifaces = Interfaces()
  69     ifaces.ifaceadd('io', p.N_IO, io_interface, 0)
  70
  71     bp = 'bsv_src'
  72     if pth:
  73         bp = os.path.join(pth, bp)
  74     if not os.path.exists(bp):
  75         os.makedirs(bp)
  76
  77     pmp = os.path.join(bp, 'pinmux.bsv')
  78     ptp = os.path.join(bp, 'PinTop.bsv')
  79     bvp = os.path.join(bp, 'bus.bsv')
  80
  81     # package and interface declaration followed by
  82     # the generic io_cell definition
  83     with open(pmp, "w") as bsv_file:
  84         bsv_file.write(header)
  85
  86         bsv_file.write('''\
  87    interface MuxSelectionLines;
  88
  89       // declare the method which will capture the user pin-mux
  90       // selection values.The width of the input is dependent on the number
  91       // of muxes happening per IO. For now we have a generalized width
  92       // where each IO will have the same number of muxes.''')
  93
  94         for cell in p.muxed_cells:
  95             bsv_file.write(mux_interface.ifacefmt(cell[0],
  96                                               int(math.log(len(cell) - 1, 2))))
  97
  98         bsv_file.write('''
  99       endinterface
 100
 101       interface PeripheralSide;
 102       // declare the interface to the IO cells.
 103       // Each IO cell will have 8 input field (output from pin mux
 104       // and on output field (input to pinmux)''')
 105         # ==============================================================
 106
 107         # == create method definitions for all peripheral interfaces ==#
 108         ifaces.ifacefmt(bsv_file)
 109
 110         # ==============================================================
 111
 112         # ===== finish interface definition and start module definition=======
 113         bsv_file.write('''
 114    endinterface
 115
 116    interface Ifc_pinmux;
 117       interface MuxSelectionLines mux_lines;
 118       interface PeripheralSide peripheral_side;
 119    endinterface
 120    (*synthesize*)
 121    module mkpinmux(Ifc_pinmux);
 122 ''')
 123         # ====================================================================
 124
 125         # ======================= create wire and registers =================#
 126         bsv_file.write('''
 127       // the followins wires capture the pin-mux selection
 128       // values for each mux assigned to a CELL
 129 ''')
 130         for cell in p.muxed_cells:
 131             bsv_file.write(mux_interface.wirefmt(
 132                 cell[0], int(math.log(len(cell) - 1, 2))))
 133
 134         ifaces.wirefmt(bsv_file)
 135
 136         bsv_file.write("\n")
 137         # ====================================================================
 138         # ========================= Actual pinmuxing ========================#
 139         bsv_file.write('''
 140       /*====== This where the muxing starts for each io-cell======*/
 141 ''')
 142         bsv_file.write(p.pinmux)
 143         bsv_file.write('''
 144       /*============================================================*/
 145 ''')
 146         # ====================================================================
 147         # ================= interface definitions for each method =============#
 148         bsv_file.write('''
 149     interface mux_lines = interface MuxSelectionLines
 150 ''')
 151         for cell in p.muxed_cells:
 152             bsv_file.write(mux_interface.ifacedef(cell[0],
 153                                                   int(math.log(len(cell) - 1, 2))))
 154         bsv_file.write('''
 155     endinterface;
 156     interface peripheral_side = interface PeripheralSide
 157 ''')
 158         ifaces.ifacedef(bsv_file)
 159         bsv_file.write(footer)
 160         print("BSV file successfully generated: bsv_src/pinmux.bsv")
 161         # ======================================================================
 162
 163     with open(ptp, 'w') as bsv_file:
 164         bsv_file.write(copyright + '''
 165 package PinTop;
 166     import pinmux::*;
 167     interface Ifc_PintTop;
 168         method ActionValue#(Bool) write(Bit#({0}) addr, Bit#({1}) data);
 169         method Tuple2#(Bool,Bit#({1})) read(Bit#({0}) addr);
 170         interface PeripheralSide peripheral_side;
 171     endinterface
 172
 173     module mkPinTop(Ifc_PintTop);
 174         // instantiate the pin-mux module here
 175         Ifc_pinmux pinmux <-mkpinmux;
 176
 177         // declare the registers which will be used to mux the IOs
 178 '''.format(p.ADDR_WIDTH, p.DATA_WIDTH))
 179
 180         for cell in p.muxed_cells:
 181             bsv_file.write('''
 182                 Reg#(Bit#({0})) rg_muxio_{1} <-mkReg(0);'''.format(
 183                 int(math.log(len(cell) - 1, 2)), cell[0]))
 184
 185         bsv_file.write('''
 186         // rule to connect the registers to the selection lines of the
 187         // pin-mux module
 188         rule connect_selection_registers;''')
 189
 190         for cell in p.muxed_cells:
 191             bsv_file.write('''
 192           pinmux.mux_lines.cell{0}_mux(rg_muxio_{0});'''.format(cell[0]))
 193
 194         bsv_file.write('''
 195         endrule
 196         // method definitions for the write user interface
 197         method ActionValue#(Bool) write(Bit#({2}) addr, Bit#({3}) data);
 198           Bool err=False;
 199           case (addr[{0}:{1}])'''.format(p.upper_offset, p.lower_offset,
 200                                          p.ADDR_WIDTH, p.DATA_WIDTH))
 201         index = 0
 202         for cell in p.muxed_cells:
 203             bsv_file.write('''
 204             {0}: rg_muxio_{1}<=truncate(data);'''.format(index, cell[0]))
 205             index = index + 1
 206
 207         bsv_file.write('''
 208             default: err=True;
 209           endcase
 210           return err;
 211         endmethod''')
 212
 213         bsv_file.write('''
 214         // method definitions for the read user interface
 215         method Tuple2#(Bool,Bit#({3})) read(Bit#({2}) addr);
 216           Bool err=False;
 217           Bit#(32) data=0;
 218           case (addr[{0}:{1}])'''.format(p.upper_offset, p.lower_offset,
 219                                          p.ADDR_WIDTH, p.DATA_WIDTH))
 220         index = 0
 221         for cell in p.muxed_cells:
 222             bsv_file.write('''
 223                 {0}: data=zeroExtend(rg_muxio_{1});'''.format(index, cell[0]))
 224             index = index + 1
 225
 226         bsv_file.write('''
 227             default:err=True;
 228           endcase
 229           return tuple2(err,data);
 230         endmethod
 231         interface peripheral_side=pinmux.peripheral_side;
 232     endmodule
 233 endpackage
 234 ''')
 235
 236     # ######## Generate bus transactors ################
 237     with open(bvp, 'w') as bsv_file:
 238         bsv_file.write(axi4_lite.format(p.ADDR_WIDTH, p.DATA_WIDTH))
 239     # ##################################################
 240
 241 def printhelp():
 242     print ('''pinmux_generator.py [-o outputdir] [-v|--validate] [-h|--help]
 243     -o outputdir    : defaults to bsv_src.  also location for reading pinmux.txt
 244                       interfaces.txt and *.txt
 245     -v | --validate : runs some validation on the pinmux
 246     -h | --help     : this help message
 247 ''')
 248
 249 if __name__ == '__main__':
 250     try:
 251         options, remainder = getopt.getopt(
 252             sys.argv[1:],
 253             'o:vh',
 254             ['output=',
 255              'validate',
 256              'help',
 257              'version=',
 258              ])
 259     except getopt.GetoptError as err:
 260         print "ERROR: %s" % str(err)
 261         printhelp()
 262         sys.exit(1)
 263
 264     output_dir = None
 265     validate = False
 266     for opt, arg in options:
 267         if opt in ('-o', '--output'):
 268             output_dir = arg
 269         elif opt in ('-v', '--validate'):
 270             validate = True
 271         elif opt in ('-h', '--help'):
 272             printhelp()
 273             sys.exit(0)
 274
 275     pinmuxgen(output_dir, validate)
 276