/*
 * Copyright (c) 2002-2006 The Regents of The University of Michigan
 * All rights reserved.
 *
 * 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.
 *
 * Authors: Steve Raasch
 */

#include <sstream>

#include "base/misc.hh"
#include "cpu/func_unit.hh"
#include "sim/builder.hh"

using namespace std;


////////////////////////////////////////////////////////////////////////////
//
//  The funciton unit
//
FuncUnit::FuncUnit()
{
    capabilityList.reset();
}


//  Copy constructor
FuncUnit::FuncUnit(const FuncUnit &fu)
{

    for (int i = 0; i < Num_OpClasses; ++i) {
        opLatencies[i] = fu.opLatencies[i];
        issueLatencies[i] = fu.issueLatencies[i];
    }

    capabilityList = fu.capabilityList;
}


void
FuncUnit::addCapability(OpClass cap, unsigned oplat, unsigned issuelat)
{
    if (issuelat == 0 || oplat == 0)
        panic("FuncUnit:  you don't really want a zero-cycle latency do you?");

    capabilityList.set(cap);

    opLatencies[cap] = oplat;
    issueLatencies[cap] = issuelat;
}

bool
FuncUnit::provides(OpClass capability)
{
    return capabilityList[capability];
}

bitset<Num_OpClasses>
FuncUnit::capabilities()
{
    return capabilityList;
}

unsigned &
FuncUnit::opLatency(OpClass cap)
{
    return opLatencies[cap];
}

unsigned
FuncUnit::issueLatency(OpClass capability)
{
    return issueLatencies[capability];
}

////////////////////////////////////////////////////////////////////////////
//
//  The SimObjects we use to get the FU information into the simulator
//
////////////////////////////////////////////////////////////////////////////

//
//  We use 2 objects to specify this data in the INI file:
//    (1) OpDesc - Describes the operation class & latencies
//                   (multiple OpDesc objects can refer to the same
//                   operation classes)
//    (2) FUDesc - Describes the operations available in the unit &
//                   the number of these units
//
//


//
//  The operation-class description object
//

BEGIN_DECLARE_SIM_OBJECT_PARAMS(OpDesc)

    SimpleEnumParam<OpClass> opClass;
    Param<unsigned>    opLat;
    Param<unsigned>    issueLat;

END_DECLARE_SIM_OBJECT_PARAMS(OpDesc)

BEGIN_INIT_SIM_OBJECT_PARAMS(OpDesc)

    INIT_ENUM_PARAM(opClass, "type of operation", opClassStrings),
    INIT_PARAM(opLat,        "cycles until result is available"),
    INIT_PARAM(issueLat,     "cycles until another can be issued")

END_INIT_SIM_OBJECT_PARAMS(OpDesc)


CREATE_SIM_OBJECT(OpDesc)
{
    return new OpDesc(getInstanceName(), opClass, opLat, issueLat);
}

REGISTER_SIM_OBJECT("OpDesc", OpDesc)


//
//  The FuDesc object
//

BEGIN_DECLARE_SIM_OBJECT_PARAMS(FUDesc)

    SimObjectVectorParam<OpDesc *> opList;
    Param<unsigned>                count;

END_DECLARE_SIM_OBJECT_PARAMS(FUDesc)


BEGIN_INIT_SIM_OBJECT_PARAMS(FUDesc)

    INIT_PARAM(opList, "list of operation classes for this FU type"),
    INIT_PARAM(count,  "number of these FU's available")

END_INIT_SIM_OBJECT_PARAMS(FUDesc)


CREATE_SIM_OBJECT(FUDesc)
{
    return new FUDesc(getInstanceName(), opList, count);
}

REGISTER_SIM_OBJECT("FUDesc", FUDesc)