xref: /gem5/src/arch/arm/isa/formats/macromem.isa

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

// Copyright (c) 2007-2008 The Florida State University
// 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: Stephen Hines

////////////////////////////////////////////////////////////////////
//
// Macro Memory-format instructions
//

def template MacroStoreDeclare {{
/**
 * Static instructions class for a store multiple instruction
 */
class %(class_name)s : public %(base_class)s
{
    public:
        // Constructor
        %(class_name)s(ExtMachInst machInst);
        %(BasicExecDeclare)s
};
}};

def template MacroStoreConstructor {{
inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
    : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
{
    %(constructor)s;
    uint32_t regs_to_handle = reglist;
    uint32_t j = 0,
             start_addr = 0,
             end_addr = 0;

    switch (puswl)
    {
        case 0x00: //       stmda
        case 0x01: //     L ldmda_l
        case 0x02: //    W  stmda_w
        case 0x03: //    WL ldmda_wl
            start_addr = (ones << 2) - 4;
            end_addr = 0;
            break;
        case 0x08: //  U    stmia_u
        case 0x09: //  U  L ldmia_ul
        case 0x0a: //  U W  stmia
        case 0x0b: //  U WL ldmia
            start_addr = 0;
            end_addr = (ones << 2) - 4;
            break;
        case 0x10: // P     stmdb
        case 0x11: // P   L ldmdb
        case 0x12: // P  W  stmdb
        case 0x13: // P  WL ldmdb
            start_addr = (ones << 2); // U-bit is already 0 for subtract
            end_addr = 4; // negative 4
            break;
        case 0x18: // PU    stmib
        case 0x19: // PU  L ldmib
        case 0x1a: // PU W  stmib
        case 0x1b: // PU WL ldmib
            start_addr = 4;
            end_addr = (ones << 2) + 4;
            break;
        default:
            panic("Unhandled Load/Store Multiple Instruction, "
                "puswl = 0x%x", (unsigned) puswl);
            break;
    }

    //TODO - Add addi_uop/subi_uop here to create starting addresses
    //Just using addi with 0 offset makes a "copy" of Rn for our use
    uint32_t newMachInst = 0;
    newMachInst = machInst & 0xffff0000;
    microOps[0] = new Addi_uop(newMachInst);

    for (int i = 1; i < ones+1; i++)
    {
        // Get next available bit for transfer
        while (! ( regs_to_handle & (1<<j)))
            j++;
        regs_to_handle &= ~(1<<j);

        microOps[i] = gen_ldrstr_uop(machInst, loadop, j, start_addr);

        if (up)
            start_addr += 4;
        else
            start_addr -= 4;
    }

    /* TODO: Take a look at how these 2 values should meet together
    if (start_addr != (end_addr - 4))
    {
        fprintf(stderr, "start_addr: %d\n", start_addr);
        fprintf(stderr, "end_addr:   %d\n", end_addr);
        panic("start_addr does not meet end_addr");
    }
    */

    if (writeback)
    {
        uint32_t newMachInst = machInst & 0xf0000000;
        uint32_t rn = (machInst >> 16) & 0x0f;
        // 3322 2222 2222 1111 1111 11
        // 1098 7654 3210 9876 5432 1098 7654 3210
        // COND 0010 0100 [RN] [RD] 0000 [  IMM  ]
        // sub rn, rn, imm
        newMachInst |= 0x02400000;
        newMachInst |= ((rn << 16) | (rn << 12));
        newMachInst |= (ones << 2);
        if (up)
        {
            microOps[numMicroops-1] = new Addi_rd_uop(newMachInst);
        }
        else
        {
            microOps[numMicroops-1] = new Subi_rd_uop(newMachInst);
        }
    }
    microOps[numMicroops-1]->setLastMicroop();
}

}};

