xref: /optee_os/core/include/tee/tee_fs.h (revision f4c0a29395d0cc70c84e47f9e169f9313f303dab)
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 
34 #define TEE_FS_NAME_MAX 350
35 
36 /*
37  * We split a TEE file into multiple blocks and stored
38  * on REE filesystem. TEE file is represented by small
39  * REE files and a special file called meta, which is used
40  * to concatenate multiple REE files.
41  *
42  * Thus, REE file path should be slightly longer than
43  * TEE file path, it's name should look like:
44  *
45  *   <tee_file_name>/meta.<backup_version>
46  *   <tee_file_name>/block0.<backup_version>
47  *   ...
48  *   <tee_file_name>/block15.<backup_version>
49  *
50  * backup_version is used to support atomic update operation
51  * any update to file block(s) and meta will not directly on
52  * original file, we create new version of the given file and
53  * update it instead.
54  *
55  * The backup_version of each block file is stored in meta
56  * file (see @backup_version_table in tee_fs_private.h), the
57  * meta file itself also has backup_version, the update is
58  * successful after new version of meta has been written.
59  */
60 #define REE_FS_NAME_MAX (TEE_FS_NAME_MAX + 20)
61 
62 typedef int tee_fs_off_t;
63 typedef uint32_t tee_fs_mode_t;
64 typedef struct tee_fs_dir tee_fs_dir;
65 
66 struct tee_fs_dirent {
67 	char *d_name;
68 };
69 
70 /*
71  * tee_fs implemets a POSIX like secure file system
72  */
73 struct tee_file_operations {
74 	int (*open)(const char *file, int flags, ...);
75 	int (*close)(int fd);
76 	int (*read)(int fd, void *buf, size_t len);
77 	int (*write)(int fd, const void *buf, size_t len);
78 	tee_fs_off_t (*lseek)(int fd, tee_fs_off_t offset, int whence);
79 	int (*rename)(const char *old, const char *new);
80 	int (*unlink)(const char *file);
81 	int (*ftruncate)(int fd, tee_fs_off_t length);
82 	int (*mkdir)(const char *path, tee_fs_mode_t mode);
83 	tee_fs_dir *(*opendir)(const char *name);
84 	int (*closedir)(tee_fs_dir *d);
85 	struct tee_fs_dirent *(*readdir)(tee_fs_dir *d);
86 	int (*rmdir)(const char *pathname);
87 	int (*access)(const char *name, int mode);
88 };
89 
90 struct tee_fs_rpc {
91 	int op;
92 	int flags;
93 	int arg;
94 	int fd;
95 	uint32_t len;
96 	int res;
97 };
98 
99 extern struct tee_file_operations tee_file_ops;
100 
101 int tee_fs_send_cmd(struct tee_fs_rpc *bf_cmd, void *data, uint32_t len,
102 		    uint32_t mode);
103 
104 #endif
105