src/dev/baddev.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  * Authors: Ali Saidi
  29  */
  30
  31 /** @file
  32  * This devices just panics when touched. For example if you have a
  33  * kernel that touches the frame buffer which isn't allowed.
  34  */
  35
  36 #ifndef __DEV_BADDEV_HH__
  37 #define __DEV_BADDEV_HH__
  38
  39 #include "dev/io_device.hh"
  40 #include "params/BadDevice.hh"
  41
  42 /**
  43  * BadDevice
  44  * This device just panics when accessed. It is supposed to warn
  45  * the user that the kernel they are running has unsupported
  46  * options (i.e. frame buffer)
  47  */
  48 class BadDevice : public BasicPioDevice
  49 {
  50   private:
  51     std::string devname;
  52
  53   public:
  54     typedef BadDeviceParams Params;
  55
  56   protected:
  57     const Params *
  58     params() const
  59     {
  60         return dynamic_cast<const Params *>(_params);
  61     }
  62
  63   public:
  64      /**
  65       * Constructor for the Baddev Class.
  66       * @param p object parameters
  67       * @param a base address of the write
  68       */
  69     BadDevice(Params *p);
  70
  71     virtual Tick read(PacketPtr pkt);
  72     virtual Tick write(PacketPtr pkt);
  73 };
  74
  75 #endif // __DEV_BADDEV_HH__