power_domain.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 2019-2020 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 __SIM_POWER_DOMAIN_HH__
#define __SIM_POWER_DOMAIN_HH__

#include <string>
#include <vector>

#include "base/statistics.hh"
#include "params/PowerDomain.hh"
#include "sim/clocked_object.hh"
#include "sim/power_state.hh"

class PowerDomain : public PowerState
{
  public:
    PowerDomain(const PowerDomainParams* p);
    typedef PowerDomainParams Params;
    ~PowerDomain() override {};

    void startup() override;

    void pwrStateChangeCallback(Enums::PwrState new_pwr_state,
                                PowerState* leader);

    void addFollower(PowerState* pwr_obj) override;

  private:
    Enums::PwrState calculatePowerDomainState(
          const std::vector<Enums::PwrState> &f_states={});

    bool isPossiblePwrState(Enums::PwrState p_state);

    void calculatePossiblePwrStates();

    void setFollowerPowerStates();

  private: /* Power domain attributes */
    std::vector<PowerState*> leaders;

    Enums::PwrState leaderTargetState;

    std::vector<PowerState*> followers;

    const Tick updateLatency = 1;

    EventWrapper<PowerDomain, &PowerDomain::setFollowerPowerStates>
                pwrStateUpdateEvent;

  protected:
    struct PowerDomainStats : public Stats::Group
    {
        PowerDomainStats(PowerDomain &pd);

        void regStats() override;

        Stats::Scalar numLeaderCalls;
        Stats::Scalar numLeaderCallsChangingState;
    } stats;
};

#endif // __SIM_POWER_DOMAIN_HH__