1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @defgroup rtems_fstab File System Mount Support
*
* @ingroup FileSystemTypesAndMount
* @brief File System Mount Functions
*
* This file contains the fsmount functions. These functions
* are used to mount a list of filesystems (and create their mount
* points before).
*/
/*
* Copyright (c) 2003 IMD Ingenieurbuero fuer Microcomputertechnik
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _FSMOUNT_H
#define _FSMOUNT_H
#include <rtems.h>
#include <rtems/libio.h>
#include <rtems/libcsupport.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup rtems_fstab File System Mount Support
*
* @ingroup FileSystemTypesAndMount
*/
/**@{**/
/**
* File system mount report and abort condition flags.
*
* The flags define, which conditions will cause a report during the mount
* process (via printf()) or abort the mount process.
*
* @see rtems_fstab_entry and rtems_fsmount().
*/
typedef enum {
/**
* No conditions.
*/
RTEMS_FSTAB_NONE = 0U,
/**
* Complete mount process was successful.
*/
RTEMS_FSTAB_OK = 0x1U,
/**
* Mount point creation failed.
*/
RTEMS_FSTAB_ERROR_MOUNT_POINT = 0x2U,
/**
* File system mount failed.
*/
RTEMS_FSTAB_ERROR_MOUNT = 0x4U,
/**
* Something failed.
*/
RTEMS_FSTAB_ERROR = RTEMS_FSTAB_ERROR_MOUNT_POINT | RTEMS_FSTAB_ERROR_MOUNT,
/**
* Any condition.
*/
RTEMS_FSTAB_ANY = RTEMS_FSTAB_OK | RTEMS_FSTAB_ERROR
} rtems_fstab_conditions;
/**
* File system table entry.
*/
typedef struct {
/**
* Source for the mount.
*/
const char *source;
/**
* Target for the mount.
*/
const char *target;
/**
* File system operations.
*/
const char *type;
/**
* File system mount options.
*/
rtems_filesystem_options_t options;
/**
* Report @ref rtems_fstab_conditions "condition flags".
*/
uint16_t report_reasons;
/**
* Abort @ref rtems_fstab_conditions "condition flags".
*/
uint16_t abort_reasons;
} rtems_fstab_entry;
/**
* @brief Mounts the file systems listed in the file system mount table.
*
* Mounts the file systems listed in the file system mount table @a fstab of
* size @a size.
*
* Each file system will be mounted according to its table entry parameters.
* In case of an abort condition the corresponding table index will be reported
* in @a abort_index. The pointer @a abort_index may be @c NULL. The mount
* point paths will be created with rtems_mkdir() and need not exist
* beforehand.
*
* On success, zero is returned. On error, -1 is returned, and @c errno is set
* appropriately.
*
* @see rtems_bdpart_register_from_disk().
*
* The following example code tries to mount a FAT file system within a SD
* Card. Some cards do not have a partition table so at first it tries to find
* a file system inside the hole disk. If this is successful the mount process
* will be aborted because the @ref RTEMS_FSTAB_OK condition is true. If this
* did not work it tries to mount the file system inside the first partition.
* If this fails the mount process will not be aborted (this is already the
* last entry), but the last error status will be returned.
*
* @code
* #include <stdio.h>
* #include <string.h>
* #include <errno.h>
*
* #include <rtems.h>
* #include <rtems/bdpart.h>
* #include <rtems/error.h>
* #include <rtems/fsmount.h>
*
* static const rtems_fstab_entry fstab [] = {
* {
* .source = "/dev/sd-card-a",
* .target = "/mnt",
* .type = "dosfs",
* .options = RTEMS_FILESYSTEM_READ_WRITE,
* .report_reasons = RTEMS_FSTAB_ANY,
* .abort_reasons = RTEMS_FSTAB_OK
* }, {
* .source = "/dev/sd-card-a1",
* .target = "/mnt",
* .type = "dosfs",
* .options = RTEMS_FILESYSTEM_READ_WRITE,
* .report_reasons = RTEMS_FSTAB_ANY,
* .abort_reasons = RTEMS_FSTAB_NONE
* }
* };
*
* static void my_mount(void)
* {
* rtems_status_code sc = RTEMS_SUCCESSFUL;
* int rv = 0;
* size_t abort_index = 0;
*
* sc = rtems_bdpart_register_from_disk("/dev/sd-card-a");
* if (sc != RTEMS_SUCCESSFUL) {
* printf("read partition table failed: %s\n", rtems_status_text(sc));
* }
*
* rv = rtems_fsmount(fstab, sizeof(fstab) / sizeof(fstab [0]), &abort_index);
* if (rv != 0) {
* printf("mount failed: %s\n", strerror(errno));
* }
* printf("mount aborted at %zu\n", abort_index);
* }
* @endcode
*/
int rtems_fsmount(
const rtems_fstab_entry *fstab,
size_t size,
size_t *abort_index
);
/** @} */
typedef rtems_fstab_entry fstab_t;
#define FSMOUNT_MNT_OK RTEMS_FSTAB_OK
#define FSMOUNT_MNTPNT_CRTERR RTEMS_FSTAB_ERROR_MOUNT_POINT
#define FSMOUNT_MNT_FAILED RTEMS_FSTAB_ERROR_MOUNT
#ifdef __cplusplus
}
#endif
#endif /* _FSMOUNT_H */
|
