Skip to content

Commit 53e83ce

Browse files
committed
Extract API documentation into separate document
1 parent 7ac0aeb commit 53e83ce

File tree

1 file changed

+1
-60
lines changed

1 file changed

+1
-60
lines changed

docs/README.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -41,66 +41,7 @@ Many ISO C standard functions are also made available. For example: fopen, fprin
4141

4242
Start pathnames on SD Cards with "/sdcard/" and pathnames on USB thumb drives with "/usb/". See the Examples section below for examples.
4343

44-
The following are additional functions provided by the library:
45-
46-
### `int` [`mount`](#)`(enum StorageDevices deviceName, enum FileSystems fileSystem, enum MountFlags mountFlags)`
47-
48-
Attach a file system to a device.
49-
50-
#### Parameters
51-
* `deviceName` The device to attach to: DEV_SDCARD or DEV_USB.
52-
* `fileSystem` The file system type to attach: FS_FAT or FS_LITTLEFS.
53-
* `mountFlags` The only valid flag at this time: MNT_DEFAULT (future platforms might also support MNT_RDONLY).
54-
55-
#### Returns
56-
On success: 0. On failure: -1 with an error code in the errno variable.
57-
58-
59-
### `int` [`umount`](#)`(enum StorageDevices deviceName)`
60-
61-
Remove the attached file system from a device.
62-
63-
#### Parameters
64-
* `deviceName` The device to remove from: DEV_SDCARD or DEV_USB.
65-
66-
#### Returns
67-
On success: 0. On failure: -1 with an error code in the errno variable.
68-
69-
70-
### `int` [`register_hotplug_callback`](#)`(enum StorageDevices deviceName, void (*callbackFunction)())`
71-
72-
Register a hotplug callback function. Currently only supported for DEV_USB on Portenta C33.
73-
74-
#### Parameters
75-
* `deviceName` The device to register for: DEV_SDCARD or DEV_USB.
76-
* `callbackFunction` A function pointer to the callback.
77-
78-
#### Returns
79-
On success: 0. On failure: -1 with an error code in the errno variable.
80-
81-
82-
### `int` [`deregister_hotplug_callback`](#)`(enum StorageDevices deviceName)`
83-
84-
Deregister a previously registered hotplug callback function. Not currently supported on any platform.
85-
86-
#### Parameters
87-
* `deviceName` The device to deregister for: DEV_SDCARD or DEV_USB.
88-
89-
#### Returns
90-
On success: 0. On failure: -1 with an error code in the errno variable.
91-
92-
93-
### `int` [`mkfs`](#)`(enum StorageDevices deviceName, enum FileSystems fileSystem)`
94-
95-
Format a device (make file system).
96-
97-
#### Parameters
98-
* `deviceName` The device to format: DEV_SDCARD or DEV_USB.
99-
* `fileSystem` The file system type to format: FS_FAT or FS_LITTLEFS. FS_FAT is probably the better choice for both SD Cards and USB thumb drives in most cases.
100-
101-
#### Returns
102-
On success: 0. On failure: -1 with an error code in the errno variable.
103-
44+
See [here](./api.md) for a complete description of the API.
10445

10546
## Examples
10647

0 commit comments

Comments
 (0)