src/arch/generic/interrupts.hh

   1 /*
   2  * Copyright 2019 Google, Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met: redistributions of source code must retain the above copyright
   7  * notice, this list of conditions and the following disclaimer;
   8  * redistributions in binary form must reproduce the above copyright
   9  * notice, this list of conditions and the following disclaimer in the
  10  * documentation and/or other materials provided with the distribution;
  11  * neither the name of the copyright holders nor the names of its
  12  * contributors may be used to endorse or promote products derived from
  13  * this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef __ARCH_GENERIC_INTERRUPTS_HH__
  29 #define __ARCH_GENERIC_INTERRUPTS_HH__
  30
  31 #include "params/BaseInterrupts.hh"
  32 #include "sim/sim_object.hh"
  33
  34 class ThreadContext;
  35 class BaseCPU;
  36
  37 class BaseInterrupts : public SimObject
  38 {
  39   protected:
  40     ThreadContext *tc = nullptr;
  41
  42   public:
  43     typedef BaseInterruptsParams Params;
  44
  45     BaseInterrupts(Params *p) : SimObject(p) {}
  46
  47     virtual void setThreadContext(ThreadContext *_tc) { tc = _tc; }
  48
  49     const Params *
  50     params() const
  51     {
  52         return dynamic_cast<const Params *>(_params);
  53     }
  54
  55     /*
  56      * Functions for retrieving interrupts for the CPU to handle.
  57      */
  58
  59     /*
  60      * Return whether there are any interrupts waiting to be recognized.
  61      */
  62     virtual bool checkInterrupts() const = 0;
  63     /*
  64      * Return an interrupt to process. This should return an interrupt exactly
  65      * when checkInterrupts returns true.
  66      */
  67     virtual Fault getInterrupt() = 0;
  68     /*
  69      * Update interrupt related state after an interrupt has been processed.
  70      */
  71     virtual void updateIntrInfo() = 0;
  72
  73     /*
  74      * Old functions needed for compatability but which will be phased out
  75      * eventually.
  76      */
  77     virtual void
  78     post(int int_num, int index)
  79     {
  80         panic("Interrupts::post unimplemented!\n");
  81     }
  82
  83     virtual void
  84     clear(int int_num, int index)
  85     {
  86         panic("Interrupts::clear unimplemented!\n");
  87     }
  88
  89     virtual void
  90     clearAll()
  91     {
  92         panic("Interrupts::clearAll unimplemented!\n");
  93     }
  94 };
  95
  96 #endif // __ARCH_GENERIC_INTERRUPTS_HH__