sv_binutils: generate fields tables
[openpower-isa.git] / src / openpower / sv / sv_analysis.py
index 175c3925123e1f3cb33bdda01ec49c765fce455a..d2b7c7abcd2dd4ad065e5704b115f6c1a9e0a2a1 100644 (file)
 # then goes through the categories and creates svp64 CSV augmentation
 # tables on a per-opcode basis
 
+import argparse
 import csv
+import enum
 import os
 from os.path import dirname, join
 from glob import glob
+from collections import defaultdict
 from collections import OrderedDict
 from openpower.decoder.power_svp64 import SVP64RM
 from openpower.decoder.power_enums import find_wiki_file, get_csv
@@ -31,8 +34,10 @@ def write_csv(name, items, headers):
 
 # This will return True if all values are true.
 # Not sure what this is about
+
+
 def blank_key(row):
-    #for v in row.values():
+    # for v in row.values():
     #    if 'SPR' in v: # skip all SPRs
     #        return True
     for v in row.values():
@@ -43,6 +48,8 @@ def blank_key(row):
 # General purpose registers have names like: RA, RT, R1, ...
 # Floating point registers names like: FRT, FRA, FR1, ..., FRTp, ...
 # Return True if field is a register
+
+
 def isreg(field):
     return (field.startswith('R') or field.startswith('FR') or
             field == 'SPR')
@@ -51,10 +58,11 @@ def isreg(field):
 # These are the attributes of the instructions,
 # register names
 keycolumns = ['unit', 'in1', 'in2', 'in3', 'out', 'CR in', 'CR out',
-                 ] # don't think we need these: 'ldst len', 'rc', 'lk']
+               # don't think we need these: 'ldst len', 'rc', 'lk']
 
 tablecols = ['unit', 'in', 'outcnt', 'CR in', 'CR out', 'imm'
-                 ] # don't think we need these: 'ldst len', 'rc', 'lk']
+             ]  # don't think we need these: 'ldst len', 'rc', 'lk']
+
 
 def create_key(row):
     res = OrderedDict()
@@ -64,6 +72,8 @@ def create_key(row):
         if key in ['in1', 'in2', 'in3']:
             if 'in' not in res:
                 res['in'] = 0
+            if row['unit'] == 'BRANCH':  # branches must not include Vector SPRs
+                continue
             if isreg(row[key]):
                 res['in'] += 1
 
@@ -87,7 +97,7 @@ def create_key(row):
                 res['crop'] = '1'
         # unit
         if key == 'unit':
-            if row[key] == 'LDST': # we care about LDST units
+            if row[key] == 'LDST':  # we care about LDST units
                 res[key] = row[key]
             else:
                 res[key] = 'OTHER'
@@ -112,25 +122,28 @@ def create_key(row):
     res['in'] = str(res['in'])
     res['outcnt'] = str(res['outcnt'])
 
-
     # constants
     if row['in2'].startswith('CONST_'):
-        res['imm'] = "1" # row['in2'].split("_")[1]
+        res['imm'] = "1"  # row['in2'].split("_")[1]
     else:
         res['imm'] = ''
 
     return res
 
 #
+
+
 def dformat(d):
     res = []
     for k, v in d.items():
         res.append("%s: %s" % (k, v))
     return ' '.join(res)
 
+
 def tformat(d):
     return ' | '.join(d) + " |"
 
+
 def keyname(row):
     res = []
     if row['unit'] != 'OTHER':
@@ -153,28 +166,104 @@ def keyname(row):
     return '-'.join(res)
 
 
-def process_csvs():
+class Format(enum.Enum):
+    BINUTILS = enum.auto()
+    VHDL = enum.auto()
+
+    @classmethod
+    def _missing_(cls, value):
+        return {
+            "binutils": Format.BINUTILS,
+            "vhdl": Format.VHDL,
+        }[value.lower()]
+
+    def __str__(self):
+        return self.name.lower()
+
+    def declarations(self, values, lens):
+        def declaration_binutils(value, width):
+            yield f"/* TODO: implement binutils declaration (value={value!r}, width={width!r}) */"
+
+        def declaration_vhdl(value, width):
+            yield f"    type sv_{value}_rom_array_t is " \
+                f"array(0 to {width}) of sv_decode_rom_t;"
+
+        for value in values:
+            if value not in lens:
+                todo = [f"TODO {value} (or no SVP64 augmentation)"]
+                todo = self.wrap_comment(todo)
+                yield from map(lambda line: f"    {line}", todo)
+            else:
+                width = lens[value]
+                yield from {
+                    Format.BINUTILS: declaration_binutils,
+                    Format.VHDL: declaration_vhdl,
+                }[self](value, width)
+
+    def definitions(self, entries_svp64, fullcols):
+        def definitions_vhdl():
+            for (value, entries) in entries_svp64.items():
+                yield ""
+                yield f"    constant sv_{value}_decode_rom_array :"
+                yield f"             sv_{value}_rom_array_t := ("
+                yield f"        -- {'  '.join(fullcols)}"
+
+                for (op, insn, row) in entries:
+                    yield f"    {op:>13} => ({', '.join(row)}), -- {insn}"
+
+                yield f"    {'others':>13} => sv_illegal_inst"
+                yield "    );"
+                yield ""
+
+        def definitions_binutils():
+            yield f"/* TODO: implement binutils definitions */"
+
+        yield from {
+            Format.BINUTILS: definitions_binutils,
+            Format.VHDL: definitions_vhdl,
+        }[self]()
+
+    def wrap_comment(self, lines):
+        def wrap_comment_binutils(lines):
+            lines = tuple(lines)
+            if len(lines) == 1:
+                yield f"/* {lines[0]} */"
+            else:
+                yield "/*"
+                yield from map(lambda line: f" * {line}", lines)
+                yield " */"
+
+        def wrap_comment_vhdl(lines):
+            yield from map(lambda line: f"-- {line}", lines)
+
+        yield from {
+            Format.BINUTILS: wrap_comment_binutils,
+            Format.VHDL: wrap_comment_vhdl,
+        }[self](lines)
+
+
+def process_csvs(format):
     csvs = {}
     csvs_svp64 = {}
     bykey = {}
     primarykeys = set()
     dictkeys = OrderedDict()
     immediates = {}
