smmu_v3_slaveifc.cc revision 14252:1659a606447f 
1/*
2 * Copyright (c) 2019 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Stan Czerniawski
38 *          Giacomo Travaglini
39 */
40
41#include "dev/arm/smmu_v3_slaveifc.hh"
42
43#include "debug/SMMUv3.hh"
44#include "dev/arm/smmu_v3.hh"
45#include "dev/arm/smmu_v3_transl.hh"
46
47SMMUv3SlaveInterface::SMMUv3SlaveInterface(
48    const SMMUv3SlaveInterfaceParams *p) :
49    ClockedObject(p),
50    smmu(nullptr),
51    microTLB(new SMMUTLB(p->utlb_entries,
52                         p->utlb_assoc,
53                         p->utlb_policy)),
54    mainTLB(new SMMUTLB(p->tlb_entries,
55                        p->tlb_assoc,
56                        p->tlb_policy)),
57    microTLBEnable(p->utlb_enable),
58    mainTLBEnable(p->tlb_enable),
59    slavePortSem(1),
60    microTLBSem(p->utlb_slots),
61    mainTLBSem(p->tlb_slots),
62    microTLBLat(p->utlb_lat),
63    mainTLBLat(p->tlb_lat),
64    slavePort(new SMMUSlavePort(csprintf("%s.slave", name()), *this)),
65    atsSlavePort(name() + ".atsSlave", *this),
66    atsMasterPort(name() + ".atsMaster", *this),
67    portWidth(p->port_width),
68    wrBufSlotsRemaining(p->wrbuf_slots),
69    xlateSlotsRemaining(p->xlate_slots),
70    pendingMemAccesses(0),
71    prefetchEnable(p->prefetch_enable),
72    prefetchReserveLastWay(
73        p->prefetch_reserve_last_way),
74    deviceNeedsRetry(false),
75    atsDeviceNeedsRetry(false),
76    sendDeviceRetryEvent(*this),
77    atsSendDeviceRetryEvent(this)
78{}
79
80void
81SMMUv3SlaveInterface::sendRange()
82{
83    if (slavePort->isConnected()) {
84        inform("Slave port is connected to %s\n", slavePort->getPeer());
85
86        slavePort->sendRangeChange();
87    } else {
88        fatal("Slave port is not connected.\n");
89    }
90}
91
92Port&
93SMMUv3SlaveInterface::getPort(const std::string &name, PortID id)
94{
95    if (name == "ats_master") {
96        return atsMasterPort;
97    } else if (name == "slave") {
98        return *slavePort;
99    } else if (name == "ats_slave") {
100        return atsSlavePort;
101    } else {
102        return ClockedObject::getPort(name, id);
103    }
104}
105
106void
107SMMUv3SlaveInterface::schedTimingResp(PacketPtr pkt)
108{
109    slavePort->schedTimingResp(pkt, nextCycle());
110}
111
112void
113SMMUv3SlaveInterface::schedAtsTimingResp(PacketPtr pkt)
114{
115    atsSlavePort.schedTimingResp(pkt, nextCycle());
116
117    if (atsDeviceNeedsRetry) {
118        atsDeviceNeedsRetry = false;
119        schedule(atsSendDeviceRetryEvent, nextCycle());
120    }
121}
122
123Tick
124SMMUv3SlaveInterface::recvAtomic(PacketPtr pkt)
125{
126    DPRINTF(SMMUv3, "[a] req from %s addr=%#x size=%#x\n",
127            slavePort->getPeer(), pkt->getAddr(), pkt->getSize());
128
129    std::string proc_name = csprintf("%s.port", name());
130    SMMUTranslationProcess proc(proc_name, *smmu, *this);
131    proc.beginTransaction(SMMUTranslRequest::fromPacket(pkt));
132
133    SMMUAction a = smmu->runProcessAtomic(&proc, pkt);
134    assert(a.type == ACTION_SEND_RESP);
135
136    return a.delay;
137}
138
139bool
140SMMUv3SlaveInterface::recvTimingReq(PacketPtr pkt)
141{
142    DPRINTF(SMMUv3, "[t] req from %s addr=%#x size=%#x\n",
143            slavePort->getPeer(), pkt->getAddr(), pkt->getSize());
144
145    // @todo: We need to pay for this and not just zero it out
146    pkt->headerDelay = pkt->payloadDelay = 0;
147
148    unsigned nbeats =
149        (pkt->getSize() + (portWidth-1)) / portWidth;
150
151    if (xlateSlotsRemaining==0 ||
152        (pkt->isWrite() && wrBufSlotsRemaining < nbeats))
153    {
154        deviceNeedsRetry = true;
155        return false;
156    }
157
158    if (pkt->isWrite())
159        wrBufSlotsRemaining -= nbeats;
160
161    std::string proc_name = csprintf("%s.port", name());
162    SMMUTranslationProcess *proc =
163        new SMMUTranslationProcess(proc_name, *smmu, *this);
164    proc->beginTransaction(SMMUTranslRequest::fromPacket(pkt));
165
166    smmu->runProcessTiming(proc, pkt);
167
168    return true;
169}
170
171Tick
172SMMUv3SlaveInterface::atsSlaveRecvAtomic(PacketPtr pkt)
173{
174    DPRINTF(SMMUv3, "[a] ATS slave  req  addr=%#x size=%#x\n",
175            pkt->getAddr(), pkt->getSize());
176
177    std::string proc_name = csprintf("%s.atsport", name());
178    const bool ats_request = true;
179    SMMUTranslationProcess proc(
180        proc_name, *smmu, *this);
181    proc.beginTransaction(SMMUTranslRequest::fromPacket(pkt, ats_request));
182
183    SMMUAction a = smmu->runProcessAtomic(&proc, pkt);
184    assert(a.type == ACTION_SEND_RESP_ATS);
185
186    return a.delay;
187}
188
189bool
190SMMUv3SlaveInterface::atsSlaveRecvTimingReq(PacketPtr pkt)
191{
192    DPRINTF(SMMUv3, "[t] ATS slave  req  addr=%#x size=%#x\n",
193            pkt->getAddr(), pkt->getSize());
194
195    // @todo: We need to pay for this and not just zero it out
196    pkt->headerDelay = pkt->payloadDelay = 0;
197
198    if (xlateSlotsRemaining == 0) {
199        deviceNeedsRetry = true;
200        return false;
201    }
202
203    std::string proc_name = csprintf("%s.atsport", name());
204    const bool ats_request = true;
205    SMMUTranslationProcess *proc =
206        new SMMUTranslationProcess(proc_name, *smmu, *this);
207    proc->beginTransaction(SMMUTranslRequest::fromPacket(pkt, ats_request));
208
209    smmu->runProcessTiming(proc, pkt);
210
211    return true;
212}
213
214bool
215SMMUv3SlaveInterface::atsMasterRecvTimingResp(PacketPtr pkt)
216{
217    DPRINTF(SMMUv3, "[t] ATS master resp addr=%#x size=%#x\n",
218            pkt->getAddr(), pkt->getSize());
219
220    // @todo: We need to pay for this and not just zero it out
221    pkt->headerDelay = pkt->payloadDelay = 0;
222
223    SMMUProcess *proc =
224        safe_cast<SMMUProcess *>(pkt->popSenderState());
225
226    smmu->runProcessTiming(proc, pkt);
227
228    return true;
229}
230
231void
232SMMUv3SlaveInterface::sendDeviceRetry()
233{
234    slavePort->sendRetryReq();
235}
236
237void
238SMMUv3SlaveInterface::atsSendDeviceRetry()
239{
240    DPRINTF(SMMUv3, "ATS retry\n");
241    atsSlavePort.sendRetryReq();
242}
243
244void
245SMMUv3SlaveInterface::scheduleDeviceRetry()
246{
247    if (deviceNeedsRetry && !sendDeviceRetryEvent.scheduled()) {
248        DPRINTF(SMMUv3, "sched slave retry\n");
249        deviceNeedsRetry = false;
250        schedule(sendDeviceRetryEvent, nextCycle());
251    }
252}
253
254DrainState
255SMMUv3SlaveInterface::drain()
256{
257    // Wait until all SMMU translations are completed
258    if (xlateSlotsRemaining < params()->xlate_slots) {
259        return DrainState::Draining;
260    }
261    return DrainState::Drained;
262}
263
264SMMUv3SlaveInterface*
265SMMUv3SlaveInterfaceParams::create()
266{
267    return new SMMUv3SlaveInterface(this);
268}
269