xref: /optee_os/core/include/tee/tee_fs.h (revision 69d4445d0c64d431120ec1747e85a7866c125f8d)
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
46  *   <tee_file_name>/block0
47  *   ...
48  *   <tee_file_name>/block15
49  */
50 #define REE_FS_NAME_MAX (TEE_FS_NAME_MAX + 20)
51 
52 typedef int tee_fs_off_t;
53 typedef uint32_t tee_fs_mode_t;
54 typedef struct tee_fs_dir tee_fs_dir;
55 
56 struct tee_fs_dirent {
57 	char *d_name;
58 };
59 
60 /*
61  * tee_fs implemets a POSIX like secure file system
62  */
63 struct tee_file_operations {
64 	int (*open)(const char *file, int flags, ...);
65 	int (*close)(int fd);
66 	int (*read)(int fd, void *buf, size_t len);
67 	int (*write)(int fd, const void *buf, size_t len);
68 	tee_fs_off_t (*lseek)(int fd, tee_fs_off_t offset, int whence);
69 	int (*rename)(const char *old, const char *new);
70 	int (*unlink)(const char *file);
71 	int (*ftruncate)(int fd, tee_fs_off_t length);
72 	int (*mkdir)(const char *path, tee_fs_mode_t mode);
73 	tee_fs_dir *(*opendir)(const char *name);
74 	int (*closedir)(tee_fs_dir *d);
75 	struct tee_fs_dirent *(*readdir)(tee_fs_dir *d);
76 	int (*rmdir)(const char *pathname);
77 	int (*access)(const char *name, int mode);
78 };
79 
80 struct tee_fs_rpc {
81 	int op;
82 	int flags;
83 	int arg;
84 	int fd;
85 	uint32_t len;
86 	int res;
87 };
88 
89 extern struct tee_file_operations tee_file_ops;
90 
91 int tee_fs_send_cmd(struct tee_fs_rpc *bf_cmd, void *data, uint32_t len,
92 		    uint32_t mode);
93 
94 #endif
95