blob: 55ef664f386a2aecb063faf0cf5a9cad745c1688 (
plain)
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
|
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file fs.hpp
* @brief File System interfaces header.
*
* @addtogroup fs_interface
* @{
*/
#ifndef _FS_HPP_
#define _FS_HPP_
#include "ch.hpp"
/**
* @name Error codes
* @{
*/
/**
* @brief No error return code.
*/
#define FILE_OK 0
/**
* @brief Error code from the file stream methods.
*/
#define FILE_ERROR 0xFFFFFFFFUL
/** @} */
/**
* @brief ChibiOS FS-related interfaces.
*/
namespace chibios_fs {
/**
* @brief File offset type.
*/
typedef uint32_t fileoffset_t;
/*------------------------------------------------------------------------*
* chibios_fs::BaseFileStreamInterface *
*------------------------------------------------------------------------*/
/**
* @brief Interface of an abstract file object.
*/
class BaseFileStreamInterface : public chibios_rt::BaseSequentialStreamInterface {
public:
/**
* @brief Returns an implementation dependent error code.
*
* @return An implementation-dependent error code.
*
* @api
*/
virtual uint32_t getAndClearLastError(void) = 0;
/**
* @brief Returns the current file size.
*
* @return The file size.
* @retval FILE_ERROR if the operation failed.
*
* @api
*/
virtual fileoffset_t getSize(void) = 0;
/**
* @brief Returns the current file pointer position.
*
* @return The current position inside the file.
* @retval FILE_ERROR if the operation failed.
*
* @api
*/
virtual fileoffset_t getPosition(void) = 0;
/**
* @brief sets the current file pointer position.
*
* @param[in] offset new absolute position
* @return The operation status.
* @retval FILE_OK if no error.
* @retval FILE_ERROR if the operation failed.
*
* @api
*/
virtual uint32_t setPosition(fileoffset_t offset) = 0;
};
/*------------------------------------------------------------------------*
* chibios_fs::BaseFileSystemInterface *
*------------------------------------------------------------------------*/
/**
* @brief Interface of an abstract file system object.
* @note The interface only exposes common features, the implementing
* classes can offer an extended interface.
*/
class BaseFileSystemInterface {
public:
/**
* @brief Returns an implementation dependent error code.
*
* @return An implementation-dependent error code.
*
* @api
*/
virtual uint32_t getAndClearLastError(void) = 0;
/**
* @brief Synchronizes caches with media device.
*/
virtual void synchronize(void) = 0;
/**
* @brief Removes a file.
*
* @param[in] fname file name
*
* @api
*/
virtual void remove(const char *fname) = 0;
/**
* @brief Opens a file for read and write.
*
* @param[in] fname file name
* @return An interface of a file object.
* @retval NULL if the operation failed.
*
* @api
*/
virtual BaseFileStreamInterface *open(const char *fname) = 0;
/**
* @brief Opens a file for read only.
*
* @param[in] fname file name
* @return An interface of a file object.
* @retval NULL if the operation failed.
*
* @api
*/
virtual BaseFileStreamInterface *openForRead(const char *fname) = 0;
/**
* @brief Opens a file for write only.
*
* @param[in] fname file name
* @return An interface of a file object.
* @retval NULL if the operation failed.
*
* @api
*/
virtual BaseFileStreamInterface *openForWrite(const char *fname) = 0;
/**
* @brief Creates a file and opens it for write only.
* @details If a file with the same name already exists then it is
* overwritten.
*
* @param[in] fname file name
* @return An interface of a file object.
* @retval NULL if the operation failed.
*
* @api
*/
virtual BaseFileStreamInterface *create(const char *fname) = 0;
/**
* @brief Closes a file.
*
* @api
*/
virtual void close(BaseFileStreamInterface *file) = 0;
};
}
#endif /* _FS_HPP_ */
/** @} */
|
