// -*- mode:c++ -*-

// Copyright .AN) 2007 MIPS Technologies, Inc.  All Rights Reserved

//  This software is part of the M5 simulator.

//  THIS IS A LEGAL AGREEMENT.  BY DOWNLOADING, USING, COPYING, CREATING
//  DERIVATIVE WORKS, AND/OR DISTRIBUTING THIS SOFTWARE YOU ARE AGREEING
//  TO THESE TERMS AND CONDITIONS.

//  Permission is granted to use, copy, create derivative works and
//  distribute this software and such derivative works for any purpose,
//  so long as (1) the copyright notice above, this grant of permission,
//  and the disclaimer below appear in all copies and derivative works
//  made, (2) the copyright notice above is augmented as appropriate to
//  reflect the addition of any new copyrightable work in a derivative
//  work (e.g., Copyright .AN) <Publication Year> Copyright Owner), and (3)
//  the name of MIPS Technologies, Inc. ($B!H(BMIPS$B!I(B) is not used in any
//  advertising or publicity pertaining to the use or distribution of
//  this software without specific, written prior authorization.

//  THIS SOFTWARE IS PROVIDED $B!H(BAS IS.$B!I(B  MIPS MAKES NO WARRANTIES AND
//  DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, STATUTORY, IMPLIED OR
//  OTHERWISE, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
//  NON-INFRINGEMENT OF THIRD PARTY RIGHTS, REGARDING THIS SOFTWARE.
//  IN NO EVENT SHALL MIPS BE LIABLE FOR ANY DAMAGES, INCLUDING DIRECT,
//  INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, OR PUNITIVE DAMAGES OF
//  ANY KIND OR NATURE, ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT,
//  THIS SOFTWARE AND/OR THE USE OF THIS SOFTWARE, WHETHER SUCH LIABILITY
//  IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE OR
//  STRICT LIABILITY), OR OTHERWISE, EVEN IF MIPS HAS BEEN WARNED OF THE
//  POSSIBILITY OF ANY SUCH LOSS OR DAMAGE IN ADVANCE.

//Authors: Korey L. Sewell
//         Jaidev Patwardhan

def operand_types {{
    'sb' : ('signed int', 8),
    'ub' : ('unsigned int', 8),
    'sh' : ('signed int', 16),
    'uh' : ('unsigned int', 16),
    'sw' : ('signed int', 32),
    'uw' : ('unsigned int', 32),
    'sd' : ('signed int', 64),
    'ud' : ('unsigned int', 64),
    'sf' : ('float', 32),
    'df' : ('float', 64),
}};

