external_slave.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.
 *
 * Authors: Andrew Bardsley
 */

#ifndef __MEM_EXTERNAL_SLAVE_HH__
#define __MEM_EXTERNAL_SLAVE_HH__

#include "mem/port.hh"
#include "params/ExternalSlave.hh"
#include "sim/sim_object.hh"

class ExternalSlave : public SimObject
{
  public:
    class ExternalPort : public SlavePort
    {
      protected:
        ExternalSlave &owner;

      public:
        ExternalPort(const std::string &name_,
            ExternalSlave &owner_) :
            SlavePort(name_, &owner_), owner(owner_)
        { }

        ~ExternalPort() { }

        AddrRangeList getAddrRanges() const;
    };

    /* Handlers are specific to *types* of port not specific port
     * instantiations.  A handler will typically build a bridge to the
     * external port from gem5 and provide gem5 with a SlavePort that can be
     * bound to for each call to Handler::getExternalPort.*/
    class Handler
    {
      public:
        virtual ExternalPort *getExternalPort(
            const std::string &name, ExternalSlave &owner,
            const std::string &port_data) = 0;
    };

  protected:
    ExternalPort *externalPort;

    std::string portName;

    std::string portType;

    std::string portData;

    AddrRangeList addrRanges;

    static std::map<std::string, Handler *> portHandlers;

  public:
    ExternalSlave(ExternalSlaveParams *params);

    Port &getPort(const std::string &if_name,
                  PortID idx=InvalidPortID) override;

    static void registerHandler(const std::string &handler_name,
        Handler *handler);

    void init() override;
};


#endif //__MEM_EXTERNAL_SLAVE_HH__