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 <kernel/tee_common_unpg.h> 34 35 /* Define to indicate default pool initiation */ 36 #define TEE_MM_POOL_NO_FLAGS 0 37 /* Flag to indicate that memory is allocated from hi address to low address */ 38 #define TEE_MM_POOL_HI_ALLOC (1u << 0) 39 40 struct _tee_mm_entry_t { 41 struct _tee_mm_pool_t *pool; 42 struct _tee_mm_entry_t *next; 43 uint32_t offset; /* offset in pages/sections */ 44 uint32_t size; /* size in pages/sections */ 45 }; 46 typedef struct _tee_mm_entry_t tee_mm_entry_t; 47 48 struct _tee_mm_pool_t { 49 tee_mm_entry_t *entry; 50 uint32_t lo; /* low boundery pf the pool */ 51 uint32_t hi; /* high boundery pf the pool */ 52 uint32_t flags; /* Config flags for the pool */ 53 uint8_t shift; /* size shift */ 54 #ifdef CFG_WITH_STATS 55 size_t max_allocated; 56 #endif 57 }; 58 typedef struct _tee_mm_pool_t tee_mm_pool_t; 59 60 /* Physical Public DDR pool */ 61 extern tee_mm_pool_t tee_mm_pub_ddr; 62 63 /* Physical Secure DDR pool */ 64 extern tee_mm_pool_t tee_mm_sec_ddr; 65 66 /* Virtual eSRAM pool */ 67 extern tee_mm_pool_t tee_mm_vcore; 68 69 /* 70 * Returns a pointer to the mm covering the supplied address, 71 * if no mm is found NULL is returned. 72 */ 73 tee_mm_entry_t *tee_mm_find(const tee_mm_pool_t *pool, uint32_t addr); 74 75 /* 76 * Validates that an address (addr) is part of the secure virtual memory 77 * Returns false if not valid, true if valid 78 * NOTE: This function is executed in abort mode. 79 * Please take care of stack usage 80 */ 81 static inline bool tee_mm_validate(const tee_mm_pool_t *pool, uint32_t addr) 82 { 83 return tee_mm_find(pool, addr) != 0; 84 } 85 86 /* 87 * Returns a virtual address to the start of the allocated memory 88 * for the mm entry. 89 */ 90 uintptr_t tee_mm_get_smem(const tee_mm_entry_t *mm); 91 92 /* Init managed memory area */ 93 bool tee_mm_init(tee_mm_pool_t *pool, uint32_t lo, uint32_t hi, uint8_t shift, 94 uint32_t flags); 95 96 /* Kill managed memory area*/ 97 void tee_mm_final(tee_mm_pool_t *pool); 98 99 /* 100 * Allocates size number of bytes in the paged virtual address space 101 * Returns a handle to the memory. The handle is used as an input to 102 * the tee_mm_free function. 103 */ 104 tee_mm_entry_t *tee_mm_alloc(tee_mm_pool_t *pool, uint32_t size); 105 106 /* Allocate supplied memory range if it's free */ 107 tee_mm_entry_t *tee_mm_alloc2(tee_mm_pool_t *pool, tee_vaddr_t base, 108 size_t size); 109 110 /* 111 * Frees the entry in the paged virtual address space pointed to by the 112 * input parameter p 113 */ 114 void tee_mm_free(tee_mm_entry_t *p); 115 116 /* Returns size in sections or pages */ 117 static inline uint32_t tee_mm_get_size(tee_mm_entry_t *p) 118 { 119 return p->size; 120 } 121 122 /* Returns offset from start of area in sections or pages */ 123 static inline uint32_t tee_mm_get_offset(tee_mm_entry_t *p) 124 { 125 return p->offset; 126 } 127 128 /* Return size of the mm entry in bytes */ 129 size_t tee_mm_get_bytes(const tee_mm_entry_t *mm); 130 131 bool tee_mm_addr_is_within_range(tee_mm_pool_t *pool, uint32_t addr); 132 133 bool tee_mm_is_empty(tee_mm_pool_t *pool); 134 135 #ifdef CFG_WITH_STATS 136 #define TEE_MM_POOL_DESC_LENGTH 32 137 struct tee_mm_pool_stats { 138 char desc[TEE_MM_POOL_DESC_LENGTH]; 139 uint32_t allocated; 140 uint32_t max_allocated; 141 uint32_t size; 142 }; 143 void tee_mm_get_pool_stats(tee_mm_pool_t *pool, struct tee_mm_pool_stats *stats, 144 bool reset); 145 #endif 146 147 #endif 148