-    insns = {} # dictionary of CSV row, by instruction
+    insns = {}  # dictionary of CSV row, by instruction
     insn_to_csv = {}
 
-    print ("# OpenPOWER ISA register 'profile's")
-    print ('')
-    print ("this page is auto-generated, do not edit")
-    print ("created by http://libre-soc.org/openpower/sv_analysis.py")
-    print ('')
+    print("# OpenPOWER ISA register 'profile's")
+    print('')
+    print("this page is auto-generated, do not edit")
+    print("created by http://libre-soc.org/openpower/sv_analysis.py")
+    print('')
 
     # Expand that (all .csv files)
     pth = find_wiki_file("*.csv")
 
     # Ignore those containing: valid test sprs
     for fname in glob(pth):
-        print ("sv analysis checking", fname)
+        print("sv analysis checking", fname)
         _, name = os.path.split(fname)
         if '-' in name:
             continue
@@ -197,19 +286,23 @@ def process_csvs():
         for row in csv:
             if blank_key(row):
                 continue
-            print ("row", row)
+            print("row", row)
             insn_name = row['comment']
             condition = row['CONDITIONS']
             # skip instructions that are not suitable
+            if insn_name.startswith("l") and insn_name.endswith("br"):
+                continue  # skip pseudo-alias lxxxbr
             if insn_name in ['mcrxr', 'mcrxrx', 'darn']:
                 continue
-            if insn_name.startswith('bc') or 'rfid' in insn_name:
+            if insn_name in ['bctar', 'bcctr']:
+                continue
+            if 'rfid' in insn_name:
                 continue
-            if insn_name in ['setvl',]: # SVP64 opcodes
+            if insn_name in ['setvl', ]:  # SVP64 opcodes
                 continue
 
-            insns[(insn_name, condition)] = row # accumulate csv data 
-            insn_to_csv[insn_name] = csvname_ # CSV file name by instruction
+            insns[(insn_name, condition)] = row  # accumulate csv data
+            insn_to_csv[insn_name] = csvname_  # CSV file name by instruction
             dkey = create_key(row)
             key = tuple(dkey.values())
             # print("key=", key)
@@ -247,6 +340,7 @@ def process_csvs():
               '1R-1W-imm': 'RM-2P-1S1D',
               '1R-CRo': 'RM-2P-1S1D',
               '1R-imm': 'non-SV',
+              '1W-CRo': 'RM-1P-1D',
               '1W': 'non-SV',
               '1W-CRi': 'RM-2P-1S1D',
               'CRio': 'RM-2P-1S1D',
@@ -264,20 +358,20 @@ def process_csvs():
               'LDST-3R-CRo': 'LDSTRM-2P-3S',  # st*x
               'LDST-3R-1W': 'LDSTRM-2P-2S1D',  # st*x
               }
-    print ("# map to old SV Prefix")
-    print ('')
-    print ('[[!table  data="""')
+    print("# map to old SV Prefix")
+    print('')
+    print('[[!table  data="""')
     for key in primarykeys:
         name = keyname(dictkeys[key])
         value = mapsto.get(name, "-")
-        print (tformat([name, value+ " "]))
-    print ('"""]]')
-    print ('')
+        print(tformat([name, value + " "]))
+    print('"""]]')
+    print('')
 
-    print ("# keys")
-    print ('')
-    print ('[[!table  data="""')
-    print (tformat(tablecols) + " imms | name |")
+    print("# keys")
+    print('')
+    print('[[!table  data="""')
+    print(tformat(tablecols) + " imms | name |")
 
     # print out the keys and the table from which they're derived
     for key in primarykeys:
