1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2017, EPAM Systems 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice, 10 * this list of conditions and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice, 13 * this list of conditions and the following disclaimer in the documentation 14 * and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef KERNEL_MSG_PARAM_H 30 #define KERNEL_MSG_PARAM_H 31 32 #include <optee_msg.h> 33 #include <stdio.h> 34 #include <types_ext.h> 35 #include <kernel/msg_param.h> 36 #include <mm/mobj.h> 37 38 /* 39 * This enum is used in tee_fill_memparam(). It describes direction of memory 40 * parameter. 41 */ 42 enum msg_param_mem_dir { 43 MSG_PARAM_MEM_DIR_IN = 0, 44 MSG_PARAM_MEM_DIR_OUT, 45 MSG_PARAM_MEM_DIR_INOUT, 46 }; 47 48 /** 49 * msg_param_mobj_from_noncontig() - construct mobj from non-contiguous 50 * list of pages. 51 * 52 * @buf_ptr - optee_msg_param.u.tmem.buf_ptr value 53 * @size - optee_msg_param.u.tmem.size value 54 * @shm_ref - optee_msg_param.u.tmem.shm_ref value 55 * @map_buffer - true if buffer needs to be mapped into OP-TEE address space 56 * 57 * return: 58 * mobj or NULL on error 59 */ 60 struct mobj *msg_param_mobj_from_noncontig(paddr_t buf_ptr, size_t size, 61 uint64_t shm_ref, bool map_buffer); 62 63 /** 64 * msg_param_init_memparam() - fill memory reference parameter for RPC call 65 * @param - parameter to fill 66 * @mobj - mobj describing the shared memory buffer 67 * @offset - offset of the buffer 68 * @size - size of the buffer 69 * @cookie - NW cookie of the shared buffer 70 * @dir - data direction 71 * 72 * Idea behind this function is that thread_rpc_alloc() can return 73 * either buffer from preallocated memory pool, of buffer constructed 74 * from supplicant's memory. In first case parameter will have type 75 * OPTEE_MSG_ATTR_TYPE_TMEM_* and OPTEE_MSG_ATTR_TYPE_RMEM_ in second case. 76 * This function will fill parameter structure with right type, depending on 77 * the passed mobj. 78 * 79 * return: 80 * true on success, false on failure 81 */ 82 bool msg_param_init_memparam(struct optee_msg_param *param, struct mobj *mobj, 83 size_t offset, size_t size, 84 uint64_t cookie, enum msg_param_mem_dir dir); 85 /** 86 * msg_param_get_buf_size() - helper functions that reads [T/R]MEM 87 * parameter size 88 * 89 * @param - struct optee_msg_param to read size from 90 * 91 * return: 92 * corresponding size field 93 */ 94 static inline size_t msg_param_get_buf_size(const struct optee_msg_param *param) 95 { 96 switch (param->attr & OPTEE_MSG_ATTR_TYPE_MASK) { 97 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 98 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 99 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 100 return param->u.tmem.size; 101 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT: 102 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT: 103 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT: 104 return param->u.rmem.size; 105 default: 106 return 0; 107 } 108 } 109 110 /** 111 * msg_param_attr_is_tmem - helper functions that cheks if attribute is tmem 112 * 113 * @attr - attribute to check 114 * 115 * return: 116 * corresponding size field 117 */ 118 static inline bool msg_param_attr_is_tmem(uint64_t attr) 119 { 120 switch (attr & OPTEE_MSG_ATTR_TYPE_MASK) { 121 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 122 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 123 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 124 return true; 125 default: 126 return false; 127 } 128 } 129 130 #endif /*KERNEL_MSG_PARAM_H*/ 131