def template MacroStoreExecute {{
Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, Trace::InstRecord *traceData) const
{
    Fault fault = NoFault;

    %(fp_enable_check)s;
    %(op_decl)s;
    %(op_rd)s;
    %(code)s;
    if (fault == NoFault)
    {
        %(op_wb)s;
    }

    return fault;
}
}};

def template MacroFPAConstructor {{
inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
    : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
{
    %(constructor)s;

    uint32_t start_addr = 0;

    if (prepost)
        start_addr = disp8;
    else
        start_addr = 0;

    emit_ldfstf_uops(microOps, 0, machInst, loadop, up, start_addr);

    if (writeback)
    {
        uint32_t newMachInst = machInst & 0xf0000000;
        uint32_t rn = (machInst >> 16) & 0x0f;
        // 3322 2222 2222 1111 1111 11
        // 1098 7654 3210 9876 5432 1098 7654 3210
        // COND 0010 0100 [RN] [RD] 0000 [  IMM  ]
        // sub rn, rn, imm
        newMachInst |= 0x02400000;
        newMachInst |= ((rn << 16) | (rn << 12));
        if (up)
        {
            newMachInst |= disp8;
            microOps[numMicroops-1] = new Addi_rd_uop(newMachInst);
        }
        else
        {
            newMachInst |= disp8;
            microOps[numMicroops-1] = new Subi_rd_uop(newMachInst);
        }
    }
    microOps[numMicroops-1]->setLastMicroop();
}

}};


def template MacroFMConstructor {{
inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
    : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
{
    %(constructor)s;

    uint32_t start_addr = 0;

    if (prepost)
        start_addr = disp8;
    else
        start_addr = 0;

    for (int i = 0; i < count; i++)
    {
        emit_ldfstf_uops(microOps, 3*i, machInst, loadop, up, start_addr);
    }

    if (writeback)
    {
        uint32_t newMachInst = machInst & 0xf0000000;
        uint32_t rn = (machInst >> 16) & 0x0f;
        // 3322 2222 2222 1111 1111 11
        // 1098 7654 3210 9876 5432 1098 7654 3210
        // COND 0010 0100 [RN] [RD] 0000 [  IMM  ]
        // sub rn, rn, imm
        newMachInst |= 0x02400000;
        newMachInst |= ((rn << 16) | (rn << 12));
        if (up)
        {
            newMachInst |= disp8;
            microOps[numMicroops-1] = new Addi_rd_uop(newMachInst);
        }
        else
        {
            newMachInst |= disp8;
            microOps[numMicroops-1] = new Subi_rd_uop(newMachInst);
        }
    }
    microOps[numMicroops-1]->setLastMicroop();
}
}};


def format ArmMacroStore(code, mem_flags = [], inst_flag = [], *opt_flags) {{
    iop = InstObjParams(name, Name, 'ArmMacroMemoryOp', code, opt_flags)
    header_output = MacroStoreDeclare.subst(iop)
    decoder_output = MacroStoreConstructor.subst(iop)
    decode_block = BasicDecode.subst(iop)
    exec_output = MacroStoreExecute.subst(iop)
}};

def format ArmMacroFPAOp(code, mem_flags = [], inst_flag = [], *opt_flags) {{
    iop = InstObjParams(name, Name, 'ArmMacroFPAOp',
                        {"code": code,
                         "predicate_test": predicateTest},
                        opt_flags)
    header_output = BasicDeclare.subst(iop)
    decoder_output = MacroFPAConstructor.subst(iop)
    decode_block = BasicDecode.subst(iop)
    exec_output = PredOpExecute.subst(iop)
}};

def format ArmMacroFMOp(code, mem_flags = [], inst_flag = [], *opt_flags) {{
    iop = InstObjParams(name, Name, 'ArmMacroFMOp',
                        {"code": code,
                         "predicate_test": predicateTest},
                        opt_flags)
    header_output = BasicDeclare.subst(iop)
    decoder_output = MacroFMConstructor.subst(iop)
    decode_block = BasicDecode.subst(iop)
    exec_output = PredOpExecute.subst(iop)
}};