xref: /optee_os/core/include/tee/tee_fs.h (revision ef4bc451c262f007562867ea4e5f4ca9f26459fd)
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 	char *d_name;
42 };
43 
44 struct tee_fs_dir;
45 struct tee_file_handle;
46 
47 /*
48  * tee_fs implements a POSIX like secure file system with GP extension
49  */
50 struct tee_file_operations {
51 	TEE_Result (*open)(const char *name, struct tee_file_handle **fh);
52 	TEE_Result (*create)(const char *name, struct tee_file_handle **fh);
53 	void (*close)(struct tee_file_handle **fh);
54 	TEE_Result (*read)(struct tee_file_handle *fh, void *buf, size_t *len);
55 	TEE_Result (*write)(struct tee_file_handle *fh, const void *buf,
56 			    size_t len);
57 	TEE_Result (*seek)(struct tee_file_handle *fh, int32_t offs,
58 			   TEE_Whence whence, int32_t *new_offs);
59 	TEE_Result (*rename)(const char *old_name, const char *new_name,
60 			     bool overwrite);
61 	TEE_Result (*remove)(const char *name);
62 	TEE_Result (*truncate)(struct tee_file_handle *fh, size_t size);
63 
64 	TEE_Result (*opendir)(const char *name, struct tee_fs_dir **d);
65 	TEE_Result (*readdir)(struct tee_fs_dir *d, struct tee_fs_dirent **ent);
66 	void (*closedir)(struct tee_fs_dir *d);
67 };
68 
69 #ifdef CFG_REE_FS
70 extern const struct tee_file_operations ree_fs_ops;
71 #endif
72 #ifdef CFG_RPMB_FS
73 extern const struct tee_file_operations rpmb_fs_ops;
74 #endif
75 #ifdef CFG_SQL_FS
76 extern const struct tee_file_operations sql_fs_ops;
77 #endif
78 
79 #endif
80