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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
//------------------------------------------------------------------------------------------------
#include "RepRapFirmware.h"
#include "FileStore.h"
#include "MassStorage.h"
#include "Platform.h"
uint32_t FileStore::longestWriteTime = 0;
FileStore::FileStore(Platform* p) : platform(p)
{
}
void FileStore::Init()
{
bufferPointer = 0;
inUse = false;
writing = false;
lastBufferEntry = 0;
openCount = 0;
closeRequested = false;
}
// Invalidate the file if it uses the specified FATFS object
void FileStore::Invalidate(const FATFS *fs)
{
if (file.fs == fs)
{
Init();
file.fs = nullptr;
}
}
// Return true if the file is open on the specified file system
bool FileStore::IsOpenOn(const FATFS *fs) const
{
return openCount != 0 && file.fs == fs;
}
// Open a local file (for example on an SD card).
// This is protected - only Platform can access it.
bool FileStore::Open(const char* directory, const char* fileName, bool write)
{
const char* location = (directory != nullptr)
? platform->GetMassStorage()->CombineName(directory, fileName)
: fileName;
writing = write;
lastBufferEntry = FileBufLen;
FRESULT openReturn = f_open(&file, location, (writing) ? FA_CREATE_ALWAYS | FA_WRITE : FA_OPEN_EXISTING | FA_READ);
if (openReturn != FR_OK)
{
// We no longer report an error if opening a file in read mode fails unless debugging is enabled, because sometimes that is quite normal.
// It is up to the caller to report an error if necessary.
if (reprap.Debug(modulePlatform))
{
platform->MessageF(GENERIC_MESSAGE, "Can't open %s to %s, error code %d\n", location, (writing) ? "write" : "read", openReturn);
}
return false;
}
bufferPointer = (writing) ? 0 : FileBufLen;
inUse = true;
openCount = 1;
return true;
}
void FileStore::Duplicate()
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to dup a non-open file.\n");
return;
}
irqflags_t flags = cpu_irq_save();
++openCount;
cpu_irq_restore(flags);
}
// This may be called from an ISR, in which case we need to defer the close
bool FileStore::Close()
{
if (inInterrupt())
{
if (!inUse)
{
return false;
}
irqflags_t flags = cpu_irq_save();
if (openCount > 1)
{
--openCount;
}
else
{
closeRequested = true;
}
cpu_irq_restore(flags);
return true;
}
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to close a non-open file.\n");
return false;
}
irqflags_t flags = cpu_irq_save();
--openCount;
bool leaveOpen = (openCount != 0);
cpu_irq_restore(flags);
if (leaveOpen)
{
return true;
}
bool ok = true;
if (writing)
{
ok = Flush();
}
FRESULT fr = f_close(&file);
inUse = false;
writing = false;
lastBufferEntry = 0;
closeRequested = false;
return ok && fr == FR_OK;
}
bool FileStore::Seek(FilePosition pos)
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to seek on a non-open file.\n");
return false;
}
if (writing)
{
WriteBuffer();
}
FRESULT fr = f_lseek(&file, pos);
bufferPointer = (writing) ? 0 : FileBufLen;
return fr == FR_OK;
}
FilePosition FileStore::Position() const
{
FilePosition pos = file.fptr;
if (writing)
{
pos += bufferPointer;
}
else if (bufferPointer < lastBufferEntry)
{
pos -= (lastBufferEntry - bufferPointer);
}
return pos;
}
#if 0 // not currently used
bool FileStore::GoToEnd()
{
return Seek(Length());
}
#endif
FilePosition FileStore::Length() const
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to size non-open file.\n");
return 0;
}
return file.fsize;
}
float FileStore::FractionRead() const
{
FilePosition len = Length();
if (len == 0)
{
return 0.0;
}
return (float)Position() / (float)len;
}
uint8_t FileStore::Status()
{
if (!inUse)
return (uint8_t)IOStatus::nothing;
if (lastBufferEntry == FileBufLen)
return (uint8_t)IOStatus::byteAvailable;
if (bufferPointer < lastBufferEntry)
return (uint8_t)IOStatus::byteAvailable;
return (uint8_t)IOStatus::nothing;
}
bool FileStore::ReadBuffer()
{
FRESULT readStatus = f_read(&file, GetBuffer(), FileBufLen, &lastBufferEntry); // Read a chunk of file
if (readStatus != FR_OK)
{
platform->Message(GENERIC_MESSAGE, "Error: Cannot read file.\n");
return false;
}
bufferPointer = 0;
return true;
}
// Single character read via the buffer
bool FileStore::Read(char& b)
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to read from a non-open file.\n");
return false;
}
if (bufferPointer >= FileBufLen)
{
bool ok = ReadBuffer();
if (!ok)
{
return false;
}
}
if (bufferPointer >= lastBufferEntry)
{
b = 0; // Good idea?
return false;
}
b = (char) GetBuffer()[bufferPointer];
bufferPointer++;
return true;
}
// Block read, doesn't use the buffer
// Returns the number of bytes read or -1 if the read process failed
int FileStore::Read(char* extBuf, size_t nBytes)
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to read from a non-open file.\n");
return -1;
}
bufferPointer = FileBufLen; // invalidate the buffer
UINT bytes_read;
FRESULT readStatus = f_read(&file, extBuf, nBytes, &bytes_read);
if (readStatus != FR_OK)
{
platform->Message(GENERIC_MESSAGE, "Error: Cannot read file.\n");
return -1;
}
return (int)bytes_read;
}
// As Read but stop after '\n' or '\r\n' and null-terminate the string.
// If the next line is too long to fit in the buffer then the line will be split.
int FileStore::ReadLine(char* buf, size_t nBytes)
{
const FilePosition lineStart = Position();
const int r = Read(buf, nBytes);
if (r < 0)
{
return r;
}
int i = 0;
while (i < r && buf[i] != '\r' && buf[i] != '\n')
{
++i;
}
if (i + 1 < r && buf[i] == '\r' && buf[i + 1] == '\n') // if stopped at CRLF (Windows-style line end)
{
Seek(lineStart + i + 2); // seek to just after the CRLF
}
else if (i < r) // if stopped at CR or LF
{
Seek(lineStart + i + 1); // seek to just after the CR or LF
}
else if (i == (int)nBytes)
{
--i; // make room for the null terminator
Seek(lineStart + i);
}
buf[i] = 0;
return i;
}
bool FileStore::WriteBuffer()
{
if (bufferPointer != 0)
{
if (!InternalWriteBlock((const char*)GetBuffer(), bufferPointer))
{
return false;
}
bufferPointer = 0;
}
return true;
}
bool FileStore::Write(char b)
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to write byte to a non-open file.\n");
return false;
}
GetBuffer()[bufferPointer] = b;
bufferPointer++;
if (bufferPointer >= FileBufLen)
{
return WriteBuffer();
}
return true;
}
bool FileStore::Write(const char* b)
{
return Write(b, strlen(b));
}
// Direct block write that bypasses the buffer. Used when uploading files.
bool FileStore::Write(const char *s, size_t len)
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to write block to a non-open file.\n");
return false;
}
if (!WriteBuffer())
{
return false;
}
return InternalWriteBlock(s, len);
}
bool FileStore::InternalWriteBlock(const char *s, size_t len)
{
size_t bytesWritten;
uint32_t time = micros();
FRESULT writeStatus = f_write(&file, s, len, &bytesWritten);
time = micros() - time;
if (time > longestWriteTime)
{
longestWriteTime = time;
}
if ((writeStatus != FR_OK) || (bytesWritten != len))
{
platform->Message(GENERIC_MESSAGE, "Error: Cannot write to file. Disc may be full.\n");
return false;
}
return true;
}
bool FileStore::Flush()
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to flush a non-open file.\n");
return false;
}
if (!WriteBuffer())
{
return false;
}
return f_sync(&file) == FR_OK;
}
float FileStore::GetAndClearLongestWriteTime()
{
float ret = (float)longestWriteTime/1000.0;
longestWriteTime = 0;
return ret;
}
#if 0 // not currently used
// Provide a cluster map for fast seeking. Needs _USE_FASTSEEK defined as 1 in conf_fatfs to make any difference.
// The first element of the table must be set to the total number of 32-bit entries in the table before calling this.
bool FileStore::SetClusterMap(uint32_t tbl[])
{
if (!inUse)
{
platform->Message(GENERIC_MESSAGE, "Error: Attempt to set cluster map for a non-open file.\n");
return false;
}
file.cltbl = tbl;
FRESULT ret = f_lseek(&file, CREATE_LINKMAP);
// debugPrintf("ret %d need %u\n", (int)ret, tbl[0]);
return ret == FR_OK;
}
#endif
// End
|