| 1 | // ========== Copyright Header Begin ========================================== |
| 2 | // |
| 3 | // OpenSPARC T2 Processor File: XactorBasePacket.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 "XactorDefines.vri" |
| 37 | #include "CTTransactionID.vrh" |
| 38 | #include "cReport.vrh" |
| 39 | |
| 40 | virtual class XactorBasePacket { |
| 41 | |
| 42 | // CTTransactionID handle |
| 43 | CTTransactionID XactionID; |
| 44 | // Report handle |
| 45 | ReportClass MyReport; |
| 46 | // Drive event |
| 47 | event DriveEvent; |
| 48 | |
| 49 | // The extended class declares all the fields that the packet |
| 50 | // encapsulates and initializes them through the new task. |
| 51 | |
| 52 | task new() {} |
| 53 | |
| 54 | // Through this task a transactionID object is passed to the packet |
| 55 | virtual task SetID(CTTransactionID XactionID); |
| 56 | |
| 57 | // Returns a CTTransactionID |
| 58 | virtual function CTTransactionID GetID(); |
| 59 | |
| 60 | // FieldType is a string that indicates which field to set. FieldValue is the actual |
| 61 | // value that the packet field will be set to. |
| 62 | virtual task Set(string FieldType, |
| 63 | bit [XACT_FIELD_WIDTH-1:0] FieldValue); |
| 64 | |
| 65 | // FieldType is a string that indicates which field to get. FieldValue is the returned |
| 66 | // value of the field indicated by FieldType. |
| 67 | virtual function bit [XACT_FIELD_WIDTH-1:0] Get(string FieldType); |
| 68 | |
| 69 | // This function will return a packet ready to be schedule for driving. |
| 70 | virtual function XactorBasePacket FormDriven(); |
| 71 | |
| 72 | // This task will display the contents of the packet. TypeRep is the report type used |
| 73 | // when printing the Packet. |
| 74 | virtual task PktDisplay(ReportType TypeRep, |
| 75 | string Message |
| 76 | ); |
| 77 | |
| 78 | // This task will compare this packet with the packet (Pkt) passed as an argument. |
| 79 | // The comparison operation is specified in the string Operation. |
| 80 | virtual function bit PktCompare(string Operation, |
| 81 | XactorBasePacket Pkt); |
| 82 | |
| 83 | // This function will return an index to a hash table of size HashSize. The value to be |
| 84 | // hashed will be formed by the Packet itself. |
| 85 | virtual function integer PktHash(integer HashSize); |
| 86 | |
| 87 | // This function will return 1 if the data of this packet that is expected has |
| 88 | // X's or Z's values. And will return 0 otherwise. |
| 89 | virtual function bit PktUndef(); |
| 90 | |
| 91 | // This task will take Pkt as an argument and will copy every field of Pkt to itself. |
| 92 | virtual task PktCopy(XactorBasePacket Pkt); |
| 93 | |
| 94 | // This task will return an object of its same type and with the same field values. |
| 95 | virtual function XactorBasePacket PktClone(); |
| 96 | |
| 97 | // This task will reset the fields of the packet. |
| 98 | virtual task PktReset(); |
| 99 | |
| 100 | // This task will sync on DriveEvent |
| 101 | virtual task SyncOnDrive() {} |
| 102 | |
| 103 | // This task will trigger DriveEvent |
| 104 | virtual task TriggerDrive() {} |
| 105 | } |
| 106 | |