basic.isa revision 12234:78ece221f9f5 
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// Declarations for execute() methods.
34def template BasicExecDeclare {{
35    Fault execute(ExecContext *, Trace::InstRecord *) const;
36}};
37
38// Basic instruction class declaration template.
39def template BasicDeclare {{
40    //
41    // Static instruction class for "%(mnemonic)s".
42    //
43    class %(class_name)s : public %(base_class)s
44    {
45      public:
46        /// Constructor.
47        %(class_name)s(MachInst machInst);
48        %(BasicExecDeclare)s
49        using %(base_class)s::generateDisassembly;
50    };
51}};
52
53// Basic instruction class constructor template.
54def template BasicConstructor {{
55    %(class_name)s::%(class_name)s(MachInst machInst)
56        : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
57    {
58        %(constructor)s;
59    }
60}};
61
62
63// Basic instruction class execute method template.
64def template BasicExecute {{
65    Fault
66    %(class_name)s::execute(ExecContext *xc,
67        Trace::InstRecord *traceData) const
68    {
69        Fault fault = NoFault;
70
71        %(op_decl)s;
72        %(op_rd)s;
73        if (fault == NoFault) {
74            %(code)s;
75            if (fault == NoFault) {
76                %(op_wb)s;
77            }
78        }
79        return fault;
80    }
81}};
82
83// Basic decode template.
84def template BasicDecode {{
85    return new %(class_name)s(machInst);
86}};
87
88// The most basic instruction format...
89def format BasicOp(code, *flags) {{
90    iop = InstObjParams(name, Name, 'RiscvStaticInst', code, flags)
91    header_output = BasicDeclare.subst(iop)
92    decoder_output = BasicConstructor.subst(iop)
93    decode_block = BasicDecode.subst(iop)
94    exec_output = BasicExecute.subst(iop)
95}};
96