@@ -287,38 +381,38 @@ def process_csvs():
         imms.sort()
         row += " %s | " % ("/".join(imms))
         row += " %s |" % name
-        print (row)
-    print ('"""]]')
-    print ('')
+        print(row)
+    print('"""]]')
+    print('')
 
     # print out, by remap name, all the instructions under that category
     for key in primarykeys:
         name = keyname(dictkeys[key])
         value = mapsto.get(name, "-")
-        print ("## %s (%s)" % (name, value))
-        print ('')
-        print ('[[!table  data="""')
-        print (tformat(['CSV', 'opcode', 'asm', 'form']))
+        print("## %s (%s)" % (name, value))
+        print('')
+        print('[[!table  data="""')
+        print(tformat(['CSV', 'opcode', 'asm', 'form']))
         rows = bykey[key]
         rows.sort()
         for row in rows:
-            print (tformat(row))
-        print ('"""]]')
-        print ('')
+            print(tformat(row))
+        print('"""]]')
+        print('')
 
-    #for fname, csv in csvs.items():
+    # for fname, csv in csvs.items():
     #    print (fname)
 
-    #for insn, row in insns.items():
+    # for insn, row in insns.items():
     #    print (insn, row)
 
-    print ("# svp64 remaps")
+    print("# svp64 remaps")
     svp64 = OrderedDict()
     # create a CSV file, per category, with SV "augmentation" info
     # XXX note: 'out2' not added here, needs to be added to CSV files
     # KEEP TRACK OF THESE https://bugs.libre-soc.org/show_bug.cgi?id=619
     csvcols = ['insn', 'CONDITIONS', 'Ptype', 'Etype', '0', '1', '2', '3']
-    csvcols += ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out'] # temporary
+    csvcols += ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']  # temporary
     for key in primarykeys:
         # get the decoded key containing row-analysis, and name/value
         dkey = dictkeys[key]
@@ -328,7 +422,7 @@ def process_csvs():
             continue
 
         # print out svp64 tables by category
-        print ("* **%s**: %s" % (name, value))
+        print("* **%s**: %s" % (name, value))
 
         # store csv entries by svp64 RM category
         if value not in svp64:
@@ -338,11 +432,11 @@ def process_csvs():
         rows.sort()
 
         for row in rows:
-            #for idx in range(len(row)):
+            # for idx in range(len(row)):
             #    if row[idx] == 'NONE':
             #        row[idx] = ''
             # get the instruction
-            print (key, row)
+            print(key, row)
             insn_name = row[2]
             condition = row[3]
             insn = insns[(insn_name, condition)]
@@ -350,7 +444,7 @@ def process_csvs():
             res = OrderedDict()
             res['insn'] = insn_name
             res['CONDITIONS'] = condition
-            res['Ptype'] = value.split('-')[1] # predication type (RM-xN-xxx)
+            res['Ptype'] = value.split('-')[1]  # predication type (RM-xN-xxx)
             # get whether R_xxx_EXTRAn fields are 2-bit or 3-bit
             res['Etype'] = 'EXTRA2'
             # go through each register matching to Rxxxx_EXTRAx
@@ -359,7 +453,7 @@ def process_csvs():
             # create "fake" out2 (TODO, needs to be added to CSV files)
             # KEEP TRACK HERE https://bugs.libre-soc.org/show_bug.cgi?id=619
             res['out2'] = 'NONE'
-            if insn['upd'] == '1': # LD/ST with update has RA as out2
+            if insn['upd'] == '1':  # LD/ST with update has RA as out2
                 res['out2'] = 'RA'
 
             # temporary useful info
@@ -377,6 +471,8 @@ def process_csvs():
                     else:
                         regs.append('')
 
+            print("regs", insn_name, regs)
+
             # for LD/ST FP, use FRT/FRS not RT/RS, and use CR1 not CR0
             if insn_name.startswith("lf"):
                 dRT = 'd:FRT'
@@ -395,178 +491,192 @@ def process_csvs():
             # but the patterns are pretty regular.
 
             if value == 'LDSTRM-2P-1S1D':
-                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                res['Etype'] = 'EXTRA3'  # RM EXTRA3 type
                 res['0'] = dRT    # RT: Rdest_EXTRA3
-                res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
+                res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
 
             elif value == 'LDSTRM-2P-1S2D':
-                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
                 res['0'] = dRT    # RT: Rdest_EXTRA3
-                res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
-                res['2'] = 's:RA' # RA: Rsrc1_EXTRA2
+                res['1'] = 'd:RA'  # RA: Rdest2_EXTRA2
+                res['2'] = 's:RA'  # RA: Rsrc1_EXTRA2
 
             elif value == 'LDSTRM-2P-2S':
                 # stw, std, sth, stb
-                res['Etype'] = 'EXTRA3' # RM EXTRA2 type
+                res['Etype'] = 'EXTRA3'  # RM EXTRA2 type
                 res['0'] = sRS    # RS: Rdest1_EXTRA2
