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