1#!/usr/bin/env python3
2
3##
4##  Copyright(c) 2019-2023 rev.ng Labs Srl. All Rights Reserved.
5##
6##  This program is free software; you can redistribute it and/or modify
7##  it under the terms of the GNU General Public License as published by
8##  the Free Software Foundation; either version 2 of the License, or
9##  (at your option) any later version.
10##
11##  This program is distributed in the hope that it will be useful,
12##  but WITHOUT ANY WARRANTY; without even the implied warranty of
13##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14##  GNU General Public License for more details.
15##
16##  You should have received a copy of the GNU General Public License
17##  along with this program; if not, see <http://www.gnu.org/licenses/>.
18##
19
20import sys
21import re
22import string
23from io import StringIO
24
25import hex_common
26
27
28##
29## Generate code to be fed to the idef_parser
30##
31## Consider A2_add:
32##
33##     Rd32=add(Rs32,Rt32), { RdV=RsV+RtV;}
34##
35## We produce:
36##
37##     A2_add(RdV, in RsV, in RtV) {
38##       { RdV=RsV+RtV;}
39##     }
40##
41## A2_add represents the instruction tag. Then we have a list of TCGv
42## that the code generated by the parser can expect in input. Some of
43## them are inputs ("in" prefix), while some others are outputs.
44##
45def main():
46    hex_common.read_semantics_file(sys.argv[1])
47    hex_common.read_attribs_file(sys.argv[2])
48    hex_common.calculate_attribs()
49    tagregs = hex_common.get_tagregs()
50    tagimms = hex_common.get_tagimms()
51
52    with open(sys.argv[3], "w") as f:
53        f.write('#include "macros.inc"\n\n')
54
55        for tag in hex_common.tags:
56            ## Skip the priv instructions
57            if "A_PRIV" in hex_common.attribdict[tag]:
58                continue
59            ## Skip the guest instructions
60            if "A_GUEST" in hex_common.attribdict[tag]:
61                continue
62            ## Skip instructions that saturate in a ternary expression
63            if tag in {"S2_asr_r_r_sat", "S2_asl_r_r_sat"}:
64                continue
65            ## Skip instructions using switch
66            if tag in {"S4_vrcrotate_acc", "S4_vrcrotate"}:
67                continue
68            ## Skip trap instructions
69            if tag in {"J2_trap0", "J2_trap1"}:
70                continue
71            ## Skip 128-bit instructions
72            if tag in {"A7_croundd_ri", "A7_croundd_rr"}:
73                continue
74            if tag in {
75                "M7_wcmpyrw",
76                "M7_wcmpyrwc",
77                "M7_wcmpyiw",
78                "M7_wcmpyiwc",
79                "M7_wcmpyrw_rnd",
80                "M7_wcmpyrwc_rnd",
81                "M7_wcmpyiw_rnd",
82                "M7_wcmpyiwc_rnd",
83            }:
84                continue
85            ## Skip interleave/deinterleave instructions
86            if tag in {"S2_interleave", "S2_deinterleave"}:
87                continue
88            ## Skip instructions using bit reverse
89            if tag in {
90                "S2_brev",
91                "S2_brevp",
92                "S2_ct0",
93                "S2_ct1",
94                "S2_ct0p",
95                "S2_ct1p",
96                "A4_tlbmatch",
97            }:
98                continue
99            ## Skip other unsupported instructions
100            if tag == "S2_cabacdecbin" or tag == "A5_ACS":
101                continue
102            if tag.startswith("Y"):
103                continue
104            if tag.startswith("V6_"):
105                continue
106            if ( tag.startswith("F") and
107                 tag not in {
108                     "F2_sfimm_p",
109                     "F2_sfimm_n",
110                     "F2_dfimm_p",
111                     "F2_dfimm_n",
112                     "F2_dfmpyll",
113                     "F2_dfmpylh"
114                 }):
115                continue
116            if tag.endswith("_locked"):
117                continue
118            if "A_COF" in hex_common.attribdict[tag]:
119                continue
120            if ( tag.startswith('R6_release_') ):
121                continue
122            ## Skip instructions that are incompatible with short-circuit
123            ## packet register writes
124            if ( tag == 'S2_insert' or
125                 tag == 'S2_insert_rp' or
126                 tag == 'S2_asr_r_svw_trun' or
127                 tag == 'A2_swiz' ):
128                continue
129
130            regs = tagregs[tag]
131            imms = tagimms[tag]
132
133            arguments = []
134            for regtype, regid in regs:
135                prefix = "in " if hex_common.is_read(regid) else ""
136
137                is_pair = hex_common.is_pair(regid)
138                is_single_old = hex_common.is_single(regid) and hex_common.is_old_val(
139                    regtype, regid, tag
140                )
141                is_single_new = hex_common.is_single(regid) and hex_common.is_new_val(
142                    regtype, regid, tag
143                )
144
145                if is_pair or is_single_old:
146                    arguments.append(f"{prefix}{regtype}{regid}V")
147                elif is_single_new:
148                    arguments.append(f"{prefix}{regtype}{regid}N")
149                else:
150                    hex_common.bad_register(regtype, regid)
151
152            for immlett, bits, immshift in imms:
153                arguments.append(hex_common.imm_name(immlett))
154
155            f.write(f"{tag}({', '.join(arguments)}) {{\n")
156            f.write("    ")
157            if hex_common.need_ea(tag):
158                f.write("size4u_t EA; ")
159            f.write(f"{hex_common.semdict[tag]}\n")
160            f.write("}\n\n")
161
162
163if __name__ == "__main__":
164    main()
165