1 files changed, 51 insertions, 0 deletions
diff --git a/configs/topologies/BaseTopology.py b/configs/topologies/BaseTopology.py
new file mode 100644
index 000000000..114a29f19
--- /dev/null
+++ b/configs/topologies/BaseTopology.py
@@ -0,0 +1,51 @@
+# Copyright (c) 2012 Advanced Micro Devices, Inc.
+# 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.
+#
+# Authors: Jason Power
+
+
+class BaseTopology(object):
+    description = "BaseTopology"
+
+    def __init__(self):
+        """ When overriding place any objects created in
+            configs/ruby/<protocol>.py that are needed in
+            makeTopology (below) here. The minimum is usually
+            all of the controllers created in the above file.
+        """
+
+    def makeTopology(self, options, IntLink, ExtLink, Router):
+        """ Called from src/mem/ruby/network/topologies/TopologyCreatory.py
+            The return value is ( list(Router), list(IntLink), list(ExtLink))
+            The API of this function cannot change when subclassing!!
+            Any additional information needed to create this topology should
+            be passed into the constructor when it's instantiated in
+            configs/ruby/<protocol>.py
+        """
+        print "BaseTopology should have been overridden in a sub class!!"
+        import sys
+        sys.exit(1)
+