xref: /gem5/src/mem/ruby/network/dummy_port.hh

/*
 * Copyright 2019 Google, Inc.
 *
 * 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: Gabe Black
 */

#ifndef __MEM_RUBY_NETWORK_DUMMY_PORT_HH__
#define __MEM_RUBY_NETWORK_DUMMY_PORT_HH__

#include "mem/port.hh"

class RubyDummyPort : public Port
{
  public:
    RubyDummyPort() : Port("DummyPort", -1) {}

    void
    bind(Port &peer) override
    {
        // No need to connect anything here currently. MessageBuffer
        // port connections only serve to print the connections in
        // the config output.
        // TODO: Add real ports to MessageBuffers and use SimObject connect
        // code below to bind MessageBuffer senders and receivers
    }
    void unbind() override {}

    static RubyDummyPort &
    instance()
    {
        static RubyDummyPort dummy;
        return dummy;
    }
};

#endif //__MEM_RUBY_NETWORK_DUMMY_PORT_HH__