drivers/gpu/arm/mali400/mali/linux/mali_memory.h

   1 /*
   2  * Copyright (C) 2013-2014 ARM Limited. All rights reserved.
   3  *
   4  * This program is free software and is provided to you under the terms of the GNU General Public License version 2
   5  * as published by the Free Software Foundation, and any use by you of this program is subject to the terms of such GNU licence.
   6  *
   7  * A copy of the licence is included with the program, and can also be obtained from Free Software
   8  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
   9  */
  10
  11 #ifndef __MALI_MEMORY_H__
  12 #define __MALI_MEMORY_H__
  13
  14 #include "mali_osk.h"
  15 #include "mali_session.h"
  16
  17 #include <linux/list.h>
  18 #include <linux/mm.h>
  19
  20 #include "mali_memory_types.h"
  21 #include "mali_memory_os_alloc.h"
  22
  23 _mali_osk_errcode_t mali_memory_initialize(void);
  24 void mali_memory_terminate(void);
  25
  26 /** @brief Allocate a page table page
  27  *
  28  * Allocate a page for use as a page directory or page table. The page is
  29  * mapped into kernel space.
  30  *
  31  * @return _MALI_OSK_ERR_OK on success, otherwise an error code
  32  * @param table_page GPU pointer to the allocated page
  33  * @param mapping CPU pointer to the mapping of the allocated page
  34  */
  35 MALI_STATIC_INLINE _mali_osk_errcode_t
  36 mali_mmu_get_table_page(mali_dma_addr *table_page, mali_io_address *mapping)
  37 {
  38         return mali_mem_os_get_table_page(table_page, mapping);
  39 }
  40
  41 /** @brief Release a page table page
  42  *
  43  * Release a page table page allocated through \a mali_mmu_get_table_page
  44  *
  45  * @param pa the GPU address of the page to release
  46  */
  47 MALI_STATIC_INLINE void
  48 mali_mmu_release_table_page(mali_dma_addr phys, void *virt)
  49 {
  50         mali_mem_os_release_table_page(phys, virt);
  51 }
  52
  53 /** @brief mmap function
  54  *
  55  * mmap syscalls on the Mali device node will end up here.
  56  *
  57  * This function allocates Mali memory and maps it on CPU and Mali.
  58  */
  59 int mali_mmap(struct file *filp, struct vm_area_struct *vma);
  60
  61 /** @brief Allocate and initialize a Mali memory descriptor
  62  *
  63  * @param session Pointer to the session allocating the descriptor
  64  * @param type Type of memory the descriptor will represent
  65  */
  66 mali_mem_allocation *mali_mem_descriptor_create(struct mali_session_data *session, mali_mem_type type);
  67
  68 /** @brief Destroy a Mali memory descriptor
  69  *
  70  * This function will only free the descriptor itself, and not the memory it
  71  * represents.
  72  *
  73  * @param descriptor Pointer to the descriptor to destroy
  74  */
  75 void mali_mem_descriptor_destroy(mali_mem_allocation *descriptor);
  76
  77 /** @brief Start a new memory session
  78  *
  79  * Called when a process opens the Mali device node.
  80  *
  81  * @param session Pointer to session to initialize
  82  */
  83 _mali_osk_errcode_t mali_memory_session_begin(struct mali_session_data *session);
  84
  85 /** @brief Close a memory session
  86  *
  87  * Called when a process closes the Mali device node.
  88  *
  89  * Memory allocated by the session will be freed
  90  *
  91  * @param session Pointer to the session to terminate
  92  */
  93 void mali_memory_session_end(struct mali_session_data *session);
  94
  95 /** @brief Prepare Mali page tables for mapping
  96  *
  97  * This function will prepare the Mali page tables for mapping the memory
  98  * described by \a descriptor.
  99  *
 100  * Page tables will be reference counted and allocated, if not yet present.
 101  *
 102  * @param descriptor Pointer to the memory descriptor to the mapping
 103  */
 104 _mali_osk_errcode_t mali_mem_mali_map_prepare(mali_mem_allocation *descriptor);
 105
 106 /** @brief Free Mali page tables for mapping
 107  *
 108  * This function will unmap pages from Mali memory and free the page tables
 109  * that are now unused.
 110  *
 111  * The updated pages in the Mali L2 cache will be invalidated, and the MMU TLBs will be zapped if necessary.
 112  *
 113  * @param descriptor Pointer to the memory descriptor to unmap
 114  */
 115 void mali_mem_mali_map_free(mali_mem_allocation *descriptor);
 116
 117 /** @brief Parse resource and prepare the OS memory allocator
 118  *
 119  * @param size Maximum size to allocate for Mali GPU.
 120  * @return _MALI_OSK_ERR_OK on success, otherwise failure.
 121  */
 122 _mali_osk_errcode_t mali_memory_core_resource_os_memory(u32 size);
 123
 124 /** @brief Parse resource and prepare the dedicated memory allocator
 125  *
 126  * @param start Physical start address of dedicated Mali GPU memory.
 127  * @param size Size of dedicated Mali GPU memory.
 128  * @return _MALI_OSK_ERR_OK on success, otherwise failure.
 129  */
 130 _mali_osk_errcode_t mali_memory_core_resource_dedicated_memory(u32 start, u32 size);
 131
 132
 133 void mali_mem_ump_release(mali_mem_allocation *descriptor);
 134 void mali_mem_external_release(mali_mem_allocation *descriptor);
 135
 136 #endif /* __MALI_MEMORY_H__ */