def operands {{
    #General Purpose Integer Reg Operands
    'Rd': ('IntReg', 'uw', 'RD', 'IsInteger', 1),
    'Rs': ('IntReg', 'uw', 'RS', 'IsInteger', 2),
    'Rt': ('IntReg', 'uw', 'RT', 'IsInteger', 3),

    #Immediate Value operand
    'IntImm': ('IntReg', 'uw', 'INTIMM', 'IsInteger', 3),

    #Operands used for Link or Syscall Insts
    'R31': ('IntReg', 'uw','31','IsInteger', 4),
    'R2':  ('IntReg', 'uw','2', 'IsInteger', 5),

    #Special Integer Reg operands
    'LO0':  ('IntReg', 'uw','MipsISA::LO', 'IsInteger', 6),
    'HI0':  ('IntReg', 'uw','MipsISA::HI', 'IsInteger', 7),

    #Bitfield-dependent HI/LO Register Access
    'LO_RD_SEL': ('IntReg','uw','MipsISA::DSPLo0 + ACDST*3', None, 6),
    'HI_RD_SEL': ('IntReg','uw','MipsISA::DSPHi0 + ACDST*3', None, 7),
    'LO_RS_SEL': ('IntReg','uw','MipsISA::DSPLo0 + ACSRC*3', None, 6),
    'HI_RS_SEL': ('IntReg','uw','MipsISA::DSPHi0 + ACSRC*3', None, 7),

    #DSP Special Purpose Integer Operands
    'DSPControl': ('IntReg', 'uw', 'MipsISA::DSPControl', None, 8),
    'DSPLo0': ('IntReg', 'uw', 'MipsISA::LO', None, 1),
    'DSPHi0': ('IntReg', 'uw', 'MipsISA::HI', None, 1),
    'DSPACX0': ('IntReg', 'uw', 'MipsISA::DSPACX0', None, 1),
    'DSPLo1': ('IntReg', 'uw', 'MipsISA::DSPLo1', None, 1),
    'DSPHi1': ('IntReg', 'uw', 'MipsISA::DSPHi1', None, 1),
    'DSPACX1': ('IntReg', 'uw', 'MipsISA::DSPACX1', None, 1),
    'DSPLo2': ('IntReg', 'uw', 'MipsISA::DSPLo2', None, 1),
    'DSPHi2': ('IntReg', 'uw', 'MipsISA::DSPHi2', None, 1),
    'DSPACX2': ('IntReg', 'uw', 'MipsISA::DSPACX2', None, 1),
    'DSPLo3': ('IntReg', 'uw', 'MipsISA::DSPLo3', None, 1),
    'DSPHi3': ('IntReg', 'uw', 'MipsISA::DSPHi3', None, 1),
    'DSPACX3': ('IntReg', 'uw', 'MipsISA::DSPACX3', None, 1),

    #Floating Point Reg Operands
    'Fd': ('FloatReg', 'sf', 'FD', 'IsFloating', 1),
    'Fs': ('FloatReg', 'sf', 'FS', 'IsFloating', 2),
    'Ft': ('FloatReg', 'sf', 'FT', 'IsFloating', 3),
    'Fr': ('FloatReg', 'sf', 'FR', 'IsFloating', 3),

    #Special Purpose Floating Point Control Reg Operands
    'FIR':  ('FloatReg', 'uw', 'MipsISA::FIR', 'IsFloating', 1),
    'FCCR': ('FloatReg', 'uw', 'MipsISA::FCCR', 'IsFloating', 2),
    'FEXR': ('FloatReg', 'uw', 'MipsISA::FEXR', 'IsFloating', 3),
    'FENR': ('FloatReg', 'uw', 'MipsISA::FENR', 'IsFloating', 3),
    'FCSR': ('FloatReg', 'uw', 'MipsISA::FCSR', 'IsFloating', 3),

    #Operands For Paired Singles FP Operations
    'Fd1': ('FloatReg', 'sf', 'FD', 'IsFloating', 4),
    'Fd2': ('FloatReg', 'sf', 'FD+1', 'IsFloating', 4),
    'Fs1': ('FloatReg', 'sf', 'FS', 'IsFloating', 5),
    'Fs2': ('FloatReg', 'sf', 'FS+1', 'IsFloating', 5),
    'Ft1': ('FloatReg', 'sf', 'FT', 'IsFloating', 6),
    'Ft2': ('FloatReg', 'sf', 'FT+1', 'IsFloating', 6),
    'Fr1': ('FloatReg', 'sf', 'FR', 'IsFloating', 7),
    'Fr2': ('FloatReg', 'sf', 'FR+1', 'IsFloating', 7),

    #Status Control Reg
    'Status': ('ControlReg', 'uw', 'MipsISA::Status', None, 1),

    #LL Flag
    'LLFlag': ('ControlReg', 'uw', 'MipsISA::LLFlag', None, 1),

    # Index Register
    'Index':('ControlReg','uw','MipsISA::Index',None,1),


    #Special cases for when a Control Register Access is dependent on
    #a combination of bitfield indices (handles MTCO & MFCO)
    # Fixed to allow CP0 Register Offset
    'CP0_RD_SEL': ('IControlReg', 'uw', '(RD << 3 | SEL) + Ctrl_Base_DepTag', None, 1),

    #MT Control Regs
    'MVPConf0': ('ControlReg', 'uw', 'MipsISA::MVPConf0', None, 1),
    'MVPControl': ('ControlReg', 'uw', 'MipsISA::MVPControl', None, 1),
    'TCBind': ('ControlReg', 'uw', 'MipsISA::TCBind', None, 1),
    'TCStatus': ('ControlReg', 'uw', 'MipsISA::TCStatus', None, 1),
    'TCRestart': ('ControlReg', 'uw', 'MipsISA::TCRestart', None, 1),
    'VPEConf0': ('ControlReg', 'uw', 'MipsISA::VPEConf0', None, 1),
    'VPEControl': ('ControlReg', 'uw', 'MipsISA::VPEControl', None, 1),
    'YQMask': ('ControlReg', 'uw', 'MipsISA::YQMask', None, 1),

    #CP0 Control Regs
    'EntryHi': ('ControlReg','uw', 'MipsISA::EntryHi',None,1),
    'EntryLo0': ('ControlReg','uw', 'MipsISA::EntryLo0',None,1),
    'EntryLo1': ('ControlReg','uw', 'MipsISA::EntryLo1',None,1),
    'PageMask': ('ControlReg','uw', 'MipsISA::PageMask',None,1),
    'Random': ('ControlReg','uw', 'MipsISA::CP0_Random',None,1),
    'ErrorEPC': ('ControlReg','uw', 'MipsISA::ErrorEPC',None,1),
    'EPC': ('ControlReg','uw', 'MipsISA::EPC',None,1),
    'DEPC': ('ControlReg','uw', 'MipsISA::DEPC',None,1),
    'SRSCtl': ('ControlReg','uw', 'MipsISA::SRSCtl',None,1),
    'Config': ('ControlReg','uw', 'MipsISA::Config',None,1),
    'Config3': ('ControlReg','uw', 'MipsISA::Config3',None,1),
    'Config1': ('ControlReg','uw', 'MipsISA::Config1',None,1),
    'Config2': ('ControlReg','uw', 'MipsISA::Config2',None,1),
    'PageGrain': ('ControlReg','uw', 'MipsISA::PageGrain',None,1),


    # named bitfields of Control Regs
    'Status_IE': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_ERL': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_EXL': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_BEV': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_CU3': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_CU2': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_CU1': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'Status_CU0': ('ControlBitfield', 'uw', 'MipsISA::Status', None, 1),
    'SRSCtl_HSS': ('ControlBitfield', 'uw', 'MipsISA::SRSCtl', None, 4),
    'SRSCtl_PSS': ('ControlBitfield', 'uw', 'MipsISA::SRSCtl', None, 4),
    'SRSCtl_CSS': ('ControlBitfield', 'uw', 'MipsISA::SRSCtl', None, 4),
    'Config_AR': ('ControlBitfield', 'uw', 'MipsISA::Config', None, 3),
    'Config_MT': ('ControlBitfield', 'uw', 'MipsISA::Config', None, 1),
    'Config1_CA': ('ControlBitfield', 'uw', 'MipsISA::Config1', None, 1),
    'Config3_SP': ('ControlBitfield', 'uw', 'MipsISA::Config3', None, 1),
    'PageGrain_ESP': ('ControlBitfield', 'uw', 'MipsISA::PageGrain', None, 1),
    'Cause_EXCCODE': ('ControlBitfield', 'uw', 'MipsISA::Cause', None, 4),
    'Cause_TI': ('ControlBitfield', 'uw', 'MipsISA::Cause', None, 4),
    'IntCtl_IPTI': ('ControlBitfield', 'uw', 'MipsISA::IntCtl', None, 4),
    'EntryHi_ASID': ('ControlBitfield', 'uw', 'MipsISA::EntryHi', None, 1),
    'EntryLo0_PFN': ('ControlBitfield', 'uw', 'MipsISA::EntryLo0', None, 1),
    'EntryLo0_C': ('ControlBitfield', 'uw', 'MipsISA::EntryLo0', None, 3),
    'EntryLo0_D': ('ControlBitfield', 'uw', 'MipsISA::EntryLo0', None, 1),
    'EntryLo0_V': ('ControlBitfield', 'uw', 'MipsISA::EntryLo0', None, 1),
    'EntryLo0_G': ('ControlBitfield', 'uw', 'MipsISA::EntryLo0', None, 1),
    'EntryLo1_PFN': ('ControlBitfield', 'uw', 'MipsISA::EntryLo1', None, 1),
    'EntryLo1_C': ('ControlBitfield', 'uw', 'MipsISA::EntryLo1', None, 3),
    'EntryLo1_D': ('ControlBitfield', 'uw', 'MipsISA::EntryLo1', None, 1),
    'EntryLo1_V': ('ControlBitfield', 'uw', 'MipsISA::EntryLo1', None, 1),
    'EntryLo1_G': ('ControlBitfield', 'uw', 'MipsISA::EntryLo1', None, 1),

    # named bitfields of Debug Regs
    'Debug_DM': ('ControlBitfield', 'uw', 'MipsISA::Debug', None, 1),
    'Debug_IEXI': ('ControlBitfield', 'uw', 'MipsISA::Debug', None, 1),

    #Memory Operand
    'Mem': ('Mem', 'uw', None, ('IsMemRef', 'IsLoad', 'IsStore'), 4),

    #Program Counter Operands
    'NPC': ('NPC', 'uw', None, 'IsControl', 4),
    'NNPC':('NNPC', 'uw', None, 'IsControl', 4)
}};