-                res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
+                res['1'] = 's:RA'  # RA: Rsrc1_EXTRA2
 
             elif value == 'LDSTRM-2P-2S1D':
-                if 'st' in insn_name and 'x' not in insn_name: # stwu/stbu etc
-                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
-                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
+                if 'st' in insn_name and 'x' not in insn_name:  # stwu/stbu etc
+                    res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
+                    res['0'] = 'd:RA'  # RA: Rdest1_EXTRA2
                     res['1'] = sRS    # RS: Rdsrc1_EXTRA2
-                    res['2'] = 's:RA' # RA: Rsrc2_EXTRA2
-                elif 'st' in insn_name and 'x' in insn_name: # stwux
-                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
-                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA2
-                    res['1'] = sRS+'s:RA' # RS: Rdest2_EXTRA2, RA: Rsrc1_EXTRA2
-                    res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
-                elif 'u' in insn_name: # ldux etc.
-                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['2'] = 's:RA'  # RA: Rsrc2_EXTRA2
+                elif 'st' in insn_name and 'x' in insn_name:  # stwux
+                    res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
+                    res['0'] = 'd:RA'  # RA: Rdest1_EXTRA2
+                    # RS: Rdest2_EXTRA2, RA: Rsrc1_EXTRA2
+                    res['1'] = sRS+'s:RA'
+                    res['2'] = 's:RB'  # RB: Rsrc2_EXTRA2
+                elif 'u' in insn_name:  # ldux etc.
+                    res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
                     res['0'] = dRT    # RT: Rdest1_EXTRA2
-                    res['1'] = 'd:RA' # RA: Rdest2_EXTRA2
-                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA2
+                    res['1'] = 'd:RA'  # RA: Rdest2_EXTRA2
+                    res['2'] = 's:RB'  # RB: Rsrc1_EXTRA2
                 else:
-                    res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                    res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
                     res['0'] = dRT     # RT: Rdest1_EXTRA2
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
-                    res['2'] = 's:RB' # RB: Rsrc2_EXTRA2
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB'  # RB: Rsrc2_EXTRA2
 
             elif value == 'LDSTRM-2P-3S':
-                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
+                res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
                 if 'cx' in insn_name:
-                    res['0'] = sRS+dCR # RS: Rsrc1_EXTRA2 CR0: dest
+                    res['0'] = sRS+dCR  # RS: Rsrc1_EXTRA2 CR0: dest
                 else:
-                    res['0'] = sRS # RS: Rsrc1_EXTRA2
-                res['1'] = 's:RA' # RA: Rsrc2_EXTRA2
-                res['2'] = 's:RB' # RA: Rsrc3_EXTRA2
+                    res['0'] = sRS  # RS: Rsrc1_EXTRA2
+                res['1'] = 's:RA'  # RA: Rsrc2_EXTRA2
+                res['2'] = 's:RB'  # RA: Rsrc3_EXTRA2
 
             elif value == 'RM-2P-1S1D':
-                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                res['Etype'] = 'EXTRA3'  # RM EXTRA3 type
                 if insn_name == 'mtspr':
-                    res['0'] = 'd:SPR' # SPR: Rdest1_EXTRA3
-                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                    res['0'] = 'd:SPR'  # SPR: Rdest1_EXTRA3
+                    res['1'] = 's:RS'  # RS: Rsrc1_EXTRA3
                 elif insn_name == 'mfspr':
-                    res['0'] = 'd:RS' # RS: Rdest1_EXTRA3
-                    res['1'] = 's:SPR' # SPR: Rsrc1_EXTRA3
+                    res['0'] = 'd:RS'  # RS: Rdest1_EXTRA3
+                    res['1'] = 's:SPR'  # SPR: Rsrc1_EXTRA3
                 elif name == 'CRio' and insn_name == 'mcrf':
-                    res['0'] = 'd:BF' # BFA: Rdest1_EXTRA3
-                    res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
+                    res['0'] = 'd:BF'  # BFA: Rdest1_EXTRA3
+                    res['1'] = 's:BFA'  # BFA: Rsrc1_EXTRA3
                 elif 'mfcr' in insn_name or 'mfocrf' in insn_name:
-                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
-                    res['1'] = 's:CR' # CR: Rsrc1_EXTRA3
+                    res['0'] = 'd:RT'  # RT: Rdest1_EXTRA3
+                    res['1'] = 's:CR'  # CR: Rsrc1_EXTRA3
                 elif insn_name == 'setb':
