114039Sstacze01@arm.com/* 214039Sstacze01@arm.com * Copyright (c) 2013, 2018-2019 ARM Limited 314039Sstacze01@arm.com * All rights reserved 414039Sstacze01@arm.com * 514039Sstacze01@arm.com * The license below extends only to copyright in the software and shall 614039Sstacze01@arm.com * not be construed as granting a license to any other intellectual 714039Sstacze01@arm.com * property including but not limited to intellectual property relating 814039Sstacze01@arm.com * to a hardware implementation of the functionality of the software 914039Sstacze01@arm.com * licensed hereunder. You may use the software subject to the license 1014039Sstacze01@arm.com * terms below provided that you ensure that this notice is replicated 1114039Sstacze01@arm.com * unmodified and in its entirety in all distributions of the software, 1214039Sstacze01@arm.com * modified or unmodified, in source code or in binary form. 1314039Sstacze01@arm.com * 1414039Sstacze01@arm.com * Redistribution and use in source and binary forms, with or without 1514039Sstacze01@arm.com * modification, are permitted provided that the following conditions are 1614039Sstacze01@arm.com * met: redistributions of source code must retain the above copyright 1714039Sstacze01@arm.com * notice, this list of conditions and the following disclaimer; 1814039Sstacze01@arm.com * redistributions in binary form must reproduce the above copyright 1914039Sstacze01@arm.com * notice, this list of conditions and the following disclaimer in the 2014039Sstacze01@arm.com * documentation and/or other materials provided with the distribution; 2114039Sstacze01@arm.com * neither the name of the copyright holders nor the names of its 2214039Sstacze01@arm.com * contributors may be used to endorse or promote products derived from 2314039Sstacze01@arm.com * this software without specific prior written permission. 2414039Sstacze01@arm.com * 2514039Sstacze01@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2614039Sstacze01@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2714039Sstacze01@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2814039Sstacze01@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2914039Sstacze01@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3014039Sstacze01@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3114039Sstacze01@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3214039Sstacze01@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3314039Sstacze01@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3414039Sstacze01@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3514039Sstacze01@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3614039Sstacze01@arm.com * 3714039Sstacze01@arm.com * Authors: Stan Czerniawski 3814039Sstacze01@arm.com */ 3914039Sstacze01@arm.com 4014039Sstacze01@arm.com#ifndef __DEV_ARM_SMMU_V3_PROC_HH__ 4114039Sstacze01@arm.com#define __DEV_ARM_SMMU_V3_PROC_HH__ 4214039Sstacze01@arm.com 4314039Sstacze01@arm.com#include <list> 4414039Sstacze01@arm.com#include <queue> 4514039Sstacze01@arm.com#include <string> 4614039Sstacze01@arm.com 4714039Sstacze01@arm.com#include "base/coroutine.hh" 4814039Sstacze01@arm.com#include "base/types.hh" 4914039Sstacze01@arm.com#include "mem/packet.hh" 5014039Sstacze01@arm.com 5114039Sstacze01@arm.comclass SMMUv3SlaveInterface; 5214039Sstacze01@arm.com 5314039Sstacze01@arm.com/* 5414039Sstacze01@arm.com * The meaning of these becomes apparent when you 5514039Sstacze01@arm.com * look at runProcessAtomic()/runProcessTiming(). 5614039Sstacze01@arm.com */ 5714039Sstacze01@arm.comenum SMMUActionType { 5814039Sstacze01@arm.com ACTION_INITIAL_NOP, 5914039Sstacze01@arm.com ACTION_SEND_REQ, 6014039Sstacze01@arm.com ACTION_SEND_REQ_FINAL, 6114039Sstacze01@arm.com ACTION_SEND_RESP, 6214039Sstacze01@arm.com ACTION_SEND_RESP_ATS, 6314039Sstacze01@arm.com ACTION_DELAY, 6414039Sstacze01@arm.com ACTION_SLEEP, 6514039Sstacze01@arm.com ACTION_TERMINATE, 6614039Sstacze01@arm.com}; 6714039Sstacze01@arm.com 6814039Sstacze01@arm.comstruct SMMUAction 6914039Sstacze01@arm.com{ 7014039Sstacze01@arm.com SMMUActionType type; 7114039Sstacze01@arm.com PacketPtr pkt; 7214039Sstacze01@arm.com SMMUv3SlaveInterface *ifc; 7314039Sstacze01@arm.com Tick delay; 7414039Sstacze01@arm.com}; 7514039Sstacze01@arm.com 7614039Sstacze01@arm.comclass SMMUv3; 7714039Sstacze01@arm.comclass SMMUProcess; 7814039Sstacze01@arm.com 7914039Sstacze01@arm.comstruct SMMUSemaphore 8014039Sstacze01@arm.com{ 8114039Sstacze01@arm.com explicit SMMUSemaphore(unsigned _max) : 8214039Sstacze01@arm.com count(_max), max(_max) 8314039Sstacze01@arm.com {} 8414039Sstacze01@arm.com 8514039Sstacze01@arm.com unsigned count; 8614039Sstacze01@arm.com unsigned max; 8714039Sstacze01@arm.com std::queue<SMMUProcess *> queue; 8814039Sstacze01@arm.com}; 8914039Sstacze01@arm.com 9014039Sstacze01@arm.comstruct SMMUSignal 9114039Sstacze01@arm.com{ 9214039Sstacze01@arm.com std::list<SMMUProcess *> waiting; 9314039Sstacze01@arm.com}; 9414039Sstacze01@arm.com 9514039Sstacze01@arm.comclass SMMUProcess : public Packet::SenderState 9614039Sstacze01@arm.com{ 9714039Sstacze01@arm.com private: 9814039Sstacze01@arm.com typedef m5::Coroutine<PacketPtr, SMMUAction> Coroutine; 9914039Sstacze01@arm.com 10014039Sstacze01@arm.com Coroutine *coroutine; 10114039Sstacze01@arm.com std::string myName; 10214039Sstacze01@arm.com 10314039Sstacze01@arm.com void wakeup(); 10414039Sstacze01@arm.com 10514039Sstacze01@arm.com protected: 10614039Sstacze01@arm.com typedef Coroutine::CallerType Yield; 10714039Sstacze01@arm.com 10814039Sstacze01@arm.com SMMUv3 &smmu; 10914039Sstacze01@arm.com 11014039Sstacze01@arm.com void reinit(); 11114039Sstacze01@arm.com 11214039Sstacze01@arm.com virtual void main(Yield &yield) = 0; 11314039Sstacze01@arm.com 11414039Sstacze01@arm.com void doRead(Yield &yield, Addr addr, void *ptr, size_t size); 11514039Sstacze01@arm.com void doWrite(Yield &yield, Addr addr, const void *ptr, size_t size); 11614039Sstacze01@arm.com void doDelay(Yield &yield, Cycles cycles); 11714039Sstacze01@arm.com void doSleep(Yield &yield); 11814039Sstacze01@arm.com 11914039Sstacze01@arm.com void doSemaphoreDown(Yield &yield, SMMUSemaphore &sem); 12014039Sstacze01@arm.com void doSemaphoreUp(SMMUSemaphore &sem); 12114039Sstacze01@arm.com 12214039Sstacze01@arm.com void doWaitForSignal(Yield &yield, SMMUSignal &sig); 12314039Sstacze01@arm.com void doBroadcastSignal(SMMUSignal &sig); 12414039Sstacze01@arm.com 12514039Sstacze01@arm.com void scheduleWakeup(Tick when); 12614039Sstacze01@arm.com 12714039Sstacze01@arm.com public: 12814039Sstacze01@arm.com SMMUProcess(const std::string &name, SMMUv3 &_smmu); 12914039Sstacze01@arm.com virtual ~SMMUProcess(); 13014039Sstacze01@arm.com 13114039Sstacze01@arm.com SMMUAction run(PacketPtr pkt); 13214039Sstacze01@arm.com 13314039Sstacze01@arm.com const std::string name() const { return myName; }; 13414039Sstacze01@arm.com}; 13514039Sstacze01@arm.com 13614039Sstacze01@arm.com#endif /* __DEV_ARM_SMMU_V3_PROC_HH__ */ 137