2 * Copyright (C) 2013-2015 ARM Limited. All rights reserved.
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.
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.
11 #ifndef __MALI_MEMORY_H__
12 #define __MALI_MEMORY_H__
15 #include "mali_session.h"
17 #include <linux/list.h>
20 #include "mali_memory_types.h"
21 #include "mali_memory_os_alloc.h"
23 _mali_osk_errcode_t mali_memory_initialize(void);
24 void mali_memory_terminate(void);
26 /** @brief Allocate a page table page
28 * Allocate a page for use as a page directory or page table. The page is
29 * mapped into kernel space.
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
35 MALI_STATIC_INLINE _mali_osk_errcode_t
36 mali_mmu_get_table_page(mali_dma_addr *table_page, mali_io_address *mapping)
38 return mali_mem_os_get_table_page(table_page, mapping);
41 /** @brief Release a page table page
43 * Release a page table page allocated through \a mali_mmu_get_table_page
45 * @param pa the GPU address of the page to release
47 MALI_STATIC_INLINE void
48 mali_mmu_release_table_page(mali_dma_addr phys, void *virt)
50 mali_mem_os_release_table_page(phys, virt);
53 /** @brief mmap function
55 * mmap syscalls on the Mali device node will end up here.
57 * This function allocates Mali memory and maps it on CPU and Mali.
59 int mali_mmap(struct file *filp, struct vm_area_struct *vma);
61 /** @brief Start a new memory session
63 * Called when a process opens the Mali device node.
65 * @param session Pointer to session to initialize
67 _mali_osk_errcode_t mali_memory_session_begin(struct mali_session_data *session);
69 /** @brief Close a memory session
71 * Called when a process closes the Mali device node.
73 * Memory allocated by the session will be freed
75 * @param session Pointer to the session to terminate
77 void mali_memory_session_end(struct mali_session_data *session);
79 /** @brief Prepare Mali page tables for mapping
81 * This function will prepare the Mali page tables for mapping the memory
82 * described by \a descriptor.
84 * Page tables will be reference counted and allocated, if not yet present.
86 * @param descriptor Pointer to the memory descriptor to the mapping
88 _mali_osk_errcode_t mali_mem_mali_map_prepare(mali_mem_allocation *descriptor);
90 /** @brief Resize Mali page tables for mapping
92 * This function will Resize the Mali page tables for mapping the memory
93 * described by \a descriptor.
95 * Page tables will be reference counted and allocated, if not yet present.
97 * @param descriptor Pointer to the memory descriptor to the mapping
98 * @param new_size The new size of descriptor
100 _mali_osk_errcode_t mali_mem_mali_map_resize(mali_mem_allocation *descriptor, u32 new_size);
102 /** @brief Free Mali page tables for mapping
104 * This function will unmap pages from Mali memory and free the page tables
105 * that are now unused.
107 * The updated pages in the Mali L2 cache will be invalidated, and the MMU TLBs will be zapped if necessary.
109 * @param descriptor Pointer to the memory descriptor to unmap
111 void mali_mem_mali_map_free(struct mali_session_data *session, u32 size, mali_address_t vaddr, u32 flags);
113 /** @brief Parse resource and prepare the OS memory allocator
115 * @param size Maximum size to allocate for Mali GPU.
116 * @return _MALI_OSK_ERR_OK on success, otherwise failure.
118 _mali_osk_errcode_t mali_memory_core_resource_os_memory(u32 size);
120 /** @brief Parse resource and prepare the dedicated memory allocator
122 * @param start Physical start address of dedicated Mali GPU memory.
123 * @param size Size of dedicated Mali GPU memory.
124 * @return _MALI_OSK_ERR_OK on success, otherwise failure.
126 _mali_osk_errcode_t mali_memory_core_resource_dedicated_memory(u32 start, u32 size);
129 struct mali_page_node *_mali_page_node_allocate(mali_page_node_type type);
131 void _mali_page_node_ref(struct mali_page_node *node);
132 void _mali_page_node_unref(struct mali_page_node *node);
133 void _mali_page_node_add_page(struct mali_page_node *node, struct page *page);
135 void _mali_page_node_add_block_item(struct mali_page_node *node, mali_block_item *item);
137 void _mali_page_node_add_swap_item(struct mali_page_node *node, struct mali_swap_item *item);
139 int _mali_page_node_get_ref_count(struct mali_page_node *node);
140 dma_addr_t _mali_page_node_get_dma_addr(struct mali_page_node *node);
141 unsigned long _mali_page_node_get_pfn(struct mali_page_node *node);
143 #endif /* __MALI_MEMORY_H__ */