smmu_v3_proc.hh revision 14039:4991b2a345a1 
1/*
2 * Copyright (c) 2013, 2018-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 */
39
40#ifndef __DEV_ARM_SMMU_V3_PROC_HH__
41#define __DEV_ARM_SMMU_V3_PROC_HH__
42
43#include <list>
44#include <queue>
45#include <string>
46
47#include "base/coroutine.hh"
48#include "base/types.hh"
49#include "mem/packet.hh"
50
51class SMMUv3SlaveInterface;
52
53/*
54 * The meaning of these becomes apparent when you
55 * look at runProcessAtomic()/runProcessTiming().
56 */
57enum SMMUActionType {
58    ACTION_INITIAL_NOP,
59    ACTION_SEND_REQ,
60    ACTION_SEND_REQ_FINAL,
61    ACTION_SEND_RESP,
62    ACTION_SEND_RESP_ATS,
63    ACTION_DELAY,
64    ACTION_SLEEP,
65    ACTION_TERMINATE,
66};
67
68struct SMMUAction
69{
70    SMMUActionType type;
71    PacketPtr pkt;
72    SMMUv3SlaveInterface *ifc;
73    Tick delay;
74};
75
76class SMMUv3;
77class SMMUProcess;
78
79struct SMMUSemaphore
80{
81    explicit SMMUSemaphore(unsigned _max) :
82        count(_max), max(_max)
83    {}
84
85    unsigned count;
86    unsigned max;
87    std::queue<SMMUProcess *> queue;
88};
89
90struct SMMUSignal
91{
92    std::list<SMMUProcess *> waiting;
93};
94
95class SMMUProcess : public Packet::SenderState
96{
97  private:
98    typedef m5::Coroutine<PacketPtr, SMMUAction> Coroutine;
99
100    Coroutine *coroutine;
101    std::string myName;
102
103    void wakeup();
104
105  protected:
106    typedef Coroutine::CallerType Yield;
107
108    SMMUv3 &smmu;
109
110    void reinit();
111
112    virtual void main(Yield &yield) = 0;
113
114    void doRead(Yield &yield, Addr addr, void *ptr, size_t size);
115    void doWrite(Yield &yield, Addr addr, const void *ptr, size_t size);
116    void doDelay(Yield &yield, Cycles cycles);
117    void doSleep(Yield &yield);
118
119    void doSemaphoreDown(Yield &yield, SMMUSemaphore &sem);
120    void doSemaphoreUp(SMMUSemaphore &sem);
121
122    void doWaitForSignal(Yield &yield, SMMUSignal &sig);
123    void doBroadcastSignal(SMMUSignal &sig);
124
125    void scheduleWakeup(Tick when);
126
127 public:
128    SMMUProcess(const std::string &name, SMMUv3 &_smmu);
129    virtual ~SMMUProcess();
130
131    SMMUAction run(PacketPtr pkt);
132
133    const std::string name() const { return myName; };
134};
135
136#endif /* __DEV_ARM_SMMU_V3_PROC_HH__ */
137