xref: /optee_os/core/include/tee/tee_fs.h (revision f17691b3f6b27866f66636a53685bd3a6f7daa8a)
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 /*
38  * We split a TEE file into multiple blocks and store them
39  * on REE filesystem. A TEE file is represented by a REE file
40  * called meta and a number of REE files called blocks. Meta
41  * file is used for storing file information, e.g. file size
42  * and backup version of each block.
43  *
44  * REE files naming rule is as follows:
45  *
46  *   <tee_file_name>/meta.<backup_version>
47  *   <tee_file_name>/block0.<backup_version>
48  *   ...
49  *   <tee_file_name>/block15.<backup_version>
50  *
51  * Backup_version is used to support atomic update operation.
52  * Original file will not be updated, instead we create a new
53  * version of the same file and update the new file 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 int64_t 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 /*
72  * tee_fs implemets a POSIX like secure file system with GP extension
73  */
74 struct tee_file_operations {
75 	int (*open)(TEE_Result *errno, const char *file, int flags, ...);
76 	int (*close)(int fd);
77 	int (*read)(TEE_Result *errno, int fd, void *buf, size_t len);
78 	int (*write)(TEE_Result *errno, int fd, const void *buf, size_t len);
79 	tee_fs_off_t (*lseek)(TEE_Result *errno,
80 			      int fd, tee_fs_off_t offset, int whence);
81 	int (*rename)(const char *old, const char *new);
82 	int (*unlink)(const char *file);
83 	int (*ftruncate)(TEE_Result *errno, int fd, tee_fs_off_t length);
84 	int (*mkdir)(const char *path, tee_fs_mode_t mode);
85 	tee_fs_dir *(*opendir)(const char *name);
86 	int (*closedir)(tee_fs_dir *d);
87 	struct tee_fs_dirent *(*readdir)(tee_fs_dir *d);
88 	int (*rmdir)(const char *pathname);
89 	int (*access)(const char *name, int mode);
90 };
91 
92 struct tee_fs_rpc {
93 	int op;
94 	int flags;
95 	int arg;
96 	int fd;
97 	uint32_t len;
98 	int res;
99 };
100 
101 extern struct tee_file_operations tee_file_ops;
102 
103 int tee_fs_send_cmd(struct tee_fs_rpc *bf_cmd, void *data, uint32_t len,
104 		    uint32_t mode);
105 
106 #endif
107