/*******************************************************************************
 * Copyright (C) 2017, MINRES Technologies GmbH
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 
 * 2. 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.
 * 
 * 3. Neither the name of the copyright holder 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 HOLDER 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.
 * 
 * Contributors:
 *       eyck@minres.com - initial API and implementation
 ******************************************************************************/

#ifndef _MINRV_IMA_H_
#define _MINRV_IMA_H_

#include <iss/arch_if.h>
#include <iss/vm_if.h>
#include <iss/arch/traits.h>

namespace iss {
namespace arch {

struct minrv_ima;

template<>
struct traits<minrv_ima> {

    enum constants {XLEN=32,XLEN2=64,XLEN_BIT_MASK=31,PCLEN=32,fence=0,fencei=1,fencevmal=2,fencevmau=3,MISA_VAL=1075056897,PGSIZE=4096,PGMASK=4095};

    enum reg_e {
        X0,
        X1,
        X2,
        X3,
        X4,
        X5,
        X6,
        X7,
        X8,
        X9,
        X10,
        X11,
        X12,
        X13,
        X14,
        X15,
        X16,
        X17,
        X18,
        X19,
        X20,
        X21,
        X22,
        X23,
        X24,
        X25,
        X26,
        X27,
        X28,
        X29,
        X30,
        X31,
        PC,
        NUM_REGS,
        NEXT_PC=NUM_REGS,
        TRAP_STATE,
        PENDING_TRAP,
        MACHINE_STATE,
        ICOUNT
    };

    typedef uint32_t reg_t;

    typedef uint32_t addr_t;
            
    typedef uint32_t code_word_t; //TODO: check removal
            
    typedef iss::typed_addr_t<iss::VIRTUAL>  virt_addr_t;

    typedef iss::typed_addr_t<iss::PHYSICAL> phys_addr_t;

    constexpr static unsigned reg_bit_width(unsigned r) {
        const uint32_t MinRV_IMA_reg_size[] = {32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,32,64};
        return MinRV_IMA_reg_size[r];
    }

    constexpr static unsigned reg_byte_offset(unsigned r) {
        const uint32_t MinRV_IMA_reg_byte_offset[] = {0,4,8,12,16,20,24,28,32,36,40,44,48,52,56,60,64,68,72,76,80,84,88,92,96,100,104,108,112,116,120,124,128,132,136,140,144,152,160};
        return MinRV_IMA_reg_byte_offset[r];
    }

    enum sreg_flag_e {FLAGS};

    enum mem_type_e {MEM,CSR,FENCE,RES};

};

struct minrv_ima: public arch_if {

    using virt_addr_t = typename traits<minrv_ima>::virt_addr_t;
    using phys_addr_t = typename traits<minrv_ima>::phys_addr_t;
    using reg_t =  typename traits<minrv_ima>::reg_t;
    using addr_t = typename traits<minrv_ima>::addr_t;

    minrv_ima();
    ~minrv_ima();

    void reset(uint64_t address=0);

//    virtual void loadFile(std::string name, int type=-1);

    uint8_t* get_regs_base_ptr() override;

    void get_reg(short idx, std::vector<uint8_t>& value) override;
    void set_reg(short idx, const std::vector<uint8_t>& value) override;

    bool get_flag(int flag) override;
    void set_flag(int, bool value) override;

    void update_flags(operations op, uint64_t opr1, uint64_t opr2) override;

    void notify_phase(exec_phase phase){
        if(phase==ISTART){
            ++reg.icount;
            reg.PC=reg.NEXT_PC;
        }
    }

    uint64_t get_icount() { return reg.icount;}

    virtual phys_addr_t v2p(const iss::addr_t& pc);

    virtual iss::sync_type needed_sync() const { return iss::PRE_SYNC; }

protected:
    struct MinRV_IMA_regs {
        uint32_t X0;
        uint32_t X1;
        uint32_t X2;
        uint32_t X3;
        uint32_t X4;
        uint32_t X5;
        uint32_t X6;
        uint32_t X7;
        uint32_t X8;
        uint32_t X9;
        uint32_t X10;
        uint32_t X11;
        uint32_t X12;
        uint32_t X13;
        uint32_t X14;
        uint32_t X15;
        uint32_t X16;
        uint32_t X17;
        uint32_t X18;
        uint32_t X19;
        uint32_t X20;
        uint32_t X21;
        uint32_t X22;
        uint32_t X23;
        uint32_t X24;
        uint32_t X25;
        uint32_t X26;
        uint32_t X27;
        uint32_t X28;
        uint32_t X29;
        uint32_t X30;
        uint32_t X31;
        uint32_t PC;
        uint32_t NEXT_PC;
        uint32_t trap_state, pending_trap, machine_state;
        uint64_t icount;
    } reg;
};

}
}            
#endif /* _MINRV_IMA_H_ */