1/*
2 * Copyright (c) 2018 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: Matteo Andreozzi
38 */
39
40#ifndef __MEM_QOS_TURNAROUND_POLICY_HH__
41#define __MEM_QOS_TURNAROUND_POLICY_HH__
42
43#include "mem_ctrl.hh"
44
45namespace QoS {
46
47/**
48 * Base class for QoS Bus Turnaround policies
49 */
50class TurnaroundPolicy : public SimObject
51{
52  protected:
53    using Params = QoSTurnaroundPolicyParams;
54
55  public:
56    TurnaroundPolicy(const Params* p) : SimObject(p) {};
57
58    virtual ~TurnaroundPolicy() {};
59
60    /**
61     * Setting a pointer to the Memory Controller implementing
62     * the turnaround policy.
63     */
64    void setMemCtrl(MemCtrl* mem) { memCtrl = mem; };
65
66    /**
67     * Bus Selection function
68     *
69     * @return selected bus state
70     */
71    virtual MemCtrl::BusState selectBusState() = 0;
72
73  protected:
74    /** Pointer to container object */
75    MemCtrl* memCtrl;
76};
77
78} // namespace QoS
79
80#endif /* __MEM_QOS_TURNAROUND_POLICY_HH__ */
81