dev/baddev.hh

   1 /*
   2  * Copyright (c) 2003 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 /* @file
  30  * This devices just panics when touched. For example if you have a
  31  * kernel that touches the frame buffer which isn't allowed.
  32  */
  33
  34 #ifndef __BADDEV_HH__
  35 #define __BADDEV_HH__
  36
  37 #include "mem/functional_mem/functional_memory.hh"
  38
  39 /**
  40  * BadDevice
  41  * This device just panics when accessed. It is supposed to warn
  42  * the user that the kernel they are running has unsupported
  43  * options (i.e. frame buffer)
  44  */
  45 class BadDevice : public FunctionalMemory
  46 {
  47   private:
  48     Addr addr;
  49     static const Addr size = 0xf;
  50
  51     std::string devname;
  52
  53   public:
  54      /**
  55       * Constructor for the Baddev Class.
  56       * @param name name of the object
  57       * @param a base address of the write
  58       * @param mmu the memory controller
  59       * @param devicename device that is not implemented
  60       */
  61     BadDevice(const std::string &name, Addr a, MemoryController *mmu,
  62               const std::string &devicename);
  63
  64     /**
  65       * On a read event we just panic aand hopefully print a
  66       * meaningful error message.
  67       * @param req Contains the address to read from.
  68       * @param data A pointer to write the read data to.
  69       * @return The fault condition of the access.
  70       */
  71     virtual Fault read(MemReqPtr &req, uint8_t *data);
  72
  73     /**
  74       * On a write event we just panic aand hopefully print a
  75       * meaningful error message.
  76       * @param req Contains the address to write to.
  77       * @param data The data to write.
  78       * @return The fault condition of the access.
  79       */
  80     virtual Fault write(MemReqPtr &req, const uint8_t *data);
  81
  82     /** @todo add serialize/unserialize */
  83 };
  84
  85 #endif // __BADDEV_HH__