basic.isa revision 12236:126ac9da6050 
1// -*- mode:c++ -*-
2
3// Copyright (c) 2009 The University of Edinburgh
4// All rights reserved.
5//
6// Redistribution and use in source and binary forms, with or without
7// modification, are permitted provided that the following conditions are
8// met: redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer;
10// redistributions in binary form must reproduce the above copyright
11// notice, this list of conditions and the following disclaimer in the
12// documentation and/or other materials provided with the distribution;
13// neither the name of the copyright holders nor the names of its
14// contributors may be used to endorse or promote products derived from
15// this software without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28//
29// Authors: Timothy M. Jones
30
31// Basic instruction class declaration template.
32def template BasicDeclare {{
33        /**
34         * Static instruction class for "%(mnemonic)s".
35         */
36        class %(class_name)s : public %(base_class)s
37        {
38          public:
39                /// Constructor.
40                %(class_name)s(ExtMachInst machInst);
41                Fault execute(ExecContext *, Trace::InstRecord *) const;
42        };
43}};
44
45// Basic instruction class constructor template.
46def template BasicConstructor {{
47        %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
48        {
49                %(constructor)s;
50        }
51}};
52
53
54// Basic instruction class execute method template.
55def template BasicExecute {{
56        Fault %(class_name)s::execute(
57            ExecContext *xc, Trace::InstRecord *traceData) const
58        {
59                Fault fault = NoFault;
60
61                %(op_decl)s;
62                %(op_rd)s;
63                %(code)s;
64
65                if (fault == NoFault)
66                {
67                    %(op_wb)s;
68                }
69
70                return fault;
71        }
72}};
73
74// Basic decode template.
75def template BasicDecode {{
76        return new %(class_name)s(machInst);
77}};
78
79// Basic decode template, passing mnemonic in as string arg to constructor.
80def template BasicDecodeWithMnemonic {{
81        return new %(class_name)s("%(mnemonic)s", machInst);
82}};
83
84// The most basic instruction format...
85def format BasicOp(code, *flags) {{
86        iop = InstObjParams(name, Name, 'PowerStaticInst', code, flags)
87        header_output = BasicDeclare.subst(iop)
88        decoder_output = BasicConstructor.subst(iop)
89        decode_block = BasicDecode.subst(iop)
90        exec_output = BasicExecute.subst(iop)
91}};
92