1/*
2 * Copyright (c) 2012-2014 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 * Authors: Andrew Bardsley
38 *          Curtis Dunham
39 *          Christian Menard
40 */
41
42#include "mem/external_master.hh"
43
44#include <cctype>
45#include <iomanip>
46
47#include "base/trace.hh"
48#include "debug/ExternalPort.hh"
49#include "sim/system.hh"
50
51std::map<std::string, ExternalMaster::Handler *>
52    ExternalMaster::portHandlers;
53
54ExternalMaster::ExternalMaster(ExternalMasterParams *params) :
55    SimObject(params),
56    externalPort(NULL),
57    portName(params->name + ".port"),
58    portType(params->port_type),
59    portData(params->port_data),
60    masterId(params->system->getMasterId(this))
61{}
62
63Port &
64ExternalMaster::getPort(const std::string &if_name, PortID idx)
65{
66    if (if_name == "port") {
67        DPRINTF(ExternalPort, "Trying to bind external port: %s %s\n",
68            portType, portName);
69
70        if (!externalPort) {
71            auto handlerIter = portHandlers.find(portType);
72
73            if (handlerIter == portHandlers.end())
74                fatal("Can't find port handler type '%s'\n", portType);
75
76            externalPort = portHandlers[portType]->getExternalPort(portName,
77                *this, portData);
78
79            if (!externalPort) {
80                fatal("%s: Can't find external port type: %s"
81                    " port_data: '%s'\n", portName, portType, portData);
82            }
83        }
84        return *externalPort;
85    } else {
86        return SimObject::getPort(if_name, idx);
87    }
88}
89
90void
91ExternalMaster::init()
92{
93    if (!externalPort) {
94        fatal("ExternalMaster %s: externalPort not set!\n", name());
95    } else if (!externalPort->isConnected()) {
96        fatal("ExternalMaster %s is unconnected!\n", name());
97    }
98}
99
100ExternalMaster *
101ExternalMasterParams::create()
102{
103    return new ExternalMaster(this);
104}
105
106void
107ExternalMaster::registerHandler(const std::string &handler_name,
108    Handler *handler)
109{
110    portHandlers[handler_name] = handler;
111}
112