QoSPolicy.py revision 12968:1c2b8dd9241f 
1# Copyright (c) 2018 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Giacomo Travaglini
37
38from m5.SimObject import *
39from m5.params import *
40
41# QoS scheduler policy used to serve incoming transaction
42class QoSPolicy(SimObject):
43    type = 'QoSPolicy'
44    abstract = True
45    cxx_header = "mem/qos/policy.hh"
46    cxx_class = 'QoS::Policy'
47
48class QoSFixedPriorityPolicy(QoSPolicy):
49    type = 'QoSFixedPriorityPolicy'
50    cxx_header = "mem/qos/policy_fixed_prio.hh"
51    cxx_class = 'QoS::FixedPriorityPolicy'
52
53    cxx_exports = [
54        PyBindMethod('initMasterName'),
55        PyBindMethod('initMasterObj'),
56    ]
57
58    _mpriorities = None
59
60    def setMasterPriority(self, master, priority):
61        if not self._mpriorities:
62            self._mpriorities = []
63
64        self._mpriorities.append([master, priority])
65
66    def init(self):
67        if not self._mpriorities:
68            print("Error, use setMasterPriority to init masters/priorities\n");
69            exit(1)
70        else:
71            for mprio in self._mpriorities:
72                master = mprio[0]
73                priority = mprio[1]
74                if isinstance(master, basestring):
75                    self.getCCObject().initMasterName(
76                        master, int(priority))
77                else:
78                    self.getCCObject().initMasterObj(
79                        master.getCCObject(), priority)
80
81    # default fixed priority value for non-listed Masters
82    qos_fixed_prio_default_prio = Param.UInt8(0,
83        "Default priority for non-listed Masters")
84