xref: /optee_os/core/include/tee/tee_obj.h (revision 1bb929836182ecb96d2d9d268daa807c67596396)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014, STMicroelectronics International N.V.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef TEE_OBJ_H
30 #define TEE_OBJ_H
31 
32 #include <tee_api_types.h>
33 #include <kernel/tee_ta_manager.h>
34 #include <sys/queue.h>
35 
36 #define TEE_USAGE_DEFAULT   0xffffffff
37 
38 struct tee_obj {
39 	TAILQ_ENTRY(tee_obj) link;
40 	TEE_ObjectInfo info;
41 	bool busy;		/* true if used by an operation */
42 	uint32_t have_attrs;	/* bitfield identifying set properties */
43 	void *attr;
44 	size_t ds_pos;
45 	struct tee_pobj *pobj;	/* ptr to persistant object */
46 	struct tee_file_handle *fh;
47 	uint32_t flags;		/* permission flags for persistent objects */
48 };
49 
50 void tee_obj_add(struct user_ta_ctx *utc, struct tee_obj *o);
51 
52 TEE_Result tee_obj_get(struct user_ta_ctx *utc, uint32_t obj_id,
53 		       struct tee_obj **obj);
54 
55 void tee_obj_close(struct user_ta_ctx *utc, struct tee_obj *o);
56 
57 void tee_obj_close_all(struct user_ta_ctx *utc);
58 
59 TEE_Result tee_obj_verify(struct tee_ta_session *sess, struct tee_obj *o);
60 
61 struct tee_obj *tee_obj_alloc(void);
62 void tee_obj_free(struct tee_obj *o);
63 
64 #endif
65