-                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
-                    res['1'] = 's:BFA' # BFA: Rsrc1_EXTRA3
-                elif insn_name.startswith('cmp'): # cmpi
-                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                elif regs == ['RA','','','RT','','']:
-                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                elif regs == ['RA','','','RT','','CR0']:
-                    res['0'] = 'd:RT;d:CR0' # RT,CR0: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                elif (regs == ['RS','','','RA','','CR0'] or
-                      regs == ['','','RS','RA','','CR0']):
-                    res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
-                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
-                elif regs == ['RS','','','RA','','']:
-                    res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
-                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
-                elif regs == ['','FRB','','FRT','0','CR1']:
-                    res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
-                elif regs == ['','FRB','','','','CR1']:
-                    res['0'] = 'd:CR1' # CR1: Rdest1_EXTRA3
-                    res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
-                elif regs == ['','FRB','','','','BF']:
-                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
-                    res['1'] = 's:FRB' # FRA: Rsrc1_EXTRA3
-                elif regs == ['','FRB','','FRT','','CR1']:
-                    res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
-                    res['1'] = 's:FRB' # FRB: Rsrc1_EXTRA3
+                    res['0'] = 'd:RT'  # RT: Rdest1_EXTRA3
+                    res['1'] = 's:BFA'  # BFA: Rsrc1_EXTRA3
+                elif insn_name.startswith('cmp'):  # cmpi
+                    res['0'] = 'd:BF'  # BF: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                elif regs == ['RA', '', '', 'RT', '', '']:
+                    res['0'] = 'd:RT'  # RT: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                elif regs == ['RA', '', '', 'RT', '', 'CR0']:
+                    res['0'] = 'd:RT;d:CR0'  # RT,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                elif (regs == ['RS', '', '', 'RA', '', 'CR0'] or
+                      regs == ['', '', 'RS', 'RA', '', 'CR0']):
+                    res['0'] = 'd:RA;d:CR0'  # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RS'  # RS: Rsrc1_EXTRA3
+                elif regs == ['RS', '', '', 'RA', '', '']:
+                    res['0'] = 'd:RA'  # RA: Rdest1_EXTRA3
+                    res['1'] = 's:RS'  # RS: Rsrc1_EXTRA3
+                elif regs == ['', 'FRB', '', 'FRT', '0', 'CR1']:
+                    res['0'] = 'd:FRT;d:CR1'  # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA3
+                elif regs == ['', 'FRB', '', '', '', 'CR1']:
+                    res['0'] = 'd:CR1'  # CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRB'  # FRA: Rsrc1_EXTRA3
+                elif regs == ['', 'FRB', '', '', '', 'BF']:
+                    res['0'] = 'd:BF'  # BF: Rdest1_EXTRA3
+                    res['1'] = 's:FRB'  # FRA: Rsrc1_EXTRA3
+                elif regs == ['', 'FRB', '', 'FRT', '', 'CR1']:
+                    res['0'] = 'd:FRT;d:CR1'  # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRB'  # FRB: Rsrc1_EXTRA3
+                elif insn_name.startswith('bc'):
+                    res['0'] = 'd:BI'  # BI: Rdest1_EXTRA3
+                    res['1'] = 's:BI'  # BI: Rsrc1_EXTRA3
                 else:
                     res['0'] = 'TODO'
 
             elif value == 'RM-1P-2S1D':
-                res['Etype'] = 'EXTRA3' # RM EXTRA3 type
+                res['Etype'] = 'EXTRA3'  # RM EXTRA3 type
                 if insn_name.startswith('cr'):
-                    res['0'] = 'd:BT' # BT: Rdest1_EXTRA3
-                    res['1'] = 's:BA' # BA: Rsrc1_EXTRA3
-                    res['2'] = 's:BB' # BB: Rsrc2_EXTRA3
-                elif regs == ['FRA','','FRC','FRT','','CR1']:
-                    res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
-                    res['2'] = 's:FRC' # FRC: Rsrc1_EXTRA3
+                    res['0'] = 'd:BT'  # BT: Rdest1_EXTRA3
+                    res['1'] = 's:BA'  # BA: Rsrc1_EXTRA3
+                    res['2'] = 's:BB'  # BB: Rsrc2_EXTRA3
+                elif regs == ['FRA', '', 'FRC', 'FRT', '', 'CR1']:
+                    res['0'] = 'd:FRT;d:CR1'  # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRC'  # FRC: Rsrc1_EXTRA3
                 # should be for fcmp
-                elif regs == ['FRA','FRB','','','','BF']:
-                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
-                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
-                elif regs == ['FRA','FRB','','FRT','','']:
-                    res['0'] = 'd:FRT' # FRT: Rdest1_EXTRA3
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
-                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
-                elif regs == ['FRA','FRB','','FRT','','CR1']:
-                    res['0'] = 'd:FRT;d:CR1' # FRT,CR1: Rdest1_EXTRA3
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA3
-                    res['2'] = 's:FRB' # FRB: Rsrc1_EXTRA3
-                elif name == '2R-1W' or insn_name == 'cmpb': # cmpb
+                elif regs == ['FRA', 'FRB', '', '', '', 'BF']:
+                    res['0'] = 'd:BF'  # BF: Rdest1_EXTRA3
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB'  # FRB: Rsrc1_EXTRA3
+                elif regs == ['FRA', 'FRB', '', 'FRT', '', '']:
+                    res['0'] = 'd:FRT'  # FRT: Rdest1_EXTRA3
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB'  # FRB: Rsrc1_EXTRA3
+                elif regs == ['FRA', 'FRB', '', 'FRT', '', 'CR1']:
+                    res['0'] = 'd:FRT;d:CR1'  # FRT,CR1: Rdest1_EXTRA3
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA3
+                    res['2'] = 's:FRB'  # FRB: Rsrc1_EXTRA3
+                elif name == '2R-1W' or insn_name == 'cmpb':  # cmpb
                     if insn_name in ['bpermd', 'cmpb']:
