xref: /optee_os/core/include/mm/tee_mm.h (revision bc420748bfc44a9e09000a3966fc59e9e0219df4)
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 
34 #include "tee_mm_unpg.h"
35 
36 /*-----------------------------------------------------------------------------
37  * Init managed memory area
38  *---------------------------------------------------------------------------*/
39 bool tee_mm_init(tee_mm_pool_t *pool, uint32_t lo, uint32_t hi, uint8_t shift,
40 		 uint32_t flags);
41 
42 /*-----------------------------------------------------------------------------
43  * Kill managed memory area
44  *---------------------------------------------------------------------------*/
45 void tee_mm_final(tee_mm_pool_t *pool);
46 
47 /*-----------------------------------------------------------------------------
48  * Allocates size number of bytes in the paged virtual address space
49  * Returns a handle to the memory. The handle is used as an input to
50  * the tee_mm_free function.
51  *---------------------------------------------------------------------------*/
52 tee_mm_entry_t *tee_mm_alloc(tee_mm_pool_t *pool, uint32_t size);
53 
54 /* Allocate supplied memory range if it's free */
55 tee_mm_entry_t *tee_mm_alloc2(tee_mm_pool_t *pool, tee_vaddr_t base,
56 			      size_t size);
57 
58 /*-----------------------------------------------------------------------------
59  * Frees the entry in the paged virtual address space pointed to by the
60  * input parameter p
61  *---------------------------------------------------------------------------*/
62 void tee_mm_free(tee_mm_entry_t *p);
63 
64 /*-----------------------------------------------------------------------------
65  * Returns size in sections or pages
66  *---------------------------------------------------------------------------*/
67 static inline uint32_t tee_mm_get_size(tee_mm_entry_t *p)
68 {
69 	return p->size;
70 }
71 
72 /*-----------------------------------------------------------------------------
73  * Returns offset from start of area in sections or pages
74  *---------------------------------------------------------------------------*/
75 static inline uint32_t tee_mm_get_offset(tee_mm_entry_t *p)
76 {
77 	return p->offset;
78 }
79 
80 /* Return size of the mm entry in bytes */
81 size_t tee_mm_get_bytes(const tee_mm_entry_t *mm);
82 
83 bool tee_mm_addr_is_within_range(tee_mm_pool_t *pool, uint32_t addr);
84 
85 bool tee_mm_is_empty(tee_mm_pool_t *pool);
86 
87 #endif
88