kernel/generic/include/mm/page.h

   1 /*
   2  * Copyright (c) 2001-2004 Jakub Jermar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup genericmm
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_PAGE_H_
  36 #define KERN_PAGE_H_
  37
  38 #include <arch/types.h>
  39 #include <mm/as.h>
  40 #include <memstr.h>
  41
  42 /**
  43  * Macro for computing page color.
  44  */
  45 #define PAGE_COLOR(va)  (((va) >> PAGE_WIDTH) & ((1 << PAGE_COLOR_BITS) - 1))
  46
  47 /** Operations to manipulate page mappings. */
  48 typedef struct {
  49         void (* mapping_insert)(as_t *as, uintptr_t page, uintptr_t frame,
  50                 int flags);
  51         void (* mapping_remove)(as_t *as, uintptr_t page);
  52         pte_t *(* mapping_find)(as_t *as, uintptr_t page);
  53 } page_mapping_operations_t;
  54
  55 extern page_mapping_operations_t *page_mapping_operations;
  56
  57 extern void page_init(void);
  58 extern void page_table_lock(as_t *as, bool lock);
  59 extern void page_table_unlock(as_t *as, bool unlock);
  60 extern void page_mapping_insert(as_t *as, uintptr_t page, uintptr_t frame,
  61     int flags);
  62 extern void page_mapping_remove(as_t *as, uintptr_t page);
  63 extern pte_t *page_mapping_find(as_t *as, uintptr_t page);
  64 extern pte_t *page_table_create(int flags);
  65 extern void page_table_destroy(pte_t *page_table);
  66 extern void map_structure(uintptr_t s, size_t size);
  67 extern uintptr_t hw_map(uintptr_t physaddr, size_t size);
  68
  69 #endif
  70
  71 /** @}
  72  */