| 1 | // ========== Copyright Header Begin ========================================== |
| 2 | // |
| 3 | // OpenSPARC T2 Processor File: XactorBaseBuilder.vr |
| 4 | // Copyright (C) 1995-2007 Sun Microsystems, Inc. All Rights Reserved |
| 5 | // 4150 Network Circle, Santa Clara, California 95054, U.S.A. |
| 6 | // |
| 7 | // * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 8 | // |
| 9 | // This program is free software; you can redistribute it and/or modify |
| 10 | // it under the terms of the GNU General Public License as published by |
| 11 | // the Free Software Foundation; version 2 of the License. |
| 12 | // |
| 13 | // This program is distributed in the hope that it will be useful, |
| 14 | // but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | // GNU General Public License for more details. |
| 17 | // |
| 18 | // You should have received a copy of the GNU General Public License |
| 19 | // along with this program; if not, write to the Free Software |
| 20 | // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 21 | // |
| 22 | // For the avoidance of doubt, and except that if any non-GPL license |
| 23 | // choice is available it will apply instead, Sun elects to use only |
| 24 | // the General Public License version 2 (GPLv2) at this time for any |
| 25 | // software where a choice of GPL license versions is made |
| 26 | // available with the language indicating that GPLv2 or any later version |
| 27 | // may be used, or where a choice of which version of the GPL is applied is |
| 28 | // otherwise unspecified. |
| 29 | // |
| 30 | // Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 31 | // CA 95054 USA or visit www.sun.com if you need additional information or |
| 32 | // have any questions. |
| 33 | // |
| 34 | // ========== Copyright Header End ============================================ |
| 35 | #include <vera_defines.vrh> |
| 36 | #include "XactorBasePacket.vrh" |
| 37 | #include "XactorBaseSignalInterface.vrh" |
| 38 | #include "XactorBaseManager.vrh" |
| 39 | #include "XactorBaseExpectDataStruct.vrh" |
| 40 | #include "XactorDefines.vri" |
| 41 | #include "cReport.vrh" |
| 42 | |
| 43 | virtual class XactorBaseBuilder { |
| 44 | |
| 45 | // Report (there will only be one report instance for all the transactor |
| 46 | // and monitor related objects |
| 47 | ReportClass MyReport; |
| 48 | |
| 49 | // This task will be chained with the new task(s) of extended classes |
| 50 | task new() {} |
| 51 | |
| 52 | // Returns a packet object specific to a transactor library |
| 53 | virtual function XactorBasePacket CreatePacket(); |
| 54 | |
| 55 | // Returns a manager object specific to a transactor library |
| 56 | virtual function XactorBaseManager CreateManager(); |
| 57 | |
| 58 | // Returns a signal interface object specific to a transactor library |
| 59 | virtual function XactorBaseSignalInterface CreateSignalInterface(); |
| 60 | |
| 61 | // Returns an expect data structure (this data structure will store |
| 62 | // expected values without "wildcards" or "don't care" bits) |
| 63 | virtual function XactorBaseExpectDataStruct CreateExpectDataStruct(){} |
| 64 | |
| 65 | // Returns an expect data structure (this data structure will store |
| 66 | // expected values with "wildcards" or "don't care" bits) |
| 67 | virtual function XactorBaseExpectDataStruct CreateXExpectDataStruct(){} |
| 68 | |
| 69 | // Not enforced. Used to assign a data structure for each element of a |
| 70 | // hash table |
| 71 | virtual function XactorBaseExpectDataStruct CreateHashElement() {} |
| 72 | |
| 73 | // Returns a string with the name of the transactor. |
| 74 | virtual function string CreateName(){} |
| 75 | |
| 76 | // Returns a report object. This should be the only report object for |
| 77 | // the transactor that is being built. |
| 78 | virtual function ReportClass CreateReport(){} |
| 79 | |
| 80 | } |