/*
 * Copyright (c) 2008 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.
 *
 * Authors: Gabe Black
 */

#ifndef __ARCH_X86_MICROCODE_ROM_HH__
#define __ARCH_X86_MICROCODE_ROM_HH__

#include "arch/x86/insts/badmicroop.hh"
#include "arch/x86/emulenv.hh"
#include "cpu/static_inst.hh"

namespace X86ISAInst
{
    class MicrocodeRom
    {
      protected:

        typedef StaticInstPtr (*GenFunc)(StaticInstPtr);

        static const MicroPC numMicroops;

        GenFunc * genFuncs;

      public:
        //Constructor.
        MicrocodeRom();

        //Destructor.
        ~MicrocodeRom()
        {
            delete [] genFuncs;
        }

        StaticInstPtr
        fetchMicroop(MicroPC microPC, StaticInstPtr curMacroop)
        {
            microPC = normalMicroPC(microPC);
            if (microPC >= numMicroops)
                return X86ISA::badMicroop;
            else
                return genFuncs[microPC](curMacroop);
        }
    };
}

namespace X86ISA
{
    using X86ISAInst::MicrocodeRom;
}

#endif // __ARCH_X86_MICROCODE_ROM_HH__
