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: Stephen Hines
42
43////////////////////////////////////////////////////////////////////
44//
45// Memory-format instructions
46//
47
48def template LoadStoreDeclare {{
49 /**
50 * Static instruction class for "%(mnemonic)s".
51 */
52 class %(class_name)s : public %(base_class)s
53 {
54 public:
55
56 /// Constructor.
57 %(class_name)s(ExtMachInst machInst);
58
59 %(BasicExecDeclare)s
60
61 %(InitiateAccDeclare)s
62
63 %(CompleteAccDeclare)s
64 };
65}};
66
67
68def template InitiateAccDeclare {{
69 Fault initiateAcc(%(CPU_exec_context)s *, Trace::InstRecord *) const;
70}};
71
72
73def template CompleteAccDeclare {{
74 Fault completeAcc(PacketPtr, %(CPU_exec_context)s *, Trace::InstRecord *) const;
75}};
76
77
78def template LoadStoreConstructor {{
79 inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
80 : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
81 {
82 %(constructor)s;
83 }
84}};
85
86let {{
87 def buildPUBWLCase(p, u, b, w, l):
88 return (p << 4) + (u << 3) + (b << 2) + (w << 1) + (l << 0)
89
90 def buildMode3Inst(p, u, i, w, type, code, mnem):
91 op = ("-", "+")[u]
92 offset = ("%s Rm", "%s hilo")[i] % op
93 ea_code = "EA = Rn %s;" % ("", offset)[p]
94 if p == 0 or w == 1:
95 code += "Rn = Rn %s;" % offset
96 newSuffix = "_P%dU%dI%dW%d" % (p, u, i, w)
97 suffix = ("Reg", "Hilo")[i]
98 return LoadStoreBase(mnem, mnem.capitalize() + newSuffix,
99 ea_code, code, mem_flags = [], inst_flags = [],
100 base_class = 'Memory' + suffix,
101 exec_template_base = type.capitalize())
102}};
103
104def format AddrMode2(imm) {{
105 if eval(imm):
106 imm = True
107 else:
108 imm = False
109
110 header_output = decoder_output = exec_output = ""
111 decode_block = "switch(PUBWL) {\n"
112
113 # Loop over all the values of p, u, b, w and l and build instructions and
114 # a decode block for them.
115 for p in (0, 1):
116 for u in (0, 1):
117 for b in (0, 1):
118 for w in (0, 1):
119 post = (p == 0)
120 user = (p == 0 and w == 0)
121 writeback = (p == 0 or w == 1)
122 add = (u == 1)
123 if b == 0:
124 size = 4
125 else:
126 size = 1
127 if add:
128 addStr = "true"
129 else:
130 addStr = "false"
131 if imm:
132 newDecode = "return new %s(machInst, RD, RN," + \
133 "%s, machInst.immed11_0);"
134 loadClass = loadImmClassName(post, add, writeback,
135 size, False, user)
136 storeClass = storeImmClassName(post, add, writeback,
137 size, False, user)
138 loadDecode = newDecode % (loadClass, addStr)
139 storeDecode = newDecode % (storeClass, addStr)
140 else:
141 newDecode = "return new %s(machInst, RD, RN, %s," + \
142 "machInst.shiftSize," + \
143 "machInst.shift, RM);"
144 loadClass = loadRegClassName(post, add, writeback,
145 size, False, user)
146 storeClass = storeRegClassName(post, add, writeback,
147 size, False, user)
148 loadDecode = newDecode % (loadClass, addStr)
149 storeDecode = newDecode % (storeClass, addStr)
150 decode = '''
151 case %#x:
152 {%s}
153 break;
154 '''
155 decode_block += decode % \
156 (buildPUBWLCase(p,u,b,w,1), loadDecode)
157 decode_block += decode % \
158 (buildPUBWLCase(p,u,b,w,0), storeDecode)
159 decode_block += '''
160 default:
161 return new Unknown(machInst);
162 break;
163 }'''
164}};
165
166def format AddrMode3(l0Type, l0Code, l1Type, l1Code) {{
167 l0Code = ArmGenericCodeSubs(l0Code);
168 l1Code = ArmGenericCodeSubs(l1Code);
169
170 header_output = decoder_output = exec_output = ""
171 decode_block = "switch(PUBWL) {\n"
172 (l0Mnem, l1Mnem) = name.split("_");
173
174 # Loop over all the values of p, u, i, w and l and build instructions and
175 # a decode block for them.
176 for (l, type, code, mnem) in ((0, l0Type, l0Code, l0Mnem),
177 (1, l1Type, l1Code, l1Mnem)):
178 for p in (0, 1):
179 wset = (0, 1)
180 if (p == 0):
181 wset = (0,)
182 for u in (0, 1):
183 for i in (0, 1):
184 for w in wset:
185 (new_header_output,
186 new_decoder_output,
187 new_decode_block,
188 new_exec_output) = buildMode3Inst(p, u, i, w,
189 type, code, mnem)
190 header_output += new_header_output
191 decoder_output += new_decoder_output
192 exec_output += new_exec_output
193 decode_block += '''
194 case %#x:
195 {%s}
196 break;
197 ''' % (buildPUBWLCase(p,u,i,w,l), new_decode_block)
198
199 decode_block += '''
200 default:
201 return new Unknown(machInst);
202 break;
203 }'''
204}};
205
206def format ArmLoadMemory(memacc_code, ea_code = {{ EA = Rn + disp; }},
207 mem_flags = [], inst_flags = []) {{
208 ea_code = ArmGenericCodeSubs(ea_code)
209 memacc_code = ArmGenericCodeSubs(memacc_code)
210 (header_output, decoder_output, decode_block, exec_output) = \
211 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
212 decode_template = BasicDecode,
213 exec_template_base = 'Load')
214}};
215
216def format ArmStoreMemory(memacc_code, ea_code = {{ EA = Rn + disp; }},
217 mem_flags = [], inst_flags = []) {{
218 ea_code = ArmGenericCodeSubs(ea_code)
219 memacc_code = ArmGenericCodeSubs(memacc_code)
220 (header_output, decoder_output, decode_block, exec_output) = \
221 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
222 exec_template_base = 'Store')
223}};
224