mem.isa revision 7279:157b02cc0ba1
1// -*- mode:c++ -*-
2
3// Copyright (c) 2010 ARM Limited
4// All rights reserved
5//
6// The license below extends only to copyright in the software and shall
7// not be construed as granting a license to any other intellectual
8// property including but not limited to intellectual property relating
9// to a hardware implementation of the functionality of the software
10// licensed hereunder.  You may use the software subject to the license
11// terms below provided that you ensure that this notice is replicated
12// unmodified and in its entirety in all distributions of the software,
13// modified or unmodified, in source code or in binary form.
14//
15// Copyright (c) 2007-2008 The Florida State University
16// All rights reserved.
17//
18// Redistribution and use in source and binary forms, with or without
19// modification, are permitted provided that the following conditions are
20// met: redistributions of source code must retain the above copyright
21// notice, this list of conditions and the following disclaimer;
22// redistributions in binary form must reproduce the above copyright
23// notice, this list of conditions and the following disclaimer in the
24// documentation and/or other materials provided with the distribution;
25// neither the name of the copyright holders nor the names of its
26// contributors may be used to endorse or promote products derived from
27// this software without specific prior written permission.
28//
29// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40//
41// Authors: Gabe Black
42
43def format AddrMode2(imm) {{
44    if eval(imm):
45        imm = True
46    else:
47        imm = False
48
49    def buildPUBWLCase(p, u, b, w, l):
50        return (p << 4) + (u << 3) + (b << 2) + (w << 1) + (l << 0)
51
52    header_output = decoder_output = exec_output = ""
53    decode_block = "switch(PUBWL) {\n"
54
55    # Loop over all the values of p, u, b, w and l and build instructions and
56    # a decode block for them.
57    for p in (0, 1):
58        for u in (0, 1):
59            for b in (0, 1):
60                for w in (0, 1):
61                    post = (p == 0)
62                    user = (p == 0 and w == 1)
63                    writeback = (p == 0 or w == 1)
64                    add = (u == 1)
65                    if b == 0:
66                        size = 4
67                    else:
68                        size = 1
69                    if add:
70                        addStr = "true"
71                    else:
72                        addStr = "false"
73                    if imm:
74                        newDecode = "return new %s(machInst, RD, RN," + \
75                                                  "%s, machInst.immed11_0);"
76                        loadClass = loadImmClassName(post, add, writeback,
77                                                     size, False, user)
78                        storeClass = storeImmClassName(post, add, writeback,
79                                                       size, False, user)
80                        loadDecode = newDecode % (loadClass, addStr)
81                        storeDecode = newDecode % (storeClass, addStr)
82                    else:
83                        newDecode = "return new %s(machInst, RD, RN, %s," + \
84                                                  "machInst.shiftSize," + \
85                                                  "machInst.shift, RM);"
86                        loadClass = loadRegClassName(post, add, writeback,
87                                                     size, False, user)
88                        storeClass = storeRegClassName(post, add, writeback,
89                                                       size, False, user)
90                        loadDecode = newDecode % (loadClass, addStr)
91                        storeDecode = newDecode % (storeClass, addStr)
92                    decode = '''
93                        case %#x:
94                          {%s}
95                          break;
96                    '''
97                    decode_block += decode % \
98                        (buildPUBWLCase(p,u,b,w,1), loadDecode)
99                    decode_block += decode % \
100                        (buildPUBWLCase(p,u,b,w,0), storeDecode)
101    decode_block += '''
102        default:
103          return new Unknown(machInst);
104        break;
105    }'''
106}};
107
108def format AddrMode3() {{
109    decode = '''
110    {
111        const uint32_t op1 = bits(machInst, 24, 20);
112        const uint32_t op2 = bits(machInst, 6, 5);
113        const uint32_t puiw = bits(machInst, 24, 21);
114        const uint32_t imm = IMMED_HI_11_8 << 4 | IMMED_LO_3_0;
115        switch (op2) {
116          case 0x1:
117            if (op1 & 0x1) {
118                %(ldrh)s
119            } else {
120                %(strh)s
121            }
122          case 0x2:
123            if (op1 & 0x1) {
124                %(ldrsb)s
125            } else {
126                %(ldrd)s
127            }
128          case 0x3:
129            if (op1 & 0x1) {
130                %(ldrsh)s
131            } else {
132                %(strd)s
133            }
134          default:
135            return new Unknown(machInst);
136        }
137    }
138    '''
139
140    def decodePuiwCase(load, d, p, u, i, w, size=4, sign=False):
141        post = (p == 0)
142        user = (p == 0 and w == 1)
143        writeback = (p == 0 or w == 1)
144        add = (u == 1)
145        caseVal = (p << 3) + (u << 2) + (i << 1) + (w << 0)
146        decode = '''
147          case %#x:
148            return new '''% caseVal
149        if add:
150            addStr = "true"
151        else:
152            addStr = "false"
153        if d:
154            dests = "RT & ~1, RT | 1"
155        else:
156            dests = "RT"
157        if i:
158            if load:
159                if d:
160                    className = loadDoubleImmClassName(post, add, writeback)
161                else:
162                    className = loadImmClassName(post, add, writeback, \
163                                                 size=size, sign=sign, \
164                                                 user=user)
165            else:
166                if d:
167                    className = storeDoubleImmClassName(post, add, writeback)
168                else:
169                    className = storeImmClassName(post, add, writeback, \
170                                                  size=size, sign=sign, \
171                                                  user=user)
172            decode += ("%s(machInst, %s, RN, %s, imm);\n" % \
173                       (className, dests, addStr))
174        else:
175            if load:
176                if d:
177                    className = loadDoubleRegClassName(post, add, writeback)
178                else:
179                    className = loadRegClassName(post, add, writeback, \
180                                                 size=size, sign=sign, \
181                                                 user=user)
182            else:
183                if d:
184                    className = storeDoubleRegClassName(post, add, writeback)
185                else:
186                    className = storeRegClassName(post, add, writeback, \
187                                                  size=size, sign=sign, \
188                                                  user=user)
189            decode += ("%s(machInst, %s, RN, %s, 0, LSL, RM);\n" % \
190                       (className, dests, addStr))
191        return decode
192
193    def decodePuiw(load, d, size=4, sign=False):
194        global decodePuiwCase
195        decode = "switch (puiw) {\n"
196        for p in (0, 1):
197            for u in (0, 1):
198                for i in (0, 1):
199                    for w in (0, 1):
200                        decode += decodePuiwCase(load, d, p, u, i, w,
201                                                 size, sign)
202        decode += '''
203          default:
204            return new Unknown(machInst);
205        }
206        '''
207        return decode
208
209    subs = {
210        "ldrh" : decodePuiw(True, False, size=2),
211        "strh" : decodePuiw(False, False, size=2),
212        "ldrsb" : decodePuiw(True, False, size=1, sign=True),
213        "ldrd" : decodePuiw(True, True),
214        "ldrsh" : decodePuiw(True, False, size=2, sign=True),
215        "strd" : decodePuiw(False, True)
216    }
217    decode_block = decode % subs
218}};
219
220def format ArmSyncMem() {{
221    decode_block = '''
222    {
223        const IntRegIndex rn = (IntRegIndex)(uint32_t)bits(machInst, 19, 16);
224        const IntRegIndex rt = (IntRegIndex)(uint32_t)bits(machInst, 15, 12);
225        const IntRegIndex rt2 = (IntRegIndex)(uint32_t)bits(machInst, 3, 0);
226        switch (PUBWL) {
227          case 0x10:
228            return new Swp(machInst, rt, rt2, rn);
229          case 0x14:
230            return new Swpb(machInst, rt, rt2, rn);
231          case 0x18:
232            return new WarnUnimplemented("strex", machInst);
233          case 0x19:
234            return new %(ldrex)s(machInst, rt, rn, true, 0);
235          case 0x1a:
236            return new WarnUnimplemented("strexd", machInst);
237          case 0x1b:
238            return new WarnUnimplemented("ldrexd", machInst);
239          case 0x1c:
240            return new WarnUnimplemented("strexb", machInst);
241          case 0x1d:
242            return new %(ldrexb)s(machInst, rt, rn, true, 0);
243          case 0x1e:
244            return new WarnUnimplemented("strexh", machInst);
245          case 0x1f:
246            return new %(ldrexh)s(machInst, rt, rn, true, 0);
247          default:
248            return new Unknown(machInst);
249        }
250    }
251    ''' % {
252        "ldrex" : "LDREX_" + loadImmClassName(False, True, False, size=4),
253        "ldrexb" : "LDREXB_" + loadImmClassName(False, True, False, size=1),
254        "ldrexh" : "LDREXH_" + loadImmClassName(False, True, False, size=2)
255    }
256}};
257
258def format Thumb32LdrStrDExTbh() {{
259    decode_block = '''
260    {
261        const uint32_t op1 = bits(machInst, 24, 23);
262        const uint32_t op2 = bits(machInst, 21, 20);
263        const uint32_t op3 = bits(machInst, 7, 4);
264        const IntRegIndex rn = (IntRegIndex)(uint32_t)bits(machInst, 19, 16);
265        const IntRegIndex rt = (IntRegIndex)(uint32_t)bits(machInst, 15, 12);
266        /* This isn't used yet, and that makes gcc upset. */
267        //const IntRegIndex rt2 = (IntRegIndex)(uint32_t)bits(machInst, 11, 8);
268        if (bits(op1, 1) == 0 && bits(op2, 1) == 0) {
269            if (op1 == 0) {
270                const uint32_t imm = bits(machInst, 7, 0) << 2;
271                if (op2 == 0) {
272                    return new WarnUnimplemented("strex", machInst);
273                } else {
274                    return new %(ldrex)s(machInst, rt, rn, true, imm);
275                }
276            } else {
277                if (op2 == 0) {
278                    switch (op3) {
279                      case 0x4:
280                        return new WarnUnimplemented("strexb", machInst);
281                      case 0x5:
282                        return new WarnUnimplemented("strexh", machInst);
283                      case 0x7:
284                        return new WarnUnimplemented("strexd", machInst);
285                      default:
286                        return new Unknown(machInst);
287                    }
288                } else {
289                    switch (op3) {
290                      case 0x0:
291                        return new WarnUnimplemented("tbb", machInst);
292                      case 0x1:
293                        return new WarnUnimplemented("tbh", machInst);
294                      case 0x4:
295                        return new %(ldrexb)s(machInst, rt, rn, true, 0);
296                      case 0x5:
297                        return new %(ldrexh)s(machInst, rt, rn, true, 0);
298                      case 0x7:
299                        return new WarnUnimplemented("ldrexd", machInst);
300                      default:
301                        return new Unknown(machInst);
302                    }
303                }
304            }
305        } else {
306            if (bits(op2, 0) == 0) {
307                return new WarnUnimplemented("strd", machInst);
308            } else {
309                return new WarnUnimplemented("ldrd", machInst);
310            }
311        }
312    }
313    ''' % {
314        "ldrex" : "LDREX_" + loadImmClassName(False, True, False, size=4),
315        "ldrexb" : "LDREXB_" + loadImmClassName(False, True, False, size=1),
316        "ldrexh" : "LDREXH_" + loadImmClassName(False, True, False, size=2)
317    }
318}};
319
320def format Thumb32LoadWord() {{
321    decode = '''
322    {
323        uint32_t op1 = bits(machInst, 24, 23);
324        if (bits(op1, 1) == 0) {
325            uint32_t op2 = bits(machInst, 11, 6);
326            if (HTRN == 0xF) {
327                if (UP) {
328                    return new %(literal_u)s(machInst, RT, INTREG_PC,
329                                             true, IMMED_11_0);
330                } else {
331                    return new %(literal)s(machInst, RT, INTREG_PC,
332                                           false, IMMED_11_0);
333                }
334            } else if (op1 == 0x1) {
335                return new %(imm_pu)s(machInst, RT, RN, true, IMMED_11_0);
336            } else if (op2 == 0) {
337                return new %(register)s(machInst, RT, RN, UP,
338                                        bits(machInst, 5, 4), LSL, RM);
339            } else if ((op2 & 0x3c) == 0x38) {
340                return new %(ldrt)s(machInst, RT, RN, true, IMMED_7_0);
341            } else if ((op2 & 0x3c) == 0x30 || //P
342                       (op2 & 0x24) == 0x24) { //W
343                uint32_t puw = bits(machInst, 10, 8);
344                uint32_t imm = IMMED_7_0;
345                switch (puw) {
346                  case 0:
347                  case 2:
348                    // If we're here, either P or W must have been set.
349                    panic("Neither P or W set, but that "
350                            "shouldn't be possible.\\n");
351                  case 1:
352                    return new %(imm_w)s(machInst, RT, RN, false, imm);
353                  case 3:
354                    return new %(imm_uw)s(machInst, RT, RN, true, imm);
355                  case 4:
356                    return new %(imm_p)s(machInst, RT, RN, false, imm);
357                  case 5:
358                    return new %(imm_pw)s(machInst, RT, RN, false, imm);
359                  case 6:
360                    return new %(imm_pu)s(machInst, RT, RN, true, imm);
361                  case 7:
362                    return new %(imm_puw)s(machInst, RT, RN, true, imm);
363                }
364            }
365        } else {
366            return new Unknown(machInst);
367        }
368    }
369    '''
370    classNames = {
371        "literal_u" : loadImmClassName(False, True, False),
372        "literal" : loadImmClassName(False, False, False),
373        "register" : loadRegClassName(False, True, False),
374        "ldrt" : loadImmClassName(False, True, False, user=True),
375        "imm_w" : loadImmClassName(True, False, True),
376        "imm_uw" : loadImmClassName(True, True, True),
377        "imm_p" : loadImmClassName(False, False, False),
378        "imm_pw" : loadImmClassName(False, False, True),
379        "imm_pu" : loadImmClassName(False, True, False),
380        "imm_puw" : loadImmClassName(False, True, True)
381    }
382    decode_block = decode % classNames
383}};
384
385def format Thumb32StoreSingle() {{
386    def buildPuwDecode(size):
387        puwDecode = '''
388                {
389                    uint32_t puw = bits(machInst, 10, 8);
390                    uint32_t imm = IMMED_7_0;
391                    switch (puw) {
392                      case 0:
393                      case 2:
394                        // If we're here, either P or W must have been set.
395                        panic("Neither P or W set, but that "
396                                "shouldn't be possible.\\n");
397                      case 1:
398                        return new %(imm_w)s(machInst, RT, RN, false, imm);
399                      case 3:
400                        return new %(imm_uw)s(machInst, RT, RN, true, imm);
401                      case 4:
402                        return new %(imm_p)s(machInst, RT, RN, false, imm);
403                      case 5:
404                        return new %(imm_pw)s(machInst, RT, RN, false, imm);
405                      case 6:
406                        return new %(imm_pu)s(machInst, RT, RN, true, imm);
407                      case 7:
408                        return new %(imm_puw)s(machInst, RT, RN, true, imm);
409                    }
410                }
411        '''
412        return puwDecode % {
413            "imm_w" : storeImmClassName(True, False, True, size=size),
414            "imm_uw" : storeImmClassName(True, True, True, size=size),
415            "imm_p" : storeImmClassName(False, False, False, size=size),
416            "imm_pw" : storeImmClassName(False, False, True, size=size),
417            "imm_pu" : storeImmClassName(False, True, False, size=size),
418            "imm_puw" : storeImmClassName(False, True, True, size=size)
419        }
420    decode = '''
421    {
422        uint32_t op1 = bits(machInst, 23, 21);
423        uint32_t op2 = bits(machInst, 11, 6);
424        bool op2Puw = ((op2 & 0x24) == 0x24 ||
425                       (op2 & 0x3c) == 0x30);
426        if (op1 == 4) {
427            return new %(strb_imm)s(machInst, RT, RN, true, IMMED_11_0);
428        } else if (op1 == 0 && op2Puw) {
429            %(strb_puw)s;
430        } else if (op1 == 0 && ((op2 & 0x3c) == 0x38)) {
431            return new %(strbt)s(machInst, RT, RN, true, IMMED_7_0);
432        } else if (op1 == 0 && op2 == 0) {
433            return new %(strb_reg)s(machInst, RT, RN, true,
434                                    bits(machInst, 5, 4), LSL, RM);
435        } else if (op1 == 5) {
436            return new %(strh_imm)s(machInst, RT, RN, true, IMMED_11_0);
437        } else if (op1 == 1 && op2Puw) {
438            %(strh_puw)s;
439        } else if (op1 == 1 && ((op2 & 0x3c) == 0x38)) {
440            return new %(strht)s(machInst, RT, RN, true, IMMED_7_0);
441        } else if (op1 == 1 && op2 == 0) {
442            return new %(strh_reg)s(machInst, RT, RN, true,
443                                    bits(machInst, 5, 4), LSL, RM);
444        } else if (op1 == 6) {
445            return new %(str_imm)s(machInst, RT, RN, true, IMMED_11_0);
446        } else if (op1 == 2 && op2Puw) {
447            %(str_puw)s;
448        } else if (op1 == 2 && ((op2 & 0x3c) == 0x38)) {
449            return new %(strt)s(machInst, RT, RN, true, IMMED_7_0);
450        } else if (op1 == 2 && op2 == 0) {
451            return new %(str_reg)s(machInst, RT, RN, true,
452                                   bits(machInst, 5, 4), LSL, RM);
453        } else {
454            return new Unknown(machInst);
455        }
456    }
457    '''
458    classNames = {
459        "strb_imm" : storeImmClassName(False, True, False, size=1),
460        "strb_puw" : buildPuwDecode(1),
461        "strbt" : storeImmClassName(False, True, False, user=True, size=1),
462        "strb_reg" : storeRegClassName(False, True, False, size=1),
463        "strh_imm" : storeImmClassName(False, True, False, size=2),
464        "strh_puw" : buildPuwDecode(2),
465        "strht" : storeImmClassName(False, True, False, user=True, size=2),
466        "strh_reg" : storeRegClassName(False, True, False, size=2),
467        "str_imm" : storeImmClassName(False, True, False),
468        "str_puw" : buildPuwDecode(4),
469        "strt" : storeImmClassName(False, True, False, user=True),
470        "str_reg" : storeRegClassName(False, True, False)
471    }
472    decode_block = decode % classNames
473}};
474
475def format LoadByteMemoryHints() {{
476    decode = '''
477    {
478        const uint32_t op1 = bits(machInst, 24, 23);
479        const uint32_t op2 = bits(machInst, 11, 6);
480        const IntRegIndex rn = (IntRegIndex)(uint32_t)bits(machInst, 19, 16);
481        const IntRegIndex rt = (IntRegIndex)(uint32_t)bits(machInst, 15, 12);
482        const IntRegIndex rm = (IntRegIndex)(uint32_t)bits(machInst, 3, 0);
483        const uint32_t imm12 = bits(machInst, 11, 0);
484        const uint32_t imm8 = bits(machInst, 7, 0);
485        bool pldw = bits(machInst, 21);
486        const uint32_t imm2 = bits(machInst, 5, 4);
487        if (rn == 0xf) {
488            if (rt == 0xf) {
489                const bool add = bits(machInst, 23);
490                if (bits(op1, 1) == 1) {
491                    if (add) {
492                        return new %(pli_iulit)s(machInst, INTREG_ZERO,
493                                                 INTREG_PC, true, imm12);
494                    } else {
495                        return new %(pli_ilit)s(machInst, INTREG_ZERO,
496                                                INTREG_PC, false, imm12);
497                    }
498                } else {
499                    if (add) {
500                        return new %(pld_iulit)s(machInst, INTREG_ZERO,
501                                                 INTREG_PC, true, imm12);
502                    } else {
503                        return new %(pld_ilit)s(machInst, INTREG_ZERO,
504                                                INTREG_PC, false, imm12);
505                    }
506                }
507            } else {
508                if (bits(op1, 1) == 1) {
509                    if (bits(machInst, 23)) {
510                        return new %(ldrsb_lit_u)s(machInst, rt, INTREG_PC,
511                                                   true, imm12);
512                    } else {
513                        return new %(ldrsb_lit)s(machInst, rt, INTREG_PC,
514                                                 false, imm12);
515                    }
516                } else {
517                    if (bits(machInst, 23)) {
518                        return new %(ldrb_lit_u)s(machInst, rt, INTREG_PC,
519                                                  true, imm12);
520                    } else {
521                        return new %(ldrb_lit)s(machInst, rt, INTREG_PC,
522                                                false, imm12);
523                    }
524                }
525            }
526        } else if (rt == 0xf) {
527            switch (op1) {
528              case 0x0:
529                if (op2 == 0x0) {
530                    if (pldw) {
531                        return new %(pldw_radd)s(machInst, INTREG_ZERO,
532                                                 rn, true, imm2, LSL, rm);
533                    } else {
534                        return new %(pld_radd)s(machInst, INTREG_ZERO,
535                                                rn, true, imm2, LSL, rm);
536                    }
537                } else if (bits(op2, 5, 2) == 0xc) {
538                    if (pldw) {
539                        return new %(pldw_isub)s(machInst, INTREG_ZERO,
540                                                 rn, false, imm8);
541                    } else {
542                        return new %(pld_isub)s(machInst, INTREG_ZERO,
543                                                rn, false, imm8);
544                    }
545                }
546                break;
547              case 0x1:
548                if (pldw) {
549                    return new %(pldw_iadd)s(machInst, INTREG_ZERO,
550                                             rn, true, imm12);
551                } else {
552                    return new %(pld_iadd)s(machInst, INTREG_ZERO,
553                                            rn, true, imm12);
554                }
555              case 0x2:
556                if (op2 == 0x0) {
557                    return new %(pli_radd)s(machInst, INTREG_ZERO, rn,
558                                            true, imm2, LSL, rm);
559                } else if (bits(op2, 5, 2) == 0xc) {
560                    return new %(pli_ilit)s(machInst, INTREG_ZERO,
561                                            INTREG_PC, false, imm8);
562                }
563                break;
564              case 0x3:
565                return new %(pli_iulit)s(machInst, INTREG_ZERO,
566                                        INTREG_PC, true, imm12);
567            }
568            return new Unknown(machInst);
569        } else {
570            switch (op1) {
571              case 0x0:
572                if (op2 == 0) {
573                    return new %(ldrb_radd)s(machInst, rt, rn, true,
574                                             imm2, LSL, rm);
575                } else if (bits(op2, 5, 2) == 0xe) {
576                    return new %(ldrbt)s(machInst, rt, rn, true, imm8);
577                } else if ((op2 & 0x24) == 0x24 || bits(op2, 5, 2) == 0xc) {
578                    const uint32_t puw = bits(machInst, 10, 8);
579                    switch (puw) {
580                      case 0x1:
581                        return new %(ldrb_iw)s(machInst, rt,
582                                               rn, false, imm8);
583                      case 0x3:
584                        return new %(ldrb_iuw)s(machInst, rt,
585                                                rn, true, imm8);
586                      case 0x4:
587                        return new %(ldrb_ip)s(machInst, rt,
588                                               rn, false, imm8);
589                      case 0x5:
590                        return new %(ldrb_ipw)s(machInst, rt,
591                                                rn, false, imm8);
592                      case 0x7:
593                        return new %(ldrb_ipuw)s(machInst, rt,
594                                                 rn, true, imm8);
595                    }
596                }
597                break;
598              case 0x1:
599                return new %(ldrb_iadd)s(machInst, rt, rn, true, imm12);
600              case 0x2:
601                if (op2 == 0) {
602                    return new %(ldrsb_radd)s(machInst, rt, rn, true,
603                                              imm2, LSL, rm);
604                } else if (bits(op2, 5, 2) == 0xe) {
605                    return new %(ldrsbt)s(machInst, rt, rn, true, imm8);
606                } else if ((op2 & 0x24) == 0x24 || bits(op2, 5, 2) == 0xc) {
607                    const uint32_t puw = bits(machInst, 10, 8);
608                    switch (puw) {
609                      case 0x1:
610                        return new %(ldrsb_iw)s(machInst, rt,
611                                                rn, false, imm8);
612                      case 0x3:
613                        return new %(ldrsb_iuw)s(machInst, rt,
614                                                 rn, true, imm8);
615                      case 0x4:
616                        return new %(ldrsb_ip)s(machInst, rt,
617                                                rn, false, imm8);
618                      case 0x5:
619                        return new %(ldrsb_ipw)s(machInst, rt,
620                                                 rn, false, imm8);
621                      case 0x7:
622                        return new %(ldrsb_ipuw)s(machInst, rt,
623                                                  rn, true, imm8);
624                    }
625                }
626                break;
627              case 0x3:
628                return new %(ldrsb_iadd)s(machInst, rt, rn, true, imm12);
629            }
630            return new Unknown(machInst);
631        }
632    }
633    '''
634    substDict = {
635        "ldrsb_lit_u" : loadImmClassName(False, True, False, 1, True),
636        "ldrsb_lit" : loadImmClassName(False, False, False, 1, True),
637        "ldrb_lit_u" : loadImmClassName(False, True, False, 1),
638        "ldrb_lit" : loadImmClassName(False, False, False, 1),
639        "ldrsb_radd" : loadRegClassName(False, True, False, 1, True),
640        "ldrb_radd" : loadRegClassName(False, True, False, 1),
641        "ldrsb_iw" : loadImmClassName(True, False, True, 1, True),
642        "ldrsb_iuw" : loadImmClassName(True, True, True, 1, True),
643        "ldrsb_ip" : loadImmClassName(False, False, False, 1, True),
644        "ldrsb_ipw" : loadImmClassName(False, False, True, 1, True),
645        "ldrsb_ipuw" : loadImmClassName(False, True, True, 1, True),
646        "ldrsb_iadd" : loadImmClassName(False, True, False, 1, True),
647        "ldrb_iw" : loadImmClassName(True, False, True, 1),
648        "ldrb_iuw" : loadImmClassName(True, True, True, 1),
649        "ldrb_ip" : loadImmClassName(False, False, False, 1),
650        "ldrb_ipw" : loadImmClassName(False, False, True, 1),
651        "ldrb_ipuw" : loadImmClassName(False, True, True, 1),
652        "ldrb_iadd" : loadImmClassName(False, True, False, 1),
653        "ldrbt" : loadImmClassName(False, True, False, 1, user=True),
654        "ldrsbt" : loadImmClassName(False, True, False, 1, True, user=True),
655        "pldw_radd" : "PLDW_" + loadRegClassName(False, True, False, 1),
656        "pld_radd" : "PLD_" + loadRegClassName(False, True, False, 1),
657        "pldw_isub" : "PLDW_" + loadImmClassName(False, False, False, 1),
658        "pld_isub" : "PLD_" + loadImmClassName(False, False, False, 1),
659        "pldw_iadd" : "PLDW_" + loadImmClassName(False, True, False, 1),
660        "pld_iadd" : "PLD_" + loadImmClassName(False, True, False, 1),
661        "pld_iulit" : "PLD_" + loadImmClassName(False, True, False, 1),
662        "pld_ilit" : "PLD_" + loadImmClassName(False, False, False, 1),
663        "pli_iulit" : "PLI_" + loadImmClassName(False, True, False, 1),
664        "pli_ilit" : "PLI_" + loadImmClassName(False, False, False, 1),
665        "pli_radd" : "PLI_" + loadRegClassName(False, True, False, 1),
666        "pli_iulit" : "PLI_" + loadImmClassName(False, True, False, 1),
667        "pli_ilit" : "PLI_" + loadImmClassName(False, False, False, 1)
668    }
669    decode_block = decode % substDict
670}};
671
672def format LoadHalfwordMemoryHints() {{
673    decode = '''
674    {
675        const uint32_t op1 = bits(machInst, 24, 23);
676        const uint32_t op2 = bits(machInst, 11, 6);
677        const IntRegIndex rn = (IntRegIndex)(uint32_t)bits(machInst, 19, 16);
678        const IntRegIndex rt = (IntRegIndex)(uint32_t)bits(machInst, 15, 12);
679        const IntRegIndex rm = (IntRegIndex)(uint32_t)bits(machInst, 3, 0);
680        const uint32_t imm12 = bits(machInst, 11, 0);
681        const uint32_t imm8 = bits(machInst, 7, 0);
682        bool pldw = bits(machInst, 21);
683        const uint32_t imm2 = bits(machInst, 5, 4);
684        if (rn == 0xf) {
685            if (rt == 0xf) {
686                if (bits(op1, 1) == 1) {
687                    // Unallocated memory hint
688                    return new NopInst(machInst);
689                } else {
690                    return new Unknown(machInst);
691                }
692            } else {
693                if (bits(op1, 1) == 1) {
694                    if (bits(machInst, 23)) {
695                        return new %(ldrsh_lit_u)s(machInst, rt, INTREG_PC,
696                                                   true, imm12);
697                    } else {
698                        return new %(ldrsh_lit)s(machInst, rt, INTREG_PC,
699                                                 false, imm12);
700                    }
701                } else {
702                    if (bits(machInst, 23)) {
703                        return new %(ldrh_lit_u)s(machInst, rt, INTREG_PC,
704                                                  true, imm12);
705                    } else {
706                        return new %(ldrh_lit)s(machInst, rt, INTREG_PC,
707                                                false, imm12);
708                    }
709                }
710            }
711        } else if (rt == 0xf) {
712            switch (op1) {
713              case 0x0:
714                if (op2 == 0x0) {
715                    if (pldw) {
716                        return new %(pldw_radd)s(machInst, INTREG_ZERO,
717                                                 rn, true, imm2, LSL, rm);
718                    } else {
719                        return new %(pld_radd)s(machInst, INTREG_ZERO,
720                                                rn, true, imm2, LSL, rm);
721                    }
722                } else if (bits(op2, 5, 2) == 0xc) {
723                    if (pldw) {
724                        return new %(pldw_isub)s(machInst, INTREG_ZERO,
725                                                 rn, false, imm8);
726                    } else {
727                        return new %(pld_isub)s(machInst, INTREG_ZERO,
728                                                rn, false, imm8);
729                    }
730                }
731                break;
732              case 0x1:
733                if (pldw) {
734                    return new %(pldw_iadd)s(machInst, INTREG_ZERO,
735                                             rn, true, imm12);
736                } else {
737                    return new %(pld_iadd)s(machInst, INTREG_ZERO,
738                                            rn, true, imm12);
739                }
740              case 0x2:
741                if (op2 == 0x0 || bits(op2, 5, 2) == 0xc) {
742                    // Unallocated memory hint
743                    return new NopInst(machInst);
744                }
745                break;
746              case 0x3:
747                return new NopInst(machInst);
748            }
749            return new Unknown(machInst);
750        } else {
751            switch (op1) {
752              case 0x0:
753                if (op2 == 0) {
754                    return new %(ldrh_radd)s(machInst, rt, rn, true,
755                                             imm2, LSL, rm);
756                } else if (bits(op2, 5, 2) == 0xe) {
757                    return new %(ldrht)s(machInst, rt, rn, true, imm8);
758                } else if ((op2 & 0x24) == 0x24 || bits(op2, 5, 2) == 0xc) {
759                    const uint32_t puw = bits(machInst, 10, 8);
760                    switch (puw) {
761                      case 0x1:
762                        return new %(ldrh_iw)s(machInst, rt,
763                                               rn, false, imm8);
764                      case 0x3:
765                        return new %(ldrh_iuw)s(machInst, rt,
766                                                rn, true, imm8);
767                      case 0x4:
768                        return new %(ldrh_ip)s(machInst, rt,
769                                               rn, false, imm8);
770                      case 0x5:
771                        return new %(ldrh_ipw)s(machInst, rt,
772                                                rn, false, imm8);
773                      case 0x7:
774                        return new %(ldrh_ipuw)s(machInst, rt,
775                                                 rn, true, imm8);
776                    }
777                }
778                break;
779              case 0x1:
780                return new %(ldrh_iadd)s(machInst, rt, rn, true, imm12);
781              case 0x2:
782                if (op2 == 0) {
783                    return new %(ldrsh_radd)s(machInst, rt, rn, true,
784                                              imm2, LSL, rm);
785                } else if (bits(op2, 5, 2) == 0xe) {
786                    return new %(ldrsht)s(machInst, rt, rn, true, imm8);
787                } else if ((op2 & 0x24) == 0x24 || bits(op2, 5, 2) == 0xc) {
788                    const uint32_t puw = bits(machInst, 10, 8);
789                    switch (puw) {
790                      case 0x1:
791                        return new %(ldrsh_iw)s(machInst, rt,
792                                                rn, false, imm8);
793                      case 0x3:
794                        return new %(ldrsh_iuw)s(machInst, rt,
795                                                 rn, true, imm8);
796                      case 0x4:
797                        return new %(ldrsh_ip)s(machInst, rt,
798                                                rn, false, imm8);
799                      case 0x5:
800                        return new %(ldrsh_ipw)s(machInst, rt,
801                                                 rn, false, imm8);
802                      case 0x7:
803                        return new %(ldrsh_ipuw)s(machInst, rt,
804                                                  rn, true, imm8);
805                    }
806                }
807                break;
808              case 0x3:
809                return new %(ldrsh_iadd)s(machInst, rt, rn, true, imm12);
810            }
811            return new Unknown(machInst);
812        }
813    }
814    '''
815    substDict = {
816        "ldrsh_lit_u" : loadImmClassName(False, True, False, 2, True),
817        "ldrsh_lit" : loadImmClassName(False, False, False, 2, True),
818        "ldrh_lit_u" : loadImmClassName(False, True, False, 2),
819        "ldrh_lit" : loadImmClassName(False, False, False, 2),
820        "ldrsh_radd" : loadRegClassName(False, True, False, 2, True),
821        "ldrh_radd" : loadRegClassName(False, True, False, 2),
822        "ldrsh_iw" : loadImmClassName(True, False, True, 2, True),
823        "ldrsh_iuw" : loadImmClassName(True, True, True, 2, True),
824        "ldrsh_ip" : loadImmClassName(False, False, False, 2, True),
825        "ldrsh_ipw" : loadImmClassName(False, False, True, 2, True),
826        "ldrsh_ipuw" : loadImmClassName(False, True, True, 2, True),
827        "ldrsh_iadd" : loadImmClassName(False, True, False, 2, True),
828        "ldrh_iw" : loadImmClassName(True, False, True, 2),
829        "ldrh_iuw" : loadImmClassName(True, True, True, 2),
830        "ldrh_ip" : loadImmClassName(False, False, False, 2),
831        "ldrh_ipw" : loadImmClassName(False, False, True, 2),
832        "ldrh_ipuw" : loadImmClassName(False, True, True, 2),
833        "ldrh_iadd" : loadImmClassName(False, True, False, 2),
834        "ldrht" : loadImmClassName(False, True, False, 2, user=True),
835        "ldrsht" : loadImmClassName(False, True, False, 2, True, user=True),
836        "pldw_radd" : "PLDW_" + loadRegClassName(False, True, False, 1),
837        "pld_radd" : "PLD_" + loadRegClassName(False, True, False, 1),
838        "pldw_isub" : "PLDW_" + loadImmClassName(False, False, False, 1),
839        "pld_isub" : "PLD_" + loadImmClassName(False, False, False, 1),
840        "pldw_iadd" : "PLDW_" + loadImmClassName(False, True, False, 1),
841        "pld_iadd" : "PLD_" + loadImmClassName(False, True, False, 1)
842    }
843    decode_block = decode % substDict
844}};
845
846def format Thumb16MemReg() {{
847    decode = '''
848    {
849        const uint32_t opb = bits(machInst, 11, 9);
850        const uint32_t rt = bits(machInst, 2, 0);
851        const uint32_t rn = bits(machInst, 5, 3);
852        const uint32_t rm = bits(machInst, 8, 6);
853        switch (opb) {
854          case 0x0:
855            return new %(str)s(machInst, rt, rn, true, 0, LSL, rm);
856          case 0x1:
857            return new %(strh)s(machInst, rt, rn, true, 0, LSL, rm);
858          case 0x2:
859            return new %(strb)s(machInst, rt, rn, true, 0, LSL, rm);
860          case 0x3:
861            return new %(ldrsb)s(machInst, rt, rn, true, 0, LSL, rm);
862          case 0x4:
863            return new %(ldr)s(machInst, rt, rn, true, 0, LSL, rm);
864          case 0x5:
865            return new %(ldrh)s(machInst, rt, rn, true, 0, LSL, rm);
866          case 0x6:
867            return new %(ldrb)s(machInst, rt, rn, true, 0, LSL, rm);
868          case 0x7:
869            return new %(ldrsh)s(machInst, rt, rn, true, 0, LSL, rm);
870        }
871    }
872    '''
873    classNames = {
874        "str" : storeRegClassName(False, True, False),
875        "strh" : storeRegClassName(False, True, False, size=2),
876        "strb" : storeRegClassName(False, True, False, size=1),
877        "ldrsb" : loadRegClassName(False, True, False, sign=True, size=1),
878        "ldr" : loadRegClassName(False, True, False),
879        "ldrh" : loadRegClassName(False, True, False, size=2),
880        "ldrb" : loadRegClassName(False, True, False, size=1),
881        "ldrsh" : loadRegClassName(False, True, False, sign=True, size=2),
882    }
883    decode_block = decode % classNames
884}};
885
886def format Thumb16MemImm() {{
887    decode = '''
888    {
889        const uint32_t opa = bits(machInst, 15, 12);
890        const uint32_t opb = bits(machInst, 11, 9);
891        const uint32_t lrt = bits(machInst, 2, 0);
892        const uint32_t lrn = bits(machInst, 5, 3);
893        const uint32_t hrt = bits(machInst, 10, 8);
894        const uint32_t imm5 = bits(machInst, 10, 6);
895        const uint32_t imm8 = bits(machInst, 7, 0);
896        const bool load = bits(opb, 2);
897        switch (opa) {
898          case 0x6:
899            if (load) {
900                return new %(ldr)s(machInst, lrt, lrn, true, imm5 << 2);
901            } else {
902                return new %(str)s(machInst, lrt, lrn, true, imm5 << 2);
903            }
904          case 0x7:
905            if (load) {
906                return new %(ldrb)s(machInst, lrt, lrn, true, imm5);
907            } else {
908                return new %(strb)s(machInst, lrt, lrn, true, imm5);
909            }
910          case 0x8:
911            if (load) {
912                return new %(ldrh)s(machInst, lrt, lrn, true, imm5 << 1);
913            } else {
914                return new %(strh)s(machInst, lrt, lrn, true, imm5 << 1);
915            }
916          case 0x9:
917            if (load) {
918                return new %(ldr)s(machInst, hrt, INTREG_SP, true, imm8 << 2);
919            } else {
920                return new %(str)s(machInst, hrt, INTREG_SP, true, imm8 << 2);
921            }
922          default:
923            return new Unknown(machInst);
924        }
925    }
926    '''
927    classNames = {
928        "ldr" : loadImmClassName(False, True, False),
929        "str" : storeImmClassName(False, True, False),
930        "ldrh" : loadImmClassName(False, True, False, size=2),
931        "strh" : storeImmClassName(False, True, False, size=2),
932        "ldrb" : loadImmClassName(False, True, False, size=1),
933        "strb" : storeImmClassName(False, True, False, size=1),
934    }
935    decode_block = decode % classNames
936}};
937
938def format Thumb16MemLit() {{
939    decode_block = '''
940    {
941        const uint32_t rt = bits(machInst, 10, 8);
942        const uint32_t imm8 = bits(machInst, 7, 0);
943        return new %s(machInst, rt, INTREG_PC, true, imm8 << 2);
944    }
945    ''' % loadImmClassName(False, True, False)
946}};
947
948