diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-04-29 08:16:10 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-04-29 08:16:10 +0000 |
| commit | 3de1c4b3fe3247d8b5fb10a8f4627f096868ed7e (patch) | |
| tree | 3518401efb415da367905e5c24dc425b3e386349 /os/hal/dox/mfs.dox | |
| parent | ca4302fcca8d855cb162f903828350a57b1c8d40 (diff) | |
| download | ChibiOS-3de1c4b3fe3247d8b5fb10a8f4627f096868ed7e.tar.gz ChibiOS-3de1c4b3fe3247d8b5fb10a8f4627f096868ed7e.tar.bz2 ChibiOS-3de1c4b3fe3247d8b5fb10a8f4627f096868ed7e.zip | |
Documentation-relate fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11978 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/dox/mfs.dox')
| -rw-r--r-- | os/hal/dox/mfs.dox | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/os/hal/dox/mfs.dox b/os/hal/dox/mfs.dox new file mode 100644 index 000000000..359cb2f9e --- /dev/null +++ b/os/hal/dox/mfs.dox @@ -0,0 +1,30 @@ +/*
+ ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+/**
+ * @defgroup MFS Managed Flash Storage Driver
+ * @brief Managed Flash Storage Driver.
+ * @details This module implements a managed flash storage able to store
+ * a finite number of variable-size records. Records are retrieved
+ * by their index number.<br>
+ * The driver is automatically performs:
+ * - Wear leveling.
+ * - Auto repair after power loss.
+ * - Garbage collection in order to remove erased data.
+ * .
+ *
+ * @ingroup HAL_COMPLEX_DRIVERS
+ */
|