mips32/state.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef KERNEL_PROCESSOR_MIPS32_STATE_H
#define KERNEL_PROCESSOR_MIPS32_STATE_H

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/processor/types.h"

class MIPS32InterruptState
{
  public:
    //
    // General Interface (both InterruptState and SyscallState)
    //
    inline uintptr_t getStackPointer() const;
    inline void setStackPointer(uintptr_t stackPointer);
    inline uintptr_t getInstructionPointer() const;
    inline void setInstructionPointer(uintptr_t instructionPointer);
    inline uintptr_t getBasePointer() const;
    inline void setBasePointer(uintptr_t basePointer);
    size_t getRegisterCount() const;
    processor_register_t getRegister(size_t index) const;
    const char *getRegisterName(size_t index) const;
    inline size_t getRegisterSize(size_t index) const;

    //
    // InterruptState Interface
    //
    inline bool kernelMode() const;
    inline size_t getInterruptNumber() const;

    //
    // SyscallState Interface
    //
    inline size_t getSyscallService() const;
    inline size_t getSyscallNumber() const;

    //
    // MIPS-specific interface.
    //
    inline bool branchDelay() const;

  private:
  public:
    MIPS32InterruptState();

    MIPS32InterruptState(const MIPS32InterruptState &);
    MIPS32InterruptState &operator=(const MIPS32InterruptState &);
    ~MIPS32InterruptState()
    {
    }

    uint32_t m_At;
    uint32_t m_V0;
    uint32_t m_V1;
    uint32_t m_A0;
    uint32_t m_A1;
    uint32_t m_A2;
    uint32_t m_A3;
    uint32_t m_T0;
    uint32_t m_T1;
    uint32_t m_T2;
    uint32_t m_T3;
    uint32_t m_T4;
    uint32_t m_T5;
    uint32_t m_T6;
    uint32_t m_T7;
    uint32_t m_S0;
    uint32_t m_S1;
    uint32_t m_S2;
    uint32_t m_S3;
    uint32_t m_S4;
    uint32_t m_S5;
    uint32_t m_S6;
    uint32_t m_S7;
    uint32_t m_T8;
    uint32_t m_T9;
    uint32_t m_Gp;
    uint32_t m_Sp;
    uint32_t m_Fp;
    uint32_t m_Ra;
    uint32_t m_Sr;
    uint32_t m_Cause;
    uint32_t m_Epc;
    uint32_t m_BadVAddr;
    uint32_t m_Context;
} PACKED;

typedef MIPS32InterruptState MIPS32SyscallState;
typedef MIPS32InterruptState MIPS32ProcessorState;

//
// Part of the Implementation
//

uintptr_t MIPS32InterruptState::getStackPointer() const
{
    return m_Sp;
}
void MIPS32InterruptState::setStackPointer(uintptr_t stackPointer)
{
}
uintptr_t MIPS32InterruptState::getInstructionPointer() const
{
    return m_Epc;
}
void MIPS32InterruptState::setInstructionPointer(uintptr_t instructionPointer)
{
}
uintptr_t MIPS32InterruptState::getBasePointer() const
{
    return 0xdeadbaba;
}
void MIPS32InterruptState::setBasePointer(uintptr_t basePointer)
{
}
size_t MIPS32InterruptState::getRegisterSize(size_t index) const
{
    return 4;
}

bool MIPS32InterruptState::kernelMode() const
{
    return true;
}
size_t MIPS32InterruptState::getInterruptNumber() const
{
    return (m_Cause >> 2) &
           0x1F;  // Return the ExcCode field of the Cause register.
}

size_t MIPS32InterruptState::getSyscallService() const
{
    return 0;
}
size_t MIPS32InterruptState::getSyscallNumber() const
{
    return 0;
}

bool MIPS32InterruptState::branchDelay() const
{
    return (m_Cause & 0x80000000);  // Test bit 31 of Cause.
}

#endif