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_init_memparam() - fill memory reference parameter for RPC call 49 * @param - parameter to fill 50 * @mobj - mobj describing the shared memory buffer 51 * @offset - offset of the buffer 52 * @size - size of the buffer 53 * @cookie - NW cookie of the shared buffer 54 * @dir - data direction 55 * 56 * Idea behind this function is that thread_rpc_alloc() can return 57 * either buffer from preallocated memory pool, of buffer constructed 58 * from supplicant's memory. In first case parameter will have type 59 * OPTEE_MSG_ATTR_TYPE_TMEM_* and OPTEE_MSG_ATTR_TYPE_RMEM_ in second case. 60 * This function will fill parameter structure with right type, depending on 61 * the passed mobj. 62 * 63 * return: 64 * true on success, false on failure 65 */ 66 bool msg_param_init_memparam(struct optee_msg_param *param, struct mobj *mobj, 67 size_t offset, size_t size, 68 uint64_t cookie, enum msg_param_mem_dir dir); 69 /** 70 * msg_param_get_buf_size() - helper functions that reads [T/R]MEM 71 * parameter size 72 * 73 * @param - struct optee_msg_param to read size from 74 * 75 * return: 76 * corresponding size field 77 */ 78 static inline size_t msg_param_get_buf_size(struct optee_msg_param *param) 79 { 80 switch (param->attr & OPTEE_MSG_ATTR_TYPE_MASK) { 81 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 82 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 83 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 84 return param->u.tmem.size; 85 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT: 86 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT: 87 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT: 88 return param->u.rmem.size; 89 default: 90 return 0; 91 } 92 } 93 94 /** 95 * msg_param_attr_is_tmem - helper functions that cheks if parameter is tmem 96 * 97 * @param - struct optee_msg_param to check 98 * 99 * return: 100 * corresponding size field 101 */ 102 static inline bool msg_param_attr_is_tmem(struct optee_msg_param *param) 103 { 104 switch (param->attr & OPTEE_MSG_ATTR_TYPE_MASK) { 105 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT: 106 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT: 107 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT: 108 return true; 109 default: 110 return false; 111 } 112 } 113 114 #endif /*KERNEL_MSG_PARAM_H*/ 115