basic.isa revision 5222:bb733a878f85 
1// -*- mode:c++ -*-
2
3// Copyright .AN) 2007 MIPS Technologies, Inc.  All Rights Reserved
4
5//  This software is part of the M5 simulator.
6
7//  THIS IS A LEGAL AGREEMENT.  BY DOWNLOADING, USING, COPYING, CREATING
8//  DERIVATIVE WORKS, AND/OR DISTRIBUTING THIS SOFTWARE YOU ARE AGREEING
9//  TO THESE TERMS AND CONDITIONS.
10
11//  Permission is granted to use, copy, create derivative works and
12//  distribute this software and such derivative works for any purpose,
13//  so long as (1) the copyright notice above, this grant of permission,
14//  and the disclaimer below appear in all copies and derivative works
15//  made, (2) the copyright notice above is augmented as appropriate to
16//  reflect the addition of any new copyrightable work in a derivative
17//  work (e.g., Copyright .AN) <Publication Year> Copyright Owner), and (3)
18//  the name of MIPS Technologies, Inc. ($B!H(BMIPS$B!I(B) is not used in any
19//  advertising or publicity pertaining to the use or distribution of
20//  this software without specific, written prior authorization.
21
22//  THIS SOFTWARE IS PROVIDED $B!H(BAS IS.$B!I(B  MIPS MAKES NO WARRANTIES AND
23//  DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, STATUTORY, IMPLIED OR
24//  OTHERWISE, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25//  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
26//  NON-INFRINGEMENT OF THIRD PARTY RIGHTS, REGARDING THIS SOFTWARE.
27//  IN NO EVENT SHALL MIPS BE LIABLE FOR ANY DAMAGES, INCLUDING DIRECT,
28//  INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, OR PUNITIVE DAMAGES OF
29//  ANY KIND OR NATURE, ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT,
30//  THIS SOFTWARE AND/OR THE USE OF THIS SOFTWARE, WHETHER SUCH LIABILITY
31//  IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE OR
32//  STRICT LIABILITY), OR OTHERWISE, EVEN IF MIPS HAS BEEN WARNED OF THE
33//  POSSIBILITY OF ANY SUCH LOSS OR DAMAGE IN ADVANCE.
34
35//Authors: Steven K. Reinhardt
36//         Korey L. Sewell
37
38// Declarations for execute() methods.
39def template BasicExecDeclare {{
40        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
41}};
42
43// Basic instruction class declaration template.
44def template BasicDeclare {{
45        /**
46         * Static instruction class for "%(mnemonic)s".
47         */
48        class %(class_name)s : public %(base_class)s
49        {
50          public:
51                /// Constructor.
52                %(class_name)s(MachInst machInst);
53                %(BasicExecDeclare)s
54        };
55}};
56
57// Basic instruction class constructor template.
58def template BasicConstructor {{
59        inline %(class_name)s::%(class_name)s(MachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
60        {
61                %(constructor)s;
62        }
63}};
64
65
66// Basic instruction class execute method template.
67def template BasicExecute {{
68        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, Trace::InstRecord *traceData) const
69        {
70                Fault fault = NoFault;
71
72                %(fp_enable_check)s;
73                %(op_decl)s;
74                %(op_rd)s;
75                if(fault == NoFault)
76                {
77                  %(code)s;
78                  if(fault == NoFault){
79                    %(op_wb)s;
80                  }
81                }
82                return fault;
83        }
84}};
85
86// Basic decode template.
87def template BasicDecode {{
88        return new %(class_name)s(machInst);
89}};
90
91// Basic decode template, passing mnemonic in as string arg to constructor.
92def template BasicDecodeWithMnemonic {{
93        return new %(class_name)s("%(mnemonic)s", machInst);
94}};
95
96// The most basic instruction format...
97def format BasicOp(code, *flags) {{
98        iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
99        header_output = BasicDeclare.subst(iop)
100        decoder_output = BasicConstructor.subst(iop)
101        decode_block = BasicDecode.subst(iop)
102        exec_output = BasicExecute.subst(iop)
103}};
104