xref: /utopia/UTPA2-700.0.x/modules/msos/msos/optee/ta_comm.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2006-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 #ifndef TA_COMM_H
96 #define TA_COMM_H
97 
98 #define TEE_Result MS_U32
99 #define TEE_SUCCESS                       0x00000000
100 #define TEE_ERROR_CORRUPT_OBJECT          0xF0100001
101 #define TEE_ERROR_CORRUPT_OBJECT_2        0xF0100002
102 #define TEE_ERROR_STORAGE_NOT_AVAILABLE   0xF0100003
103 #define TEE_ERROR_STORAGE_NOT_AVAILABLE_2 0xF0100004
104 #define TEE_ERROR_GENERIC                 0xFFFF0000
105 #define TEE_ERROR_ACCESS_DENIED           0xFFFF0001
106 #define TEE_ERROR_CANCEL                  0xFFFF0002
107 #define TEE_ERROR_ACCESS_CONFLICT         0xFFFF0003
108 #define TEE_ERROR_EXCESS_DATA             0xFFFF0004
109 #define TEE_ERROR_BAD_FORMAT              0xFFFF0005
110 #define TEE_ERROR_BAD_PARAMETERS          0xFFFF0006
111 #define TEE_ERROR_BAD_STATE               0xFFFF0007
112 #define TEE_ERROR_ITEM_NOT_FOUND          0xFFFF0008
113 #define TEE_ERROR_NOT_IMPLEMENTED         0xFFFF0009
114 #define TEE_ERROR_NOT_SUPPORTED           0xFFFF000A
115 #define TEE_ERROR_NO_DATA                 0xFFFF000B
116 #define TEE_ERROR_OUT_OF_MEMORY           0xFFFF000C
117 #define TEE_ERROR_BUSY                    0xFFFF000D
118 #define TEE_ERROR_COMMUNICATION           0xFFFF000E
119 #define TEE_ERROR_SECURITY                0xFFFF000F
120 #define TEE_ERROR_SHORT_BUFFER            0xFFFF0010
121 #define TEE_ERROR_EXTERNAL_CANCEL         0xFFFF0011
122 #define TEE_ERROR_OVERFLOW                0xFFFF300F
123 #define TEE_ERROR_TARGET_DEAD             0xFFFF3024
124 #define TEE_ERROR_STORAGE_NO_SPACE        0xFFFF3041
125 #define TEE_ERROR_MAC_INVALID             0xFFFF3071
126 #define TEE_ERROR_SIGNATURE_INVALID       0xFFFF3072
127 #define TEE_ERROR_TIME_NOT_SET            0xFFFF5000
128 #define TEE_ERROR_TIME_NEEDS_RESET        0xFFFF5001
129 
130 /* Parameter Type Constants */
131 #define TEE_PARAM_TYPE_NONE             0
132 #define TEE_PARAM_TYPE_VALUE_INPUT      1
133 #define TEE_PARAM_TYPE_VALUE_OUTPUT     2
134 #define TEE_PARAM_TYPE_VALUE_INOUT      3
135 #define TEE_PARAM_TYPE_MEMREF_INPUT     5
136 #define TEE_PARAM_TYPE_MEMREF_OUTPUT    6
137 #define TEE_PARAM_TYPE_MEMREF_INOUT     7
138 
139 typedef unsigned int                    uint32_t;
140 
141 #define __unused __attribute__((unused))
142 
143 #define TEE_PARAM_TYPES(t0,t1,t2,t3) \
144    ((t0) | ((t1) << 4) | ((t2) << 8) | ((t3) << 12))
145 typedef union {
146     struct {
147         void *buffer;
148         MS_U32 size;
149     } memref;
150     struct {
151         MS_U32 a;
152         MS_U32 b;
153     } value;
154 } TEE_Param;
155 
156 
157 typedef struct {
158     MS_U32 timeLow;
159     MS_U16 timeMid;
160     MS_U16 timeHiAndVersion;
161     MS_U8 clockSeqAndNode[8];
162 } TEE_UUID;
163 
164 /* Trusted Application Function header */
165 typedef struct ta_func_head {
166     MS_U32 cmd_id;    /* Trusted Application Function ID */
167     MS_U32 start;        /* offset to start func */
168 } ta_func_head_t;
169 
170 
171 typedef struct {
172     /* Same Prefix as ta_head_t */
173     TEE_UUID uuid;
174     const char *name;
175     MS_U32 flags;
176 
177     /* properties */
178     MS_U32 prop_datasize;
179     MS_U32 prop_stacksize;
180     MS_U32 prop_tracelevel;
181 
182     const ta_func_head_t *funcs;
183     MS_U32 nbr_func;
184      TEE_Result(*create_entry_point) (void);
185     void (*destroy_entry_point) (void);
186      TEE_Result(*open_session_entry_point) (MS_U32 nParamTypes,
187                          TEE_Param pParams[4],
188                          void **ppSessionContext);
189     void (*close_session_entry_point) (void *pSessionContext);
190      TEE_Result(*invoke_command_entry_point) (void *pSessionContext,
191                            MS_U32 nCommandID,
192                            MS_U32 nParamTypes,
193                            TEE_Param pParams[4]);
194      TEE_Result(*core_entries) (MS_U32 nServiceId, MS_U32 nParamTypes,
195                    TEE_Param pParam[4]);
196 } ta_static_head_t;
197 
198 #endif /* TA_COMM_H */
199