-                        res['0'] = 'd:RA' # RA: Rdest1_EXTRA3
-                        res['1'] = 's:RS' # RS: Rsrc1_EXTRA3
+                        res['0'] = 'd:RA'  # RA: Rdest1_EXTRA3
+                        res['1'] = 's:RS'  # RS: Rsrc1_EXTRA3
                     else:
-                        res['0'] = 'd:RT' # RT: Rdest1_EXTRA3
-                        res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
-                elif insn_name.startswith('cmp'): # cmp
-                    res['0'] = 'd:BF' # BF: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
-                elif (regs == ['','RB','RS','RA','','CR0'] or
-                      regs == ['RS','RB','','RA','','CR0']):
-                    res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
-                    res['1'] = 's:RB' # RB: Rsrc1_EXTRA3
-                    res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
-                elif regs == ['RA','RB','','RT','','CR0']:
-                    res['0'] = 'd:RT;d:CR0' # RT,CR0: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                    res['2'] = 's:RB' # RB: Rsrc1_EXTRA3
-                elif regs == ['RA','','RS','RA','','CR0']:
-                    res['0'] = 'd:RA;d:CR0' # RA,CR0: Rdest1_EXTRA3
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA3
-                    res['2'] = 's:RS' # RS: Rsrc1_EXTRA3
+                        res['0'] = 'd:RT'  # RT: Rdest1_EXTRA3
+                        res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB'  # RB: Rsrc1_EXTRA3
+                elif insn_name.startswith('cmp'):  # cmp
+                    res['0'] = 'd:BF'  # BF: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB'  # RB: Rsrc1_EXTRA3
+                elif (regs == ['', 'RB', 'RS', 'RA', '', 'CR0'] or
+                      regs == ['RS', 'RB', '', 'RA', '', 'CR0']):
+                    res['0'] = 'd:RA;d:CR0'  # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RB'  # RB: Rsrc1_EXTRA3
+                    res['2'] = 's:RS'  # RS: Rsrc1_EXTRA3
+                elif regs == ['RA', 'RB', '', 'RT', '', 'CR0']:
+                    res['0'] = 'd:RT;d:CR0'  # RT,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RB'  # RB: Rsrc1_EXTRA3
+                elif regs == ['RA', '', 'RS', 'RA', '', 'CR0']:
+                    res['0'] = 'd:RA;d:CR0'  # RA,CR0: Rdest1_EXTRA3
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA3
+                    res['2'] = 's:RS'  # RS: Rsrc1_EXTRA3
                 else:
                     res['0'] = 'TODO'
 
             elif value == 'RM-2P-2S1D':
-                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
-                if insn_name.startswith('mt'): # mtcrf
-                    res['0'] = 'd:CR' # CR: Rdest1_EXTRA2
-                    res['1'] = 's:RS' # RS: Rsrc1_EXTRA2
-                    res['2'] = 's:CR' # CR: Rsrc2_EXTRA2
+                res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
+                if insn_name.startswith('mt'):  # mtcrf
+                    res['0'] = 'd:CR'  # CR: Rdest1_EXTRA2
+                    res['1'] = 's:RS'  # RS: Rsrc1_EXTRA2
+                    res['2'] = 's:CR'  # CR: Rsrc2_EXTRA2
                 else:
                     res['0'] = 'TODO'
 
             elif value == 'RM-1P-3S1D':
-                res['Etype'] = 'EXTRA2' # RM EXTRA2 type
-                if insn_name == 'isel':
-                    res['0'] = 'd:RT' # RT: Rdest1_EXTRA2
-                    res['1'] = 's:RA' # RA: Rsrc1_EXTRA2
-                    res['2'] = 's:RB' # RT: Rsrc2_EXTRA2
-                    res['3'] = 's:BC' # BC: Rsrc3_EXTRA2
+                res['Etype'] = 'EXTRA2'  # RM EXTRA2 type
+                if regs == ['RA', 'RB', 'RT', 'RT', '', 'CR0']:
+                    res['0'] = 'd:RT;d:CR0'  # RT,CR0: Rdest1_EXTRA2
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB'  # RT: Rsrc2_EXTRA2
+                    res['3'] = 's:RT'  # RT: Rsrc3_EXTRA2
+                elif insn_name == 'isel':
+                    res['0'] = 'd:RT'  # RT: Rdest1_EXTRA2
+                    res['1'] = 's:RA'  # RA: Rsrc1_EXTRA2
+                    res['2'] = 's:RB'  # RT: Rsrc2_EXTRA2
+                    res['3'] = 's:BC'  # BC: Rsrc3_EXTRA2
                 else:
