f4bdf1615cd2d5d34ce0685e630140a868cadaf1
[soc.git] / src / soc / decoder / power_fields.py
1 from collections import OrderedDict, namedtuple
2 from soc.decoder.power_enums import find_wiki_file
3
4
5 class BitRange(OrderedDict):
6 """BitRange: remaps from straight indices (0,1,2..) to bit numbers
7 """
8
9 def __getitem__(self, subscript):
10 if isinstance(subscript, slice):
11 return list(self.values())[subscript]
12 else:
13 return OrderedDict.__getitem__(self, subscript)
14
15
16 def decode_instructions(form):
17 res = {}
18 accum = []
19 for l in form:
20 if l.strip().startswith("Formats"):
21 l = l.strip().split(":")[-1]
22 l = l.replace(" ", "")
23 l = l.split(",")
24 for fmt in l:
25 if fmt not in res:
26 res[fmt] = [accum[0]]
27 else:
28 res[fmt].append(accum[0])
29 accum = []
30 else:
31 accum.append(l.strip())
32 return res
33
34
35 def decode_form_header(hdr):
36 res = {}
37 count = 0
38 hdr = hdr.strip()
39 for f in hdr.split("|"):
40 if not f:
41 continue
42 if f[0].isdigit():
43 idx = int(f.strip().split(' ')[0])
44 res[count] = idx
45 count += len(f) + 1
46 return res
47
48
49 def find_unique(d, key):
50 if key not in d:
51 return key
52 idx = 1
53 while "%s_%d" % (key, idx) in d:
54 idx += 1
55 return "%s_%d" % (key, idx)
56
57
58 def decode_line(header, line):
59 line = line.strip()
60 res = {}
61 count = 0
62 prev_fieldname = None
63 for f in line.split("|"):
64 if not f:
65 continue
66 end = count + len(f) + 1
67 fieldname = f.strip()
68 if not fieldname or fieldname.startswith('/'):
69 if prev_fieldname is not None:
70 res[prev_fieldname] = (res[prev_fieldname], header[count])
71 prev_fieldname = None
72 count = end
73 continue
74 bitstart = header[count]
75 if prev_fieldname is not None:
76 res[prev_fieldname] = (res[prev_fieldname], bitstart)
77 res[fieldname] = bitstart
78 count = end
79 prev_fieldname = fieldname
80 res[prev_fieldname] = (bitstart, 32)
81 return res
82
83
84 def decode_form(form):
85 header = decode_form_header(form[0])
86 res = []
87 for line in form[1:]:
88 dec = decode_line(header, line)
89 if dec:
90 res.append(dec)
91 fields = {}
92 falternate = {}
93 for l in res:
94 for k, (start, end) in l.items():
95 if k in fields:
96 if (start, end) == fields[k]:
97 continue # already in and matching for this Form
98 if k in falternate:
99 alternate = "%s_%d" % (k, falternate[k])
100 if (start, end) == fields[alternate]:
101 continue
102 falternate[k] = fidx = falternate.get(k, 0) + 1
103 fields["%s_%d" % (k, fidx)] = (start, end)
104 else:
105 fields[k] = (start, end)
106 return fields
107
108
109 class DecodeFields:
110
111 def __init__(self, bitkls=BitRange, bitargs=(), fname=None,
112 name_on_wiki=None):
113 self.bitkls = bitkls
114 self.bitargs = bitargs
115 if fname is None:
116 assert name_on_wiki is None
117 fname = "fields.txt"
118 name_on_wiki = "fields.text"
119 self.fname = find_wiki_file(name_on_wiki)
120
121 def create_specs(self):
122 self.forms, self.instrs = self.decode_fields()
123 self.form_names = forms = self.instrs.keys()
124 #print ("specs", self.forms, forms)
125 for form in forms:
126 fields = self.instrs[form]
127 fk = fields.keys()
128 Fields = namedtuple("Fields", fk)
129 instr = Fields(**fields)
130 setattr(self, "Form%s" % form, instr)
131 # now add in some commonly-used fields (should be done automatically)
132 # note that these should only be ones which are the same on all Forms
133 # note: these are from microwatt insn_helpers.vhdl
134 self.common_fields = {
135 "RS": self.FormX.RS,
136 "RT": self.FormX.RT,
137 "RA": self.FormX.RA,
138 "RB": self.FormX.RB,
139 "SI": self.FormD.SI,
140 "UI": self.FormD.UI,
141 "L": self.FormD.L,
142 "SH32": self.FormM.SH,
143 "sh": self.FormMD.sh,
144 "MB32": self.FormM.MB,
145 "ME32": self.FormM.ME,
146 "LI": self.FormI.LI,
147 "LK": self.FormI.LK,
148 "AA": self.FormB.AA,
149 "Rc": self.FormX.Rc,
150 "OE": self.FormXO.Rc,
151 "BD": self.FormB.BD,
152 "BF": self.FormX.BF,
153 "CR": self.FormXL.XO,
154 "BB": self.FormXL.BB,
155 "BA": self.FormXL.BA,
156 "BT": self.FormXL.BT,
157 "FXM": self.FormXFX.FXM,
158 "BO": self.FormXL.BO,
159 "BI": self.FormXL.BI,
160 "BH": self.FormXL.BH,
161 "D": self.FormD.D,
162 "DS": self.FormDS.DS,
163 "TO": self.FormX.TO,
164 "BC": self.FormA.BC,
165 "SH": self.FormX.SH,
166 "ME": self.FormM.ME,
167 "MB": self.FormM.MB,
168 "SPR": self.FormXFX.SPR}
169 for k, v in self.common_fields.items():
170 setattr(self, k, v)
171
172 def decode_fields(self):
173 with open(self.fname) as f:
174 txt = f.readlines()
175 #print ("decode", txt)
176 forms = {}
177 reading_data = False
178 for l in txt:
179 l = l.strip()
180 if len(l) == 0:
181 continue
182 if reading_data:
183 if l[0] == '#':
184 reading_data = False
185 else:
186 forms[heading].append(l)
187 if not reading_data:
188 assert l[0] == '#'
189 heading = l[1:].strip()
190 # if heading.startswith('1.6.28'): # skip instr fields for now
191 # break
192 heading = heading.split(' ')[-1]
193 reading_data = True
194 forms[heading] = []
195
196 res = {}
197 inst = {}
198
199 for hdr, form in forms.items():
200 if heading == 'Fields':
201 i = decode_instructions(form)
202 for form, field in i.items():
203 inst[form] = self.decode_instruction_fields(field)
204 # else:
205 # res[hdr] = decode_form(form)
206 return res, inst
207
208 def decode_instruction_fields(self, fields):
209 res = {}
210 for field in fields:
211 f, spec = field.strip().split(" ")
212 ss = spec[1:-1].split(",")
213 fs = f.split(",")
214 if len(fs) > 1:
215 individualfields = []
216 for f0, s0 in zip(fs, ss):
217 txt = "%s (%s)" % (f0, s0)
218 individualfields.append(txt)
219 if len(fs) > 1:
220 res.update(self.decode_instruction_fields(
221 individualfields))
222 d = self.bitkls(*self.bitargs)
223 idx = 0
224 for s in ss:
225 s = s.split(':')
226 if len(s) == 1:
227 d[idx] = int(s[0])
228 idx += 1
229 else:
230 start = int(s[0])
231 end = int(s[1])
232 while start <= end:
233 d[idx] = start
234 idx += 1
235 start += 1
236 f = f.replace(",", "_")
237 unique = find_unique(res, f)
238 res[unique] = d
239
240 return res
241
242
243 if __name__ == '__main__':
244 dec = DecodeFields()
245 dec.create_specs()
246 forms, instrs = dec.forms, dec.instrs
247 for form, fields in instrs.items():
248 print("Form", form)
249 for field, bits in fields.items():
250 print("\tfield", field, bits)