/*********************************************************************
 *                
 * Copyright (C) 2002-2003, 2006-2008,  Karlsruhe University
 *                
 * File path:     arch/x86/x32/ptab.h
 * Description:   pagetable management
 *                
 * 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.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *                
 * $Id: ptab.h,v 1.11 2006/11/17 17:22:30 skoglund Exp $
 *                
 ********************************************************************/


#ifndef __ARCH__X86__X32__PTAB_H__
#define __ARCH__X86__X32__PTAB_H__

#include INC_ARCH(x86.h)

#if !defined(ASSEMBLY)

#define HW_PGSHIFTS		{ 12, 22, 32 }
#define HW_VALID_PGSIZES	((1 << 12) | (1 << 22))

#define MDB_BUFLIST_SIZES	{ {12}, {8}, {4096}, {0} }
#define MDB_PGSHIFTS		{ 12, 22, 32 }
#define MDB_NUM_PGSIZES		(2)

#define X86_PGSIZES		{  size_4k = 0,	size_4m = 1, size_4g = 2, \
				   size_sync = size_4m, size_superpage = size_4m, size_max = size_4m }

class pgent_t;

#include <debug.h>
class x86_pgent_t 
{
public:
    enum pagesize_e {
	size_4k = 0,
	size_4m = 1
    };

    // predicates
    bool is_valid() 
	{ return pg.present == 1; }

    bool is_writable() 
	{ return pg.rw == 1; }

    bool is_executable() 
	{ return pg.present == 1; }

    bool is_accessed()
	{ return pg.accessed == 1; }

    bool is_dirty()
	{ return pg.dirty == 1; }

    bool is_superpage()
	{ return pg.size == 1; }

    bool is_kernel()
	{ return pg.privilege == 0; }

    bool is_write_through()
	{ return pg.write_through == 1; }

    bool is_cache_disabled()
	{ return pg.cache_disabled == 1; }
    
    bool is_pat(pagesize_e size)
	{ 
#if defined(CONFIG_X86_PAT)
	    return (size == size_4k ? pg.size : pg4m.pat); 
#else
	    return false;
#endif
	}
    
    bool is_global ()
	{ return pg.global == 1; }
    
    bool is_cpulocal ()
	{ return pg.cpulocal == 1; }

    // retrieval
    addr_t get_address(pagesize_e size)
	{ return (addr_t) (raw & (size == size_4k ? X86_PAGE_MASK :
				  X86_SUPERPAGE_MASK)); }

    x86_pgent_t * get_ptab()
	{ return (x86_pgent_t*)(raw & X86_PAGE_MASK); }

    u32_t get_raw()
	{ return raw; }

    // modification
    void clear()
	{ raw = 0; }

    void set_entry(addr_t addr, pagesize_e size, u32_t attrib)
	{ 
	    if (size == size_4k)
		raw = ((u32_t)(addr) & X86_PAGE_MASK) | (attrib & X86_PAGE_FLAGS_MASK);
	    else
		raw = ((u32_t)(addr) & X86_SUPERPAGE_MASK) | X86_PAGE_SUPER |
		    (attrib & X86_SUPERPAGE_FLAGS_MASK);
	}

    void set_ptab_entry(addr_t addr, u32_t attrib)
	{
	    raw = ((u32_t)(addr) & X86_PAGE_MASK) | 
		X86_PAGE_VALID |
		(attrib & X86_X32_PTAB_FLAGS_MASK);
	}
		
    // attributes
    
    void set_cacheability (bool cacheable, pagesize_e size)
	{
	    this->pg.cache_disabled = !cacheable;
#if defined(CONFIG_X86_PAT)
	    if (size == size_4k) 
		pg.size = 0;
	    else
		pg4m.pat = 0;
#endif
	}

    void set_pat (word_t pat, pagesize_e size)
	{
	    pg.write_through  = (pat & 1) ? 1 : 0;
	    pg.cache_disabled = (pat & 2) ? 1 : 0;
#if defined(CONFIG_X86_PAT)
	    if (size == size_4k)
		pg.size  = (pat & 4) ? 1 : 0;
	    else
		pg4m.pat = (pat & 4) ? 1 : 0;
#endif
	}

    void set_global (bool global)
    {
	this->pg.global = global;
    }


    void set_cpulocal (bool local)
    {
	this->pg.cpulocal = local;
    }
    
    void set_accessed (bool accessed)
    {
	this->pg.accessed = accessed;
    }

    void set_dirty (bool dirty)
    {
	this->pg.dirty = dirty;
    }


	      
private:
    union {
	struct {
	    unsigned present		:1;
	    unsigned rw			:1;
	    unsigned privilege		:1;
	    unsigned write_through	:1;

	    unsigned cache_disabled	:1;
	    unsigned accessed		:1;
	    unsigned dirty		:1;
	    unsigned size		:1;

	    unsigned global		:1;
	    unsigned cpulocal		:1;
	    unsigned avail		:2;

	    unsigned base		:20;
	} pg;

	struct {
	    unsigned present		:1;
	    unsigned rw			:1;
	    unsigned privilege		:1;
	    unsigned write_through	:1;

	    unsigned cache_disabled	:1;
	    unsigned accessed		:1;
	    unsigned dirty		:1;
	    unsigned size		:1;

	    unsigned global		:1;
	    unsigned cpulocal		:1;
	    unsigned avail		:2;

	    unsigned pat		:1;
	    unsigned reserved		:9;
	    unsigned base		:10;
	} pg4m;

	u32_t raw;
    };

    friend class pgent_t;
};

#endif /* !ASSEMBLY */


#endif /* !__ARCH__X86__X32__PTAB_H__ */