-
Notifications
You must be signed in to change notification settings - Fork 39
/
dir.c
188 lines (165 loc) · 6.02 KB
/
dir.c
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
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file dir.c
* @brief File System Directory Access and Management.
*/
#include "dir.h"
#include "fs_common.h"
fs_status_t dir_open(dir_t * dir, fs_dir_t fs_specific_dir, const char * __generic_ptr path)
{
uint8_t vol_id;
logical_drive_t * logical_drive;
fs_status_t res;
res = FILE_SYSTEM_VALIDATE_OBJECT(dir);
if (FSS_OK != res) {
// error: the dir parameter is NULL
return res;
}
res = FILE_SYSTEM_VALIDATE_OBJECT(fs_specific_dir);
if (FSS_OK != res) {
// error: the fs_specific_dir parameter is NULL
return res;
}
// check if the directory can be opened
res = file_system_validate_object_opening(dir);
if (FSS_OK != res) {
// error: directory is either already open, or the registry is full
return res;
}
res = file_system_get_drive_id(path, &vol_id);
if (FSS_OK != res) {
// error: given path is not valid
return res;
}
// validate the logical drive
logical_drive = file_system_get_registred_volume(vol_id);
res = FILE_SYSTEM_VALIDATE_LOGICAL_DRIVE(logical_drive);
if (FSS_OK != res) {
// error: logical drive is either nullptr or is not initialized
return res;
}
// open the fs_specific_dir on the logical_drive
res = logical_drive->vtptr->d_open(logical_drive, fs_specific_dir, path);
if (FSS_OK == res) {
// initialize the dir structure
dir->logical_drive = logical_drive;
dir->fs_dir = fs_specific_dir;
// register the directory with the logical drive
++logical_drive->object_count;
// register the directory with the file system
file_system_register_object(dir);
}
return res;
}
fs_status_t dir_close(dir_t * dir)
{
logical_drive_t * logical_drive;
fs_status_t res;
uint8_t found_object_index;
res = FILE_SYSTEM_VALIDATE_OBJECT(dir);
if (FSS_OK != res) {
// error: the dir parameter is NULL
return res;
}
// check if the directory is open
res = file_system_validate_object_closing(dir, &found_object_index);
if (FSS_OK != res) {
// error: the diurectory is not open
return res;
}
// close the dir->fs_dir on the logical_drive
logical_drive = dir->logical_drive;
res = logical_drive->vtptr->d_close(logical_drive, dir->fs_dir);
if (FSS_OK == res) {
// deinitialize the dir_t structure
dir->logical_drive = (logical_drive_t *)0;
dir->fs_dir = (fs_dir_t)0;
// unregister the directory from the logical drive
--logical_drive->object_count;
// unregister the directory from the file system
file_system_unregister_object(dir, found_object_index);
}
return res;
}
fs_status_t dir_read(dir_t * dir, void * file_information)
{
logical_drive_t * logical_drive;
fs_status_t res;
uint8_t found_object_index;
res = FILE_SYSTEM_VALIDATE_OBJECT(dir);
if (FSS_OK != res) {
// error: the dir parameter is NULL
return res;
}
res = FILE_SYSTEM_VALIDATE_OBJECT(file_information);
if (FSS_OK != res) {
// error: the file_information parameter is NULL
return res;
}
// check if the directory is open
found_object_index = file_system_check_object_registration(dir);
if (FILE_SYSTEM_OBJECT_NOT_FOUND == found_object_index) {
// error: the directory must be opened first
return FSS_GENERAL_ERROR;
}
// read entry from dir->fs_dir on the logical_drive
logical_drive = dir->logical_drive;
return logical_drive->vtptr->d_read(logical_drive, dir->fs_dir, file_information);
}
fs_status_t dir_rewind(dir_t * dir)
{
logical_drive_t * logical_drive;
fs_status_t res;
uint8_t found_object_index;
res = FILE_SYSTEM_VALIDATE_OBJECT(dir);
if (FSS_OK != res) {
// error: the dir parameter is NULL
return res;
}
// check if the directory is open
found_object_index = file_system_check_object_registration(dir);
if (FILE_SYSTEM_OBJECT_NOT_FOUND == found_object_index) {
// error: the directory must be opened first
return FSS_GENERAL_ERROR;
}
// move read/write offset to the beginning of the dir->fs_dir on the logical_drive
logical_drive = dir->logical_drive;
return logical_drive->vtptr->d_rewind(logical_drive, dir->fs_dir);
}