You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/api/storage/FATFileSystem.md
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2,31 +2,31 @@
2
2
3
3
<spanclass="images"><span>FATFileSystem class hierarchy</span></span>
4
4
5
-
The FAT file system is a well-known and established diskoriented file system that you can find on Mbed OS and some lesser known operating systems such as Windows, Linux, and OSX. Due to its age and popularity, the FAT file system has become the de facto standard for forms of portable storage, such as flash drivers and SD cards.
5
+
The FAT file system is an established disk-oriented file system that you can find on Mbed OS, Windows, Linux and Mac OS X. Due to its age and popularity, the FAT file system has become the standard for portable storage, such as flash drivers and SD cards.
6
6
7
-
-**Portable** - Due to its nearly universal support across OSs, the FAT file system provides and easy way to access storage from both the embedded system and a user's PC.
7
+
-**Portable** - Due to its nearly universal support across operating systems, the FAT file system provides access to storage from both the embedded system and your PC.
8
8
9
-
-**Embedded** - Built on the well-known ChanFS project, the FAT file system has been heavily optimized for embedded systems.
9
+
-**Embedded** - Built on the ChanFS project, the FAT file system is optimized for embedded systems.
10
10
11
11
For additional information, please see the [storage overview page](/docs/development/reference/storage.html#declaring-a-file-system).
12
12
13
13
### Use cases
14
14
15
-
The main reason to use the FAT file system is for its usefulness on portable storage. Because of this, most applications using FAT will likely use it in conjunction with an SD card.
15
+
The main reason to use the FAT file system is its usefulness on portable storage. Because of this, most applications using FAT in conjunction with an SD card.
16
16
17
-
The first step to using the FAT file system will be formatting storage with FAT. This can be performed on a PC with the native format command, or it can be performed on Mbed OS with the `format` function.
17
+
The first step to using the FAT file system is formatting storage with FAT. You can do this on a PC with the native format command or on Mbed OS with the `format` function.
18
18
19
-
**Note:** The FAT file system requires at minimum 256 erase blocks. You can find the number of blocks on a block device by dividing the block device's size by its erase size.
19
+
<spanclass="notes">**Note:** The FAT file system requires at minimum 256 erase blocks. You can find the number of blocks on a block device by dividing the block device's size by its erase size.</span>
20
20
21
-
The FAT file system does support external flash, however it must allocate a full erase block for internal operations, which can get quite large for some forms of flash. If RAM consumption becomes a problem, we suggest switching to LittleFS. Fortunately, the Mbed OS file system APIs make switching file systems an easy task. One common strategy is to use the FAT file system for debugging, and switch to LittleFS when the application becomes stable.
21
+
The FAT file system supports external flash; however, it must allocate a full erase block for internal operations, which can become large for some forms of flash. If RAM consumption becomes a problem, we suggest switching to LittleFileSsystem. The Mbed OS file system APIs make switching file systems a straightforward task. One common strategy is to use the FAT file system for debugging and switch to LittleFileSystem when the application becomes stable.
22
22
23
23
### Usage
24
24
25
25
Instantiate the `FATFileSystem` class with a block device and file path.
26
26
27
27
The API that this presents is the standard Mbed OS file system API. Once declared, Mbed OS provides the retargeting layer for the standard C library.
28
28
29
-
The FAT file system can be easily swapped in place with other Mbed OS file systems and is a great method for prototyping applications.
29
+
You can swap the FAT file system in place with other Mbed OS file systems, which is a good method for prototyping applications.
0 commit comments