Skip to content

Commit 5b17470

Browse files
update fatdrvce/msddrvce docs
Signed-off-by: mateoconlechuga <matthewwaltzis@gmail.com>
1 parent addd16c commit 5b17470

File tree

4 files changed

+15
-19
lines changed

4 files changed

+15
-19
lines changed

docs/libraries/fatdrvce.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Known Limitations
2929
-----------------
3030

3131
- The filesystem must use 512 byte logical blocks.
32-
- The filesystem must be formatted as FAT32 (currently no support for FAT12, FAT16, or exFAT)
33-
- Long name support is not yet implemented.
32+
- The filesystem must be formatted as FAT32 (no support for FAT12, FAT16, or exFAT)
33+
- Long name support is not currently implemented.
3434

3535
API Documentation
3636
-----------------
3737

3838
.. doxygenfile:: fatdrvce.h
39-
:project: CE C Toolchain
39+
:project: CE C/C++ Toolchain

docs/libraries/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,7 @@ USB Libraries:
2525

2626
usbdrvce
2727
srldrvce
28+
msddrvce
29+
fatdrvce
2830

2931
Click any of the above links to navigate to the library's documentation.

docs/libraries/msddrvce.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,20 @@ The **msddrvce** library implements routines for writing and reading data to/fro
1111
Common MSDs include flash drives, SD cards, hard drives, and similar block-level storage devices.
1212
Both synchronous and asynchronous block read/write functions are provided by this library.
1313

14-
.. note::
15-
16-
Only drives utilizing 512 byte logical blocks and Master Boot Record (MBR) partition formats are currently supported.
17-
1814
.. contents:: :local:
1915
:depth: 3
2016

17+
Known Limitations
18+
-----------------
19+
20+
- The maximum drive size is 2TiB.
21+
- Only drives utilizing 512 byte logical blocks are supported.
22+
2123
Supported Devices
2224
-----------------
2325

24-
The following drives have been verified to work (or not work) when used with a standard OTG adapter connector.
26+
The following drives have been verified to work when used with a standard OTG adapter connector.
27+
Other devices may also work but may not have been tested.
2528
The **msd_bandwidth** program found in the msddrvce examples directory can be used to determine if the device is suitable.
2629
This program can also be used to test the bandwidth for reading/writing blocks on the device, given in the below table:
2730

@@ -40,13 +43,11 @@ This program can also be used to test the bandwidth for reading/writing blocks o
4043
+--------------------------------------------+-------------+---------------+--------------+
4144
| Sandisk Ultra 32GB | 3.0 | 222.57 | 253.29 |
4245
+--------------------------------------------+-------------+---------------+--------------+
43-
| Sandisk Cruzer Glide 32B | 2.0 | 232.94 | 252.94 |
44-
+--------------------------------------------+-------------+---------------+--------------+
45-
| Cheap unamed drive | 2.0 | 210.00 | 252.35 |
46+
| Sandisk Cruzer Glide 32GB | 2.0 | 232.94 | 252.94 |
4647
+--------------------------------------------+-------------+---------------+--------------+
4748

4849
API Documentation
4950
-----------------
5051

5152
.. doxygenfile:: msddrvce.h
52-
:project: CE C Toolchain
53+
:project: CE C/C++ Toolchain

src/msddrvce/msddrvce.h

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
* @file
33
* @brief Mass Storage Device (MSD) Driver
44
*
5-
* This library can be used to communicate with Mass Storage Devices (MSD).
6-
* Common mass storage devices are flash drives, SD cards, and external SSDs.
7-
*
8-
* Currently only drives with a logical block size of 512 bytes are supported,
9-
* which is the most common block size available. Larger drives and SSDs may
10-
* not work. The maximum drive size is 2TiB.
11-
*
125
* @author Matt "MateoConLechuga" Waltz
136
* @author Jacob "jacobly" Young
147
*/

0 commit comments

Comments
 (0)