/*
 * Copyright (c) 2006-2007 The Regents of The University of Michigan
 * 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.
 */

#ifndef __ARCH_SPARC_INSTS_BLOCKMEM_HH__
#define __ARCH_SPARC_INSTS_BLOCKMEM_HH__

#include "arch/sparc/insts/micro.hh"

namespace gem5
{

namespace SparcISA
{

////////////////////////////////////////////////////////////////////
//
// Block Memory instructions
//

class BlockMem : public SparcMacroInst
{
  protected:
    // We make the assumption that all block memory operations will take
    // 8 instructions to execute.
    BlockMem(const char *mnem, ExtMachInst _machInst) :
        SparcMacroInst(mnem, _machInst, No_OpClass, 8)
    {}
};

class BlockMemImm : public BlockMem
{
  protected:
    using BlockMem::BlockMem;
};

class BlockMemMicro : public SparcMicroInst
{
  protected:
    BlockMemMicro(const char *mnem, ExtMachInst _machInst,
                  OpClass __opClass, int8_t _offset) :
        SparcMicroInst(mnem, _machInst, __opClass), offset(_offset)
    {}

    std::string generateDisassembly(
            Addr pc, const loader::SymbolTable *symtab) const override;

    const int8_t offset;
};

class BlockMemImmMicro : public BlockMemMicro
{
  protected:
    BlockMemImmMicro(const char *mnem, ExtMachInst _machInst,
                     OpClass __opClass, int8_t _offset) :
        BlockMemMicro(mnem, _machInst, __opClass, _offset),
        imm(szext<13>(_machInst))
    {}

    std::string generateDisassembly(
            Addr pc, const loader::SymbolTable *symtab) const override;

    const int32_t imm;
};

} // namespace SparcISA
} // namespace gem5

#endif // __ARCH_SPARC_INSTS_BLOCKMEM_HH__