xref: /optee_os/core/include/tee/tee_fs.h (revision 40ea51dee3aa8ae6f07ff8bf1299bfe7799a4db5)
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 
28 #ifndef TEE_FS_H
29 #define TEE_FS_H
30 
31 #include <stddef.h>
32 #include <stdint.h>
33 #include <tee_api_types.h>
34 
35 #define TEE_FS_NAME_MAX 350
36 
37 typedef int64_t tee_fs_off_t;
38 typedef uint32_t tee_fs_mode_t;
39 
40 struct tee_fs_dirent {
41 	uint8_t oid[TEE_OBJECT_ID_MAX_LEN];
42 	size_t oidlen;
43 };
44 
45 struct tee_fs_dir;
46 struct tee_file_handle;
47 struct tee_pobj;
48 
49 /*
50  * tee_fs implements a POSIX like secure file system with GP extension
51  */
52 struct tee_file_operations {
53 	TEE_Result (*open)(struct tee_pobj *po, struct tee_file_handle **fh);
54 	TEE_Result (*create)(struct tee_pobj *po, struct tee_file_handle **fh);
55 	void (*close)(struct tee_file_handle **fh);
56 	TEE_Result (*read)(struct tee_file_handle *fh, size_t pos,
57 			   void *buf, size_t *len);
58 	TEE_Result (*write)(struct tee_file_handle *fh, size_t pos,
59 			    const void *buf, size_t len);
60 	TEE_Result (*rename)(struct tee_pobj *old_po, struct tee_pobj *new_po,
61 			     bool overwrite);
62 	TEE_Result (*remove)(struct tee_pobj *po);
63 	TEE_Result (*truncate)(struct tee_file_handle *fh, size_t size);
64 
65 	TEE_Result (*opendir)(const TEE_UUID *uuid, struct tee_fs_dir **d);
66 	TEE_Result (*readdir)(struct tee_fs_dir *d, struct tee_fs_dirent **ent);
67 	void (*closedir)(struct tee_fs_dir *d);
68 };
69 
70 #ifdef CFG_REE_FS
71 extern const struct tee_file_operations ree_fs_ops;
72 #endif
73 #ifdef CFG_RPMB_FS
74 extern const struct tee_file_operations rpmb_fs_ops;
75 #endif
76 #ifdef CFG_SQL_FS
77 extern const struct tee_file_operations sql_fs_ops;
78 #endif
79 
80 #endif
81