energy_ctrl.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2014 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 __DEV_ARM_ENERGY_CTRL_HH__
#define __DEV_ARM_ENERGY_CTRL_HH__

#include "dev/io_device.hh"
#include "params/EnergyCtrl.hh"

class DVFSHandler;

class EnergyCtrl : public BasicPioDevice
{
  public:
    enum Registers {
        DVFS_HANDLER_STATUS = 0,
        DVFS_NUM_DOMAINS,
        DVFS_DOMAINID_AT_INDEX,
        DVFS_HANDLER_TRANS_LATENCY,
        DOMAIN_ID,
        PERF_LEVEL,
        PERF_LEVEL_ACK,
        NUM_OF_PERF_LEVELS,
        PERF_LEVEL_TO_READ,
        FREQ_AT_PERF_LEVEL,
        VOLT_AT_PERF_LEVEL,
        PIO_NUM_FIELDS
    };

    typedef EnergyCtrlParams Params;
    EnergyCtrl(const Params *p);

    Tick read(PacketPtr pkt) override;
    Tick write(PacketPtr pkt) override;

    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;

    void startup() override;
    void init() override;

  private:
    DVFSHandler *dvfsHandler;

    uint32_t domainID;

    uint32_t domainIDIndexToRead;

    uint32_t perfLevelAck;

    uint32_t perfLevelToRead;

    static uint32_t ticksTokHz(Tick period) {
        return (uint32_t)(SimClock::Int::ms / period);
    }

    static uint32_t toMicroVolt(double voltage) {
        return (uint32_t)(voltage * 1000000);
    }

    void updatePLAck() {
        perfLevelAck = 1;
    }

    EventFunctionWrapper updateAckEvent;
};
#endif //__DEV_ARM_ENERGY_CTRL_HH__