xref: /optee_os/core/include/tee/tee_svc.h (revision c2f5808039471d8cb9ac43385b63fb8dc6aa8ac4)
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 #ifndef TEE_SVC_H
28 #define TEE_SVC_H
29 
30 #include <stdint.h>
31 #include <kernel/tee_common_unpg.h>	/* tee_uaddr_t */
32 #include <tee_api_types.h>
33 #include <utee_types.h>
34 #include <assert.h>
35 #include <types_ext.h>
36 
37 extern vaddr_t tee_svc_uref_base;
38 
39 struct tee_ta_session;
40 
41 /* TA Properties */
42 struct tee_props {
43 	const char *name;
44 
45 	/* prop_type is of type enum user_ta_prop_type*/
46 	const uint32_t prop_type;
47 
48 	/* either get_prop_func or both data and len */
49 	TEE_Result (*get_prop_func)(struct tee_ta_session *sess,
50 				    void *buf, size_t *blen);
51 	const void *data;
52 	const size_t len;
53 };
54 
55 struct tee_vendor_props {
56 	const struct tee_props *props;
57 	size_t len;
58 };
59 void syscall_sys_return(unsigned long ret);
60 
61 void syscall_log(const void *buf, size_t len);
62 
63 void syscall_panic(unsigned long code);
64 
65 TEE_Result syscall_not_supported(void);
66 
67 /* prop_set defined by enum utee_property */
68 TEE_Result syscall_get_property(unsigned long prop_set,
69 				unsigned long index,
70 				void *name, uint32_t *name_len,
71 				void *buf, uint32_t *blen,
72 				uint32_t *prop_type);
73 TEE_Result syscall_get_property_name_to_index(unsigned long prop_set,
74 					      void *name,
75 					      unsigned long name_len,
76 					      uint32_t *index);
77 
78 TEE_Result syscall_open_ta_session(const TEE_UUID *dest,
79 			unsigned long cancel_req_to, struct utee_params *params,
80 			uint32_t *sess, uint32_t *ret_orig);
81 
82 TEE_Result syscall_close_ta_session(unsigned long sess);
83 
84 TEE_Result syscall_invoke_ta_command(unsigned long sess,
85 			unsigned long cancel_req_to, unsigned long cmd_id,
86 			struct utee_params *params, uint32_t *ret_orig);
87 
88 TEE_Result syscall_check_access_rights(unsigned long flags, const void *buf,
89 				       size_t len);
90 
91 TEE_Result tee_svc_copy_from_user(void *kaddr, const void *uaddr, size_t len);
92 TEE_Result tee_svc_copy_to_user(void *uaddr, const void *kaddr, size_t len);
93 
94 TEE_Result tee_svc_copy_kaddr_to_uref(uint32_t *uref, void *kaddr);
95 
96 static inline uint32_t tee_svc_kaddr_to_uref(void *kaddr)
97 {
98 	assert(((vaddr_t)kaddr - tee_svc_uref_base) < UINT32_MAX);
99 	return (vaddr_t)kaddr - tee_svc_uref_base;
100 }
101 
102 static inline vaddr_t tee_svc_uref_to_vaddr(uint32_t uref)
103 {
104 	return tee_svc_uref_base + uref;
105 }
106 
107 static inline void *tee_svc_uref_to_kaddr(uint32_t uref)
108 {
109 	return (void *)tee_svc_uref_to_vaddr(uref);
110 }
111 
112 TEE_Result syscall_get_cancellation_flag(uint32_t *cancel);
113 
114 TEE_Result syscall_unmask_cancellation(uint32_t *old_mask);
115 
116 TEE_Result syscall_mask_cancellation(uint32_t *old_mask);
117 
118 TEE_Result syscall_wait(unsigned long timeout);
119 
120 TEE_Result syscall_get_time(unsigned long cat, TEE_Time *time);
121 TEE_Result syscall_set_ta_time(const TEE_Time *time);
122 
123 #endif /* TEE_SVC_H */
124