-                    res['0'] = 'd:FRT;d:CR1' # FRT, CR1: Rdest1_EXTRA2
-                    res['1'] = 's:FRA' # FRA: Rsrc1_EXTRA2
-                    res['2'] = 's:FRB' # FRB: Rsrc2_EXTRA2
-                    res['3'] = 's:FRC' # FRC: Rsrc3_EXTRA2
+                    res['0'] = 'd:FRT;d:CR1'  # FRT, CR1: Rdest1_EXTRA2
+                    res['1'] = 's:FRA'  # FRA: Rsrc1_EXTRA2
+                    res['2'] = 's:FRB'  # FRB: Rsrc2_EXTRA2
+                    res['3'] = 's:FRC'  # FRC: Rsrc3_EXTRA2
+
+            elif value == 'RM-1P-1D':
+                res['Etype'] = 'EXTRA3'  # RM EXTRA3 type
+                if insn_name == 'svstep':
+                    res['0'] = 'd:RT;d:CR0'  # RT,CR0: Rdest1_EXTRA2
 
             # add to svp64 csvs
-            #for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
+            # for k in ['in1', 'in2', 'in3', 'out', 'CR in', 'CR out']:
             #    del res[k]
-            #if res['0'] != 'TODO':
+            # if res['0'] != 'TODO':
             for k in res:
                 if k == 'CONDITIONS':
                     continue
@@ -577,16 +687,22 @@ def process_csvs():
             csv_fname = insn_to_csv[insn_name]
             csvs_svp64[csv_fname].append(res)
 
-    print ('')
+    print('')
 
     # now write out the csv files
     for value, csv in svp64.items():
+        if value == '-':
+            from time import sleep
+            print ("WARNING, filename '-' should NOT exist. instrs missing")
+            print ("TODO: fix this (and put in the bugreport number here)")
+            sleep(2)
+            continue
         # print out svp64 tables by category
-        print ("## %s" % value)
-        print ('')
-        print ('[[!table format=csv file="openpower/isatables/%s.csv"]]' % \
-                    value)
-        print ('')
+        print("## %s" % value)
+        print('')
+        print('[[!table format=csv file="openpower/isatables/%s.csv"]]' %
+              value)
+        print('')
 
         #csvcols = ['insn', 'Ptype', 'Etype', '0', '1', '2', '3']
         write_csv("%s.csv" % value, csv, csvcols + ['out2'])
@@ -600,7 +716,7 @@ def process_csvs():
 
     # Ignore those containing: valid test sprs
     for fname in glob(pth):
-        print ("post-checking", fname)
+        print("post-checking", fname)
         _, name = os.path.split(fname)
         if '-' in name:
             continue
@@ -619,85 +735,104 @@ def process_csvs():
     csvcols = ['insn', 'Ptype', 'Etype']
     csvcols += ['in1', 'in2', 'in3', 'out', 'out2', 'CR in', 'CR out']
 
