src/mem/qos/policy_fixed_prio.hh

   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  * Author: Matteo Andreozzi
  38  */
  39
  40 #ifndef __MEM_QOS_POLICY_FIXED_PRIO_HH__
  41 #define __MEM_QOS_POLICY_FIXED_PRIO_HH__
  42
  43 #include "mem/qos/policy.hh"
  44 #include "params/QoSFixedPriorityPolicy.hh"
  45
  46 namespace QoS {
  47
  48 /**
  49  * Fixed Priority QoS Policy
  50  *
  51  * Fixed Priority Policy: based on a configured MasterID to priority map,
  52  * it returns a fixed QoS priority value: every master has a fixed priority.
  53  */
  54 class FixedPriorityPolicy : public Policy
  55 {
  56     using Params = QoSFixedPriorityPolicyParams;
  57
  58   public:
  59     FixedPriorityPolicy(const Params*);
  60     virtual ~FixedPriorityPolicy();
  61
  62     void init() override;
  63
  64     /**
  65      * Initialize the fixed master's priority by providing
  66      * the master's name and priority value.
  67      * The master's name has to match a name in the system.
  68      *
  69      * @param master master's name to lookup.
  70      * @param priority priority value for the master
  71      */
  72     void initMasterName(std::string master, uint8_t priority);
  73
  74     /**
  75      * Initialize the fixed master's priority by providing
  76      * the master's SimObject pointer and priority value.
  77      *
  78      * @param master master's SimObject pointer to lookup.
  79      * @param priority priority value for the master
  80      */
  81     void initMasterObj(const SimObject* master, uint8_t priority);
  82
  83     /**
  84      * Schedules a packet based on fixed priority configuration
  85      *
  86      * @param mId master id to schedule
  87      * @param data data to schedule
  88      * @return QoS priority value
  89      */
  90     virtual uint8_t schedule(const MasterID, const uint64_t) override;
  91
  92   protected:
  93     /** Default fixed priority value for non-listed masters */
  94     const uint8_t defaultPriority;
  95
  96     /**
  97      * Priority map, associates configured masters with
  98      * a fixed QoS priority value
  99      */
 100     std::map<MasterID, uint8_t> priorityMap;
 101 };
 102
 103 } // namespace QoS
 104
 105 #endif // __MEM_QOS_POLICY_FIXED_PRIO_HH__