arm_926e/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_ARM926E_STATE_H
#define KERNEL_PROCESSOR_ARM926E_STATE_H

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

class ARM926EInterruptState
{
  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;

  private:
  public:
    ARM926EInterruptState();

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

    uint32_t m_r0;
    uint32_t m_r1;
    uint32_t m_r2;
    uint32_t m_r3;
    uint32_t m_r4;
    uint32_t m_r5;
    uint32_t m_r6;
    uint32_t m_r7;
    uint32_t m_r8;
    uint32_t m_r9;
    uint32_t m_r10;
    uint32_t m_Fp;
    uint32_t m_r12;
    uint32_t m_Sp;
    uint32_t m_Lnk;
    uint32_t m_Pc;
    uint32_t
        m_Cpsr;  // holds cpu mode, IRQ and FIQ status, and 4 flags (32-bit)
} PACKED;

typedef ARM926EInterruptState ARM926ESyscallState;
typedef ARM926EInterruptState ARM926EProcessorState;

class __attribute__((aligned(16))) ARM926ESchedulerState
{
  public:
    uint32_t edi;
    uint32_t esi;
    uint32_t ebx;
    uint32_t ebp;
    uint32_t esp;
    uint32_t eip;

    // bit 0: Has FPU
    // bit 1: Used SSE
    uint32_t flags;

    uint8_t x87FPU_MMX_XMM_MXCSR_State[512 + 16] __attribute__((aligned(16)));
} __attribute__((aligned(16)));

//
// Part of the Implementation
//

uintptr_t ARM926EInterruptState::getStackPointer() const
{
    return m_Sp;
}
void ARM926EInterruptState::setStackPointer(uintptr_t stackPointer)
{
}
uintptr_t ARM926EInterruptState::getInstructionPointer() const
{
    return m_Pc;
}
void ARM926EInterruptState::setInstructionPointer(uintptr_t instructionPointer)
{
}
uintptr_t ARM926EInterruptState::getBasePointer() const
{
    return m_Fp;  // assume frame pointer = base pointer
}
void ARM926EInterruptState::setBasePointer(uintptr_t basePointer)
{
    m_Fp = basePointer;  // TODO: some form of casting? Not sure which to use...
}
size_t ARM926EInterruptState::getRegisterSize(size_t index) const
{
#if defined(BITS_32)
    return 4;
#else
    return 4;  // TODO: handle other bits sizes (this is mainly here)
               // in order to help future development if ARM ends up
               // requiring 64-bit or something
#endif
}

bool ARM926EInterruptState::kernelMode() const
{
    // TODO: the ARM926E is NOT always in kernel mode, handle this properly
    // This'll require some reading up on the CPSR mode bits
    return true;
}
size_t ARM926EInterruptState::getInterruptNumber() const
{
    // TODO: implement
    return 0;
}

size_t ARM926EInterruptState::getSyscallService() const
{
    // TODO: implement
    return 0;
}
size_t ARM926EInterruptState::getSyscallNumber() const
{
    // TODO: implement
    return 0;
}

#endif