dev/platform.hh

   1 /*
   2  * Copyright (c) 2004-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  * Generic interface for platforms
  32  */
  33
  34 #ifndef __DEV_PLATFORM_HH__
  35 #define __DEV_PLATFORM_HH__
  36
  37 #include "sim/sim_object.hh"
  38 #include "arch/isa_traits.hh"
  39
  40 class PciConfigAll;
  41 class IntrControl;
  42 class SimConsole;
  43 class Uart;
  44 class System;
  45
  46 class Platform : public SimObject
  47 {
  48   public:
  49     /** Pointer to the interrupt controller */
  50     IntrControl *intrctrl;
  51
  52     /** Pointer to the PCI configuration space */
  53     PciConfigAll *pciconfig;
  54
  55     /** Pointer to the UART, set by the uart */
  56     Uart *uart;
  57
  58     /** Pointer to the system for info about the memory system. */
  59     System *system;
  60
  61   public:
  62     Platform(const std::string &name, IntrControl *intctrl);
  63     virtual ~Platform();
  64     virtual void init() { if (pciconfig == NULL) panic("PCI Config not set"); }
  65     virtual void postConsoleInt() = 0;
  66     virtual void clearConsoleInt() = 0;
  67     virtual Tick intrFrequency() = 0;
  68     virtual void postPciInt(int line);
  69     virtual void clearPciInt(int line);
  70     virtual Addr pciToDma(Addr pciAddr) const;
  71 };
  72
  73 #endif // __DEV_PLATFORM_HH__