sc_port.hh revision 12868:23162a436538
1/* 2 * Copyright 2018 Google, Inc. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer; 8 * redistributions in binary form must reproduce the above copyright 9 * notice, this list of conditions and the following disclaimer in the 10 * documentation and/or other materials provided with the distribution; 11 * neither the name of the copyright holders nor the names of its 12 * contributors may be used to endorse or promote products derived from 13 * this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * Authors: Gabe Black 28 */ 29 30#ifndef __SYSTEMC_EXT_CORE_SC_PORT_HH__ 31#define __SYSTEMC_EXT_CORE_SC_PORT_HH__ 32 33#include "sc_module.hh" // for sc_gen_unique_name 34#include "sc_object.hh" 35 36namespace sc_core 37{ 38 39class sc_interface; 40 41enum sc_port_policy 42{ 43 SC_ONE_OR_MORE_BOUND, // Default 44 SC_ZERO_OR_MORE_BOUND, 45 SC_ALL_BOUND 46}; 47 48class sc_port_base : public sc_object 49{ 50 public: 51 sc_port_base(const char *name, int n, sc_port_policy p) : sc_object(name) 52 {} 53 54 void warn_unimpl(const char *func) const; 55}; 56 57template <class IF> 58class sc_port_b : public sc_port_base 59{ 60 public: 61 void 62 operator () (IF &) 63 { 64 this->warn_unimpl(__PRETTY_FUNCTION__); 65 } 66 67 void 68 operator () (sc_port_b<IF> &) 69 { 70 this->warn_unimpl(__PRETTY_FUNCTION__); 71 } 72 73 virtual void 74 bind(IF &) 75 { 76 this->warn_unimpl(__PRETTY_FUNCTION__); 77 } 78 79 virtual void 80 bind(sc_port_b<IF> &) 81 { 82 this->warn_unimpl(__PRETTY_FUNCTION__); 83 } 84 85 int 86 size() const 87 { 88 this->warn_unimpl(__PRETTY_FUNCTION__); 89 return 0; 90 } 91 92 IF * 93 operator -> () 94 { 95 this->warn_unimpl(__PRETTY_FUNCTION__); 96 return (IF *)nullptr; 97 } 98 99 const IF * 100 operator -> () const 101 { 102 this->warn_unimpl(__PRETTY_FUNCTION__); 103 return (IF *)nullptr; 104 } 105 106 IF * 107 operator [] (int) 108 { 109 this->warn_unimpl(__PRETTY_FUNCTION__); 110 return (IF *)nullptr; 111 } 112 113 const IF * 114 operator [] (int) const 115 { 116 this->warn_unimpl(__PRETTY_FUNCTION__); 117 return (IF *)nullptr; 118 } 119 120 virtual sc_interface * 121 get_interface() 122 { 123 this->warn_unimpl(__PRETTY_FUNCTION__); 124 return (sc_interface *)nullptr; 125 } 126 127 virtual const sc_interface * 128 get_interface() const 129 { 130 this->warn_unimpl(__PRETTY_FUNCTION__); 131 return (sc_interface *)nullptr; 132 } 133 134 protected: 135 virtual void before_end_of_elaboration() {} 136 virtual void end_of_elaboration() {} 137 virtual void start_of_elaboration() {} 138 virtual void end_of_simulation() {} 139 140 explicit sc_port_b(int n, sc_port_policy p) : 141 sc_port_base(sc_gen_unique_name("sc_port"), n, p) 142 {} 143 sc_port_b(const char *name, int n, sc_port_policy p) : 144 sc_port_base(name, n, p) 145 {} 146 virtual ~sc_port_b() {} 147 148 private: 149 // Disabled 150 sc_port_b() {} 151 sc_port_b(const sc_port_b<IF> &) {} 152 sc_port_b<IF> &operator = (const sc_port_b<IF> &) { return *this; } 153}; 154 155template <class IF, int N=1, sc_port_policy P=SC_ONE_OR_MORE_BOUND> 156class sc_port : public sc_port_b<IF> 157{ 158 public: 159 sc_port() : sc_port_b<IF>(N, P) {} 160 explicit sc_port(const char *name) : sc_port_b<IF>(name, N, P) {} 161 virtual ~sc_port() {} 162 163 // Deprecated binding constructors. 164 explicit sc_port(const IF &interface) : sc_port_b<IF>(N, P) 165 { 166 this->warn_unimpl(__PRETTY_FUNCTION__); 167 // Should warn that these are deprecated. See Accellera sc_port.h. 168 sc_port_b<IF>::bind(const_cast<IF &>(interface)); 169 } 170 sc_port(const char *name, const IF &interface) : sc_port_b<IF>(name, N, P) 171 { 172 this->warn_unimpl(__PRETTY_FUNCTION__); 173 // Should warn that these are deprecated. See Accellera sc_port.h. 174 sc_port_b<IF>::bind(const_cast<IF &>(interface)); 175 } 176 explicit sc_port(sc_port_b<IF> &parent) : sc_port_b<IF>(N, P) 177 { 178 this->warn_unimpl(__PRETTY_FUNCTION__); 179 // Should warn that these are deprecated. See Accellera sc_port.h. 180 sc_port_b<IF>::bind(parent); 181 } 182 sc_port(const char *name, sc_port_b<IF> &parent) : 183 sc_port_b<IF>(name, N, P) 184 { 185 this->warn_unimpl(__PRETTY_FUNCTION__); 186 // Should warn that these are deprecated. See Accellera sc_port.h. 187 sc_port_b<IF>::bind(parent); 188 } 189 explicit sc_port(sc_port<IF, N, P> &parent) : sc_port_b<IF>(N, P) 190 { 191 this->warn_unimpl(__PRETTY_FUNCTION__); 192 // Should warn that these are deprecated. See Accellera sc_port.h. 193 sc_port_b<IF>::bind(parent); 194 } 195 sc_port(const char *name, sc_port<IF, N, P> &parent) : 196 sc_port_b<IF>(name, N, P) 197 { 198 this->warn_unimpl(__PRETTY_FUNCTION__); 199 // Should warn that these are deprecated. See Accellera sc_port.h. 200 sc_port_b<IF>::bind(parent); 201 } 202 203 virtual const char *kind() const { return "sc_port"; } 204 205 private: 206 // Disabled 207 sc_port(const sc_port<IF, N, P> &) {} 208 sc_port<IF, N, P> &operator = (const sc_port<IF, N, P> &) { return *this; } 209}; 210 211} // namespace sc_core 212 213#endif //__SYSTEMC_EXT_CORE_SC_PORT_HH__ 214