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 "dev/alpha/tsunami.hh"
39#include "dev/pci/host.hh"
40#include "params/TsunamiPChip.hh"
41
42/**
43 * A very simple implementation of the Tsunami PCI interface chips.
44 */
45class TsunamiPChip : public GenericPciHost
46{
47  protected:
48
49    /** Pchip control register */
50    uint64_t pctl;
51
52    /** Window Base addresses */
53    uint64_t wsba[4];
54
55    /** Window masks */
56    uint64_t wsm[4];
57
58    /** Translated Base Addresses */
59    uint64_t tba[4];
60
61  public:
62    typedef TsunamiPChipParams Params;
63    /**
64     * Register the PChip with the mmu and init all wsba, wsm, and tba to 0
65     * @param p pointer to the parameters struct
66     */
67    TsunamiPChip(const Params *p);
68
69    const Params *
70    params() const
71    {
72        return dynamic_cast<const Params *>(_params);
73    }
74
75
76    void serialize(CheckpointOut &cp) const override;
77    void unserialize(CheckpointIn &cp) override;
78
79  public:
80    Tick read(PacketPtr pkt) override;
81    Tick write(PacketPtr pkt) override;
82
83    AddrRangeList getAddrRanges() const override;
84
85    /**
86     * Translate a PCI bus address to a memory address for DMA.
87     * @todo Andrew says this needs to be fixed. What's wrong with it?
88     * @param pci_addr PCI address to translate.
89     * @return memory system address
90     */
91    Addr dmaAddr(const PciBusAddr &addr, Addr pci_addr) const override;
92
93  protected:
94    const AddrRange pioRange;
95    const Tick pioDelay;
96};
97
98#endif // __TSUNAMI_PCHIP_HH__
99