src/arch/power/isa/formats/basic.isa

   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 // Declarations for execute() methods.
  32 def template BasicExecDeclare {{
  33         Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
  34 }};
  35
  36 // Basic instruction class declaration template.
  37 def template BasicDeclare {{
  38         /**
  39          * Static instruction class for "%(mnemonic)s".
  40          */
  41         class %(class_name)s : public %(base_class)s
  42         {
  43           public:
  44                 /// Constructor.
  45                 %(class_name)s(ExtMachInst machInst);
  46                 %(BasicExecDeclare)s
  47         };
  48 }};
  49
  50 // Basic instruction class constructor template.
  51 def template BasicConstructor {{
  52         inline %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
  53         {
  54                 %(constructor)s;
  55         }
  56 }};
  57
  58
  59 // Basic instruction class execute method template.
  60 def template BasicExecute {{
  61         Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, Trace::InstRecord *traceData) const
  62         {
  63                 Fault fault = NoFault;
  64
  65                 %(op_decl)s;
  66                 %(op_rd)s;
  67                 %(code)s;
  68
  69                 if (fault == NoFault)
  70                 {
  71                     %(op_wb)s;
  72                 }
  73
  74                 return fault;
  75         }
  76 }};
  77
  78 // Basic decode template.
  79 def template BasicDecode {{
  80         return new %(class_name)s(machInst);
  81 }};
  82
  83 // Basic decode template, passing mnemonic in as string arg to constructor.
  84 def template BasicDecodeWithMnemonic {{
  85         return new %(class_name)s("%(mnemonic)s", machInst);
  86 }};
  87
  88 // Definitions of execute methods that panic.
  89 def template BasicExecPanic {{
  90 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
  91 {
  92         panic("Execute method called when it shouldn't!");
  93 }
  94 }};
  95
  96 // The most basic instruction format...
  97 def format BasicOp(code, *flags) {{
  98         iop = InstObjParams(name, Name, 'PowerStaticInst', 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 }};