blob: f4e27425bd96cd0e19c603a49028ff0b3421406b [file] [log] [blame]
/*
* Copyright (c) 2018 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.
*/
#ifndef __MEM_QOS_TURNAROUND_POLICY_HH__
#define __MEM_QOS_TURNAROUND_POLICY_HH__
#include "mem_ctrl.hh"
namespace QoS {
/**
* Base class for QoS Bus Turnaround policies
*/
class TurnaroundPolicy : public SimObject
{
protected:
using Params = QoSTurnaroundPolicyParams;
public:
TurnaroundPolicy(const Params* p) : SimObject(p) {};
virtual ~TurnaroundPolicy() {};
/**
* Setting a pointer to the Memory Controller implementing
* the turnaround policy.
*/
void setMemCtrl(MemCtrl* mem) { memCtrl = mem; };
/**
* Bus Selection function
*
* @return selected bus state
*/
virtual MemCtrl::BusState selectBusState() = 0;
protected:
/** Pointer to container object */
MemCtrl* memCtrl;
};
} // namespace QoS
#endif /* __MEM_QOS_TURNAROUND_POLICY_HH__ */