QMK/lib/chibios/os/hal/dox/hal_mfs.dox

31 lines
1.1 KiB
Plaintext

/*
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 HAL_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
*/