/*
 * Copyright (c) 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.
 */

/**
 * @file Definition of a bus object.
 */


#include "base/trace.hh"
#include "mem/bus.hh"
#include "sim/builder.hh"

/** Get the ranges of anyone that we are connected to. */
void
Bus::init()
{
    std::vector<Port*>::iterator intIter;
    for (intIter = interfaces.begin(); intIter != interfaces.end(); intIter++)
        (*intIter)->sendStatusChange(Port::RangeChange);
}


/** Function called by the port when the bus is recieving a Timing
 * transaction.*/
bool
Bus::recvTiming(Packet *pkt)
{
    Port *port;
    if (pkt->dest == Packet::Broadcast) {
        port = findPort(pkt->addr, pkt->src);
    } else {
        assert(pkt->dest >= 0 && pkt->dest < interfaces.size());
        assert(pkt->dest != pkt->src); // catch infinite loops
        port = interfaces[pkt->dest];
    }
    return port->sendTiming(pkt);
}

Port *
Bus::findPort(Addr addr, int id)
{
    /* An interval tree would be a better way to do this. --ali. */
    int dest_id = -1;
    int i = 0;
    bool found = false;

    while (i < portList.size() && !found)
    {
        if (portList[i].range == addr) {
            dest_id = portList[i].portId;
            found = true;
            DPRINTF(Bus, "Found Addr: %llx on device %d\n", addr, dest_id);
        }
        i++;
    }
    if (dest_id == -1)
        panic("Unable to find destination for addr: %llx", addr);

    // we shouldn't be sending this back to where it came from
    assert(dest_id != id);

    return interfaces[dest_id];
}

/** Function called by the port when the bus is recieving a Atomic
 * transaction.*/
Tick
Bus::recvAtomic(Packet *pkt)
{
    assert(pkt->dest == Packet::Broadcast);
    return findPort(pkt->addr, pkt->src)->sendAtomic(pkt);
}

/** Function called by the port when the bus is recieving a Functional
 * transaction.*/
void
Bus::recvFunctional(Packet *pkt)
{
    assert(pkt->dest == Packet::Broadcast);
    findPort(pkt->addr, pkt->src)->sendFunctional(pkt);
}

/** Function called by the port when the bus is recieving a status change.*/
void
Bus::recvStatusChange(Port::Status status, int id)
{
    DPRINTF(Bus, "Bus %d recieved status change from device id %d\n",
            busId, id);
    assert(status == Port::RangeChange &&
           "The other statuses need to be implemented.");

    assert(id < interfaces.size() && id >= 0);
    int x;
    Port *port = interfaces[id];
    AddrRangeList ranges;
    AddrRangeList snoops;
    AddrRangeIter iter;
    std::vector<DevMap>::iterator portIter;

    // Clean out any previously existent ids
    for (portIter = portList.begin(); portIter != portList.end(); ) {
        if (portIter->portId == id)
            portIter = portList.erase(portIter);
        else
            portIter++;
    }

    port->getPeerAddressRanges(ranges, snoops);

    // not dealing with snooping yet either
    assert(snoops.size() == 0);
    for(iter = ranges.begin(); iter != ranges.end(); iter++) {
        DevMap dm;
        dm.portId = id;
        dm.range = *iter;

        DPRINTF(MMU, "Adding range %llx - %llx for id %d\n", dm.range.start,
                dm.range.end, id);
        portList.push_back(dm);
    }
    DPRINTF(MMU, "port list has %d entries\n", portList.size());

    // tell all our peers that our address range has changed.
    // Don't tell the device that caused this change, it already knows
    for (x = 0; x < interfaces.size(); x++)
        if (x != id)
            interfaces[x]->sendStatusChange(Port::RangeChange);
}

void
Bus::addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id)
{
    std::vector<DevMap>::iterator portIter;

    resp.clear();
    snoop.clear();

    DPRINTF(Bus, "Bus id %d recieved address range request returning\n",
            busId);
    for (portIter = portList.begin(); portIter != portList.end(); portIter++) {
        if (portIter->portId != id) {
            resp.push_back(portIter->range);
            DPRINTF(Bus, "-- %#llX : %#llX\n", portIter->range.start,
                    portIter->range.end);
        }
    }
}

BEGIN_DECLARE_SIM_OBJECT_PARAMS(Bus)

    Param<int> bus_id;

END_DECLARE_SIM_OBJECT_PARAMS(Bus)

BEGIN_INIT_SIM_OBJECT_PARAMS(Bus)
    INIT_PARAM(bus_id, "a globally unique bus id")
END_INIT_SIM_OBJECT_PARAMS(Bus)

CREATE_SIM_OBJECT(Bus)
{
    return new Bus(getInstanceName(), bus_id);
}

REGISTER_SIM_OBJECT("Bus", Bus)