Outline ![]()
Files ![]()
loading...
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** FileX Component */
/** */
/** Utility */
/** */
/**************************************************************************/
/**************************************************************************/
#define FX_SOURCE_CODE
/* Include necessary system files. */
#include "fx_api.h"
#include "fx_system.h"
#include "fx_utility.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _fx_utility_FAT_flush PORTABLE C */
/* 6.1.2 */
/* AUTHOR */
/* */
/* William E. Lamie, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function flushes the contents of the FAT cache to the media. */
/* 12-bit, 16-bit and 32-bit FAT writing is supported. */
/* */
/* INPUT */
/* */
/* media_ptr Media control block pointer */
/* */
/* OUTPUT */
/* */
/* return status */
/* */
/* CALLS */
/* */
/* _fx_utility_16_unsigned_write Write a UINT into buffer */
/* _fx_utility_32_unsigned_read Read a ULONG from buffer */
/* _fx_utility_32_unsigned_write Write a ULONG into buffer */
/* _fx_utility_logical_sector_read Read FAT sector into memory */
/* _fx_utility_logical_sector_write Write FAT sector back to disk */
/* */
/* CALLED BY */
/* */
/* FileX System Functions */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
/* 09-30-2020 William E. Lamie Modified comment(s), */
/* resulting in version 6.1 */
/* 11-09-2020 William E. Lamie Modified comment(s), */
/* updated logic for */
/* FAT secondary update map, */
/* resulting in version 6.1.2 */
/* */
/**************************************************************************/
UINT _fx_utility_FAT_flush(FX_MEDIA *media_ptr)
{
ULONG FAT_sector;
ULONG byte_offset;
UCHAR *FAT_ptr;
UINT temp, i;
UINT status, index, ind;
ULONG cluster, next_cluster;
UCHAR sectors_per_bit;
INT multi_sector_entry;
ULONG sector;
#ifndef FX_MEDIA_STATISTICS_DISABLE
/* Increment the number of cache flush requests. */
media_ptr -> fx_media_fat_cache_flushes++;
#endif
/* Loop through the media's FAT cache and flush out dirty entries. */
for (index = 0; index < FX_MAX_FAT_CACHE; index++)
{
/* Determine if the entry is dirty. */
if ((media_ptr -> fx_media_fat_cache[index].fx_fat_cache_entry_dirty) == 0)
{
/* No, just advance to the next entry. */
continue;
}
/* Otherwise, the entry is indeed dirty and must be flushed out. Process
relative to the type of FAT that is being used. */
/* Pickup the contents of the FAT cache entry. */
cluster = media_ptr -> fx_media_fat_cache[index].fx_fat_cache_entry_cluster;
/* Determine which type of FAT is present. */
#ifdef FX_ENABLE_EXFAT
if (media_ptr -> fx_media_FAT_type == FX_FAT12)
#else
if (media_ptr -> fx_media_12_bit_FAT)
#endif /* FX_ENABLE_EXFAT */
{
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster << 1) + cluster) >> 1;
/* Calculate the FAT sector the requested FAT entry resides in. */
FAT_sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Initialize as not written. */
multi_sector_entry = -1;
for (;;)
{
/* Pickup the FAT sector. */
status = _fx_utility_logical_sector_read(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
/* Determine if a mulit-sector FAT update is present. */
if (multi_sector_entry != -1)
{
/* Yes, store the remaining portion of the new FAT entry in the
next FAT sector. */
/* Setup a pointer into the buffer. */
FAT_ptr = (UCHAR *)media_ptr -> fx_media_memory_buffer;
/* Pickup the cluster and next cluster. */
cluster = (media_ptr -> fx_media_fat_cache[multi_sector_entry].fx_fat_cache_entry_cluster);
next_cluster = media_ptr -> fx_media_fat_cache[multi_sector_entry].fx_fat_cache_entry_value;
/* Determine if the cluster entry is odd or even. */
if (cluster & 1)
{
/* Store the upper 8 bits of the FAT entry. */
*FAT_ptr = (UCHAR)((next_cluster >> 4) & 0xFF);
}
else
{
/* Store the upper 4 bits of the FAT entry. */
temp = ((UINT)*FAT_ptr) & 0xF0;
*FAT_ptr = (UCHAR)(temp | ((next_cluster >> 8) & 0xF));
}
/* Clear the multi-sector flag. */
multi_sector_entry = -1;
}
/* Loop through the remainder of the cache to check for multiple entries
within the same FAT sector being written out. */
for (i = index; i < FX_MAX_FAT_CACHE; i++)
{
/* Is the cache entry dirty? */
if ((media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty) == 0)
{
/* Not dirty, does not need to be flushed. */
continue;
}
/* Isolate the cluster. */
cluster = (media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_cluster);
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster << 1) + cluster) >> 1;
/* Pickup the sector. */
sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Is it the current FAT sector? */
if (sector != FAT_sector)
{
/* Different FAT sector - not in this pass of the loop. */
continue;
}
/* Pickup new value for this FAT entry. */
next_cluster = media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_value;
/* Now calculate the byte offset into this FAT sector. */
byte_offset = byte_offset -
((FAT_sector - (ULONG)media_ptr -> fx_media_reserved_sectors) *
media_ptr -> fx_media_bytes_per_sector);
/* Determine if we are now past the end of the FAT buffer in memory. */
if (byte_offset == (ULONG)(media_ptr -> fx_media_bytes_per_sector - 1))
{
/* Yes, we need to read the next sector */
multi_sector_entry = (INT)i;
}
/* Setup a pointer into the buffer. */
FAT_ptr = (UCHAR *)media_ptr -> fx_media_memory_buffer + (UINT)byte_offset;
/* Clear the dirty flag. */
media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty = 0;
/* Determine if the cluster entry is odd or even. */
if (cluster & 1)
{
/* Odd cluster number. */
/* Pickup the upper nibble of the FAT entry. */
/* First, set the lower nibble of the FAT entry. */
temp = (((UINT)*FAT_ptr) & 0x0F);
*FAT_ptr = (UCHAR)(temp | ((next_cluster << 4) & 0xF0));
/* Determine if this is a mulit-sector entry. */
if ((multi_sector_entry) == (INT)i)
{
/* Yes, requires multiple sector - will write rest of the part later. */
continue;
}
/* Move to the next byte of the FAT entry. */
FAT_ptr++;
/* Store the upper 8 bits of the FAT entry. */
*FAT_ptr = (UCHAR)((next_cluster >> 4) & 0xFF);
}
else
{
/* Even cluster number. */
/* Store the lower byte of the FAT entry. */
*FAT_ptr = (UCHAR)(next_cluster & 0xFF);
/* Determine if this is a mulit-sector entry. */
if ((multi_sector_entry) == (INT)i)
{
/* Yes, requires multiple sector - will write rest of the part later. */
continue;
}
/* Move to the next nibble of the FAT entry. */
FAT_ptr++;
/* Store the upper 4 bits of the FAT entry. */
temp = ((UINT)*FAT_ptr) & 0xF0;
*FAT_ptr = (UCHAR)(temp | ((next_cluster >> 8) & 0xF));
}
}
/* First, write out the current sector. */
status = _fx_utility_logical_sector_write(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
/* Mark the FAT sector update bit map to indicate this sector has been written. */
if (media_ptr -> fx_media_sectors_per_FAT % (FX_FAT_MAP_SIZE << 3) == 0)
{
sectors_per_bit = (UCHAR)((UINT)media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3));
}
else
{
sectors_per_bit = (UCHAR)((UINT)media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3) + 1);
}
/* Check for invalid value. */
if (sectors_per_bit == 0)
{
/* Invalid media, return error. */
return(FX_MEDIA_INVALID);
}
ind = ((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) >> 3;
media_ptr -> fx_media_fat_secondary_update_map[ind] =
(UCHAR)((INT)media_ptr -> fx_media_fat_secondary_update_map[ind]
| (1 <<(((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) & 7)));
/* Determine if the multi-sector flag is set. */
if (multi_sector_entry != -1)
{
/* Yes, position to the next sector and read it in. */
FAT_sector++;
}
else
{
/* No, we are finished with this loop. */
break;
}
}
}
#ifdef FX_ENABLE_EXFAT
else if (media_ptr -> fx_media_FAT_type == FX_FAT16)
#else
else if (!media_ptr -> fx_media_32_bit_FAT)
#endif /* FX_ENABLE_EXFAT */
{
/* 16-bit FAT is present. */
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster) << 1);
/* Calculate the FAT sector the requested FAT entry resides in. */
FAT_sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Read the FAT sector. */
status = _fx_utility_logical_sector_read(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
/* Loop through the remainder of the cache to check for multiple entries
within the same FAT sector being written out. */
for (i = index; i < FX_MAX_FAT_CACHE; i++)
{
/* Determine if the entry is dirty. */
if (media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty == 0)
{
/* Not dirty, does not need to be flushed. */
continue;
}
/* Isolate the cluster. */
cluster = (media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_cluster);
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster) * 2);
/* Pickup the sector. */
sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Is it the current FAT sector? */
if (sector != FAT_sector)
{
/* Different FAT sector - not in this pass of the loop. */
continue;
}
/* Now calculate the byte offset into this FAT sector. */
byte_offset = byte_offset -
((FAT_sector - (ULONG)media_ptr -> fx_media_reserved_sectors) *
media_ptr -> fx_media_bytes_per_sector);
/* Setup a pointer into the buffer. */
FAT_ptr = (UCHAR *)media_ptr -> fx_media_memory_buffer + (UINT)byte_offset;
/* Pickup new value for this FAT entry. */
next_cluster = media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_value;
/* Store the FAT entry. */
_fx_utility_16_unsigned_write(FAT_ptr, (UINT)next_cluster);
/* Clear the dirty flag. */
media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty = 0;
}
/* Write the last written FAT sector out. */
status = _fx_utility_logical_sector_write(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
/* Mark the FAT sector update bit map to indicate this sector has been
written. */
if (media_ptr -> fx_media_sectors_per_FAT % (FX_FAT_MAP_SIZE << 3) == 0)
{
sectors_per_bit = (UCHAR)(media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3));
}
else
{
sectors_per_bit = (UCHAR)((media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3)) + 1);
}
ind = ((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) >> 3;
media_ptr -> fx_media_fat_secondary_update_map[ind] =
(UCHAR)((INT)media_ptr -> fx_media_fat_secondary_update_map[ind]
| (1 <<(((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) & 7)));
}
else
{
/* 32-bit FAT or exFAT are present. */
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster) * 4);
/* Calculate the FAT sector the requested FAT entry resides in. */
FAT_sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Read the FAT sector. */
status = _fx_utility_logical_sector_read(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
/* Loop through the remainder of the cache to check for multiple entries
within the same FAT sector being written out. */
for (i = index; i < FX_MAX_FAT_CACHE; i++)
{
/* Determine if the entry is dirty. */
if (media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty == 0)
{
/* Not dirty, does not need to be flushed. */
continue;
}
/* Isolate the cluster. */
cluster = (media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_cluster);
/* Calculate the byte offset to the cluster entry. */
byte_offset = (((ULONG)cluster) * 4);
/* Pickup the sector. */
sector = (byte_offset / media_ptr -> fx_media_bytes_per_sector) +
(ULONG)media_ptr -> fx_media_reserved_sectors;
/* Is it the current FAT sector? */
if (sector != FAT_sector)
{
/* Different FAT sector - not in this pass of the loop. */
continue;
}
/* Now calculate the byte offset into this FAT sector. */
byte_offset = byte_offset -
((FAT_sector - (ULONG)media_ptr -> fx_media_reserved_sectors) *
media_ptr -> fx_media_bytes_per_sector);
/* Setup a pointer into the buffer. */
FAT_ptr = (UCHAR *)media_ptr -> fx_media_memory_buffer + (UINT)byte_offset;
/* Pickup new value for this FAT entry. */
next_cluster = media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_value;
/* Store the FAT entry. */
_fx_utility_32_unsigned_write(FAT_ptr, next_cluster);
/* Clear the dirty flag. */
media_ptr -> fx_media_fat_cache[i].fx_fat_cache_entry_dirty = 0;
}
/* Write the last written FAT sector out. */
status = _fx_utility_logical_sector_write(media_ptr, (ULONG64) FAT_sector,
media_ptr -> fx_media_memory_buffer, ((ULONG) 1), FX_FAT_SECTOR);
/* Determine if an error occurred. */
if (status != FX_SUCCESS)
{
/* Return the error status. */
return(status);
}
#ifdef FX_ENABLE_EXFAT
/* We are not using fx_media_fat_secondary_update_map for exFAT. */
if (media_ptr -> fx_media_FAT_type == FX_FAT32)
{
#endif /* FX_ENABLE_EXFAT */
/* Mark the FAT sector update bit map to indicate this sector has been
written. */
if (media_ptr -> fx_media_sectors_per_FAT % (FX_FAT_MAP_SIZE << 3) == 0)
{
sectors_per_bit = (UCHAR)(media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3));
}
else
{
sectors_per_bit = (UCHAR)((media_ptr -> fx_media_sectors_per_FAT / (FX_FAT_MAP_SIZE << 3)) + 1);
}
ind = ((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) >> 3;
media_ptr -> fx_media_fat_secondary_update_map[ind] =
(UCHAR)((INT)media_ptr -> fx_media_fat_secondary_update_map[ind]
| (1 <<(((FAT_sector - media_ptr -> fx_media_reserved_sectors) / sectors_per_bit) & 7)));
#ifdef FX_ENABLE_EXFAT
}
#endif /* FX_ENABLE_EXFAT */
}
}
#ifdef FX_ENABLE_FAULT_TOLERANT
/* While fault_tolerant is enabled, this function will be called before the return of all APIs. */
if (media_ptr -> fx_media_fault_tolerant_enabled)
{
/* Delete the record of FAT sector since all FAT entries are flushed. */
media_ptr -> fx_media_fault_tolerant_cached_FAT_sector = 0;
}
#endif /* FX_ENABLE_FAULT_TOLERANT */
/* Return successful status. */
return(FX_SUCCESS);
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.