MemoryRegion.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_MEMORYREGION_H
#define KERNEL_PROCESSOR_MEMORYREGION_H

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

class EXPORTED_PUBLIC MemoryRegion
{
    friend class X86CommonPhysicalMemoryManager;
    friend class PpcCommonPhysicalMemoryManager;
    friend class ArmV7PhysicalMemoryManager;
    friend class HostedPhysicalMemoryManager;

  public:
    MemoryRegion(const char *pName);
    virtual ~MemoryRegion();

    void free();

    void *virtualAddress() const;
    physical_uintptr_t physicalAddress() const;
    size_t size() const;
    const char *name() const;

    operator bool() const;

    bool physicalBoundsCheck(physical_uintptr_t address);
    template <typename T>
    T *convertPhysicalPointer(physical_uintptr_t address);

    void setNonRamMemory(bool b);
    bool getNonRamMemory();
    void setForced(bool b);
    bool getForced();

  private:
    MemoryRegion(const MemoryRegion &);
    MemoryRegion &operator=(const MemoryRegion &);

    void *m_VirtualAddress;
    physical_uintptr_t m_PhysicalAddress;
    size_t m_Size;
    const char *m_pName;

    bool m_bNonRamMemory, m_bForced;
};

template <typename T>
T *MemoryRegion::convertPhysicalPointer(physical_uintptr_t address)
{
    return reinterpret_cast<T *>(
        reinterpret_cast<uintptr_t>(m_VirtualAddress) +
        (address - m_PhysicalAddress));
}

#endif