xref: /optee_os/core/include/tee/tee_svc.h (revision 64a5011e3774c8664fefc6dff966d0096cdd56d7)
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 
36 extern vaddr_t tee_svc_uref_base;
37 
38 struct tee_ta_session;
39 
40 void syscall_sys_return(unsigned long ret);
41 
42 void syscall_log(const void *buf, size_t len);
43 
44 void syscall_panic(unsigned long code);
45 
46 TEE_Result syscall_not_supported(void);
47 
48 uint32_t syscall_dummy(uint32_t *a);
49 uint32_t syscall_dummy_7args(unsigned long a1, unsigned long a2,
50 			unsigned long a3, unsigned long a4, unsigned long a5,
51 			unsigned long a6, unsigned long a7);
52 
53 uint32_t syscall_nocall(void);
54 
55 TEE_Result syscall_get_property_obsolete(unsigned long prop, void *buf,
56 					 size_t blen);
57 
58 /* prop_set defined by enum utee_property */
59 TEE_Result syscall_get_property(unsigned long prop_set,
60 				unsigned long index,
61 				void *name, uint32_t *name_len,
62 				void *buf, uint32_t *blen,
63 				uint32_t *prop_type);
64 TEE_Result syscall_get_property_name_to_index(unsigned long prop_set,
65 					      void *name,
66 					      unsigned long name_len,
67 					      uint32_t *index);
68 
69 TEE_Result syscall_open_ta_session(const TEE_UUID *dest,
70 			unsigned long cancel_req_to, struct utee_params *params,
71 			uint32_t *sess, uint32_t *ret_orig);
72 
73 TEE_Result syscall_close_ta_session(unsigned long sess);
74 
75 TEE_Result syscall_invoke_ta_command(unsigned long sess,
76 			unsigned long cancel_req_to, unsigned long cmd_id,
77 			struct utee_params *params, uint32_t *ret_orig);
78 
79 TEE_Result syscall_check_access_rights(unsigned long flags, const void *buf,
80 				       size_t len);
81 
82 TEE_Result tee_svc_copy_from_user(struct tee_ta_session *sess, void *kaddr,
83 				  const void *uaddr, size_t len);
84 TEE_Result tee_svc_copy_to_user(struct tee_ta_session *sess, void *uaddr,
85 				const void *kaddr, size_t len);
86 
87 TEE_Result tee_svc_copy_kaddr_to_uref(struct tee_ta_session *sess,
88 			uint32_t *uref, void *kaddr);
89 
90 static inline uint32_t tee_svc_kaddr_to_uref(void *kaddr)
91 {
92 	assert(((vaddr_t)kaddr - tee_svc_uref_base) < UINT32_MAX);
93 	return (vaddr_t)kaddr - tee_svc_uref_base;
94 }
95 
96 static inline vaddr_t tee_svc_uref_to_vaddr(uint32_t uref)
97 {
98 	return tee_svc_uref_base + uref;
99 }
100 
101 static inline void *tee_svc_uref_to_kaddr(uint32_t uref)
102 {
103 	return (void *)tee_svc_uref_to_vaddr(uref);
104 }
105 
106 TEE_Result syscall_get_cancellation_flag(uint32_t *cancel);
107 
108 TEE_Result syscall_unmask_cancellation(uint32_t *old_mask);
109 
110 TEE_Result syscall_mask_cancellation(uint32_t *old_mask);
111 
112 TEE_Result syscall_wait(unsigned long timeout);
113 
114 TEE_Result syscall_get_time(unsigned long cat, TEE_Time *time);
115 TEE_Result syscall_set_ta_time(const TEE_Time *time);
116 
117 #endif /* TEE_SVC_H */
118