baddev.hh revision 1762
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/** @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 __DEV_BADDEV_HH__ 35#define __DEV_BADDEV_HH__ 36 37#include "base/range.hh" 38#include "dev/io_device.hh" 39 40/** 41 * BadDevice 42 * This device just panics when accessed. It is supposed to warn 43 * the user that the kernel they are running has unsupported 44 * options (i.e. frame buffer) 45 */ 46class BadDevice : public PioDevice 47{ 48 private: 49 Addr addr; 50 static const Addr size = 0xf; 51 52 std::string devname; 53 54 public: 55 /** 56 * Constructor for the Baddev Class. 57 * @param name name of the object 58 * @param a base address of the write 59 * @param mmu the memory controller 60 * @param hier object to store parameters universal the device hierarchy 61 * @param bus The bus that this device is attached to 62 * @param devicename device that is not implemented 63 */ 64 BadDevice(const std::string &name, Addr a, MemoryController *mmu, 65 HierParams *hier, Bus *bus, const std::string &devicename); 66 67 /** 68 * On a read event we just panic aand hopefully print a 69 * meaningful error message. 70 * @param req Contains the address to read from. 71 * @param data A pointer to write the read data to. 72 * @return The fault condition of the access. 73 */ 74 virtual Fault read(MemReqPtr &req, uint8_t *data); 75 76 /** 77 * On a write event we just panic aand hopefully print a 78 * meaningful error message. 79 * @param req Contains the address to write to. 80 * @param data The data to write. 81 * @return The fault condition of the access. 82 */ 83 virtual Fault write(MemReqPtr &req, const uint8_t *data); 84 85 /** 86 * Return how long this access will take. 87 * @param req the memory request to calcuate 88 * @return Tick when the request is done 89 */ 90 Tick cacheAccess(MemReqPtr &req); 91}; 92 93#endif // __DEV_BADDEV_HH__ 94