xref: /optee_os/core/include/tee/tee_fs.h (revision 1bb929836182ecb96d2d9d268daa807c67596396)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014, STMicroelectronics International N.V.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef TEE_FS_H
30 #define TEE_FS_H
31 
32 #include <stddef.h>
33 #include <stdint.h>
34 #include <tee_api_types.h>
35 
36 #define TEE_FS_NAME_MAX 350
37 
38 typedef int64_t tee_fs_off_t;
39 typedef uint32_t tee_fs_mode_t;
40 
41 struct tee_fs_dirent {
42 	uint8_t oid[TEE_OBJECT_ID_MAX_LEN];
43 	size_t oidlen;
44 };
45 
46 struct tee_fs_dir;
47 struct tee_file_handle;
48 struct tee_pobj;
49 
50 /*
51  * tee_fs implements a POSIX like secure file system with GP extension
52  */
53 struct tee_file_operations {
54 	TEE_Result (*open)(struct tee_pobj *po, size_t *size,
55 			   struct tee_file_handle **fh);
56 	TEE_Result (*create)(struct tee_pobj *po, bool overwrite,
57 			     const void *head, size_t head_size,
58 			     const void *attr, size_t attr_size,
59 			     const void *data, size_t data_size,
60 			     struct tee_file_handle **fh);
61 	void (*close)(struct tee_file_handle **fh);
62 	TEE_Result (*read)(struct tee_file_handle *fh, size_t pos,
63 			   void *buf, size_t *len);
64 	TEE_Result (*write)(struct tee_file_handle *fh, size_t pos,
65 			    const void *buf, size_t len);
66 	TEE_Result (*rename)(struct tee_pobj *old_po, struct tee_pobj *new_po,
67 			     bool overwrite);
68 	TEE_Result (*remove)(struct tee_pobj *po);
69 	TEE_Result (*truncate)(struct tee_file_handle *fh, size_t size);
70 
71 	TEE_Result (*opendir)(const TEE_UUID *uuid, struct tee_fs_dir **d);
72 	TEE_Result (*readdir)(struct tee_fs_dir *d, struct tee_fs_dirent **ent);
73 	void (*closedir)(struct tee_fs_dir *d);
74 };
75 
76 #ifdef CFG_REE_FS
77 extern const struct tee_file_operations ree_fs_ops;
78 #endif
79 #ifdef CFG_RPMB_FS
80 extern const struct tee_file_operations rpmb_fs_ops;
81 
82 TEE_Result tee_rpmb_fs_raw_open(const char *fname, bool create,
83 				struct tee_file_handle **fh);
84 #endif
85 
86 #endif /*TEE_FS_H*/
87