xref: /optee_os/core/include/tee/tee_pobj.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_POBJ_H
30 #define TEE_POBJ_H
31 
32 #include <stdint.h>
33 #include <sys/queue.h>
34 #include <tee_api_types.h>
35 #include <tee/tee_fs.h>
36 
37 struct tee_pobj {
38 	TAILQ_ENTRY(tee_pobj) link;
39 	uint32_t refcnt;
40 	TEE_UUID uuid;
41 	void *obj_id;
42 	uint32_t obj_id_len;
43 	uint32_t flags;
44 	bool temporary;
45 	/* Filesystem handling this object */
46 	const struct tee_file_operations *fops;
47 };
48 
49 TEE_Result tee_pobj_get(TEE_UUID *uuid, void *obj_id, uint32_t obj_id_len,
50 			uint32_t flags, bool temporary,
51 			const struct tee_file_operations *fops,
52 			struct tee_pobj **obj);
53 
54 TEE_Result tee_pobj_release(struct tee_pobj *obj);
55 
56 TEE_Result tee_pobj_rename(struct tee_pobj *obj, void *obj_id,
57 			   uint32_t obj_id_len);
58 
59 #endif
60