1 /* 2 * Copyright (c) 2017, EPAM Systems 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 KERNEL_MSG_PARAM_H 29 #define KERNEL_MSG_PARAM_H 30 31 #include <optee_msg.h> 32 #include <stdio.h> 33 #include <types_ext.h> 34 #include <kernel/msg_param.h> 35 #include <mm/mobj.h> 36 37 /* 38 * This enum is used in tee_fill_memparam(). It describes direction of memory 39 * parameter. 40 */ 41 enum msg_param_mem_dir { 42 MSG_PARAM_MEM_DIR_IN = 0, 43 MSG_PARAM_MEM_DIR_OUT, 44 MSG_PARAM_MEM_DIR_INOUT, 45 }; 46 47 /** 48 * msg_param_mobj_from_noncontig() - construct mobj from non-contiguous 49 * list of pages. 50 * 51 * @param - pointer to msg_param with OPTEE_MSG_ATTR_NONCONTIG flag set 52 * @map_buffer - true if buffer needs to be mapped into OP-TEE address space 53 * 54 * return: 55 * mobj or NULL on error 56 */ 57 struct mobj *msg_param_mobj_from_noncontig(const struct optee_msg_param *param, 58 bool map_buffer); 59 60 /** 61 * msg_param_init_memparam() - fill memory reference parameter for RPC call 62 * @param - parameter to fill 63 * @mobj - mobj describing the shared memory buffer 64 * @offset - offset of the buffer 65 * @size - size of the buffer 66 * @cookie - NW cookie of the shared buffer 67 * @dir - data direction 68 * 69 * Idea behind this function is that thread_rpc_alloc() can return 70 * either buffer from preallocated memory pool, of buffer constructed 71 * from supplicant's memory. In first case parameter will have type 72 * OPTEE_MSG_ATTR_TYPE_TMEM_* and OPTEE_MSG_ATTR_TYPE_RMEM_ in second case. 73 * This function will fill parameter structure with right type, depending on 74 * the passed mobj. 75 * 76 * return: 77 * true on success, false on failure 78 */ 79 bool msg_param_init_memparam(struct optee_msg_param *param, struct mobj *mobj, 80 size_t offset, size_t size, 81 uint64_t cookie, enum msg_param_mem_dir dir); 82 /** 83 * msg_param_get_buf_size() - helper functions that reads [T/R]MEM 84 * parameter size 85 * 86 * @param - struct optee_msg_param to read size from 87 * 88 * return: 89 * corresponding size field 90 */ 91 static inline size_t msg_param_get_buf_size(const struct optee_msg_param *param) 92 { 93 switch (param->attr & OPTEE_MSG_ATTR_TYPE_MASK) { 94 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 95 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 96 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 97 return param->u.tmem.size; 98 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT: 99 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT: 100 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT: 101 return param->u.rmem.size; 102 default: 103 return 0; 104 } 105 } 106 107 /** 108 * msg_param_attr_is_tmem - helper functions that cheks if parameter is tmem 109 * 110 * @param - struct optee_msg_param to check 111 * 112 * return: 113 * corresponding size field 114 */ 115 static inline bool msg_param_attr_is_tmem(const struct optee_msg_param *param) 116 { 117 switch (param->attr & OPTEE_MSG_ATTR_TYPE_MASK) { 118 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 119 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 120 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 121 return true; 122 default: 123 return false; 124 } 125 } 126 127 #endif /*KERNEL_MSG_PARAM_H*/ 128