summaryrefslogtreecommitdiff
path: root/src/dev/arm/smmu_v3_slaveifc.hh
blob: 7838e4ad0328f47a41484e10115dab1ae7316223 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * Copyright (c) 2013, 2018-2019 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Stan Czerniawski
 */

#ifndef __DEV_ARM_SMMU_V3_SLAVEIFC_HH__
#define __DEV_ARM_SMMU_V3_SLAVEIFC_HH__

#include <list>

#include "dev/arm/smmu_v3_caches.hh"
#include "dev/arm/smmu_v3_defs.hh"
#include "dev/arm/smmu_v3_events.hh"
#include "dev/arm/smmu_v3_ports.hh"
#include "dev/arm/smmu_v3_proc.hh"
#include "params/SMMUv3SlaveInterface.hh"
#include "sim/clocked_object.hh"

class SMMUTranslationProcess;
class SMMUv3;
class SMMUSlavePort;

class SMMUv3SlaveInterface : public ClockedObject
{
  protected:
    friend class SMMUTranslationProcess;

  public:
    SMMUv3 *smmu;
    SMMUTLB* microTLB;
    SMMUTLB* mainTLB;

    const bool microTLBEnable;
    const bool mainTLBEnable;

    SMMUSemaphore slavePortSem;
    SMMUSemaphore microTLBSem;
    SMMUSemaphore mainTLBSem;

    const Cycles microTLBLat;
    const Cycles mainTLBLat;

    SMMUSlavePort *slavePort;
    SMMUATSSlavePort  atsSlavePort;
    SMMUATSMasterPort atsMasterPort;

    // in bytes
    const unsigned portWidth;

    unsigned wrBufSlotsRemaining;
    unsigned xlateSlotsRemaining;
    unsigned pendingMemAccesses;

    const bool prefetchEnable;
    const bool prefetchReserveLastWay;

    std::list<SMMUTranslationProcess *> duplicateReqs;
    SMMUSignal duplicateReqRemoved;

    std::list<SMMUTranslationProcess *> dependentReads[SMMU_MAX_TRANS_ID];
    std::list<SMMUTranslationProcess *> dependentWrites[SMMU_MAX_TRANS_ID];
    SMMUSignal dependentReqRemoved;

    // Receiving translation requests from the master device
    Tick recvAtomic(PacketPtr pkt);
    bool recvTimingReq(PacketPtr pkt);
    void schedTimingResp(PacketPtr pkt);

    Tick atsSlaveRecvAtomic(PacketPtr pkt);
    bool atsSlaveRecvTimingReq(PacketPtr pkt);
    bool atsMasterRecvTimingResp(PacketPtr pkt);
    void schedAtsTimingResp(PacketPtr pkt);

    void scheduleDeviceRetry();
    void sendDeviceRetry();
    void atsSendDeviceRetry();

    bool deviceNeedsRetry;
    bool atsDeviceNeedsRetry;

    SMMUDeviceRetryEvent sendDeviceRetryEvent;
    EventWrapper<
        SMMUv3SlaveInterface,
        &SMMUv3SlaveInterface::atsSendDeviceRetry> atsSendDeviceRetryEvent;

    Port& getPort(const std::string &name, PortID id) override;

  public:
    SMMUv3SlaveInterface(const SMMUv3SlaveInterfaceParams *p);

    ~SMMUv3SlaveInterface()
    {
        delete microTLB;
        delete mainTLB;
    }

    const SMMUv3SlaveInterfaceParams *
    params() const
    {
        return static_cast<const SMMUv3SlaveInterfaceParams *>(_params);
    }

    DrainState drain() override;

    void setSMMU(SMMUv3 *_smmu) { smmu = _smmu; }
    void sendRange();
};

#endif /* __DEV_ARM_SMMU_V3_SLAVEIFC_HH__ */