xref: /optee_os/core/include/mm/tee_mm.h (revision 9bdc34f232fcac3c42210f9ae8fa0c54fc44ddb2)
1 /*
2  * Copyright (c) 2014, STMicroelectronics International N.V.
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 are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef TEE_MM_H
29 #define TEE_MM_H
30 
31 #include <stdint.h>
32 #include <stdbool.h>
33 #include <mm/tee_mm_unpg.h>
34 
35 /*-----------------------------------------------------------------------------
36  * Init managed memory area
37  *---------------------------------------------------------------------------*/
38 bool tee_mm_init(tee_mm_pool_t *pool, uint32_t lo, uint32_t hi, uint8_t shift,
39 		 uint32_t flags);
40 
41 /*-----------------------------------------------------------------------------
42  * Kill managed memory area
43  *---------------------------------------------------------------------------*/
44 void tee_mm_final(tee_mm_pool_t *pool);
45 
46 /*-----------------------------------------------------------------------------
47  * Allocates size number of bytes in the paged virtual address space
48  * Returns a handle to the memory. The handle is used as an input to
49  * the tee_mm_free function.
50  *---------------------------------------------------------------------------*/
51 tee_mm_entry_t *tee_mm_alloc(tee_mm_pool_t *pool, uint32_t size);
52 
53 /* Allocate supplied memory range if it's free */
54 tee_mm_entry_t *tee_mm_alloc2(tee_mm_pool_t *pool, tee_vaddr_t base,
55 			      size_t size);
56 
57 /*-----------------------------------------------------------------------------
58  * Frees the entry in the paged virtual address space pointed to by the
59  * input parameter p
60  *---------------------------------------------------------------------------*/
61 void tee_mm_free(tee_mm_entry_t *p);
62 
63 /*-----------------------------------------------------------------------------
64  * Returns size in sections or pages
65  *---------------------------------------------------------------------------*/
66 static inline uint32_t tee_mm_get_size(tee_mm_entry_t *p)
67 {
68 	return p->size;
69 }
70 
71 /*-----------------------------------------------------------------------------
72  * Returns offset from start of area in sections or pages
73  *---------------------------------------------------------------------------*/
74 static inline uint32_t tee_mm_get_offset(tee_mm_entry_t *p)
75 {
76 	return p->offset;
77 }
78 
79 /* Return size of the mm entry in bytes */
80 size_t tee_mm_get_bytes(const tee_mm_entry_t *mm);
81 
82 bool tee_mm_addr_is_within_range(tee_mm_pool_t *pool, uint32_t addr);
83 
84 bool tee_mm_is_empty(tee_mm_pool_t *pool);
85 
86 #endif
87