-    # and a nice microwatt VHDL file
-    file_path = find_wiki_file("sv_decode.vhdl")
-    with open(file_path, 'w') as vhdl:
-        # autogeneration warning
-        vhdl.write("-- this file is auto-generated, do not edit\n")
-        vhdl.write("-- http://libre-soc.org/openpower/sv_analysis.py\n")
-        vhdl.write("-- part of Libre-SOC, sponsored by NLnet\n")
-        vhdl.write("\n")
-
-        # first create array types
-        lens = {'major' : 63,
-                'minor_4': 63,
-                'minor_19': 7,
-                'minor_30': 15,
-                'minor_31': 1023,
-                'minor_58': 63,
-                'minor_59': 31,
-                'minor_62': 63,
-                'minor_63l': 511,
-                'minor_63h': 16,
-                }
-        for value, csv in csvs_svp64.items():
-            # munge name
-            value = value.lower()
-            value = value.replace("-", "_")
-            if value not in lens:
-                todo = "    -- TODO %s (or no SVP64 augmentation)\n"
-                vhdl.write(todo % value)
-                continue
-            width = lens[value]
-            typarray = "    type sv_%s_rom_array_t is " \
-                       "array(0 to %d) of sv_decode_rom_t;\n"
-            vhdl.write(typarray % (value, width))
-
-        # now output structs
-        sv_cols = ['sv_in1', 'sv_in2', 'sv_in3', 'sv_out', 'sv_out2',
-                                'sv_cr_in', 'sv_cr_out']
-        fullcols = csvcols + sv_cols
-        hdr = "\n" \
-              "    constant sv_%s_decode_rom_array :\n" \
-              "             sv_%s_rom_array_t := (\n" \
-              "        -- %s\n"
-        ftr = "          others  => sv_illegal_inst\n" \
-              "    );\n\n"
-        for value, csv in csvs_svp64.items():
-            # munge name
-            value = value.lower()
-            value = value.replace("-", "_")
-            if value not in lens:
-                continue
-            vhdl.write(hdr % (value, value, "  ".join(fullcols)))
-            for entry in csv:
-                insn = str(entry['insn'])
-                condition = str(entry['CONDITIONS'])
-                sventry = svt.svp64_instrs.get(insn, None)
-                op = insns[(insn, condition)]['opcode']
-                # binary-to-vhdl-binary
-                if op.startswith("0b"):
-                    op = "2#%s#" % op[2:]
-                row = []
-                for colname in csvcols[1:]:
-                    re = entry[colname]
-                    # zero replace with NONE
-                    if re == '0':
-                        re = 'NONE'
-                    # 1/2 predication
-                    re = re.replace("1P", "P1")
-                    re = re.replace("2P", "P2")
-                    row.append(re)
-                print ("sventry", sventry)
-                for colname in sv_cols:
-                    if sventry is None:
-                        re = 'NONE'
-                    else:
-                        re = sventry[colname]
-                    row.append(re)
-                row = ', '.join(row)
-                vhdl.write("    %13s => (%s), -- %s\n" % (op, row, insn))
-            vhdl.write(ftr)
+    if format is Format.VHDL:
+        # and a nice microwatt VHDL file
+        file_path = find_wiki_file("sv_decode.vhdl")
+    elif format is Format.BINUTILS:
+        file_path = find_wiki_file("binutils.c")
+
+    with open(file_path, 'w') as stream:
+        output(format, svt, csvcols, insns, csvs_svp64, stream)
+
+
+def output_autogen_disclaimer(format, stream):
+    lines = (
+        "this file is auto-generated, do not edit",
+        "http://libre-soc.org/openpower/sv_analysis.py",
+        "part of Libre-SOC, sponsored by NLnet",
+    )
+    for line in format.wrap_comment(lines):
+        stream.write(line)
+        stream.write("\n")
+    stream.write("\n")
+
+
+def output(format, svt, csvcols, insns, csvs_svp64, stream):
+    lens = {
+        'major': 63,
+        'minor_4': 63,
+        'minor_19': 7,
+        'minor_30': 15,
+        'minor_31': 1023,
+        'minor_58': 63,
+        'minor_59': 31,
+        'minor_62': 63,
+        'minor_63l': 511,
+        'minor_63h': 16,
+    }
+
+    def svp64_canonicalize(item):
+        (value, csv) = item
+        value = value.lower().replace("-", "_")
+        return (value, csv)
+
+    csvs_svp64_canon = dict(map(svp64_canonicalize, csvs_svp64.items()))
+
+    # disclaimer
+    output_autogen_disclaimer(format, stream)
+
+    # declarations
+    for line in format.declarations(csvs_svp64_canon.keys(), lens):
+        stream.write(f"{line}\n")
+
+    # definitions
+    sv_cols = ['sv_in1', 'sv_in2', 'sv_in3', 'sv_out', 'sv_out2',
+               'sv_cr_in', 'sv_cr_out']
+    fullcols = csvcols + sv_cols
+
+    entries_svp64 = defaultdict(list)
+    for (value, csv) in filter(lambda kv: kv[0] in lens, csvs_svp64_canon.items()):
+        for entry in csv:
+            insn = str(entry['insn'])
+            condition = str(entry['CONDITIONS'])
+            sventry = svt.svp64_instrs.get(insn, None)
+            op = insns[(insn, condition)]['opcode']
+            # binary-to-vhdl-binary
+            if op.startswith("0b"):
+                op = "2#%s#" % op[2:]
+            row = []
+            for colname in csvcols[1:]:
+                re = entry[colname]
+                # zero replace with NONE
+                if re == '0':
+                    re = 'NONE'
+                # 1/2 predication
+                re = re.replace("1P", "P1")
+                re = re.replace("2P", "P2")
+                row.append(re)
+            print("sventry", sventry)
+            for colname in sv_cols:
+                if sventry is None:
+                    re = 'NONE'
+                else:
+                    re = sventry[colname]
+                row.append(re)
+            entries_svp64[value].append((op, insn, row))
+
+    for line in format.definitions(entries_svp64, fullcols):
+        stream.write(f"{line}\n")
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-f", "--format",
+                        type=Format, choices=Format, default=Format.VHDL,
+                        help="format to be used (binutils or VHDL)")
+    args = parser.parse_args()
+    process_csvs(args.format)
+
 
 if __name__ == '__main__':
-    process_csvs()
+    # don't do anything other than call main() here, cuz this code is bypassed
+    # by the sv_analysis command created by setup.py
+    main()