/*
 * Copyright (c) 2010 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Copyright (c) 2006 The Regents of The University of Michigan
 * 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: Gabe Black
 *          Stephen Hines
 */

#ifndef __ARCH_ARM_PREDECODER_HH__
#define __ARCH_ARM_PREDECODER_HH__

#include "arch/arm/types.hh"
#include "base/misc.hh"
#include "base/types.hh"

class ThreadContext;

namespace ArmISA
{
    class Predecoder
    {
      protected:
        ThreadContext * tc;
        //The extended machine instruction being generated
        ExtMachInst emi;
        MachInst data;
        bool bigThumb;
        int offset;

      public:
        Predecoder(ThreadContext * _tc) :
            tc(_tc), data(0), bigThumb(false), offset(0)
        {}

        ThreadContext * getTC()
        {
            return tc;
        }

        void setTC(ThreadContext * _tc)
        {
            tc = _tc;
        }

        void reset()
        {
            bigThumb = false;
            offset = 0;
            emi = 0;
        }

        void process()
        {
            if (!emi.thumb) {
                emi.instBits = data;
                emi.sevenAndFour = bits(data, 7) && bits(data, 4);
                emi.isMisc = (bits(data, 24, 23) == 0x2 &&
                              bits(data, 20) == 0);
                DPRINTF(Predecoder, "Arm inst.\n");
            } else {
                uint16_t word = (data >> (offset * 8));
                if (bigThumb) {
                    // A 32 bit thumb inst is half collected.
                    emi.instBits = emi.instBits | word;
                    bigThumb = false;
                    offset += 2;
                    DPRINTF(Predecoder, "Second half of 32 bit Thumb.\n");
                } else {
                    uint16_t highBits = word & 0xF800;
                    if (highBits == 0xE800 || highBits == 0xF000 ||
                            highBits == 0xF800) {
                        // The start of a 32 bit thumb inst.
                        emi.bigThumb = 1;
                        if (offset == 0) {
                            // We've got the whole thing.
                            DPRINTF(Predecoder,
                                    "All of 32 bit Thumb.\n");
                            emi.instBits = (data >> 16) | (data << 16);
                            offset += 4;
                        } else {
                            // We only have the first half word.
                            DPRINTF(Predecoder,
                                    "First half of 32 bit Thumb.\n");
                            emi.instBits = (uint32_t)word << 16;
                            bigThumb = true;
                            offset += 2;
                        }
                    } else {
                        // A 16 bit thumb inst.
                        DPRINTF(Predecoder, "16 bit Thumb.\n");
                        offset += 2;
                        emi.instBits = word;
                    }
                }
            }
        }

        //Use this to give data to the predecoder. This should be used
        //when there is control flow.
        void moreBytes(Addr pc, Addr fetchPC, MachInst inst)
        {
            data = inst;
            offset = (fetchPC >= pc) ? 0 : pc - fetchPC;
            emi.thumb = (pc & (ULL(1) << PcTBitShift)) ? 1 : 0;
            process();
        }

        //Use this to give data to the predecoder. This should be used
        //when instructions are executed in order.
        void moreBytes(MachInst machInst)
        {
            moreBytes(0, 0, machInst);
        }

        bool needMoreBytes()
        {
            return sizeof(MachInst) > offset;
        }

        bool extMachInstReady()
        {
            // The only way an instruction wouldn't be ready is if this is a
            // 32 bit ARM instruction that's not 32 bit aligned.
            return !bigThumb;
        }

        int getInstSize()
        {
            return (!emi.thumb || emi.bigThumb) ? 4 : 2;
        }

        //This returns a constant reference to the ExtMachInst to avoid a copy
        ExtMachInst getExtMachInst()
        {
            ExtMachInst thisEmi = emi;
            emi = 0;
            return thisEmi;
        }
    };
};

#endif // __ARCH_ARM_PREDECODER_HH__