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