tsunami_pchip.hh revision 5834:b9e30a60dee4 
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 * Tsunami PCI interface CSRs
33 */
34
35#ifndef __TSUNAMI_PCHIP_HH__
36#define __TSUNAMI_PCHIP_HH__
37
38#include "base/range.hh"
39#include "dev/alpha/tsunami.hh"
40#include "dev/io_device.hh"
41#include "params/TsunamiPChip.hh"
42
43/**
44 * A very simple implementation of the Tsunami PCI interface chips.
45 */
46class TsunamiPChip : public BasicPioDevice
47{
48  protected:
49
50    static const Addr TsunamiPciBus0Config = ULL(0x801fe000000);
51
52    /** Pchip control register */
53    uint64_t pctl;
54
55    /** Window Base addresses */
56    uint64_t wsba[4];
57
58    /** Window masks */
59    uint64_t wsm[4];
60
61    /** Translated Base Addresses */
62    uint64_t tba[4];
63
64  public:
65    typedef TsunamiPChipParams Params;
66    /**
67     * Register the PChip with the mmu and init all wsba, wsm, and tba to 0
68     * @param p pointer to the parameters struct
69     */
70    TsunamiPChip(const Params *p);
71
72    const Params *
73    params() const
74    {
75        return dynamic_cast<const Params *>(_params);
76    }
77
78    /**
79     * Translate a PCI bus address to a memory address for DMA.
80     * @todo Andrew says this needs to be fixed. What's wrong with it?
81     * @param busAddr PCI address to translate.
82     * @return memory system address
83     */
84    Addr translatePciToDma(Addr busAddr);
85
86    Addr calcConfigAddr(int bus, int dev, int func);
87    Addr calcIOAddr(Addr addr);
88    Addr calcMemAddr(Addr addr);
89
90    virtual Tick read(PacketPtr pkt);
91    virtual Tick write(PacketPtr pkt);
92
93    /**
94     * Serialize this object to the given output stream.
95     * @param os The stream to serialize to.
96     */
97    virtual void serialize(std::ostream &os);
98
99    /**
100     * Reconstruct the state of this object from a checkpoint.
101     * @param cp The checkpoint use.
102     * @param section The section name of this object
103     */
104    virtual void unserialize(Checkpoint *cp, const std::string &section);
105};
106
107#endif // __TSUNAMI_PCHIP_HH__
108